diff --git a/docs/pages/toolchain/sozo/world-commands/account.mdx b/docs/pages/toolchain/sozo/world-commands/account.mdx new file mode 100644 index 00000000..c0b9188e --- /dev/null +++ b/docs/pages/toolchain/sozo/world-commands/account.mdx @@ -0,0 +1,88 @@ +import WorldOptions from '../common/world-options.mdx' +import StarknetOptions from '../common/starknet-options.mdx' +import AccountOptions from '../common/account-options.mdx' +import SignerOptionsRaw from '../common/signer-options-raw.mdx' +import SignerOptionsKeystore from '../common/signer-options-keystore.mdx' +import TransactionOptions from '../common/transaction-options.mdx' + +## Sozo Account + +The `sozo account` command allows managing account contracts. +It provides functionalities to create new account configurations, deploying them, and fetch +account configuration for already existing account. + +Note that we currently only support the OpenZeppelin account variant. For more advanced use cases, consider using [starkli](https://book.starkli.rs/accounts). + +## Usage + +```bash +sozo account [OPTIONS] + +Commands: + new Create a new account configuration without actually deploying. + deploy Deploy account contract with a DeployAccount transaction. + fetch Fetch account config from an already deployed account contract. + help Print this message or the help of the given subcommand(s). + +``` +### Subcommands + +#### `new` + +Create a new account configuration without actually deploying. + +#### `deploy` + +Deploy account contract + +#### `fetch` + +Fetch account config from an already deployed account contract. + +### OPTIONS + +#### Starknet Options + + + +#### Signer Options - Raw + + + +#### Signer Options - Keystore + + + +#### Transaction Options + + + +#### Specific Options: + +`--simulate`: Simulate the transaction without sending it. + +`--estimate_only`: Only estimate the transaction fee without sending the transaction. + +`--nonce`: Manually provide a nonce for the transaction. + +`--poll_interval`: Set the interval (in milliseconds) for polling the transaction result. [default: 1000] + +`--file`: Path to the account config file. + +`--no_confirmation`: Skip the user confirmation step. + + +### Example + +#### Create a New Keystore file + +```sh +sozo keystore new .json +``` + +#### Create a New Account Configuration + +```sh +sozo account new --keystore .json .json +``` + diff --git a/vocs.config.ts b/vocs.config.ts index cc82c1e1..3c8100f2 100644 --- a/vocs.config.ts +++ b/vocs.config.ts @@ -251,6 +251,10 @@ export default defineConfig({ text: "auth", link: "/toolchain/sozo/world-commands/auth", }, + { + text: "account", + link: "/toolchain/sozo/world-commands/account", + }, { text: "configruations", link: "/toolchain/sozo/common-options/configurations",