diff --git a/docs/soroban-cli-full-docs.md b/docs/soroban-cli-full-docs.md index 040371dd09..d174c6e491 100644 --- a/docs/soroban-cli-full-docs.md +++ b/docs/soroban-cli-full-docs.md @@ -4,72 +4,72 @@ This document contains the help content for the `soroban` command-line program. **Command Overview:** -- [`soroban`↴](#soroban) -- [`soroban completion`↴](#soroban-completion) -- [`soroban config`↴](#soroban-config) -- [`soroban config network`↴](#soroban-config-network) -- [`soroban config network add`↴](#soroban-config-network-add) -- [`soroban config network rm`↴](#soroban-config-network-rm) -- [`soroban config network ls`↴](#soroban-config-network-ls) -- [`soroban config network start`↴](#soroban-config-network-start) -- [`soroban config network stop`↴](#soroban-config-network-stop) -- [`soroban config identity`↴](#soroban-config-identity) -- [`soroban config identity add`↴](#soroban-config-identity-add) -- [`soroban config identity address`↴](#soroban-config-identity-address) -- [`soroban config identity fund`↴](#soroban-config-identity-fund) -- [`soroban config identity generate`↴](#soroban-config-identity-generate) -- [`soroban config identity ls`↴](#soroban-config-identity-ls) -- [`soroban config identity rm`↴](#soroban-config-identity-rm) -- [`soroban config identity show`↴](#soroban-config-identity-show) -- [`soroban contract`↴](#soroban-contract) -- [`soroban contract asset`↴](#soroban-contract-asset) -- [`soroban contract asset id`↴](#soroban-contract-asset-id) -- [`soroban contract asset deploy`↴](#soroban-contract-asset-deploy) -- [`soroban contract bindings`↴](#soroban-contract-bindings) -- [`soroban contract bindings json`↴](#soroban-contract-bindings-json) -- [`soroban contract bindings rust`↴](#soroban-contract-bindings-rust) -- [`soroban contract bindings typescript`↴](#soroban-contract-bindings-typescript) -- [`soroban contract build`↴](#soroban-contract-build) -- [`soroban contract extend`↴](#soroban-contract-extend) -- [`soroban contract deploy`↴](#soroban-contract-deploy) -- [`soroban contract fetch`↴](#soroban-contract-fetch) -- [`soroban contract id`↴](#soroban-contract-id) -- [`soroban contract id asset`↴](#soroban-contract-id-asset) -- [`soroban contract id wasm`↴](#soroban-contract-id-wasm) -- [`soroban contract init`↴](#soroban-contract-init) -- [`soroban contract inspect`↴](#soroban-contract-inspect) -- [`soroban contract install`↴](#soroban-contract-install) -- [`soroban contract invoke`↴](#soroban-contract-invoke) -- [`soroban contract optimize`↴](#soroban-contract-optimize) -- [`soroban contract read`↴](#soroban-contract-read) -- [`soroban contract restore`↴](#soroban-contract-restore) -- [`soroban events`↴](#soroban-events) -- [`soroban keys`↴](#soroban-keys) -- [`soroban keys add`↴](#soroban-keys-add) -- [`soroban keys address`↴](#soroban-keys-address) -- [`soroban keys fund`↴](#soroban-keys-fund) -- [`soroban keys generate`↴](#soroban-keys-generate) -- [`soroban keys ls`↴](#soroban-keys-ls) -- [`soroban keys rm`↴](#soroban-keys-rm) -- [`soroban keys show`↴](#soroban-keys-show) -- [`soroban lab`↴](#soroban-lab) -- [`soroban lab token`↴](#soroban-lab-token) -- [`soroban lab token wrap`↴](#soroban-lab-token-wrap) -- [`soroban lab token id`↴](#soroban-lab-token-id) -- [`soroban lab xdr`↴](#soroban-lab-xdr) -- [`soroban lab xdr types`↴](#soroban-lab-xdr-types) -- [`soroban lab xdr types list`↴](#soroban-lab-xdr-types-list) -- [`soroban lab xdr guess`↴](#soroban-lab-xdr-guess) -- [`soroban lab xdr decode`↴](#soroban-lab-xdr-decode) -- [`soroban lab xdr encode`↴](#soroban-lab-xdr-encode) -- [`soroban lab xdr version`↴](#soroban-lab-xdr-version) -- [`soroban network`↴](#soroban-network) -- [`soroban network add`↴](#soroban-network-add) -- [`soroban network rm`↴](#soroban-network-rm) -- [`soroban network ls`↴](#soroban-network-ls) -- [`soroban network start`↴](#soroban-network-start) -- [`soroban network stop`↴](#soroban-network-stop) -- [`soroban version`↴](#soroban-version) +* [`soroban`↴](#soroban) +* [`soroban completion`↴](#soroban-completion) +* [`soroban config`↴](#soroban-config) +* [`soroban config network`↴](#soroban-config-network) +* [`soroban config network add`↴](#soroban-config-network-add) +* [`soroban config network rm`↴](#soroban-config-network-rm) +* [`soroban config network ls`↴](#soroban-config-network-ls) +* [`soroban config network start`↴](#soroban-config-network-start) +* [`soroban config network stop`↴](#soroban-config-network-stop) +* [`soroban config identity`↴](#soroban-config-identity) +* [`soroban config identity add`↴](#soroban-config-identity-add) +* [`soroban config identity address`↴](#soroban-config-identity-address) +* [`soroban config identity fund`↴](#soroban-config-identity-fund) +* [`soroban config identity generate`↴](#soroban-config-identity-generate) +* [`soroban config identity ls`↴](#soroban-config-identity-ls) +* [`soroban config identity rm`↴](#soroban-config-identity-rm) +* [`soroban config identity show`↴](#soroban-config-identity-show) +* [`soroban contract`↴](#soroban-contract) +* [`soroban contract asset`↴](#soroban-contract-asset) +* [`soroban contract asset id`↴](#soroban-contract-asset-id) +* [`soroban contract asset deploy`↴](#soroban-contract-asset-deploy) +* [`soroban contract bindings`↴](#soroban-contract-bindings) +* [`soroban contract bindings json`↴](#soroban-contract-bindings-json) +* [`soroban contract bindings rust`↴](#soroban-contract-bindings-rust) +* [`soroban contract bindings typescript`↴](#soroban-contract-bindings-typescript) +* [`soroban contract build`↴](#soroban-contract-build) +* [`soroban contract extend`↴](#soroban-contract-extend) +* [`soroban contract deploy`↴](#soroban-contract-deploy) +* [`soroban contract fetch`↴](#soroban-contract-fetch) +* [`soroban contract id`↴](#soroban-contract-id) +* [`soroban contract id asset`↴](#soroban-contract-id-asset) +* [`soroban contract id wasm`↴](#soroban-contract-id-wasm) +* [`soroban contract init`↴](#soroban-contract-init) +* [`soroban contract inspect`↴](#soroban-contract-inspect) +* [`soroban contract install`↴](#soroban-contract-install) +* [`soroban contract invoke`↴](#soroban-contract-invoke) +* [`soroban contract optimize`↴](#soroban-contract-optimize) +* [`soroban contract read`↴](#soroban-contract-read) +* [`soroban contract restore`↴](#soroban-contract-restore) +* [`soroban events`↴](#soroban-events) +* [`soroban keys`↴](#soroban-keys) +* [`soroban keys add`↴](#soroban-keys-add) +* [`soroban keys address`↴](#soroban-keys-address) +* [`soroban keys fund`↴](#soroban-keys-fund) +* [`soroban keys generate`↴](#soroban-keys-generate) +* [`soroban keys ls`↴](#soroban-keys-ls) +* [`soroban keys rm`↴](#soroban-keys-rm) +* [`soroban keys show`↴](#soroban-keys-show) +* [`soroban lab`↴](#soroban-lab) +* [`soroban lab token`↴](#soroban-lab-token) +* [`soroban lab token wrap`↴](#soroban-lab-token-wrap) +* [`soroban lab token id`↴](#soroban-lab-token-id) +* [`soroban lab xdr`↴](#soroban-lab-xdr) +* [`soroban lab xdr types`↴](#soroban-lab-xdr-types) +* [`soroban lab xdr types list`↴](#soroban-lab-xdr-types-list) +* [`soroban lab xdr guess`↴](#soroban-lab-xdr-guess) +* [`soroban lab xdr decode`↴](#soroban-lab-xdr-decode) +* [`soroban lab xdr encode`↴](#soroban-lab-xdr-encode) +* [`soroban lab xdr version`↴](#soroban-lab-xdr-version) +* [`soroban network`↴](#soroban-network) +* [`soroban network add`↴](#soroban-network-add) +* [`soroban network rm`↴](#soroban-network-rm) +* [`soroban network ls`↴](#soroban-network-ls) +* [`soroban network start`↴](#soroban-network-start) +* [`soroban network stop`↴](#soroban-network-stop) +* [`soroban version`↴](#soroban-version) ## `soroban` @@ -102,24 +102,26 @@ Full CLI reference: https://github.com/stellar/soroban-tools/tree/main/docs/soro ###### **Subcommands:** -- `completion` — Print shell completion code for the specified shell -- `config` — Deprecated, use `soroban keys` and `soroban network` instead -- `contract` — Tools for smart contract developers -- `events` — Watch the network for contract events -- `keys` — Create and manage identities including keys and addresses -- `lab` — Experiment with early features and expert tools -- `network` — Start and configure networks -- `version` — Print version information +* `completion` — Print shell completion code for the specified shell +* `config` — Deprecated, use `soroban keys` and `soroban network` instead +* `contract` — Tools for smart contract developers +* `events` — Watch the network for contract events +* `keys` — Create and manage identities including keys and addresses +* `lab` — Experiment with early features and expert tools +* `network` — Start and configure networks +* `version` — Print version information ###### **Options:** -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." -- `-f`, `--filter-logs ` — Filter logs output. To turn on "soroban_cli::log::footprint=debug" or off "=off". Can also use env var `RUST_LOG` -- `-q`, `--quiet` — Do not write logs to stderr including `INFO` -- `-v`, `--verbose` — Log DEBUG events -- `--very-verbose` — Log DEBUG and TRACE events -- `--list` — List installed plugins. E.g. `soroban-hello` +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `-f`, `--filter-logs ` — Filter logs output. To turn on "soroban_cli::log::footprint=debug" or off "=off". Can also use env var `RUST_LOG` +* `-q`, `--quiet` — Do not write logs to stderr including `INFO` +* `-v`, `--verbose` — Log DEBUG events +* `--very-verbose` — Log DEBUG and TRACE events +* `--list` — List installed plugins. E.g. `soroban-hello` + + ## `soroban completion` @@ -129,19 +131,22 @@ Ensure the completion package for your shell is installed, e.g., bash-completion for bash. To enable autocomplete in the current bash shell, run: -source <(soroban completion --shell bash) + source <(soroban completion --shell bash) To enable autocomplete permanently, run: -echo "source <(soroban completion --shell bash)" >> ~/.bashrc + echo "source <(soroban completion --shell bash)" >> ~/.bashrc **Usage:** `soroban completion --shell ` ###### **Options:** -- `--shell ` — The shell type +* `--shell ` — The shell type Possible values: `bash`, `elvish`, `fish`, `powershell`, `zsh` + + + ## `soroban config` Deprecated, use `soroban keys` and `soroban network` instead @@ -150,8 +155,10 @@ Deprecated, use `soroban keys` and `soroban network` instead ###### **Subcommands:** -- `network` — Configure different networks. Depraecated, use `soroban network` instead -- `identity` — Identity management. Deprecated, use `soroban keys` instead +* `network` — Configure different networks. Depraecated, use `soroban network` instead +* `identity` — Identity management. Deprecated, use `soroban keys` instead + + ## `soroban config network` @@ -161,11 +168,13 @@ Configure different networks. Depraecated, use `soroban network` instead ###### **Subcommands:** -- `add` — Add a new network -- `rm` — Remove a network -- `ls` — List networks -- `start` — Start network -- `stop` — Stop network +* `add` — Add a new network +* `rm` — Remove a network +* `ls` — List networks +* `start` — Start network +* `stop` — Stop network + + ## `soroban config network add` @@ -175,14 +184,16 @@ Add a new network ###### **Arguments:** -- `` — Name of network +* `` — Name of network ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban config network rm` @@ -192,12 +203,14 @@ Remove a network ###### **Arguments:** -- `` — Network to remove +* `` — Network to remove ###### **Options:** -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban config network ls` @@ -207,37 +220,60 @@ List networks ###### **Options:** -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." -- `-l`, `--long` — Get more info about the networks +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `-l`, `--long` — Get more info about the networks + + ## `soroban config network start` Start network -**Usage:** `soroban config network start [OPTIONS] [-- ...]` +This command allows for starting a stellar quickstart container. To run it, you can use the following command: `soroban network start [OPTIONS]` + +By default, when starting a testnet container, without any optional arguments, it will run the equivalent of the following docker command: docker run --rm -p 8000:8000 --name stellar stellar/quickstart:testing --testnet --enable-soroban-rpc + +**Usage:** `soroban config network start [OPTIONS] ` ###### **Arguments:** -- `` — Network to start, e.g. local, testnet, futurenet, pubnet -- `` +* `` — Network to start + + Possible values: `local`, `testnet`, `futurenet`, `pubnet` + ###### **Options:** -- `-t`, `--image-tag-override ` — optional argument to override the default docker image tag for the given network -- `-r`, `--disable-soroban-rpc` — optional argument to turn off soroban rpc -- `-p`, `--protocol-version ` -- `-l`, `--limit ` +* `-d`, `--docker-socket-path ` — Optional argument to override the default docker socket path. This is useful when you are using a non-standard docker socket path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +* `-l`, `--limit ` — Optional argument to specify the limits for the local network only +* `-p`, `--ports-mapping ` — Argument to specify the HOST_PORT:CONTAINER_PORT mapping + + Default value: `8000:8000` +* `-r`, `--disable-soroban-rpc` — Optional argument to turn off soroban rpc +* `-t`, `--image-tag-override ` — Optional argument to override the default docker image tag for the given network +* `-v`, `--protocol-version ` — Optional argument to specify the protocol version for the local network only + + ## `soroban config network stop` Stop network -**Usage:** `soroban config network stop [CONTAINER]` +**Usage:** `soroban config network stop [OPTIONS] ` ###### **Arguments:** -- `` — docker container to stop, defaults to "stellar" +* `` — Network to stop + + Possible values: `local`, `testnet`, `futurenet`, `pubnet` + + +###### **Options:** + +* `-d`, `--docker-socket-path ` — Optional argument to override the default docker socket path. This is useful when you are using a non-standard docker socket path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock + + ## `soroban config identity` @@ -247,13 +283,15 @@ Identity management. Deprecated, use `soroban keys` instead ###### **Subcommands:** -- `add` — Add a new identity (keypair, ledger, macOS keychain) -- `address` — Given an identity return its address (public key) -- `fund` — Fund an identity on a test network -- `generate` — Generate a new identity with a seed phrase, currently 12 words -- `ls` — List identities -- `rm` — Remove an identity -- `show` — Given an identity return its private key +* `add` — Add a new identity (keypair, ledger, macOS keychain) +* `address` — Given an identity return its address (public key) +* `fund` — Fund an identity on a test network +* `generate` — Generate a new identity with a seed phrase, currently 12 words +* `ls` — List identities +* `rm` — Remove an identity +* `show` — Given an identity return its private key + + ## `soroban config identity add` @@ -263,14 +301,16 @@ Add a new identity (keypair, ledger, macOS keychain) ###### **Arguments:** -- `` — Name of identity +* `` — Name of identity ###### **Options:** -- `--secret-key` — Add using secret_key Can provide with SOROBAN_SECRET_KEY -- `--seed-phrase` — Add using 12 word seed phrase to generate secret_key -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--secret-key` — Add using secret_key Can provide with SOROBAN_SECRET_KEY +* `--seed-phrase` — Add using 12 word seed phrase to generate secret_key +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban config identity address` @@ -280,13 +320,15 @@ Given an identity return its address (public key) ###### **Arguments:** -- `` — Name of identity to lookup, default test identity used if not provided +* `` — Name of identity to lookup, default test identity used if not provided ###### **Options:** -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban config identity fund` @@ -296,16 +338,18 @@ Fund an identity on a test network ###### **Arguments:** -- `` — Name of identity to lookup, default test identity used if not provided +* `` — Name of identity to lookup, default test identity used if not provided ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban config identity generate` @@ -315,20 +359,22 @@ Generate a new identity with a seed phrase, currently 12 words ###### **Arguments:** -- `` — Name of identity +* `` — Name of identity ###### **Options:** -- `--no-fund` — Do not fund address -- `--seed ` — Optional seed to use when generating seed phrase. Random otherwise -- `-s`, `--as-secret` — Output the generated identity as a secret key -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." -- `--hd-path ` — When generating a secret key, which hd_path should be used from the original seed_phrase -- `-d`, `--default-seed` — Generate the default seed phrase. Useful for testing. Equivalent to --seed 0000000000000000 -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config +* `--no-fund` — Do not fund address +* `--seed ` — Optional seed to use when generating seed phrase. Random otherwise +* `-s`, `--as-secret` — Output the generated identity as a secret key +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `--hd-path ` — When generating a secret key, which hd_path should be used from the original seed_phrase +* `-d`, `--default-seed` — Generate the default seed phrase. Useful for testing. Equivalent to --seed 0000000000000000 +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config + + ## `soroban config identity ls` @@ -338,9 +384,11 @@ List identities ###### **Options:** -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." -- `-l`, `--long` +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `-l`, `--long` + + ## `soroban config identity rm` @@ -350,12 +398,14 @@ Remove an identity ###### **Arguments:** -- `` — Identity to remove +* `` — Identity to remove ###### **Options:** -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban config identity show` @@ -365,13 +415,15 @@ Given an identity return its private key ###### **Arguments:** -- `` — Name of identity to lookup, default is test identity +* `` — Name of identity to lookup, default is test identity ###### **Options:** -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban contract` @@ -381,20 +433,22 @@ Tools for smart contract developers ###### **Subcommands:** -- `asset` — Utilities to deploy a Stellar Asset Contract or get its id -- `bindings` — Generate code client bindings for a contract -- `build` — Build a contract from source -- `extend` — Extend the time to live ledger of a contract-data ledger entry -- `deploy` — Deploy a wasm contract -- `fetch` — Fetch a contract's Wasm binary -- `id` — Generate the contract id for a given contract or asset -- `init` — Initialize a Soroban project with an example contract -- `inspect` — Inspect a WASM file listing contract functions, meta, etc -- `install` — Install a WASM file to the ledger without creating a contract instance -- `invoke` — Invoke a contract function -- `optimize` — Optimize a WASM file -- `read` — Print the current value of a contract-data ledger entry -- `restore` — Restore an evicted value for a contract-data legder entry +* `asset` — Utilities to deploy a Stellar Asset Contract or get its id +* `bindings` — Generate code client bindings for a contract +* `build` — Build a contract from source +* `extend` — Extend the time to live ledger of a contract-data ledger entry +* `deploy` — Deploy a wasm contract +* `fetch` — Fetch a contract's Wasm binary +* `id` — Generate the contract id for a given contract or asset +* `init` — Initialize a Soroban project with an example contract +* `inspect` — Inspect a WASM file listing contract functions, meta, etc +* `install` — Install a WASM file to the ledger without creating a contract instance +* `invoke` — Invoke a contract function +* `optimize` — Optimize a WASM file +* `read` — Print the current value of a contract-data ledger entry +* `restore` — Restore an evicted value for a contract-data legder entry + + ## `soroban contract asset` @@ -404,8 +458,10 @@ Utilities to deploy a Stellar Asset Contract or get its id ###### **Subcommands:** -- `id` — Get Id of builtin Soroban Asset Contract. Deprecated, use `soroban contract id asset` instead -- `deploy` — Deploy builtin Soroban Asset Contract +* `id` — Get Id of builtin Soroban Asset Contract. Deprecated, use `soroban contract id asset` instead +* `deploy` — Deploy builtin Soroban Asset Contract + + ## `soroban contract asset id` @@ -415,14 +471,16 @@ Get Id of builtin Soroban Asset Contract. Deprecated, use `soroban contract id a ###### **Options:** -- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config -- `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` -- `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config +* `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` +* `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban contract asset deploy` @@ -432,18 +490,20 @@ Deploy builtin Soroban Asset Contract ###### **Options:** -- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config -- `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` -- `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config +* `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` +* `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` + + ## `soroban contract bindings` Generate code client bindings for a contract @@ -452,9 +512,11 @@ Generate code client bindings for a contract ###### **Subcommands:** -- `json` — Generate Json Bindings -- `rust` — Generate Rust bindings -- `typescript` — Generate a TypeScript / JavaScript package +* `json` — Generate Json Bindings +* `rust` — Generate Rust bindings +* `typescript` — Generate a TypeScript / JavaScript package + + ## `soroban contract bindings json` @@ -464,7 +526,9 @@ Generate Json Bindings ###### **Options:** -- `--wasm ` — Path to wasm binary +* `--wasm ` — Path to wasm binary + + ## `soroban contract bindings rust` @@ -474,7 +538,9 @@ Generate Rust bindings ###### **Options:** -- `--wasm ` — Path to wasm binary +* `--wasm ` — Path to wasm binary + + ## `soroban contract bindings typescript` @@ -484,15 +550,17 @@ Generate a TypeScript / JavaScript package ###### **Options:** -- `--wasm ` — Path to optional wasm binary -- `--output-dir ` — Where to place generated project -- `--overwrite` — Whether to overwrite output directory if it already exists -- `--contract-id ` — The contract ID/address on the network -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config +* `--wasm ` — Path to optional wasm binary +* `--output-dir ` — Where to place generated project +* `--overwrite` — Whether to overwrite output directory if it already exists +* `--contract-id ` — The contract ID/address on the network +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config + + ## `soroban contract build` @@ -506,20 +574,20 @@ To view the commands that will be executed, without executing them, use the --pr ###### **Options:** -- `--manifest-path ` — Path to Cargo.toml +* `--manifest-path ` — Path to Cargo.toml Default value: `Cargo.toml` - -- `--package ` — Package to build -- `--profile ` — Build with the specified profile +* `--package ` — Package to build +* `--profile ` — Build with the specified profile Default value: `release` +* `--features ` — Build with the list of features activated, space or comma separated +* `--all-features` — Build with the all features activated +* `--no-default-features` — Build with the default feature not activated +* `--out-dir ` — Directory to copy wasm files to +* `--print-commands-only` — Print commands to build without executing them + -- `--features ` — Build with the list of features activated, space or comma separated -- `--all-features` — Build with the all features activated -- `--no-default-features` — Build with the default feature not activated -- `--out-dir ` — Directory to copy wasm files to -- `--print-commands-only` — Print commands to build without executing them ## `soroban contract extend` @@ -531,35 +599,36 @@ If no keys are specified the contract itself is extended. ###### **Options:** -- `--ledgers-to-extend ` — Number of ledgers to extend the entries -- `--ttl-ledger-only` — Only print the new Time To Live ledger -- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -- `--key ` — Storage key (symbols only) -- `--key-xdr ` — Storage key (base64-encoded XDR) -- `--wasm ` — Path to Wasm file of contract code to extend -- `--wasm-hash ` — Path to Wasm file of contract code to extend -- `--durability ` — Storage entry durability +* `--ledgers-to-extend ` — Number of ledgers to extend the entries +* `--ttl-ledger-only` — Only print the new Time To Live ledger +* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +* `--key ` — Storage key (symbols only) +* `--key-xdr ` — Storage key (base64-encoded XDR) +* `--wasm ` — Path to Wasm file of contract code to extend +* `--wasm-hash ` — Path to Wasm file of contract code to extend +* `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: Persistent - `temporary`: Temporary -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config -- `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` -- `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config +* `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` +* `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` + + ## `soroban contract deploy` Deploy a wasm contract @@ -568,24 +637,25 @@ Deploy a wasm contract ###### **Options:** -- `--wasm ` — WASM file to deploy -- `--wasm-hash ` — Hash of the already installed/deployed WASM file -- `--salt ` — Custom salt 32-byte salt for the token id -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config -- `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` -- `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--wasm ` — WASM file to deploy +* `--wasm-hash ` — Hash of the already installed/deployed WASM file +* `--salt ` — Custom salt 32-byte salt for the token id +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config +* `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` +* `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts +* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` + + ## `soroban contract fetch` Fetch a contract's Wasm binary @@ -594,13 +664,15 @@ Fetch a contract's Wasm binary ###### **Options:** -- `--id ` — Contract ID to fetch -- `-o`, `--out-file ` — Where to write output otherwise stdout is used -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config +* `--id ` — Contract ID to fetch +* `-o`, `--out-file ` — Where to write output otherwise stdout is used +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config + + ## `soroban contract id` @@ -610,8 +682,10 @@ Generate the contract id for a given contract or asset ###### **Subcommands:** -- `asset` — Deploy builtin Soroban Asset Contract -- `wasm` — Deploy normal Wasm Contract +* `asset` — Deploy builtin Soroban Asset Contract +* `wasm` — Deploy normal Wasm Contract + + ## `soroban contract id asset` @@ -621,14 +695,16 @@ Deploy builtin Soroban Asset Contract ###### **Options:** -- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config -- `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` -- `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config +* `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` +* `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban contract id wasm` @@ -638,14 +714,16 @@ Deploy normal Wasm Contract ###### **Options:** -- `--salt ` — ID of the Soroban contract -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config -- `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` -- `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--salt ` — ID of the Soroban contract +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config +* `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` +* `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban contract init` @@ -655,18 +733,20 @@ Initialize a Soroban project with an example contract ###### **Arguments:** -- `` +* `` ###### **Options:** -- `-w`, `--with-example ` +* `-w`, `--with-example ` Possible values: `account`, `alloc`, `atomic_multiswap`, `atomic_swap`, `auth`, `cross_contract`, `custom_types`, `deep_contract_auth`, `deployer`, `errors`, `events`, `fuzzing`, `increment`, `liquidity_pool`, `logging`, `mint-lock`, `simple_account`, `single_offer`, `timelock`, `token`, `upgradeable_contract`, `workspace` -- `-f`, `--frontend-template ` +* `-f`, `--frontend-template ` Default value: `` + + ## `soroban contract inspect` Inspect a WASM file listing contract functions, meta, etc @@ -675,13 +755,12 @@ Inspect a WASM file listing contract functions, meta, etc ###### **Options:** -- `--wasm ` — Path to wasm binary -- `--output ` — Output just XDR in base64 +* `--wasm ` — Path to wasm binary +* `--output ` — Output just XDR in base64 Default value: `docs` Possible values: - - `xdr-base64`: XDR of array of contract spec entries - `xdr-base64-array`: @@ -689,8 +768,10 @@ Inspect a WASM file listing contract functions, meta, etc - `docs`: Pretty print of contract spec entries -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban contract install` @@ -700,22 +781,23 @@ Install a WASM file to the ledger without creating a contract instance ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config -- `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` -- `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config +* `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` +* `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--wasm ` — Path to wasm binary -- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts +* `--wasm ` — Path to wasm binary +* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` + + ## `soroban contract invoke` Invoke a contract function @@ -728,25 +810,27 @@ soroban contract invoke ... -- --help ###### **Arguments:** -- `` — Function name as subcommand, then arguments for that function as `--arg-name value` +* `` — Function name as subcommand, then arguments for that function as `--arg-name value` ###### **Options:** -- `--id ` — Contract ID to invoke -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--is-view` — Do not sign and submit transaction -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config -- `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` -- `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--id ` — Contract ID to invoke +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--is-view` — Do not sign and submit transaction +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config +* `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` +* `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` + + ## `soroban contract optimize` Optimize a WASM file @@ -755,8 +839,10 @@ Optimize a WASM file ###### **Options:** -- `--wasm ` — Path to wasm binary -- `--wasm-out ` — Path to write the optimized WASM file to (defaults to same location as --wasm with .optimized.wasm suffix) +* `--wasm ` — Path to wasm binary +* `--wasm-out ` — Path to write the optimized WASM file to (defaults to same location as --wasm with .optimized.wasm suffix) + + ## `soroban contract read` @@ -766,12 +852,11 @@ Print the current value of a contract-data ledger entry ###### **Options:** -- `--output ` — Type of output to generate +* `--output ` — Type of output to generate Default value: `string` Possible values: - - `string`: String - `json`: @@ -779,29 +864,30 @@ Print the current value of a contract-data ledger entry - `xdr`: XDR -- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -- `--key ` — Storage key (symbols only) -- `--key-xdr ` — Storage key (base64-encoded XDR) -- `--wasm ` — Path to Wasm file of contract code to extend -- `--wasm-hash ` — Path to Wasm file of contract code to extend -- `--durability ` — Storage entry durability +* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +* `--key ` — Storage key (symbols only) +* `--key-xdr ` — Storage key (base64-encoded XDR) +* `--wasm ` — Path to Wasm file of contract code to extend +* `--wasm-hash ` — Path to Wasm file of contract code to extend +* `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: Persistent - `temporary`: Temporary -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config -- `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` -- `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config +* `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` +* `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban contract restore` @@ -813,35 +899,36 @@ If no keys are specificed the contract itself is restored. ###### **Options:** -- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -- `--key ` — Storage key (symbols only) -- `--key-xdr ` — Storage key (base64-encoded XDR) -- `--wasm ` — Path to Wasm file of contract code to extend -- `--wasm-hash ` — Path to Wasm file of contract code to extend -- `--durability ` — Storage entry durability +* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +* `--key ` — Storage key (symbols only) +* `--key-xdr ` — Storage key (base64-encoded XDR) +* `--wasm ` — Path to Wasm file of contract code to extend +* `--wasm-hash ` — Path to Wasm file of contract code to extend +* `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: Persistent - `temporary`: Temporary -- `--ledgers-to-extend ` — Number of ledgers to extend the entry -- `--ttl-ledger-only` — Only print the new Time To Live ledger -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config -- `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` -- `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--ledgers-to-extend ` — Number of ledgers to extend the entry +* `--ttl-ledger-only` — Only print the new Time To Live ledger +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config +* `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` +* `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` + + ## `soroban events` Watch the network for contract events @@ -850,14 +937,13 @@ Watch the network for contract events ###### **Options:** -- `--start-ledger ` — The first ledger sequence number in the range to pull events https://developers.stellar.org/docs/encyclopedia/ledger-headers#ledger-sequence -- `--cursor ` — The cursor corresponding to the start of the event range -- `--output ` — Output formatting options for event stream +* `--start-ledger ` — The first ledger sequence number in the range to pull events https://developers.stellar.org/docs/encyclopedia/ledger-headers#ledger-sequence +* `--cursor ` — The cursor corresponding to the start of the event range +* `--output ` — Output formatting options for event stream Default value: `pretty` Possible values: - - `pretty`: Colorful, human-oriented console output - `plain`: @@ -865,23 +951,24 @@ Watch the network for contract events - `json`: JSONified console output -- `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) +* `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) Default value: `10` - -- `--id ` — A set of (up to 5) contract IDs to filter events on. This parameter can be passed multiple times, e.g. `--id C123.. --id C456..`, or passed with multiple parameters, e.g. `--id C123 C456` -- `--topic ` — A set of (up to 4) topic filters to filter event topics on. A single topic filter can contain 1-4 different segment filters, separated by commas, with an asterisk (\* character) indicating a wildcard segment -- `--type ` — Specifies which type of contract events to display +* `--id ` — A set of (up to 5) contract IDs to filter events on. This parameter can be passed multiple times, e.g. `--id C123.. --id C456..`, or passed with multiple parameters, e.g. `--id C123 C456` +* `--topic ` — A set of (up to 4) topic filters to filter event topics on. A single topic filter can contain 1-4 different segment filters, separated by commas, with an asterisk (* character) indicating a wildcard segment +* `--type ` — Specifies which type of contract events to display Default value: `all` Possible values: `all`, `contract`, `system` -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config + + ## `soroban keys` @@ -891,13 +978,15 @@ Create and manage identities including keys and addresses ###### **Subcommands:** -- `add` — Add a new identity (keypair, ledger, macOS keychain) -- `address` — Given an identity return its address (public key) -- `fund` — Fund an identity on a test network -- `generate` — Generate a new identity with a seed phrase, currently 12 words -- `ls` — List identities -- `rm` — Remove an identity -- `show` — Given an identity return its private key +* `add` — Add a new identity (keypair, ledger, macOS keychain) +* `address` — Given an identity return its address (public key) +* `fund` — Fund an identity on a test network +* `generate` — Generate a new identity with a seed phrase, currently 12 words +* `ls` — List identities +* `rm` — Remove an identity +* `show` — Given an identity return its private key + + ## `soroban keys add` @@ -907,14 +996,16 @@ Add a new identity (keypair, ledger, macOS keychain) ###### **Arguments:** -- `` — Name of identity +* `` — Name of identity ###### **Options:** -- `--secret-key` — Add using secret_key Can provide with SOROBAN_SECRET_KEY -- `--seed-phrase` — Add using 12 word seed phrase to generate secret_key -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--secret-key` — Add using secret_key Can provide with SOROBAN_SECRET_KEY +* `--seed-phrase` — Add using 12 word seed phrase to generate secret_key +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban keys address` @@ -924,13 +1015,15 @@ Given an identity return its address (public key) ###### **Arguments:** -- `` — Name of identity to lookup, default test identity used if not provided +* `` — Name of identity to lookup, default test identity used if not provided ###### **Options:** -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban keys fund` @@ -940,16 +1033,18 @@ Fund an identity on a test network ###### **Arguments:** -- `` — Name of identity to lookup, default test identity used if not provided +* `` — Name of identity to lookup, default test identity used if not provided ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban keys generate` @@ -959,20 +1054,22 @@ Generate a new identity with a seed phrase, currently 12 words ###### **Arguments:** -- `` — Name of identity +* `` — Name of identity ###### **Options:** -- `--no-fund` — Do not fund address -- `--seed ` — Optional seed to use when generating seed phrase. Random otherwise -- `-s`, `--as-secret` — Output the generated identity as a secret key -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." -- `--hd-path ` — When generating a secret key, which hd_path should be used from the original seed_phrase -- `-d`, `--default-seed` — Generate the default seed phrase. Useful for testing. Equivalent to --seed 0000000000000000 -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config +* `--no-fund` — Do not fund address +* `--seed ` — Optional seed to use when generating seed phrase. Random otherwise +* `-s`, `--as-secret` — Output the generated identity as a secret key +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `--hd-path ` — When generating a secret key, which hd_path should be used from the original seed_phrase +* `-d`, `--default-seed` — Generate the default seed phrase. Useful for testing. Equivalent to --seed 0000000000000000 +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config + + ## `soroban keys ls` @@ -982,9 +1079,11 @@ List identities ###### **Options:** -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." -- `-l`, `--long` +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `-l`, `--long` + + ## `soroban keys rm` @@ -994,12 +1093,14 @@ Remove an identity ###### **Arguments:** -- `` — Identity to remove +* `` — Identity to remove ###### **Options:** -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban keys show` @@ -1009,13 +1110,15 @@ Given an identity return its private key ###### **Arguments:** -- `` — Name of identity to lookup, default is test identity +* `` — Name of identity to lookup, default is test identity ###### **Options:** -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban lab` @@ -1025,8 +1128,10 @@ Experiment with early features and expert tools ###### **Subcommands:** -- `token` — Wrap, create, and manage token contracts -- `xdr` — Decode xdr +* `token` — Wrap, create, and manage token contracts +* `xdr` — Decode xdr + + ## `soroban lab token` @@ -1036,8 +1141,10 @@ Wrap, create, and manage token contracts ###### **Subcommands:** -- `wrap` — Deploy a token contract to wrap an existing Stellar classic asset for smart contract usage Deprecated, use `soroban contract deploy asset` instead -- `id` — Compute the expected contract id for the given asset Deprecated, use `soroban contract id asset` instead +* `wrap` — Deploy a token contract to wrap an existing Stellar classic asset for smart contract usage Deprecated, use `soroban contract deploy asset` instead +* `id` — Compute the expected contract id for the given asset Deprecated, use `soroban contract id asset` instead + + ## `soroban lab token wrap` @@ -1047,18 +1154,20 @@ Deploy a token contract to wrap an existing Stellar classic asset for smart cont ###### **Options:** -- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config -- `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` -- `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config +* `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` +* `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` + + ## `soroban lab token id` Compute the expected contract id for the given asset Deprecated, use `soroban contract id asset` instead @@ -1067,14 +1176,16 @@ Compute the expected contract id for the given asset Deprecated, use `soroban co ###### **Options:** -- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--network ` — Name of network to use from config -- `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` -- `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--network ` — Name of network to use from config +* `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` +* `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban lab xdr` @@ -1084,20 +1195,23 @@ Decode xdr ###### **Subcommands:** -- `types` — View information about types -- `guess` — Guess the XDR type -- `decode` — Decode XDR -- `encode` — Encode XDR -- `version` — Print version information +* `types` — View information about types +* `guess` — Guess the XDR type +* `decode` — Decode XDR +* `encode` — Encode XDR +* `version` — Print version information ###### **Arguments:** -- `` — Channel of XDR to operate on +* `` — Channel of XDR to operate on Default value: `+curr` Possible values: `+curr`, `+next` + + + ## `soroban lab xdr types` View information about types @@ -1106,7 +1220,9 @@ View information about types ###### **Subcommands:** -- `list` — +* `list` — + + ## `soroban lab xdr types list` @@ -1114,12 +1230,15 @@ View information about types ###### **Options:** -- `--output ` +* `--output ` Default value: `plain` Possible values: `plain`, `json`, `json-formatted` + + + ## `soroban lab xdr guess` Guess the XDR type @@ -1128,26 +1247,28 @@ Guess the XDR type ###### **Arguments:** -- `` — File to decode, or stdin if omitted +* `` — File to decode, or stdin if omitted ###### **Options:** -- `--input ` +* `--input ` Default value: `single-base64` Possible values: `single`, `single-base64`, `stream`, `stream-base64`, `stream-framed` -- `--output ` +* `--output ` Default value: `list` Possible values: `list` -- `--certainty ` — Certainty as an arbitrary value +* `--certainty ` — Certainty as an arbitrary value Default value: `2` + + ## `soroban lab xdr decode` Decode XDR @@ -1156,23 +1277,26 @@ Decode XDR ###### **Arguments:** -- `` — Files to decode, or stdin if omitted +* `` — Files to decode, or stdin if omitted ###### **Options:** -- `--type ` — XDR type to decode -- `--input ` +* `--type ` — XDR type to decode +* `--input ` Default value: `stream-base64` Possible values: `single`, `single-base64`, `stream`, `stream-base64`, `stream-framed` -- `--output ` +* `--output ` Default value: `json` Possible values: `json`, `json-formatted` + + + ## `soroban lab xdr encode` Encode XDR @@ -1181,29 +1305,34 @@ Encode XDR ###### **Arguments:** -- `` — Files to encode, or stdin if omitted +* `` — Files to encode, or stdin if omitted ###### **Options:** -- `--type ` — XDR type to encode -- `--input ` +* `--type ` — XDR type to encode +* `--input ` Default value: `json` Possible values: `json` -- `--output ` +* `--output ` Default value: `single-base64` Possible values: `single`, `single-base64` + + + ## `soroban lab xdr version` Print version information **Usage:** `soroban lab xdr version` + + ## `soroban network` Start and configure networks @@ -1212,11 +1341,13 @@ Start and configure networks ###### **Subcommands:** -- `add` — Add a new network -- `rm` — Remove a network -- `ls` — List networks -- `start` — Start network -- `stop` — Stop network +* `add` — Add a new network +* `rm` — Remove a network +* `ls` — List networks +* `start` — Start network +* `stop` — Stop network + + ## `soroban network add` @@ -1226,14 +1357,16 @@ Add a new network ###### **Arguments:** -- `` — Name of network +* `` — Name of network ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--rpc-url ` — RPC server endpoint +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban network rm` @@ -1243,12 +1376,14 @@ Remove a network ###### **Arguments:** -- `` — Network to remove +* `` — Network to remove ###### **Options:** -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." + + ## `soroban network ls` @@ -1258,37 +1393,60 @@ List networks ###### **Options:** -- `--global` — Use global config -- `--config-dir ` — Location of config directory, default is "." -- `-l`, `--long` — Get more info about the networks +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `-l`, `--long` — Get more info about the networks + + ## `soroban network start` Start network -**Usage:** `soroban network start [OPTIONS] [-- ...]` +This command allows for starting a stellar quickstart container. To run it, you can use the following command: `soroban network start [OPTIONS]` + +By default, when starting a testnet container, without any optional arguments, it will run the equivalent of the following docker command: docker run --rm -p 8000:8000 --name stellar stellar/quickstart:testing --testnet --enable-soroban-rpc + +**Usage:** `soroban network start [OPTIONS] ` ###### **Arguments:** -- `` — Network to start, e.g. local, testnet, futurenet, pubnet -- `` +* `` — Network to start + + Possible values: `local`, `testnet`, `futurenet`, `pubnet` + ###### **Options:** -- `-t`, `--image-tag-override ` — optional argument to override the default docker image tag for the given network -- `-r`, `--disable-soroban-rpc` — optional argument to turn off soroban rpc -- `-p`, `--protocol-version ` -- `-l`, `--limit ` +* `-d`, `--docker-socket-path ` — Optional argument to override the default docker socket path. This is useful when you are using a non-standard docker socket path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +* `-l`, `--limit ` — Optional argument to specify the limits for the local network only +* `-p`, `--ports-mapping ` — Argument to specify the HOST_PORT:CONTAINER_PORT mapping + + Default value: `8000:8000` +* `-r`, `--disable-soroban-rpc` — Optional argument to turn off soroban rpc +* `-t`, `--image-tag-override ` — Optional argument to override the default docker image tag for the given network +* `-v`, `--protocol-version ` — Optional argument to specify the protocol version for the local network only + + ## `soroban network stop` Stop network -**Usage:** `soroban network stop [CONTAINER]` +**Usage:** `soroban network stop [OPTIONS] ` ###### **Arguments:** -- `` — docker container to stop, defaults to "stellar" +* `` — Network to stop + + Possible values: `local`, `testnet`, `futurenet`, `pubnet` + + +###### **Options:** + +* `-d`, `--docker-socket-path ` — Optional argument to override the default docker socket path. This is useful when you are using a non-standard docker socket path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock + + ## `soroban version` @@ -1296,9 +1454,11 @@ Print version information **Usage:** `soroban version` + +
-This document was generated automatically by -clap-markdown. + This document was generated automatically by + clap-markdown.