Add udc docs #954
Add udc docs #954
Conversation
There was a problem hiding this comment.
Looking good! left some comments.
We should add Utilities,Universal Deployer Contract to page-sidebar-collapse-default: in antora.yml as well.
And the most important thing I think we should focus is being more explicit on the differences between UDC origin-dependent deployments, and deploy_syscall origin-dependent deployments, since currently it seems origin-dependent is specific to UDC while is not (from utilities names and wording).
Co-authored-by: Eric Nordelo <[email protected]>
Co-authored-by: Eric Nordelo <[email protected]>
| salt: felt252, | ||
| class_hash: ClassHash, | ||
| constructor_calldata: Span<felt252>, | ||
| deployer_address: ContractAddress |
There was a problem hiding this comment.
Wdyt about making this an Option instead of expecting zero?
If we do this I think we can convert the two udc helpers into just one, by receiving an Option<DeployerInfo>, being DeployerInfo (caller_address, udc_address).
There was a problem hiding this comment.
Much better solution! Good call
docs/modules/ROOT/nav.adoc
Outdated
| @@ -38,6 +38,8 @@ | |||
| *** xref:/api/upgrades.adoc[API Reference] | |||
|
|
|||
| ** xref:utilities.adoc[Utilities] | |||
| *** xref:udc.adoc[Universal Deployer Contract] | |||
There was a problem hiding this comment.
I feel this should not be under utilities, since we have a preset, I think this should be under the modules section directly, even if the interface is in the utilities.
Co-authored-by: Eric Nordelo <[email protected]>
Co-authored-by: Eric Nordelo <[email protected]>
docs/modules/ROOT/pages/udc.adoc
Outdated
| :utils-api: xref:/utilities.adoc#deployments[Utilities API] | ||
|
|
||
| This library offers utility functions written in Cairo to precompute contract addresses. | ||
| They include the generic {calculate_contract_address_from_deploy_syscall} as well as UDC-specific calculations. |
There was a problem hiding this comment.
Should we link the udc util too?
| /// Returns the contract address from a `deploy_syscall`. | ||
| /// `deployer_address` should be the zero address if the deployment is origin-independent (deployed from zero). | ||
| /// For more information, see https://docs.starknet.io/documentation/architecture_and_concepts/Smart_Contracts/contract-address/ | ||
| fn calculate_contract_address_from_deploy_syscall( |
There was a problem hiding this comment.
| fn calculate_contract_address_from_deploy_syscall( | |
| fn deploy_syscall_calculate_contract_address( |
just for consistency with udc_calculate_contract_address
There was a problem hiding this comment.
Small last comment, sorry since I was the one suggesting the change, but what do you think of putting calculate_contract_address at the beginning of the helper name? I think it feels better that way, since the most important part is that, no the deploy_syscall.
TL'DR: I vote we change deploy_syscall_calculate_contract_address to calculate_contract_address_from_deploy_syscall, and udc_calculate_contract_address to calculate_contract_address_from_udc
There was a problem hiding this comment.
Haha no worries. Yeah, it seems more natural starting with calculate_. Will update
Fixes #950.
PR Checklist
Tried the feature on a public networkIgnore the line: "The UDC address is deployed at address0xFIX-MEin ADD-NETWORKS-WHEN-DEPLOYED." This will be added when available.