search

stacks-network / sbtc-docs

Documentation about sBTC
https://stacks-network.github.io/sbtc-docs/
MIT License
9 stars 8 forks source link

Document the sBTC PoX Contract #9

Open netrome opened 1 year ago

netrome commented 1 year ago

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.

netrome commented 1 year ago

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.

MarvinJanssen commented 1 year ago

It would be more runtime cost efficient to keep the contracts split, but let's discuss that on docs.

netrome commented 1 year ago

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.

MarvinJanssen commented 1 year ago

I agree.

stale[bot] commented 5 months ago

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.