From f8f1b72fff1a71714a3428f99f3b9c55ebd70cf7 Mon Sep 17 00:00:00 2001 From: Warm Beer Date: Tue, 19 Nov 2024 15:17:36 +0100 Subject: [PATCH] docs: add CLI wallet docs --- autonomi-cli/README.md | 54 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 53 insertions(+), 1 deletion(-) diff --git a/autonomi-cli/README.md b/autonomi-cli/README.md index 6da4930612..c51abf2020 100644 --- a/autonomi-cli/README.md +++ b/autonomi-cli/README.md @@ -7,6 +7,7 @@ Commands: file Operations related to file handling register Operations related to register management vault Operations related to vault management + wallet Operations related to wallet management help Print this message or the help of the given subcommand(s) Options: @@ -26,9 +27,60 @@ Options: Print version ``` +## Wallet + +### Create a new wallet + +```bash +wallet create +``` + +> Add the `--no-password` flag to skip the optional encryption step. + +> **Wallet Security** +> +> Encrypted wallets provide an additional layer of security, requiring a password to read the private key and perform +> transactions. However, ensure you remember your password; losing it may result in the inability to access your encrypted +> wallet. + +Example: + + ```bash + $ wallet create + Enter password (leave empty for none): + Repeat password: + Wallet address: 0xaf676aC7C821977506AC9DcE28bFe83fb06938d8 + Stored wallet in: "/Users/macuser/Library/Application Support/safe/autonomi/wallets/0xaf676aC7C821977506AC9DcE28bFe83fb06938d8.encrypted" + ``` + +### Import a wallet + +```bash +wallet create --private-key +``` + +### Check wallet balance + +```bash +wallet balance +``` + +Example: + + ```bash + $ wallet balance + Wallet balances: 0x5A631e17FfB0F07b00D88E0e42246495Bf21d698 + +---------------+---+ + | Token Balance | 0 | + +---------------+---+ + | Gas Balance | 0 | + +---------------+---+ + ``` + ## License -This Safe Network repository is licensed under the General Public License (GPL), version 3 ([LICENSE](LICENSE) http://www.gnu.org/licenses/gpl-3.0.en.html). +This Safe Network repository is licensed under the General Public License (GPL), version +3 ([LICENSE](LICENSE) http://www.gnu.org/licenses/gpl-3.0.en.html). ---