Add udc docs #526
Merged
Add udc docs #526
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ericnordelo
reviewed
Dec 11, 2022
There was a problem hiding this comment.
Looking very good @andrew-fleming ! Left a couple of comments.
docs/modules/ROOT/pages/udc.adoc
Outdated
| ** <<reserved_address_space_for_deployer,Reserved Address Space for Deployer>> | ||
| ** <<reproducible_deployments,Reproducible Deployments>> | ||
| * <<calculating_counterfactual_addresses,Calculating Counterfactual Addresses>> | ||
| * <<universal_deployer_contract_api,Universal Deployer Contract API>> |
There was a problem hiding this comment.
I would use UDC API Specification for consistency with other parts of the doc. A refactor to unify this pattern (and others) would be helpful IMO (out of scope for this PR).
Co-authored-by: Eric Nordelo <eric.nordelo39@gmail.com>
martriay
reviewed
Dec 24, 2022
docs/modules/ROOT/pages/udc.adoc
Outdated
| @@ -0,0 +1,228 @@ | |||
| = Universal Deployer Contract | |||
|
|
|||
| Account contracts make up very critical components of the StarkNet ecosystem, since a bug in any implementation (let alone a widespread one) could prove disastrous. | |||
There was a problem hiding this comment.
this was the rationale to propose the UDC showcasing a use case but i'm not sure it's the same we need to explain what it is/how to use it once it's established.
i wouldn't focus that much in account account security but rather mention:
- it's a smart contract wrapping the deployment syscall to serve/support all other contracts that do not implement the function such as most account contracts
- it emits standard events for observability
- it aims to cover for the lack of a native deployment transaction type for accounts
Co-authored-by: Martín Triay <martriay@gmail.com>
martriay
reviewed
Dec 27, 2022
Co-authored-by: Martín Triay <martriay@gmail.com>
martriay
approved these changes
Dec 28, 2022
Co-authored-by: Martín Triay <martriay@gmail.com>
Co-authored-by: Martín Triay <martriay@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Depends on #530 and #532.
Resolves #500. This PR follows the old API format (consistent with entire Contracts documentation); however, I strongly recommend updating to the API presentation proposed in OpenZeppelin/nile#298 in the future.