# Token CLI Commands Reference An CLI utility for ethereum token management. ## Global Options - `--api-url ` - Token API URL to connect to (default: http://localhost:4000, env: TOKEN_API_URL) - `--state-manager-url ` - State Manager URL to connect to (default: http://localhost:3030, env: STATE_MANAGER_URL) ## Top-Level Commands ### Ping Ping the Token API server. ```bash token-cli ping ``` ### ApiVersion Display the Token API version. ```bash token-cli api-version ``` ### NetworkInfo Display network information. ```bash token-cli network-info ``` --- ## Util Commands Utility sub-commands for account and wallet management. **Global Option:** - `--remote` - Use remote API to perform sensitive operations (default: false) ### util create-account Create a new Ethereum account. ```bash token-cli util [--remote] create-account [SECRET] ``` **Arguments:** - `SECRET` - Optional secret to derive the account from **Note:** Accounts created locally will not match those created by the remote API due to different derivation methods. ### util calculate-address Calculate Ethereum address from private key. ```bash token-cli util [--remote] calculate-address ``` **Arguments:** - `PRIVATE_KEY` - Private key in hex format (with or without 0x prefix) ### util check-address Check if an Ethereum address is valid. ```bash token-cli util check-address
``` **Arguments:** - `ADDRESS` - Ethereum address to check ### util encode-wallet Encode a JSON Keystore wallet from private key and password. ```bash token-cli util [--remote] encode-wallet --private-key --password [--dir ] [--filename ] ``` **Options:** - `--private-key ` - Private key in hex format - `--password ` - Password to encrypt the wallet - `--dir ` - Output directory to save the keystore file (default: current directory) - `--filename ` - Output file name to save the keystore JSON (default: auto-generated) ### util decode-wallet Decode a JSON Keystore wallet to retrieve the private key. ```bash token-cli util [--remote] decode-wallet --file --password ``` **Options:** - `--file ` - Input keystore file containing the keystore JSON - `--password ` - Password to decrypt the wallet ### util digest Compute the Ethereum Signed Message Digest for a given input string. ```bash token-cli util digest ``` **Arguments:** - `MESSAGE` - Input string to compute the digest for ### util sign-digest Sign an Ethereum Signed Message Digest with a private key. ```bash token-cli util [--remote] sign-digest --private-key ``` **Arguments:** - `DIGEST` - 32-byte hex string digest (with or without 0x prefix) **Options:** - `--private-key ` - Private key in hex format **Note:** Signatures generated locally may vary from remote API due to different recovery ID handling. ### util sign-message Sign a message with a private key. ```bash token-cli util [--remote] sign-message --private-key ``` **Arguments:** - `MESSAGE` - Input string message to sign **Options:** - `--private-key ` - Private key in hex format ### util recover-address Recover Ethereum address from signed message and signature. ```bash token-cli util [--remote] recover-address ``` **Arguments:** - `MESSAGE` - Message that was signed - `SIGNATURE` - Signature in hex format ### util balance-of Get the ether balance of an Ethereum address. ```bash token-cli util balance-of [--pretty] [--in-wei] ``` **Arguments:** - `ACCOUNT` - Ethereum address to check balance **Options:** - `--pretty` - Pretty print the balance with commas (default: false) - `--in-wei` - Display the balance in wei instead of ether (default: false) ### util send Send ether from one account to another. ```bash token-cli util send --from --private-key --to --amount [--in-wei] ``` **Options:** - `--from ` - Ethereum address to send from - `--private-key ` - Private key of the sender - `--to ` - Ethereum address to send to - `--amount ` - Amount to send (in ether by default, or wei if --in-wei is set) - `--in-wei` - Indicate if the amount is specified in wei instead of ether (default: false) --- ## Task Commands Commands for managing tasks. ### task info Get task information by its key. ```bash token-cli task info ``` **Arguments:** - `TASK_KEY` - Task key to get information for ### task list List tasks. ```bash token-cli task list [--role ] [--all] ``` **Options:** - `--role ` - Filter tasks by role - `--all` - Show all tasks, including inactive ones (default: false) ### task approve Approve a task. ```bash token-cli task approve [--private-key | --wallet --password ] ``` **Arguments:** - `TASK_KEY` - Key of the task to approve **Options:** - `--private-key ` - Private key to sign the approval - `--wallet ` - Input keystore wallet file - `--password ` - Password for the keystore wallet (will prompt if not provided) ### task execute Execute a task. ```bash token-cli task execute ``` **Arguments:** - `TASK_KEY` - Key of the task to execute ### task collect Force a task into collectable state. ```bash token-cli task collect ``` **Arguments:** - `TASK_KEY` - Key of the task to collect ### task abort Abort a task by creating an abort task. ```bash token-cli task abort [--description ] [--min-approvals ] ``` **Arguments:** - `KEY_TO_ABORT` - Key of the task to abort **Options:** - `--description ` - Description for the abort task - `--min-approvals ` - Minimum number of approvals required (default: 1) --- ## Token Commands Commands for managing a single token. All commands require `--name `. ### token deploy Deploy a new Ethereum token (DEFAULT_ADMIN_ROLE only). ```bash token-cli token --name deploy --symbol [OPTIONS] ``` **Required Options:** - `--symbol ` - Symbol of the token (e.g., MTK) **Token Configuration:** - `--decimals ` - Decimal places of the token (default: 18) - `--max-supply ` - Maximum supply (0 for unlimited) - `--initial-supply ` - Initial supply - `--initial-holder
` - Address of the initial token holder **Token Features:** - `--no-transfer` - Disable token transfers (default: false) - `--frozen` - Freeze the token after creation (default: false) - `--with-permission` - Enable permission for the token (default: false) - `--private-permission` - Enable private permission for the token (default: false) - `--token-permission
` - Address of token permission contract (default: ZERO_ADDRESS) - `--with-mask` - Turn on permission mask feature (default: false) - `--with-kyc` - Enable KYC feature (default: false) - `--with-token-fee` - Enable token fee feature (default: false) **Fee Configuration:** - `--vip-rate ` - VIP rate in basis points - `--default-rate ` - Default rate in basis points - `--min-fee ` - Minimum fee for token transfers - `--max-fee ` - Maximum fee for token transfers **Role Management:** - `--isolated-roles` - Enable local account manager for role management (default: false) - `--account-man
` - Private account manager address (default: ZERO_ADDRESS) - `--root
` - Local root address for local account manager - `--default-admin-roles ` - Comma-separated list of default admin roles - `--upgrader-admin-roles ` - Comma-separated list of upgrader admin roles - `--mint-admin-roles ` - Comma-separated list of minter admin roles - `--burn-admin-roles ` - Comma-separated list of burner admin roles - `--compliance-admin-roles ` - Comma-separated list of compliance admin roles - `--fee-admin-roles ` - Comma-separated list of fee admin roles - `--fee-recipient-roles ` - Comma-separated list of fee recipient roles - `--pauser-admin-roles ` - Comma-separated list of pauser admin roles **Task Options:** - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800, 0 for no expiry) - `--collect-delay ` - Delay before task collection starts (default: 86400) - `--description ` - Description for the deploy task ### token migrate Migrate an existing token to a new code version (UPGRADER_ROLE only). ```bash token-cli token --name migrate --new-version [OPTIONS] ``` **Required Options:** - `--new-version ` - New token code version to migrate to **Task Options:** - `--description ` - Description for the migrate task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### token address Get the token contract address by token name. ```bash token-cli token --name address ``` ### token code-version Get the code version of a deployed token. ```bash token-cli token --name code-version ``` ### token settings Get the token settings by token name. ```bash token-cli token --name settings [--pretty] [--in-base-unit] ``` **Options:** - `--pretty` - Output raw balance in pretty format (default: false) - `--in-base-unit` - Show balance as base units (true) or full tokens (false, default - more user-friendly) ### token supply Get the current supply information of a token. ```bash token-cli token --name supply [--pretty] [--in-base-unit] ``` **Options:** - `--pretty` - Output raw balance in pretty format (default: false) - `--in-base-unit` - Show balance as base units (true) or full tokens (false, default - more user-friendly) ### token balance-of Get the balance of an account for the token. ```bash token-cli token --name balance-of
[--pretty] [--in-base-unit] ``` **Arguments:** - `ADDRESS` - Account address to query balance for **Options:** - `--pretty` - Output raw balance in pretty format (default: false) - `--in-base-unit` - Show balance as base units (true) or full tokens (false, default - more user-friendly) ### token send Send tokens from one account to another. ```bash token-cli token --name send --from --to --amount [--in-base-unit] --private-key ``` **Options:** - `--from ` - Sender address - `--to ` - Recipient address - `--amount ` - Amount to send (as string, in base units) - `--in-base-unit` - Treat amount as base units (true) or full tokens (false, default - more user-friendly) - `--private-key ` - Private key of the sender address ### token mint Mint new tokens to a specified account (MINT_ADMIN_ROLE only). ```bash token-cli token --name mint --to --amount [--in-base-unit] [OPTIONS] ``` **Required Options:** - `--to ` - Recipient address - `--amount ` - Amount to mint (as string, e.g. '100' for 100 tokens or '100000000000000000000' if using --in-base-unit) **Options:** - `--in-base-unit` - Treat amount as base units (true) or full tokens (false, default - more user-friendly) **Task Options:** - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) - `--description ` - Description for the mint task ### token burn Burn tokens from a specified account (BURN_ADMIN_ROLE only). ```bash token-cli token --name burn --from --amount [--in-base-unit] [OPTIONS] ``` **Required Options:** - `--from ` - Address from which to burn tokens - `--amount ` - Amount to burn (as string, e.g. '100' for 100 tokens or '100000000000000000000' if using --in-base-unit) **Options:** - `--in-base-unit` - Treat amount as base units (true) or full tokens (false, default - more user-friendly) **Task Options:** - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) - `--description ` - Description for the burn task ### token freeze Freeze the token (PAUSER_ROLE only). ```bash token-cli token --name freeze [OPTIONS] ``` **Task Options:** - `--description ` - Description for the freeze token task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### token unfreeze Unfreeze the token (PAUSER_ROLE only). ```bash token-cli token --name unfreeze [OPTIONS] ``` **Task Options:** - `--description ` - Description for the unfreeze token task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### token is-frozen Check if the token is frozen. ```bash token-cli token --name is-frozen ``` ### token enable-transfer Enable token transfers (PAUSER_ROLE only). ```bash token-cli token --name enable-transfer [OPTIONS] ``` **Task Options:** - `--description ` - Description for the enable transfer task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### token disable-transfer Disable token transfers (PAUSER_ROLE only). ```bash token-cli token --name disable-transfer [OPTIONS] ``` **Task Options:** - `--description ` - Description for the disable transfer task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### token is-transfer-enabled Check if token transfers are enabled. ```bash token-cli token --name is-transfer-enabled ``` ### token set-symbol Set a new symbol for the token (UPGRADER_ROLE only). ```bash token-cli token --name set-symbol [OPTIONS] ``` **Arguments:** - `SYMBOL` - New symbol for the token **Task Options:** - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### token set-decimals Set token decimals (UPGRADER_ROLE only). ```bash token-cli token --name set-decimals [OPTIONS] ``` **Arguments:** - `DECIMALS` - New decimals for the token **Task Options:** - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) --- ## Tokens Commands Token factory management sub-commands. ### tokens list List all tokens. ```bash token-cli tokens list ``` ### tokens code-version Get the default code version of token factory. ```bash token-cli tokens code-version ``` ### tokens has-code-version Check if a token code version is uploaded. ```bash token-cli tokens has-code-version ``` **Arguments:** - `CODE_VERSION` - Code version of the token contract to check ### tokens list-codes List all uploaded token contract code versions. ```bash token-cli tokens list-codes ``` ### tokens upload-code Create a task to upload token contract bytecode to the blockchain. ```bash token-cli tokens upload-code --file-path --code-version [OPTIONS] ``` **Required Options:** - `--file-path ` - File path of the token contract code - `--code-version ` - Code version of the token contract being uploaded **Task Options:** - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) - `--description ` - Description for the task --- ## Transaction Commands Transaction related sub-commands. ### transaction status Show the status of a transaction by its hash. ```bash token-cli transaction status --txid ``` **Options:** - `--txid ` - Transaction hash ### transaction wait Wait for a transaction to be confirmed. ```bash token-cli transaction wait --txid [--confirmations ] [--poll-interval ] ``` **Options:** - `--txid ` - Transaction hash - `--confirmations ` - Number of confirmations to wait for (default: 1) - `--poll-interval ` - Polling interval in seconds (default: 10) --- ## Fee Commands Commands for managing token fee. All commands require `--name `. ### fee settings Get token fee settings. ```bash token-cli fee --name settings [--pretty] [--in-base-unit] ``` **Options:** - `--pretty` - Pretty print amount (default: false) - `--in-base-unit` - Show amount in base units ### fee is-fee-enabled Check if the token fee feature is enabled. ```bash token-cli fee --name is-fee-enabled ``` ### fee get-vip-rate Get token fee rate for all VIPs (in basis points). ```bash token-cli fee --name get-vip-rate ``` ### fee get-default-rate Get default token fee rate for all non-VIPs (in basis points). ```bash token-cli fee --name get-default-rate ``` ### fee get-account-rate Get token fee rate for a specific account. ```bash token-cli fee --name get-account-rate --account ``` **Options:** - `--account ` - Account address ### fee calculate-fee Calculate token fee for a transfer. ```bash token-cli fee --name calculate-fee --from --to --amount [--pretty] [--in-base-unit] ``` **Options:** - `--from ` - Sender address - `--to ` - Receiver address - `--amount ` - Amount to transfer - `--pretty` - Pretty print amount (default: false) - `--in-base-unit` - Show amount in base units ### fee is-vip-account Check if an account is a VIP. ```bash token-cli fee --name is-vip-account --account ``` **Options:** - `--account ` - Account address ### fee get-min-fee Get minimum fee. ```bash token-cli fee --name get-min-fee [--pretty] [--in-base-unit] ``` **Options:** - `--pretty` - Pretty print amount (default: false) - `--in-base-unit` - Show amount in base units ### fee get-max-fee Get maximum fee. ```bash token-cli fee --name get-max-fee [--pretty] [--in-base-unit] ``` **Options:** - `--pretty` - Pretty print amount (default: false) - `--in-base-unit` - Show amount in base units ### fee get-current-total-fee-in-pool Get current total fee in the pool. ```bash token-cli fee --name get-current-total-fee-in-pool [--pretty] [--in-base-unit] ``` **Options:** - `--pretty` - Pretty print amount (default: false) - `--in-base-unit` - Show amount in base units ### fee get-total-collected-fee Get total collected fee so far. ```bash token-cli fee --name get-total-collected-fee [--pretty] [--in-base-unit] ``` **Options:** - `--pretty` - Pretty print amount (default: false) - `--in-base-unit` - Show amount in base units ### fee set-fee-settings Set token fee settings (FEE_ADMIN_ROLE only). ```bash token-cli fee --name set-fee-settings --enabled --vip-rate --default-rate --min-fee --max-fee [--in-base-unit] [OPTIONS] ``` **Required Options:** - `--enabled ` - Enable or disable fee feature - `--vip-rate ` - VIP fee rate (in basis points) - `--default-rate ` - Default fee rate (in basis points) - `--min-fee ` - Minimum fee (default: 0) - `--max-fee ` - Maximum fee (default: 0 for unlimited) **Options:** - `--in-base-unit` - Treat min and max fee as base units (true) or full tokens (false, default - more user-friendly) **Task Options:** - `--description ` - Description for the set fee settings task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### fee enable Enable token fee feature (FEE_ADMIN_ROLE only). ```bash token-cli fee --name enable [OPTIONS] ``` **Task Options:** - `--description ` - Description for the enable fee task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### fee disable Disable token fee feature (FEE_ADMIN_ROLE only). ```bash token-cli fee --name disable [OPTIONS] ``` **Task Options:** - `--description ` - Description for the disable fee task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### fee set-account-rate Set token fee rate for a specific account (FEE_ADMIN_ROLE only). ```bash token-cli fee --name set-account-rate --account --rate [OPTIONS] ``` **Required Options:** - `--account ` - Account address - `--rate ` - Fee rate for the account (in basis points) **Task Options:** - `--description ` - Description for the set account rate task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### fee set-vip-account Set/unset VIP account (FEE_ADMIN_ROLE only). ```bash token-cli fee --name set-vip-account --account --is-vip [OPTIONS] ``` **Required Options:** - `--account ` - Account address - `--is-vip ` - Is VIP or not **Task Options:** - `--description ` - Description for the set VIP account task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### fee withdraw Withdraw fee from the pool to an authorized fee recipient. ```bash token-cli fee --name withdraw --to --amount [--in-base-unit] ``` **Options:** - `--to ` - Recipient address - `--amount ` - Amount to withdraw - `--in-base-unit` - Treat amount as base units (true) or full tokens (false, default - more user-friendly) --- ## Permission Commands Commands for managing token permission. ### permission settings Get current status of permission control. ```bash token-cli permission settings --name ``` **Options:** - `--name ` - Token name ### permission get-default-permission Get the default permission applied to all non-private-permission tokens. ```bash token-cli permission get-default-permission ``` ### permission get-token-permission Get token's effective permission (local or global according to token settings). ```bash token-cli permission get-token-permission --name ``` **Options:** - `--name ` - Token name ### permission is-account-locked Check if an account is locked by a permission object. ```bash token-cli permission is-account-locked [--name ] [--permission ] --account [--force] ``` **Options:** - `--name ` - Token name (used to find the effective permission contract) - `--permission ` - Permission contract address (if not provided, use token's effective permission) - `--account ` - Account address - `--force` - Force checking even if token permission is disabled **Note:** If both `--name` and `--permission` are provided, `--name` takes precedence. If neither is provided, uses the default permission contract. ### permission get-mask Get permission mask of an account. ```bash token-cli permission get-mask [--name ] [--permission ] --account [--force] ``` **Options:** - `--name ` - Token name (used to find the effective permission contract) - `--permission ` - Permission contract address - `--account ` - Account address - `--force` - Force get mask even if token permission is disabled ### permission get-kyc-level Get KYC level of an account. ```bash token-cli permission get-kyc-level [--name ] [--permission ] --account [--force] ``` **Options:** - `--name ` - Token name (used to find the effective permission contract) - `--permission ` - Permission contract address - `--account ` - Account address - `--force` - Force get KYC level even if token permission is disabled ### permission can-transfer Check if a sender can transfer an amount of tokens to a receiver. ```bash token-cli permission can-transfer --name --from --to --amount ``` **Options:** - `--name ` - Token name - `--from ` - Sender address - `--to ` - Recipient address - `--amount ` - Amount to transfer ### permission create-permission Create a permission contract, returns the address of new permission contract. ```bash token-cli permission create-permission ``` ### permission set-permission Set token's private permission (UPGRADER_ROLE only). ```bash token-cli permission set-permission --name --permission [OPTIONS] ``` **Required Options:** - `--name ` - Token name - `--permission ` - Permission contract address (set to empty string to use default permission) **Task Options:** - `--description ` - Description for the set permission task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### permission enable-permission Enable permission control (COMPLIANCE_ADMIN_ROLE only). ```bash token-cli permission enable-permission --name [OPTIONS] ``` **Options:** - `--name ` - Token name **Task Options:** - `--description ` - Description for the enable permission task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### permission disable-permission Disable permission control (COMPLIANCE_ADMIN_ROLE only). ```bash token-cli permission disable-permission --name [OPTIONS] ``` **Options:** - `--name ` - Token name **Task Options:** - `--description ` - Description for the disable permission task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### permission set-mode Set permission work mode (COMPLIANCE_ADMIN_ROLE only). ```bash token-cli permission set-mode --name --with-mask --with-kyc [OPTIONS] ``` **Required Options:** - `--name ` - Token name - `--with-mask ` - Enable or disable mask control - `--with-kyc ` - Enable or disable KYC control **Task Options:** - `--description ` - Description for the set mode task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### permission lock-account Lock an account (COMPLIANCE_ADMIN_ROLE only). ```bash token-cli permission lock-account --name --account [OPTIONS] ``` **Required Options:** - `--name ` - Token name - `--account ` - Address of account to lock **Task Options:** - `--description ` - Description for the lock account task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### permission unlock-account Unlock an account (COMPLIANCE_ADMIN_ROLE only). ```bash token-cli permission unlock-account --name --account [OPTIONS] ``` **Required Options:** - `--name ` - Token name - `--account ` - Address of account to unlock **Task Options:** - `--description ` - Description for the unlock account task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### permission set-mask Change the permission mask of an account (COMPLIANCE_ADMIN_ROLE only). ```bash token-cli permission set-mask --name --account --can-send --can-receive [OPTIONS] ``` **Required Options:** - `--name ` - Token name - `--account ` - Account address - `--can-send ` - Can send tokens - `--can-receive ` - Can receive tokens **Task Options:** - `--description ` - Description for the set mask task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### permission set-kyc-level Set KYC level of an account (COMPLIANCE_ADMIN_ROLE only). ```bash token-cli permission set-kyc-level --name --account --level [OPTIONS] ``` **Required Options:** - `--name ` - Token name - `--account ` - Account address - `--level ` - New KYC level (enum value) **Task Options:** - `--description ` - Description for the set KYC level task - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) --- ## Role Commands Commands for managing roles. `--name` option defaults to empty string for global role management. ### role is-root Check if an account is root. ```bash token-cli role [--name ] is-root ``` **Arguments:** - `ACCOUNT` - Account address to check **Options:** - `--name ` - Token name (empty string for global role management, default: empty) ### role get-root Get the root account. ```bash token-cli role [--name ] get-root ``` **Options:** - `--name ` - Token name (empty string for global role management, default: empty) ### role is-role Check if an account has a specific role. ```bash token-cli role [--name ] is-role --account --role ``` **Options:** - `--name ` - Token name (empty string for global role management, default: empty) - `--account ` - Account address to check - `--role ` - Role identifier (enum value) ### role get-role-members Get all members of a role. ```bash token-cli role [--name ] get-role-members --role ``` **Options:** - `--name ` - Token name (empty string for global role management, default: empty) - `--role ` - Role identifier (enum value) ### role change-root Change root account (ROOT only). ```bash token-cli role [--name ] change-root --account [OPTIONS] ``` **Required Options:** - `--account ` - New root account address **Options:** - `--name ` - Token name (empty string for global role management, default: empty) **Task Options:** - `--description ` - Description for the change root task - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800, 0 for no expiry) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### role set-role Set a role for an account (ROOT only). ```bash token-cli role [--name ] set-role --account --role [OPTIONS] ``` **Required Options:** - `--account ` - Account address - `--role ` - Role identifier (enum value) **Options:** - `--name ` - Token name (empty string for global role management, default: empty) **Task Options:** - `--description ` - Description for the set role task - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) ### role unset-role Unset a role for an account (ROOT only). ```bash token-cli role [--name ] unset-role --account --role [OPTIONS] ``` **Required Options:** - `--account ` - Account address - `--role ` - Role identifier (enum value) **Options:** - `--name ` - Token name (empty string for global role management, default: empty) **Task Options:** - `--description ` - Description for the unset role task - `--auto-execute` - Automatically execute after reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800) - `--collect-delay ` - Delay before task collection starts (default: 86400) --- ## Common Task Options Many commands that create tasks support the following common options: - `--min-approvals ` - Minimum number of approvals required (default: 1) - `--auto-execute` - Automatically execute after task reaching minimum approvals - `--expiry ` - Expiry time in seconds (default: 604800 = 7 days, 0 for no expiry) - `--collect-delay ` - Delay in seconds before task collection starts (default: 86400 = 1 day, 0 for no collection, 1 for immediate collection) - `--description ` - Description for the task ## Role Types Available role types (as CLI argument values): - `ROOT` - Root account with highest privileges - `DEFAULT_ADMIN_ROLE` - Default admin role - `UPGRADER_ROLE` - Upgrader role for contract upgrades - `MINT_ADMIN_ROLE` - Mint admin role for minting tokens - `BURN_ADMIN_ROLE` - Burn admin role for burning tokens - `COMPLIANCE_ADMIN_ROLE` - Compliance admin role for KYC and permissions - `FEE_ADMIN_ROLE` - Fee admin role for managing fees - `FEE_RECIPIENT_ROLE` - Fee recipient role for receiving fees - `PAUSER_ROLE` - Pauser role for freezing/unfreezing tokens ## KYC Levels Available KYC level types: - `KYC0` - No KYC verification - `KYC1` - Basic KYC - `KYC2` - Level 2 KYC - `KYC3` - Level 3 KYC - `KYC4` - Full KYC verification ## Notes 1. **Task Lifecycle**: Many administrative operations create tasks that require approval before execution. Tasks go through states: Pending → Ready → Executed (or Expired/Aborted). 2. **Expiry Time**: Tasks have an expiry time (default 7 days). If not approved within this time, they expire and cannot be executed. 3. **Collection Delay**: After a task reaches a terminal state, it remains in the system for a grace period (default 1 day) before being collected (removed). 4. **Auto Execute**: When enabled, tasks will automatically execute once they reach the minimum approval threshold. 5. **Remote vs Local Operations**: Utility commands support both remote (API-based) and local (client-side) execution. Local operations may produce different results due to implementation differences. 6. **Private Keys**: Always handle private keys securely. The CLI supports both direct private key input and encrypted keystore wallets.