From 0be5fc5e789a375720873a2da47c03fc6aa0395c Mon Sep 17 00:00:00 2001 From: Augusto Hack Date: Tue, 5 Mar 2024 18:47:28 +0100 Subject: [PATCH] pre-commit: fix errors and run all hooks (#506) --- .pre-commit-config.yaml | 4 ++-- docs/src/introduction/getting-started.md | 20 ++++++++++---------- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 9248d33b9..9208d3c20 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -33,10 +33,10 @@ repos: args: ["+stable", "check", "--all-targets"] - id: cargo name: Cargo check --all-targets --no-default-features - args: ["+stable", "check", "--all-targets", "--no-default-features"] + args: ["+stable", "check", "--no-default-features", "--workspace", "--exclude", "miden-mock"] - id: cargo name: Cargo check --all-targets --all-features - args: ["+stable", "check", "--all-targets", "--all-features","--workspace", "--exclude", "miden-mock"] + args: ["+stable", "check", "--all-targets", "--all-features", "--workspace"] # Unlike fmt, clippy will not be automatically applied - id: cargo name: Cargo clippy diff --git a/docs/src/introduction/getting-started.md b/docs/src/introduction/getting-started.md index d90891a15..082053d46 100644 --- a/docs/src/introduction/getting-started.md +++ b/docs/src/introduction/getting-started.md @@ -1,6 +1,6 @@ # Getting started -This tutorial will guide you through the process generating a new Miden account, requesting funds from a public faucet and interacting with the Miden rollup using the Miden client. +This tutorial will guide you through the process generating a new Miden account, requesting funds from a public faucet and interacting with the Miden rollup using the Miden client. The Miden node processes transactions and creates blocks for the Miden rollup. The Miden client provides a way to execute and prove transactions, facilitating the interaction with the Miden rollup. By the end of this tutorial, you will be able to configure the Miden client, connect to a Miden node, and perform basic operations like sending transactions, generating and consuming notes. @@ -80,13 +80,13 @@ In this first part of the tutorial we will teach you how to create a new Miden a ### Importing the note into the Miden client -1. **Importing & visualising notes:** From your terminal we will use the Miden client to import and visualise the note that you have received using the following commands: +1. **Importing & visualising notes:** From your terminal we will use the Miden client to import and visualise the note that you have received using the following commands: ```shell miden-client input-notes -i ``` - Now that the note has been successfully imported you should be able to visualise it's information using the following command: + Now that the note has been successfully imported you should be able to visualise it's information using the following command: ```shell miden-client input-notes -l @@ -103,12 +103,12 @@ In this first part of the tutorial we will teach you how to create a new Miden a ### Consuming the note & receiving the funds -1. **Consuming the note:** Now that we have synced the client the input-note that we have imported from the faucet should have a `commit-height` confirming it's existence at the rollup level: +1. **Consuming the note:** Now that we have synced the client the input-note that we have imported from the faucet should have a `commit-height` confirming it's existence at the rollup level: ```shell miden-client input-notes -l ``` - We can now consume the note and add the funds contained inside it's vault to our account using the following commands: + We can now consume the note and add the funds contained inside it's vault to our account using the following commands: ```shell miden-client tx new consume-notes @@ -120,22 +120,22 @@ In this first part of the tutorial we will teach you how to create a new Miden a miden-client account -l miden-client input-notes -l ``` - -2. **Visualising account vault:** After successfully running the previous commands your account should now contained the tokens sent from the faucet. You can visualise your accounts vault by running the following command: + +2. **Visualising account vault:** After successfully running the previous commands your account should now contained the tokens sent from the faucet. You can visualise your accounts vault by running the following command: ```shell miden-client account show -v ``` - You should now see your accounts vault containing the funds sent by the faucet. + You should now see your accounts vault containing the funds sent by the faucet. #### Congratulations! You finished the first part of the tutorial, continue to learn more about Miden and understand how to send Peer-to-Peer private off-chain transactions! ## Part 2: Peer-to-Peer private off-chain transactions -In this second part of the tutorial we will teach you how to make off-chain transactions and send funds to another account using the Miden client. +In this second part of the tutorial we will teach you how to make off-chain transactions and send funds to another account using the Miden client. > **Note**: -> We consider that you have done the first part of the turorial and that the state of your local client has not been reset. +> We consider that you have done the first part of the turorial and that the state of your local client has not been reset. ### Setting-up the Miden client