-
Notifications
You must be signed in to change notification settings - Fork 8
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
Document the sBTC PoX Contract #9
Comments
Open question: I know sBTC Mini is broken down to many contracts. I don't know if we'll do the same with the final PoX contract. If so, it could be good to document the public interface but also provide an explanation of the sub-contracts as sub-chapters. |
It would be more runtime cost efficient to keep the contracts split, but let's discuss that on docs. |
Let's aim for a similar structure. I think it is easier to understand a collection of small focused contracts for a reader rather than one single massive contract too. I guess only the asset contract and PoX will be externally facing in sBTC though, so let's focus on those for starters. |
I agree. |
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
Definition of done
The documentation contains a chapter explaining which functions the new PoX contract should contain, their purpose and who calls them.
Note: This should focus on the public interface and anything critical to the sBTC design. Implementation details may be omitted.
The text was updated successfully, but these errors were encountered: