Update generated docs

stellar · Sep 3, 2024 · b4ad9dc · b4ad9dc
1 parent df84abb
commit b4ad9dc
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 5 deletions.
diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md
@@ -118,6 +118,10 @@ Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id a
 * `--asset <ASSET>` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5"
 * `--source-account <SOURCE_ACCOUNT>` — Account where the final transaction originates from. If no `--sign-with-*` flag is passed, passed key will also be used to sign the transaction. Can be an identity (`--source alice`), a secret key (`--source SC36…`), or a seed phrase (`--source "kite urban…"`)
 * `--sign-with-key <SIGN_WITH_KEY>` — Sign with a local key. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path
+* `--sign-with-lab` — Sign with laboratory
+* `--lab-url <LAB_URL>` — Lab URL for `sign_with_lab`
+
+  Default value: `https://lab.stellar.org/transaction/sign`
 * `--hd-path <HD_PATH>` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0`
 * `--yes` — If one of `--sign-with-*` flags is provided, don't ask to confirm to sign a transaction
 * `--rpc-url <RPC_URL>` — RPC server endpoint
@@ -139,6 +143,10 @@ Deploy builtin Soroban Asset Contract
 * `--asset <ASSET>` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5"
 * `--source-account <SOURCE_ACCOUNT>` — Account where the final transaction originates from. If no `--sign-with-*` flag is passed, passed key will also be used to sign the transaction. Can be an identity (`--source alice`), a secret key (`--source SC36…`), or a seed phrase (`--source "kite urban…"`)
 * `--sign-with-key <SIGN_WITH_KEY>` — Sign with a local key. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path
+* `--sign-with-lab` — Sign with laboratory
+* `--lab-url <LAB_URL>` — Lab URL for `sign_with_lab`
+
+  Default value: `https://lab.stellar.org/transaction/sign`
 * `--hd-path <HD_PATH>` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0`
 * `--yes` — If one of `--sign-with-*` flags is provided, don't ask to confirm to sign a transaction
 * `--rpc-url <RPC_URL>` — RPC server endpoint
@@ -352,6 +360,10 @@ If no keys are specified the contract itself is extended.
 
 * `--source-account <SOURCE_ACCOUNT>` — Account where the final transaction originates from. If no `--sign-with-*` flag is passed, passed key will also be used to sign the transaction. Can be an identity (`--source alice`), a secret key (`--source SC36…`), or a seed phrase (`--source "kite urban…"`)
 * `--sign-with-key <SIGN_WITH_KEY>` — Sign with a local key. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path
+* `--sign-with-lab` — Sign with laboratory
+* `--lab-url <LAB_URL>` — Lab URL for `sign_with_lab`
+
+  Default value: `https://lab.stellar.org/transaction/sign`
 * `--hd-path <HD_PATH>` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0`
 * `--yes` — If one of `--sign-with-*` flags is provided, don't ask to confirm to sign a transaction
 * `--rpc-url <RPC_URL>` — RPC server endpoint
@@ -382,6 +394,10 @@ Deploy a wasm contract
 * `--salt <SALT>` — Custom salt 32-byte salt for the token id
 * `--source-account <SOURCE_ACCOUNT>` — Account where the final transaction originates from. If no `--sign-with-*` flag is passed, passed key will also be used to sign the transaction. Can be an identity (`--source alice`), a secret key (`--source SC36…`), or a seed phrase (`--source "kite urban…"`)
 * `--sign-with-key <SIGN_WITH_KEY>` — Sign with a local key. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path
+* `--sign-with-lab` — Sign with laboratory
+* `--lab-url <LAB_URL>` — Lab URL for `sign_with_lab`
+
+  Default value: `https://lab.stellar.org/transaction/sign`
 * `--hd-path <HD_PATH>` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0`
 * `--yes` — If one of `--sign-with-*` flags is provided, don't ask to confirm to sign a transaction
 * `--rpc-url <RPC_URL>` — RPC server endpoint
@@ -445,6 +461,10 @@ Deploy builtin Soroban Asset Contract
 * `--asset <ASSET>` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5"
 * `--source-account <SOURCE_ACCOUNT>` — Account where the final transaction originates from. If no `--sign-with-*` flag is passed, passed key will also be used to sign the transaction. Can be an identity (`--source alice`), a secret key (`--source SC36…`), or a seed phrase (`--source "kite urban…"`)
 * `--sign-with-key <SIGN_WITH_KEY>` — Sign with a local key. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path
+* `--sign-with-lab` — Sign with laboratory
+* `--lab-url <LAB_URL>` — Lab URL for `sign_with_lab`
+
+  Default value: `https://lab.stellar.org/transaction/sign`
 * `--hd-path <HD_PATH>` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0`
 * `--yes` — If one of `--sign-with-*` flags is provided, don't ask to confirm to sign a transaction
 * `--rpc-url <RPC_URL>` — RPC server endpoint
@@ -466,6 +486,10 @@ Deploy normal Wasm Contract
 * `--salt <SALT>` — ID of the Soroban contract
 * `--source-account <SOURCE_ACCOUNT>` — Account where the final transaction originates from. If no `--sign-with-*` flag is passed, passed key will also be used to sign the transaction. Can be an identity (`--source alice`), a secret key (`--source SC36…`), or a seed phrase (`--source "kite urban…"`)
 * `--sign-with-key <SIGN_WITH_KEY>` — Sign with a local key. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path
+* `--sign-with-lab` — Sign with laboratory
+* `--lab-url <LAB_URL>` — Lab URL for `sign_with_lab`
+
+  Default value: `https://lab.stellar.org/transaction/sign`
 * `--hd-path <HD_PATH>` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0`
 * `--yes` — If one of `--sign-with-*` flags is provided, don't ask to confirm to sign a transaction
 * `--rpc-url <RPC_URL>` — RPC server endpoint
@@ -666,6 +690,10 @@ Install a WASM file to the ledger without creating a contract instance
 
 * `--source-account <SOURCE_ACCOUNT>` — Account where the final transaction originates from. If no `--sign-with-*` flag is passed, passed key will also be used to sign the transaction. Can be an identity (`--source alice`), a secret key (`--source SC36…`), or a seed phrase (`--source "kite urban…"`)
 * `--sign-with-key <SIGN_WITH_KEY>` — Sign with a local key. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path
+* `--sign-with-lab` — Sign with laboratory
+* `--lab-url <LAB_URL>` — Lab URL for `sign_with_lab`
+
+  Default value: `https://lab.stellar.org/transaction/sign`
 * `--hd-path <HD_PATH>` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0`
 * `--yes` — If one of `--sign-with-*` flags is provided, don't ask to confirm to sign a transaction
 * `--rpc-url <RPC_URL>` — RPC server endpoint
@@ -707,6 +735,10 @@ stellar contract invoke ... -- --help
 * `--is-view` — View the result simulating and do not sign and submit transaction. Deprecated use `--send=no`
 * `--source-account <SOURCE_ACCOUNT>` — Account where the final transaction originates from. If no `--sign-with-*` flag is passed, passed key will also be used to sign the transaction. Can be an identity (`--source alice`), a secret key (`--source SC36…`), or a seed phrase (`--source "kite urban…"`)
 * `--sign-with-key <SIGN_WITH_KEY>` — Sign with a local key. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path
+* `--sign-with-lab` — Sign with laboratory
+* `--lab-url <LAB_URL>` — Lab URL for `sign_with_lab`
+
+  Default value: `https://lab.stellar.org/transaction/sign`
 * `--hd-path <HD_PATH>` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0`
 * `--yes` — If one of `--sign-with-*` flags is provided, don't ask to confirm to sign a transaction
 * `--rpc-url <RPC_URL>` — RPC server endpoint
@@ -790,6 +822,10 @@ Print the current value of a contract-data ledger entry
 
 * `--source-account <SOURCE_ACCOUNT>` — Account where the final transaction originates from. If no `--sign-with-*` flag is passed, passed key will also be used to sign the transaction. Can be an identity (`--source alice`), a secret key (`--source SC36…`), or a seed phrase (`--source "kite urban…"`)
 * `--sign-with-key <SIGN_WITH_KEY>` — Sign with a local key. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path
+* `--sign-with-lab` — Sign with laboratory
+* `--lab-url <LAB_URL>` — Lab URL for `sign_with_lab`
+
+  Default value: `https://lab.stellar.org/transaction/sign`
 * `--hd-path <HD_PATH>` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0`
 * `--yes` — If one of `--sign-with-*` flags is provided, don't ask to confirm to sign a transaction
 * `--rpc-url <RPC_URL>` — RPC server endpoint
@@ -829,6 +865,10 @@ If no keys are specificed the contract itself is restored.
 * `--ttl-ledger-only` — Only print the new Time To Live ledger
 * `--source-account <SOURCE_ACCOUNT>` — Account where the final transaction originates from. If no `--sign-with-*` flag is passed, passed key will also be used to sign the transaction. Can be an identity (`--source alice`), a secret key (`--source SC36…`), or a seed phrase (`--source "kite urban…"`)
 * `--sign-with-key <SIGN_WITH_KEY>` — Sign with a local key. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path
+* `--sign-with-lab` — Sign with laboratory
+* `--lab-url <LAB_URL>` — Lab URL for `sign_with_lab`
+
+  Default value: `https://lab.stellar.org/transaction/sign`
 * `--hd-path <HD_PATH>` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0`
 * `--yes` — If one of `--sign-with-*` flags is provided, don't ask to confirm to sign a transaction
 * `--rpc-url <RPC_URL>` — RPC server endpoint
@@ -1316,6 +1356,10 @@ Simulate a transaction envelope from stdin
 
 * `--source-account <SOURCE_ACCOUNT>` — Account where the final transaction originates from. If no `--sign-with-*` flag is passed, passed key will also be used to sign the transaction. Can be an identity (`--source alice`), a secret key (`--source SC36…`), or a seed phrase (`--source "kite urban…"`)
 * `--sign-with-key <SIGN_WITH_KEY>` — Sign with a local key. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path
+* `--sign-with-lab` — Sign with laboratory
+* `--lab-url <LAB_URL>` — Lab URL for `sign_with_lab`
+
+  Default value: `https://lab.stellar.org/transaction/sign`
 * `--hd-path <HD_PATH>` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0`
 * `--yes` — If one of `--sign-with-*` flags is provided, don't ask to confirm to sign a transaction
 * `--rpc-url <RPC_URL>` — RPC server endpoint
@@ -1349,6 +1393,10 @@ Sign a transaction envolope appending the signature to the envelope
 ###### **Options:**
 
 * `--sign-with-key <SIGN_WITH_KEY>` — Sign with a local key. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path
+* `--sign-with-lab` — Sign with laboratory
+* `--lab-url <LAB_URL>` — Lab URL for `sign_with_lab`
+
+  Default value: `https://lab.stellar.org/transaction/sign`
 * `--hd-path <HD_PATH>` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0`
 * `--yes` — If one of `--sign-with-*` flags is provided, don't ask to confirm to sign a transaction
 * `--rpc-url <RPC_URL>` — RPC server endpoint

diff --git a/cmd/soroban-cli/src/config/sign_with.rs b/cmd/soroban-cli/src/config/sign_with.rs
@@ -48,11 +48,7 @@ pub struct Args {
     )]
     pub sign_with_key: Option<String>,
     /// Sign with laboratory
-    #[arg(
-        long,
-        conflicts_with = "sign_with_key",
-        env = "STELLAR_SIGN_WITH_LABORATORY"
-    )]
+    #[arg(long, conflicts_with = "sign_with_key", env = "STELLAR_SIGN_WITH_LAB")]
     pub sign_with_lab: bool,
     /// Lab URL for `sign_with_lab`
     #[arg(