Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add licencing info #92

Closed
wants to merge 1 commit into from
Closed

add licencing info #92

wants to merge 1 commit into from

Conversation

RnkSngh
Copy link
Collaborator

@RnkSngh RnkSngh commented Apr 23, 2024 •
edited by coderabbitai bot
Loading

PR to add SDPX licence to this repo.

I've neglected adding it to the test files, since I'm assuming we aren't distributing those?

Summary by CodeRabbit

  • Documentation
    • Introduced Apache License Version 2.0 across various components, ensuring all users and developers are aware of the terms for use, reproduction, and distribution.
  • Chores
    • Updated SPDX license identifiers to Apache-2.0 for multiple contracts and interfaces, standardizing the licensing across the codebase.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Apr 23, 2024 •
edited
Loading

Walkthrough

The primary update across the project involves transitioning from an UNLICENSED status to adopting the Apache License Version 2.0. This change affects multiple files, primarily updating the SPDX license identifier and adding copyright and licensing information for Polymer Labs. No functional changes in the code were noted, focusing solely on licensing updates.

Changes

Files Change Summary
LICENSE, contracts/.../GeneralMiddleware.sol, contracts/.../Dispatcher.sol, contracts/.../OpLightClient.sol, contracts/.../OpProofVerifier.sol, contracts/.../UniversalChannelHandler.sol, contracts/.../Earth.sol, contracts/.../Mars.sol, contracts/.../IDispatcher.sol, contracts/.../IUniversalChannelHandler.sol, contracts/.../IbcDispatcher.sol, contracts/.../IbcMiddleware.sol, contracts/.../IbcReceiver.sol, contracts/.../IbcReceiverUpgradeable.sol, contracts/.../LightClient.sol, contracts/.../ProofVerifier.sol, contracts/.../Ibc.sol, contracts/.../DummyLightClient.sol, contracts/.../DummyProofVerifier.sol, contracts/.../GasAudit.sol, test/TestUtils.t.sol, test/.../DispatcherV2.sol, test/.../DispatcherV2Initializable.sol Updated SPDX license identifier from UNLICENSED to Apache-2.0. Added copyright and licensing information for Polymer Labs. No functional changes.

🐇✨
In the meadow of code, under the sky so blue,
A little rabbit hopped, with a license brand new.
From UNLICENSED to Apache, with a hop, skip, and a leap,
Ensuring the garden of software is theirs to keep.
Oh, how the fields of code now gleefully sway,
Under the watchful eyes of Apache's fair play.
🌼📜

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 5731020 and 9304eae.
Files selected for processing (23)
  • LICENSE (1 hunks)
  • contracts/base/GeneralMiddleware.sol (1 hunks)
  • contracts/core/Dispatcher.sol (1 hunks)
  • contracts/core/OpLightClient.sol (1 hunks)
  • contracts/core/OpProofVerifier.sol (1 hunks)
  • contracts/core/UniversalChannelHandler.sol (1 hunks)
  • contracts/examples/Earth.sol (1 hunks)
  • contracts/examples/Mars.sol (1 hunks)
  • contracts/interfaces/IDispatcher.sol (1 hunks)
  • contracts/interfaces/IUniversalChannelHandler.sol (1 hunks)
  • contracts/interfaces/IbcDispatcher.sol (1 hunks)
  • contracts/interfaces/IbcMiddleware.sol (1 hunks)
  • contracts/interfaces/IbcReceiver.sol (1 hunks)
  • contracts/interfaces/IbcReceiverUpgradeable.sol (1 hunks)
  • contracts/interfaces/LightClient.sol (1 hunks)
  • contracts/interfaces/ProofVerifier.sol (1 hunks)
  • contracts/libs/Ibc.sol (1 hunks)
  • contracts/utils/DummyLightClient.sol (1 hunks)
  • contracts/utils/DummyProofVerifier.sol (1 hunks)
  • contracts/utils/GasAudit.sol (1 hunks)
  • test/TestUtils.t.sol (1 hunks)
  • test/upgradeableProxy/upgrades/DispatcherV2.sol (1 hunks)
  • test/upgradeableProxy/upgrades/DispatcherV2Initializable.sol (1 hunks)
Files not reviewed due to errors (1)
  • test/upgradeableProxy/upgrades/DispatcherV2.sol (no review received)
Files skipped from review due to trivial changes (12)
  • LICENSE
  • contracts/core/OpLightClient.sol
  • contracts/core/OpProofVerifier.sol
  • contracts/interfaces/IDispatcher.sol
  • contracts/interfaces/IUniversalChannelHandler.sol
  • contracts/interfaces/IbcMiddleware.sol
  • contracts/interfaces/IbcReceiver.sol
  • contracts/interfaces/ProofVerifier.sol
  • contracts/libs/Ibc.sol
  • contracts/utils/GasAudit.sol
  • test/TestUtils.t.sol
  • test/upgradeableProxy/upgrades/DispatcherV2Initializable.sol
Additional Context Used
GitHub Check Runs (1)
lint success (11)

contracts/base/GeneralMiddleware.sol: [warning] 21-21:
imported name Ibc is not used

contracts/base/GeneralMiddleware.sol: [warning] 41-41:
Variable name must be in mixedCase

contracts/base/GeneralMiddleware.sol: [warning] 59-59:
Named parameters missing. MIN unnamed argumenst is 4

contracts/base/GeneralMiddleware.sol: [warning] 70-70:
Named parameters missing. MIN unnamed argumenst is 4

contracts/base/GeneralMiddleware.sol: [warning] 73-73:
All public or external methods in a contract must override a definition from an interface

contracts/base/GeneralMiddleware.sol: [warning] 89-89:
Named parameters missing. MIN unnamed argumenst is 4

contracts/base/GeneralMiddleware.sol: [warning] 118-118:
Named parameters missing. MIN unnamed argumenst is 4

contracts/base/GeneralMiddleware.sol: [warning] 135-135:
Named parameters missing. MIN unnamed argumenst is 4

contracts/base/GeneralMiddleware.sol: [warning] 148-148:
Named parameters missing. MIN unnamed argumenst is 4

contracts/base/GeneralMiddleware.sol: [warning] 168-168:
Code contains empty blocks

Additional comments not posted (10)
contracts/utils/DummyProofVerifier.sol (1)

1-16: The licensing information has been updated correctly to reflect the Apache-2.0 license as intended by the PR. The header includes all necessary components such as the copyright notice, license URL, and the disclaimer.

contracts/interfaces/LightClient.sol (1)

1-16: The licensing information has been updated correctly to reflect the Apache-2.0 license as intended by the PR. The header includes all necessary components such as the copyright notice, license URL, and the disclaimer.

contracts/utils/DummyLightClient.sol (1)

1-16: The licensing information has been updated correctly to reflect the Apache-2.0 license as intended by the PR. The header includes all necessary components such as the copyright notice, license URL, and the disclaimer.

contracts/interfaces/IbcReceiverUpgradeable.sol (1)

1-16: The licensing information has been updated correctly to reflect the Apache-2.0 license as intended by the PR. The header includes all necessary components such as the copyright notice, license URL, and the disclaimer.

contracts/examples/Earth.sol (1)

1-16: The licensing information has been updated correctly to reflect the Apache-2.0 license as intended by the PR. The header includes all necessary components such as the copyright notice, license URL, and the disclaimer.

contracts/interfaces/IbcDispatcher.sol (1)

1-16: The licensing information has been updated correctly to reflect the Apache-2.0 license as intended by the PR. The header includes all necessary components such as the copyright notice, license URL, and the disclaimer.

contracts/examples/Mars.sol (1)

1-16: The licensing information has been updated correctly to reflect the Apache-2.0 license as intended by the PR. The header includes all necessary components such as the copyright notice, license URL, and the disclaimer.

contracts/base/GeneralMiddleware.sol (1)

1-17: The licensing information has been updated correctly to reflect the Apache-2.0 license as intended by the PR. The header includes all necessary components such as the copyright notice, license URL, and the disclaimer.

contracts/core/UniversalChannelHandler.sol (1)

1-15: The licensing header has been updated correctly to reflect the Apache License Version 2.0 as per the PR objectives. The format and placement are appropriate.

contracts/core/Dispatcher.sol (1)

1-15: The licensing header has been updated correctly to reflect the Apache License Version 2.0 as per the PR objectives. The format and placement are appropriate.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@RnkSngh RnkSngh linked an issue Apr 23, 2024 that may be closed by this pull request
Pre Solidity audit checklist #93
Closed
7 tasks
@RnkSngh RnkSngh closed this Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Pre Solidity audit checklist
1 participant
@RnkSngh