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.

Sign up for GitHub

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

Again some clean ups in the docs #647

Merged
merged 2 commits into from
May 1, 2024
Merged

Again some clean ups in the docs #647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0894cd
some cleanups before internal testing
Dominik1999 Apr 26, 2024
88e5ab7
correct consume-notes command
Dominik1999 May 1, 2024
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
Binary file modified docs/img/roadmap.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 7 additions & 2 deletions docs/introduction/get-started/create-account-use-faucet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,16 @@ The Miden client facilitates interaction with the Miden rollup and provides a wa
miden-client init
```

Accept the defaults for `Protocol`, `Node RPC Port`, and `Sqlite file path`by clicking enter.
Accept the default for `Protocol` by clicking enter.

When `Host` comes up, enter `18.203.155.106`

```sh
Host (default: localhost): 18.203.155.106
```

Then accept the defaults for `Node RPC Port`, and `Sqlite file path`.

4. Check you can sync with the blockchain.

```shell
Expand Down Expand Up @@ -137,13 +139,16 @@ State synced to block 179672

```shell
miden-client account -l
```

```shell
miden-client input-notes -l
```

4. Consume the note and add the funds from its vault to our account using the following command:

```shell
miden-client tx new consume-notes --account <Account-Id> <Note-Id>
miden-client tx new consume-notes <Account-Id> <Note-Id>
```

Amazing! You just have created a client-side zero-knowledge proof locally on your machine.
Expand Down
8 changes: 4 additions & 4 deletions docs/introduction/get-started/p2p-private.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ In this section, we show you how to make private transactions and send funds to
To do this, run:

```shell
miden-client tx new p2id --note-type private --sender <regular-account-id-A> --target <regular-account-id-B> --faucet <faucet-account-id> 50
miden-client tx new p2id --note-type private <regular-account-id-A> <regular-account-id-B> <faucet-account-id> 50
```

!!! note
Expand All @@ -47,7 +47,7 @@ In this section, we show you how to make private transactions and send funds to
2. First, sync the accounts.

```shell
miden-client sync # Make sure we have an updated view of the state
miden-client sync
```

3. Get the second note id.
Expand All @@ -59,7 +59,7 @@ In this section, we show you how to make private transactions and send funds to
4. Have the second account consume the note.

```sh
miden-client tx new consume-notes --account <regular-account-ID-B> <input-note-id>
miden-client tx new consume-notes <regular-account-ID-B> <input-note-id>
```

!!! tip
Expand All @@ -81,7 +81,7 @@ In this section, we show you how to make private transactions and send funds to
6. Check the original account:

```sh
miden-client account show <regular-account-ID-A> -v # Show account A's vault assets (950 fungible tokens)
miden-client account show <regular-account-ID-A> -v
```

![Result of listing miden accounts](../../img/get-started/account-a.png)
Expand Down
8 changes: 4 additions & 4 deletions docs/introduction/get-started/p2p-public.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,18 +61,18 @@ To do this, we use two terminals with their own state (using their own `miden-cl
To do this, from the first client run:

```shell
miden-client tx new p2id --sender <basic-account-id-A> --target <basic-account-id-C> --faucet <faucet-account-id> 50 --note-type public
miden-client tx new p2id --note-type public <basic-account-id-A> <basic-account-id-C> <faucet-account-id> 50
```

!!! note
The faucet account id is `0xad904b3138d71d3e` and can also be found on the [Miden faucet website](https://testnet.miden.io/) under the title **Miden faucet**.

This generates a Pay-to-ID (`P2ID`) note containing `50` assets, transferred from one account to the other. As the note is public, the second account can receive the necessary details by syncing with the node.
This generates a Pay-to-ID (`P2ID`) note containing `50` tokens, transferred from one account to the other. As the note is public, the second account can receive the necessary details by syncing with the node.

2. First, sync the account on the new client.

```shell
miden-client sync # Make sure we have an updated view of the state
miden-client sync
```

3. At this point, we should have received the public note details.
Expand All @@ -86,7 +86,7 @@ To do this, we use two terminals with their own state (using their own `miden-cl
4. Have the second account consume the note.

```sh
miden-client tx new consume-notes --account <regular-account-ID-C> <input-note-id>
miden-client tx new consume-notes <regular-account-ID-C> <input-note-id>
```

!!! tip
Expand Down
Loading