Skip to content

Commit

Permalink
docs: update examples for changes in #281 from miden-client (#623)
Browse files Browse the repository at this point in the history
  • Loading branch information
mFragaBA authored Apr 30, 2024
1 parent 9a2b8ee commit 1307080
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 10 deletions.
4 changes: 0 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,7 @@ Accounts can expose any interface in the future. This is the Miden version of a

#### Customized note scripts

<<<<<<< HEAD
Users will be able to write their own note scripts using the Miden client. Note scripts are executed during note consumption and they can be arbitrarily complex due to the underlying Turing-complete Miden VM.
=======
Users can write their own note scripts using the Miden client. Note scripts are executed during note consumption and they can be arbitrarily complex due to the underlying Turing-complete Miden VM.
>>>>>>> dd9667d79cf3d4cc5d6a7ccc8509bdf77fdc0289

#### Network transactions

Expand Down
2 changes: 1 addition & 1 deletion docs/introduction/get-started/create-account-use-faucet.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ State synced to block 179672
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-Id> <Note-Id>
miden-client tx new consume-notes --account <Account-Id> <Note-Id>
```
Amazing! You just have created a client-side zero-knowledge proof locally on your machine.
Expand Down
6 changes: 3 additions & 3 deletions docs/introduction/get-started/p2p-private.md
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 <regular-account-id-A> <regular-account-id-B> <faucet-account-id> 50
miden-client tx new p2id --note-type private --sender <regular-account-id-A> --target <regular-account-id-B> --faucet <faucet-account-id> 50
```

!!! note
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 <regular-account-ID-B> <input-note-id>
miden-client tx new consume-notes --account <regular-account-ID-B> <input-note-id>

This comment has been minimized.

Copy link
@Dominik1999

Dominik1999 May 1, 2024

Collaborator

@mFragaBA why did you add those --account? It seems to break the tutorial? Or is this change in the CLI only in next?

This comment has been minimized.

Copy link
@bobbinth

bobbinth May 1, 2024

Contributor

Yeah - I believe this is currently implemented only in the next branch.

```

!!! tip
Expand Down Expand Up @@ -102,4 +102,4 @@ For more information on the Miden client, refer to the [Miden client documentati

Wanna do more? [Sending public notes](p2p-public.md)

</br>
</br>
4 changes: 2 additions & 2 deletions docs/introduction/get-started/p2p-public.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ 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 <basic-account-id-A> <basic-account-id-C> <faucet-account-id> 50 --note-type public
miden-client tx new p2id --sender <basic-account-id-A> --target <basic-account-id-C> --faucet <faucet-account-id> 50 --note-type public
```
!!! note
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 <regular-account-ID-C> <input-note-id>
miden-client tx new consume-notes --account <regular-account-ID-C> <input-note-id>
```
!!! tip
Expand Down

0 comments on commit 1307080

Please sign in to comment.