Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
forc-wallet
A forc plugin for managing Fuel wallets.
Quickstart
Installation through fuelup (recommended)
forc-wallet
is packaged alongside the default distributed toolchains when installed using
fuelup. If you have the latest
toolchain installed,
you should already have forc-wallet
available:
$ fuelup toolchain install latest
$ forc-wallet --version
forc-wallet 0.2.2
For usage in custom toolchains:
Installation through cargo
Otherwise, you may use cargo:
Create a wallet
Before creating accounts and signing transactions with them you need to create a wallet. To do so:
This will require a password for encrypting the wallet. After the wallet is created you will be shown the mnemonic phrase.
Note: You will need your password for signing and account derivation, and you will need your mnemonic phrase if you wish to recover your wallet in the future.
Import a wallet
To import a wallet from an existing mnemonic phrase, use:
Note:
forc-wallet
adheres to the Web3 Secret Storage Definition and accepts paths to wallet files that adhere to this standard.
Create an account
To create an account for the wallet, you can run:
This will require your wallet password (the one that you chose during creation). This command will always derive the next account that has not yet been derived locally.
To list all accounts derived so far, use the following:
Note: When we "create" an account, we are really just revealing it. All accounts are derived deterministically based on the wallet's mnemonic phrase and derivation path.
forc-wallet
will cache the public addresses of derived accounts within~/.fuel/wallets/accounts
.
Sign a transaction
To sign a transaction, you can provide the transaction ID. You can generate a transaction and get its ID using forc-client
. Signing the transaction once you have the ID is simple:
Sign arbitrary data
You may sign a string directly:
Or the contents of a file:
You may also sign a hex-encoded byte string:
You can also use the sign
subcommand directly, e.g. the following is the same:
Using the sign
subcommand, you can choose to sign directly with a private key (rather than a wallet account):
Other useful commands
Get address of an account
To derive the address of a specific account, you can use:
Get private key of an account
To retrieve the private key of a specific account, you can use:
Get public key of an account
To retrieve the public key of a specific account, you can use: