Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add CLI wallet docs #2453

Merged
merged 1 commit into from
Nov 19, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 53 additions & 1 deletion autonomi-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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 <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).

---

Expand Down
Loading