Skip to main content

Account Interface

The Account Interface is evaluated, after the Account Manager Interface, repeatedly through a prompt within the wallet binary.

It is responsible for the creation and management of account addresses and their outputs, tokens, native tokens, NFTs...

Commands

addresses

Lists all account addresses.

Example

> Account "main": addresses

balance

Prints the account balance.

Example

> Account "main": balance

burn-native-token

Burns a native token.

Parameters

NameOptionalDefaultExample
token_idN/A0x08860e1f3593ba86c597cf86f61d8b04d8a714c02c7c5da7132d45be9c2ce6445c0300000000
amountN/A100

Example

Burn the provided amount of a native token.

> Account "main": burn-native-token 0x08860e1f3593ba86c597cf86f61d8b04d8a714c02c7c5da7132d45be9c2ce6445c0300000000 100

burn-nft

Burns an NFT.

Parameters

NameOptionalDefaultExample
nft_idN/A0x397ae8552dcf0dc604a44c9d86a5005d09f95d67e2965ea3b1c1271f9a9ae44c

Example

Burn a provided NFT.

> Account "main": burn-nft 0x397ae8552dcf0dc604a44c9d86a5005d09f95d67e2965ea3b1c1271f9a9ae44c

claim

Tries to claim outputs with storage deposit return, expiration or timelock unlock conditions.

Parameters

NameOptionalDefaultExample
output_idN/A0xd5dff9ee869dfa7796d5132b220cb5c00146c36abba27d3562e2d726decb50850000

Examples

Try to claim all outputs with storage deposit return, expiration or timelock unlock conditions.

> Account "main": claim

Try to claim a specific output.

> Account "main": claim 0xd5dff9ee869dfa7796d5132b220cb5c00146c36abba27d3562e2d726decb50850000

clear

Clears the terminal.

Example

> Account "main": clear

consolidate

Tries to consolidate outputs into a single one.

Note that only Basic Outputs with only an address unlock condition can be consolidated.

Example

> Account "main": consolidate

decrease-native-token-supply

Melts a native token.

Parameters

NameOptionalDefaultExample
token_idN/A0x08860e1f3593ba86c597cf86f61d8b04d8a714c02c7c5da7132d45be9c2ce6445c0300000000
amountN/A100

Example

Melt the provided amount of a native token.

> Account "main": decrease-native-token-supply 0x08860e1f3593ba86c597cf86f61d8b04d8a714c02c7c5da7132d45be9c2ce6445c0300000000 100

destroy-alias

Destroys an alias.

Parameters

NameOptionalDefaultExample
alias_idN/A0xb2bcba092bfb3fe3a12afcf21115016b27d833a7c456404fe2fe0921799f24dd

Example

> Account "main": destroy-alias 0xb2bcba092bfb3fe3a12afcf21115016b27d833a7c456404fe2fe0921799f24dd

destroy-foundry

Destroys a foundry.

Parameters

NameOptionalDefaultExample
foundry_idN/A0x08b2bcba092bfb3fe3a12afcf21115016b27d833a7c456404fe2fe0921799f24dd0100000000

Example

> Account "main": destroy-foundry 0x08b2bcba092bfb3fe3a12afcf21115016b27d833a7c456404fe2fe0921799f24dd0100000000

exit

Exits the cli-wallet.

Example

> Account "main": exit

faucet

Requests funds from a faucet.

Parameters

NameOptionalDefaultExample
urlhttp://localhost:8091/api/enqueuehttp://localhost:8091/api/enqueue
addressThe latest address of the accountrms1qztwng6cty8cfm42nzvq099ev7udhrnk0rw8jt8vttf9kpqnxhpsx869vr3

Examples

Request funds from a given faucet to the latest account address.

> Account "main": faucet http://localhost:8091/api/enqueue

Request funds from a given faucet to a given address.

> Account "main": faucet http://localhost:8091/api/enqueue rms1qztwng6cty8cfm42nzvq099ev7udhrnk0rw8jt8vttf9kpqnxhpsx869vr3

help

Displays the account interface usage.

Example

> Account "main": help

increase-native-token-supply

Mint more of a native token.

Parameters

NameOptionalDefaultExample
token_idN/A0x08860e1f3593ba86c597cf86f61d8b04d8a714c02c7c5da7132d45be9c2ce6445c0300000000
amountN/A10

Example

Mint 10 additional native tokens.

> Account "main": increase-native-token-supply 0x08860e1f3593ba86c597cf86f61d8b04d8a714c02c7c5da7132d45be9c2ce6445c0300000000 10

mint-native-token

Mints a native token.

Parameters

NameOptionalDefaultExample
circulating_supplyN/A1000
maximum_supplyN/A1000
foundry_metadata_hexNone0xabcdef
foundry_metadata_fileNonemetadata.json

Examples

Mint a native token with a maximum supply.

> Account "main": mint-native-token 1000 1000

Mint a native token with a maximum supply and hexadecimal foundry metadata.

> Account "main": mint-native-token 1000 1000 --foundry-metadata-hex 0xabcdef

Mint a native token with a maximum supply and foundry metadata from a file.

> Account "main": mint-native-token 1000 1000 --foundry-metadata-file metadata.json

mint-nft

Mints an NFT.

Parameters

NameOptionalDefaultExample
addressThe first address of the accountrms1qztwng6cty8cfm42nzvq099ev7udhrnk0rw8jt8vttf9kpqnxhpsx869vr3
immutable_metadata_hexNone0xabcdef
immutable_metadata_fileNonemetadata.json
metadata_hexNone0xabcdef
metadata_fileNonemetadata.json

Examples

Mint an NFT to the latest address of the account.

> Account "main": mint-nft

Mint an NFT to a given address.

> Account "main": mint-nft rms1qztwng6cty8cfm42nzvq099ev7udhrnk0rw8jt8vttf9kpqnxhpsx869vr3

Mint an NFT to a given address with hexadecimal immutable metadata and metadata from a file.

> Account "main": mint-nft rms1qztwng6cty8cfm42nzvq099ev7udhrnk0rw8jt8vttf9kpqnxhpsx869vr3 --immutable-metadata-hex 0xabcdef --metadata-file metadata.json

new-address

Generates a new address.

Example

> Account "main": new-address

output

Displays an output that is stored in the account.

Parameters

NameOptionalDefaultExample
output_idN/A0x1c7a765db0c1f5eceb0ea5578585359c5b0c1ab8d958829f5990997b93f0ec7d0100

Example

> Account "main": output 0x1c7a765db0c1f5eceb0ea5578585359c5b0c1ab8d958829f5990997b93f0ec7d0100

outputs

Displays all outputs that are stored in the account.

Example

> Account "main": outputs

send

Sends an amount to an address.

Parameters

NameOptionalDefaultExample
addressN/Arms1qztwng6cty8cfm42nzvq099ev7udhrnk0rw8jt8vttf9kpqnxhpsx869vr3
amountN/A1000000

Example

> Account "main": send rms1qztwng6cty8cfm42nzvq099ev7udhrnk0rw8jt8vttf9kpqnxhpsx869vr3 1000000

send-micro

Sends a micro amount to an address with StorageDepositReturn and Expiration Unlock Conditions.

Parameters

NameOptionalDefaultExample
addressN/Arms1qztwng6cty8cfm42nzvq099ev7udhrnk0rw8jt8vttf9kpqnxhpsx869vr3
amountN/A1

Example

> Account "main": send-micro rms1qztwng6cty8cfm42nzvq099ev7udhrnk0rw8jt8vttf9kpqnxhpsx869vr3 1

send-native-token

Sends native tokens to an address with StorageDepositReturn and Expiration Unlock Condition.

To send the native tokens together with the required storage deposit and without StorageDepositReturn and Expiration, provide true for gift_storage_deposit.

Parameters

NameOptionalDefaultExample
addressN/Arms1qztwng6cty8cfm42nzvq099ev7udhrnk0rw8jt8vttf9kpqnxhpsx869vr3
token_idN/A0x08860e1f3593ba86c597cf86f61d8b04d8a714c02c7c5da7132d45be9c2ce6445c0300000000
amountN/A100
gift_storage_depositfalsetrue

Example

Sending with storage deposit return and expiration:

> Account "main": send-native-token rms1qztwng6cty8cfm42nzvq099ev7udhrnk0rw8jt8vttf9kpqnxhpsx869vr3 0x08860e1f3593ba86c597cf86f61d8b04d8a714c02c7c5da7132d45be9c2ce6445c0300000000 100

Sending without storage deposit return and expiration, gifting the required storage deposit:

> Account "main": send-native-token rms1qztwng6cty8cfm42nzvq099ev7udhrnk0rw8jt8vttf9kpqnxhpsx869vr3 0x08860e1f3593ba86c597cf86f61d8b04d8a714c02c7c5da7132d45be9c2ce6445c0300000000 100 true

send-nft

Sends an NFT to an address.

Parameters

NameOptionalDefaultExample
addressN/Arms1qztwng6cty8cfm42nzvq099ev7udhrnk0rw8jt8vttf9kpqnxhpsx869vr3
nft_idN/A0x397ae8552dcf0dc604a44c9d86a5005d09f95d67e2965ea3b1c1271f9a9ae44c

Example

> Account "main": send-nft rms1qztwng6cty8cfm42nzvq099ev7udhrnk0rw8jt8vttf9kpqnxhpsx869vr3 0x397ae8552dcf0dc604a44c9d86a5005d09f95d67e2965ea3b1c1271f9a9ae44c

sync

Synchronises the account.

Example

> Account "main": sync

transactions

Lists all account transactions.

Example

> Account "main": transactions

unspent-outputs

Displays all unspent outputs that are stored in the account.

Example

> Account "main": unspent-outputs