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.

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

Proposal to refactor contracts folder for devUX #36

Closed
tmsdkeys opened this issue Dec 12, 2023 · 1 comment · Fixed by #43
Closed

Proposal to refactor contracts folder for devUX #36

tmsdkeys opened this issue Dec 12, 2023 · 1 comment · Fixed by #43

Comments

@tmsdkeys
Copy link
Contributor

tmsdkeys commented Dec 12, 2023

The contracts folder is starting to look messy with a large amount of files. External developers will also add the contracts to their projects when downloading npm package.

I propose to clean it up by introducing some folders; i.e. interfaces, utils, examples, libs and core for the main logic.

Example:

.
contracts
├── core
│   ├── Dispatcher.sol
│   ├── OpConsensusStateManager.sol
│   ├── OpProofVerifier.sol
│   └── UniversalChannelHandler.sol
├── examples
│   ├── Earth.sol
│   ├── GeneralMiddleware.sol
│   └── Mars.sol
├── interfaces
│   ├── ConsensusStateManager.sol
│   ├── IbcDispatcher.sol
│   ├── IbcMiddleware.sol
│   ├── IbcReceiver.sol
│   └── ProofVerifier.sol
├── libs
│   └── Ibc.sol
└── utils
    ├── DummyConsensusStateManager.sol
    ├── DummyProofVerifier.sol
    └── GasAudit.sol

External dApp devs would then mostly be interested in interfaces and demo folders.

@tmsdkeys
Copy link
Contributor Author

Updated this to match contracts prior to public testnet

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant