docs: Updated content on deploying a new account. #1163

stoobie · 2024-03-06T09:33:53Z

Description of the Changes

This PR addresses #935.

PR Preview URL

Deploying new accounts

Also moved Universal Deployer Contract to a different place in the TOC:

Check List

Changes have been done against main branch, and PR does not conflict
PR title follows the convention: <docs/feat/fix/chore>(optional scope): <description>, e.g: fix: minor typos in code

This change is

github-actions · 2024-03-06T09:35:20Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1163/documentation/ .

odednaor · 2024-03-06T13:04:40Z

...onents/Starknet/modules/architecture_and_concepts/pages/Accounts/deploying_new_accounts.adoc


-== Deploy account transaction
+* Send a `DEPLOY_ACCOUNT` transaction. This method does not require a preexisting account.
+* Include the `deploy` syscall in the account contract, such as by invoking the Universal Deployer Contract (UDC) with an `INVOKE` transaction. This method requires an existing account to send the `INVOKE` transaction.


Suggested change

* Include the `deploy` syscall in the account contract, such as by invoking the Universal Deployer Contract (UDC) with an `INVOKE` transaction. This method requires an existing account to send the `INVOKE` transaction.

* Using the Universal Deployer Contract (UDC). This method requires an existing account to send the `INVOKE` transaction.

Also suggest referencing the UDC documentation

odednaor · 2024-03-06T13:06:07Z

...onents/Starknet/modules/architecture_and_concepts/pages/Accounts/deploying_new_accounts.adoc

-* Decide on the account contract that you want to deploy
-* Compute your would-be account address off-chain
-* Send funds to this address
+. Verifies that the address has funds to pay for the deployment.


If deployed using the DEPLOY_ACCOUNT tx, then the fees are paid from the deployed account address. If by using the UDC, then from the sender account.

odednaor · 2024-03-06T13:07:10Z

...onents/Starknet/modules/architecture_and_concepts/pages/Accounts/deploying_new_accounts.adoc

-* Compute your would-be account address off-chain
-* Send funds to this address
+. Verifies that the address has funds to pay for the deployment.
+. Executes the constructor with the given arguments.


Other way around, first the validate deploy or validate, only then the constructor.

odednaor · 2024-03-06T13:07:22Z

...onents/Starknet/modules/architecture_and_concepts/pages/Accounts/deploying_new_accounts.adoc

+. Verifies that the address has funds to pay for the deployment.
+. Executes the constructor with the given arguments.
+. Runs the respective validation function in the contract, as follows:
+** When deploying with the `DEPLOY_ACCOUNT` transaction type, the sequencer executes the `+__validate_deploy__+` function in the contract.


Suggested change

** When deploying with the `DEPLOY_ACCOUNT` transaction type, the sequencer executes the `+__validate_deploy__+` function in the contract.

** When deploying with the `DEPLOY_ACCOUNT` transaction type, the sequencer executes the `+__validate_deploy__+` function in the deployed contract.

odednaor · 2024-03-06T13:07:47Z

...onents/Starknet/modules/architecture_and_concepts/pages/Accounts/deploying_new_accounts.adoc

+. Executes the constructor with the given arguments.
+. Runs the respective validation function in the contract, as follows:
+** When deploying with the `DEPLOY_ACCOUNT` transaction type, the sequencer executes the `+__validate_deploy__+` function in the contract.
+** When deploying with the `INVOKE` transaction type and a contract that includes the `deploy` syscall, such as the UDC, the sequencer executes the `+__validate__+` function in the contract.


Suggested change

** When deploying with the `INVOKE` transaction type and a contract that includes the `deploy` syscall, such as the UDC, the sequencer executes the `+__validate__+` function in the contract.

** When deploying using the UDC, the sequencer executes the `+__validate__+` function in the contract of the sender address.

odednaor · 2024-03-06T13:08:40Z

...onents/Starknet/modules/architecture_and_concepts/pages/Accounts/deploying_new_accounts.adoc

+** When deploying with the `DEPLOY_ACCOUNT` transaction type, the sequencer executes the `+__validate_deploy__+` function in the contract.
+** When deploying with the `INVOKE` transaction type and a contract that includes the `deploy` syscall, such as the UDC, the sequencer executes the `+__validate__+` function in the contract.
+. Charges fees from the new account address.
+. Sets the account's nonce to `1`.


This is only true in case the account is deployed with the DEPLOY_ACCOUNT tx. If by the UDC, the nonce of the deployed account is 0.

odednaor · 2024-03-06T13:09:42Z

...onents/Starknet/modules/architecture_and_concepts/pages/Accounts/deploying_new_accounts.adoc


-Once the address has enough funds to pay for the deployment, you can then send a `deploy_account` transaction.
+== Deploying a new account with Starkli


I suggest just having a link to the Starkli book instead of having this full section.

I got rid of the Prerequisites and the Procedure heading.

odednaor

Left some comments.

stoobie · 2024-03-06T13:58:51Z

...onents/Starknet/modules/architecture_and_concepts/pages/Accounts/deploying_new_accounts.adoc

-* Decide on the account contract that you want to deploy
-* Compute your would-be account address off-chain
-* Send funds to this address
+. Verifies that the address has funds to pay for the deployment.


Suggested change

. Verifies that the address has funds to pay for the deployment.

. Verifies that the address has funds to pay for the deployment.

+

If you use a `DEPLOY_ACCOUNT` transaction, the fees are paid from the address of the deployed account. If you use the UDC, the fees are paid from the sender's account.

Remove it from the numbered list and add as a note. For DEPLOY_ACCOUNT tx, the fees are charged from the deployed address and from an INVOKE tx using the UDC, the fees are charged from the sender's account (and add a link to the transactions types page to invoke tx v1 and v3).

github-actions · 2024-03-06T14:09:41Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1163/documentation/ .

odednaor

see inline comments

github-actions · 2024-03-14T09:30:04Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1163/documentation/ .

github-actions · 2024-03-14T09:31:09Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1163/documentation/ .

odednaor

lgtm

* Updated content on deploying a new account. * SME comments. * SME comments

Updated content on deploying a new account.

74f8a45

stoobie requested a review from odednaor March 6, 2024 09:34

stoobie changed the title ~~Updated content on deploying a new account.~~ docs: Updated content on deploying a new account. Mar 6, 2024

odednaor reviewed Mar 6, 2024

View reviewed changes

stoobie commented Mar 6, 2024

View reviewed changes

SME comments.

e748073

stoobie requested a review from odednaor March 10, 2024 14:04

odednaor requested changes Mar 14, 2024

View reviewed changes

stoobie and others added 2 commits March 14, 2024 11:29

SME comments

222672a

Merge branch 'main' into steve/deploy_new_account

033584a

odednaor approved these changes Mar 14, 2024

View reviewed changes

stoobie merged commit b19927b into main Mar 14, 2024
3 checks passed

stoobie deleted the steve/deploy_new_account branch March 14, 2024 09:36

stoobie mentioned this pull request Mar 14, 2024

Correct the deploy account page and provide more ways to deploy accounts using UDC #935

Closed

xiaolou86 pushed a commit to xiaolou86/starknet-docs that referenced this pull request Apr 7, 2024

docs: Updated content on deploying a new account. (starknet-io#1163)

17058a7

* Updated content on deploying a new account. * SME comments. * SME comments

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Updated content on deploying a new account. #1163

docs: Updated content on deploying a new account. #1163

stoobie commented Mar 6, 2024 •

edited

Loading

github-actions bot commented Mar 6, 2024

odednaor Mar 6, 2024

stoobie Mar 6, 2024

odednaor Mar 6, 2024

stoobie Mar 6, 2024

odednaor Mar 6, 2024

stoobie Mar 6, 2024

odednaor Mar 6, 2024

stoobie Mar 6, 2024

odednaor Mar 6, 2024

stoobie Mar 6, 2024

odednaor Mar 6, 2024

stoobie Mar 6, 2024

odednaor Mar 6, 2024 •

edited

Loading

stoobie Mar 6, 2024

odednaor left a comment

stoobie Mar 6, 2024

stoobie Mar 6, 2024

odednaor Mar 14, 2024

stoobie Mar 14, 2024

github-actions bot commented Mar 6, 2024

odednaor left a comment

github-actions bot commented Mar 14, 2024

github-actions bot commented Mar 14, 2024

odednaor left a comment

	* Include the `deploy` syscall in the account contract, such as by invoking the Universal Deployer Contract (UDC) with an `INVOKE` transaction. This method requires an existing account to send the `INVOKE` transaction.
	* Using the Universal Deployer Contract (UDC). This method requires an existing account to send the `INVOKE` transaction.

	** When deploying with the `DEPLOY_ACCOUNT` transaction type, the sequencer executes the `+__validate_deploy__+` function in the contract.
	** When deploying with the `DEPLOY_ACCOUNT` transaction type, the sequencer executes the `+__validate_deploy__+` function in the deployed contract.

	** When deploying with the `INVOKE` transaction type and a contract that includes the `deploy` syscall, such as the UDC, the sequencer executes the `+__validate__+` function in the contract.
	** When deploying using the UDC, the sequencer executes the `+__validate__+` function in the contract of the sender address.


		Once the address has enough funds to pay for the deployment, you can then send a `deploy_account` transaction.
		== Deploying a new account with Starkli

docs: Updated content on deploying a new account. #1163

docs: Updated content on deploying a new account. #1163

Conversation

stoobie commented Mar 6, 2024 • edited Loading

Description of the Changes

PR Preview URL

Check List

github-actions bot commented Mar 6, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

odednaor Mar 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

odednaor left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Mar 6, 2024

odednaor left a comment

Choose a reason for hiding this comment

github-actions bot commented Mar 14, 2024

github-actions bot commented Mar 14, 2024

odednaor left a comment

Choose a reason for hiding this comment

stoobie commented Mar 6, 2024 •

edited

Loading

odednaor Mar 6, 2024 •

edited

Loading