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

docs: update contracts/README.md #191

Open
Theo6890 opened this issue Feb 10, 2023 · 1 comment
Open

docs: update contracts/README.md #191

Theo6890 opened this issue Feb 10, 2023 · 1 comment

Comments

@Theo6890
Copy link

Hey guys, first of all thank you very much for this library it so helpful 🙏

I do have a recommendation to complete the Layout section to explain the role of internal interfaces and regular interfaces.

Here is what I propose:

folder layer contents description example
- 'internal' interface custom error, enum, struct, event & preferably modifier parent of IXyz.sol IDiamondWritableInternal.sol, IDiamondReadableInternal.sol
- interface function prototypes child of internal interfaces (e.g. IRandomnessWritable is IRandomnessWritableInternal) IDiamondFallback.sol, IDiamondReadble.sol, IDiamondWritable.sol
@Theo6890 Theo6890 changed the title docs: update /contracts/README.md docs: update contracts/README.md Feb 10, 2023
@Theo6890 Theo6890 changed the title docs: update contracts/README.md docs: update contracts/README.md Feb 10, 2023
@ItsNickBarry
Copy link
Member

There are some issues with the inheritance patterns that must be resolved, then we will add this type of documentation.

Specifically, this PR does not compile: solidstate-network/layerzero-client#3

The resolution might affect the recommended patterns.

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

No branches or pull requests

2 participants