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: update readme about transfers #2024

Merged
merged 1 commit into from
Aug 6, 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
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,22 +210,27 @@ cargo run --bin safe --features local-discovery -- folders download <target dir

Use your local wallet to demonstrate sending tokens and receiving transfers.

First, get your wallet address:
First, get your wallet address, this address can be safely shared publicly

```
cargo run --bin safe -- wallet address
```

Now send some tokens to that address:
You can also get your balance with:

```
cargo run --bin safe --features local-discovery -- wallet send 2 [address]
cargo run --bin safe -- wallet balance
```

This will output a transfer as a hex string, which should be sent to the recipient out-of-band.
Now to send some tokens to an address:

```
cargo run --bin safe --features local-discovery -- wallet send 2 [address]
```

For demonstration purposes, copy the transfer string and use it to receive the transfer in your own
wallet:
This will output a transfer as a hex string, which should be sent to the recipient.
This transfer is encrypted to the recipient so only the recipient can read and redeem it.
To receive a transfer, simply paste it after the wallet receive command:

```
cargo run --bin safe --features local-discovery -- wallet receive [transfer]
Expand Down
Loading