Skip to main content

Account Manager Interface

The Account Manager Interface is evaluated through the Command Line Interface of the wallet binary, once per execution.

It is responsible for the creation and management of the wallet and its accounts.

Commands

./wallet

Starts the wallet without a specified account:

  • If the wallet has only one account, it will be used;
  • If the wallet has more than one account, a selector will be shown to decide which account to use.

The wallet needs to be initialised (init command) and with at least one account (new command).

Example

$ ./wallet

./wallet [account]

Starts the wallet with a specified account;

The wallet needs to be initialised (init command).

Example

$ ./wallet main

./wallet backup

Creates a stronghold backup file.

Parameters

NameOptionalExample
pathbackup.stronghold

Example

Create a stronghold backup file.

$ ./wallet backup backup.stronghold

./wallet change-password

Changes the stronghold password.

Example

Change the stronghold password.

$ ./wallet change-password

./wallet help

Displays the account manager interface usage and exits.

Example

$ ./wallet help

./wallet init

Initialises the wallet by creating a stronghold file from a provided or generated mnemonic.

The wallet can only be initialised once.

When just initialised, the wallet has no account yet, use the new command to create one.

Parameters

NameOptionalDefaultExample
mnemonicRandomly generated"aunt middle impose faith ramp kid olive good practice motor grab ready group episode oven matrix silver rhythm avocado assume humble tiger shiver hurt" (DO NOT USE THIS MNEMONIC)
nodehttp://localhost:14265http://localhost:14265
coin-type4219 (=Shimmer)4218 (=IOTA)

Examples

Initialise the wallet with a randomly generated mnemonic and the default node.

$ ./wallet init

Initialise the wallet with a given mnemonic and the default node. DO NOT USE THIS MNEMONIC.

$ ./wallet init --mnemonic "aunt middle impose faith ramp kid olive good practice motor grab ready group episode oven matrix silver rhythm avocado assume humble tiger shiver hurt"

Initialise the wallet with a randomly generated mnemonic and a given node.

$ ./wallet init --node http://localhost:14265

Initialise the wallet with a given coin type. See SLIP-0044 for all registered coin types.

$ ./wallet init --coin-type 4219

./wallet mnemonic

Generates a new random mnemonic.

Example

Generate a new random mnemonic.

$ ./wallet mnemonic

./wallet new

Creates a new account.

The wallet needs to be initialised (init command).

Parameters

NameOptionalDefaultExample
aliasAccount indexmain

Examples

Create a new account with the account index as alias.

$ ./wallet new

Create a new account with a provided alias.

$ ./wallet new main

./wallet restore

Restores accounts from a stronghold backup file.

Parameters

NameOptionalExample
pathbackup.stronghold

Example

Restore accounts from a stronghold backup file.

$ ./wallet restore backup.stronghold

./wallet set-node

Sets the node to be used for all requests.

The new node URL is persisted to the storage and all future requests will use it.

Parameters

NameOptionalExample
urlhttp://localhost:14265

Example

$ ./wallet set-node http://localhost:14265

./wallet sync

Synchronises all accounts.

Example

$ ./wallet sync