run

Run a Move Function

Usage

movement aptos move run [OPTIONS]

Options

• --function-id <FUNCTION_ID> Function name as <ADDRESS>::<MODULE_ID>::<FUNCTION_NAME>. Example: 0x842ed41fad9640a2ad08fdd7d3e4f7f505319aac7d67e1c0dd6a7cce8732c7e3::message::set_message

• --type-args [<TYPE_ARGS>...] TypeTag arguments separated by spaces. Example: u8 u16 u32 u64 u128 u256 bool address vector signer

• --args [<ARGS>...] Arguments combined with their type separated by spaces. Supported types [address, bool, hex, string, u8, u16, u32, u64, u128, u256, raw]. Vectors may be specified using JSON array literal syntax. Example: address:0x1 bool:true u8:0 u256:1234 "bool:[true, false]" 'address:[["0xace", "0xbee"], []]'

• --json-file <JSON_FILE> JSON file specifying public entry function ID, type arguments, and arguments.

• --sender-account <SENDER_ACCOUNT> Sender account address. This allows you to override the account address from the derived account address in the event that the authentication key was rotated or for a resource account.

• --private-key-file <PRIVATE_KEY_FILE> Signing Ed25519 private key file path. Encoded with type from --encoding. Mutually exclusive with --private-key.

• --private-key <PRIVATE_KEY> Signing Ed25519 private key. Encoded with type from --encoding. Mutually exclusive with --private-key-file.

• --encoding <ENCODING> Encoding of data as one of [base64, bcs, hex]. [default: hex] Possible values:

  • bcs: Binary Canonical Serialization

  • hex: Hex encoded e.g. 0xABCDE12345

  • base64: Base 64 encoded

• --profile <PROFILE> Profile to use from the CLI config. This will be used to override associated settings such as the REST URL, the Faucet URL, and the private key arguments. Defaults to "default".

• --url <URL> URL to a fullnode on the network. Defaults to the URL in the default profile.

• --connection-timeout-secs <CONNECTION_TIMEOUT_SECS> Connection timeout in seconds, used for the REST endpoint of the fullnode. [default: 30]

• --gas-unit-price <GAS_UNIT_PRICE> Gas multiplier per unit of gas. The amount of Octas (10^-8 APT) used for a transaction is equal to (gas unit price * gas used). Without a value, it will determine the price based on the current estimated price.

• --max-gas <MAX_GAS> Maximum amount of gas units to be used to send this transaction. For example, if I wanted to pay a maximum of 100 Octas, I may have the max gas set to 100 if the gas unit price is 1. Without a value, it will determine the price based on simulating the current transaction.

• --expiration-secs <EXPIRATION_SECS> Number of seconds to expire the transaction. [default: 30]

• --assume-yes Assume yes for all yes/no prompts.

• --assume-no Assume no for all yes/no prompts.

• --profile-gas If this option is set, simulate the transaction locally using the debugger and generate flamegraphs that reflect the gas usage.