Tutorial Fixes (#117)

* fix create deploy tutorial

* fix miden node setup

* fix deploying a counter contract

* fix interacting with public smart contracts

* fix network transactions on Miden

* fix fpi

* remove all truncate stack and remove network_counter.masm

* add print commitment back in

* fix counter.masm

* fix rebase issues

* fix: CI & counter contract redeploy

* Apply suggestions from code review

---------

Co-authored-by: riemann <aleqvids@gmail.com>
Co-authored-by: Marti <marcin.gorny.94@protonmail.com>

Author: 3 people

docs/src/lib.rs

@@ -1,9 +1,9 @@
 #![doc = include_str!("rust-client/create_deploy_tutorial.md")]
 #![doc = include_str!("rust-client/mint_consume_create_tutorial.md")]
 #![doc = include_str!("rust-client/counter_contract_tutorial.md")]
-#![doc = include_str!("rust-client/public_account_interaction_tutorial.md")]
 #![doc = include_str!("rust-client/custom_note_how_to.md")]
 #![doc = include_str!("rust-client/foreign_procedure_invocation_tutorial.md")]
+#![doc = include_str!("rust-client/public_account_interaction_tutorial.md")]
 #![doc = include_str!("rust-client/unauthenticated_note_how_to.md")]
 #![doc = include_str!("rust-client/mappings_in_masm_how_to.md")]
 #![doc = include_str!("rust-client/creating_notes_in_masm_tutorial.md")]

docs/src/miden_node_setup.md

@@ -27,7 +27,7 @@ mkdir accounts
 
 miden-node bundled bootstrap \
   --data-directory data \
-  --accounts-directory .
+  --accounts-directory accounts
 ```
 
 Expected output:

docs/src/rust-client/counter_contract_tutorial.md

@@ -50,7 +50,7 @@ In the previous section, we explained how to instantiate the Miden client. We ca
 
 Copy and paste the following code into your `src/main.rs` file:
 
-```rust,no_run
+```rust
 use miden_lib::account::auth::NoAuth;
 use rand::RngCore;
 use std::{fs, path::Path, sync::Arc};
@@ -179,9 +179,6 @@ export.get_count
 
     exec.account::get_item
     # => [count]
-
-    exec.sys::truncate_stack
-    # => []
 end
 
 # => []
@@ -237,7 +234,7 @@ end
 
 To build the counter contract copy and paste the following code at the end of your `src/main.rs` file:
 
-```rust,no_run
+```rust
 # use miden_lib::account::auth::NoAuth;
 # use rand::RngCore;
 # use std::{fs, path::Path, sync::Arc};
@@ -332,13 +329,17 @@ let (counter_contract, counter_seed) = AccountBuilder::new(seed)
     .build()
     .unwrap();
 
+println!(
+        "counter_contract commitment: {:?}",
+        counter_contract.commitment()
+    );
 println!(
     "counter_contract id: {:?}",
     Address::from(AccountIdAddress::new(
         counter_contract.id(),
         AddressInterface::Unspecified
     ))
-    .to_bech32(NetworkId::Devnet)
+    .to_bech32(NetworkId::Testnet)
 );
 println!("counter_contract storage: {:?}", counter_contract.storage());
 
@@ -372,7 +373,7 @@ Now that we built the counter contract, lets create a transaction request to inc
 
 Paste the following code at the end of your `src/main.rs` file:
 
-```rust,no_run
+```rust
 # use miden_lib::account::auth::NoAuth;
 # use rand::RngCore;
 # use std::{fs, path::Path, sync::Arc};
@@ -477,7 +478,7 @@ Paste the following code at the end of your `src/main.rs` file:
 #             counter_contract.id(),
 #             AddressInterface::Unspecified
 #         ))
-#         .to_bech32(NetworkId::Devnet)
+#         .to_bech32(NetworkId::Testnet)
 #     );
 #     println!("counter_contract storage: {:?}", counter_contract.storage());
 #
@@ -501,16 +502,13 @@ let account_component_lib = create_library(
     &counter_code,
 )
 .unwrap();
-println!("here");
 
 let tx_script = ScriptBuilder::new(true)
     .with_dynamically_linked_library(&account_component_lib)
     .unwrap()
     .compile_tx_script(script_code)
     .unwrap();
 
-println!("here");
-
 // Build a transaction request with the custom script
 let tx_increment_request = TransactionRequestBuilder::new()
     .custom_script(tx_script)
@@ -656,7 +654,7 @@ async fn main() -> Result<(), ClientError> {
             counter_contract.id(),
             AddressInterface::Unspecified
         ))
-        .to_bech32(NetworkId::Devnet)
+        .to_bech32(NetworkId::Testnet)
     );
     println!("counter_contract storage: {:?}", counter_contract.storage());
 
@@ -681,16 +679,13 @@ async fn main() -> Result<(), ClientError> {
         &counter_code,
     )
     .unwrap();
-    println!("here");
 
     let tx_script = ScriptBuilder::new(true)
         .with_dynamically_linked_library(&account_component_lib)
         .unwrap()
         .compile_tx_script(script_code)
         .unwrap();
 
-    println!("here");
-
     // Build a transaction request with the custom script
     let tx_increment_request = TransactionRequestBuilder::new()
         .custom_script(tx_script)
@@ -728,15 +723,16 @@ async fn main() -> Result<(), ClientError> {
 The output of our program will look something like this:
 
 ```text
-Latest block: 226717
+Latest block: 374255
 
 [STEP 1] Creating counter contract.
-counter_contract commitment: RpoDigest([10854804595308759734, 11034759279878416408, 15662010127375823242, 9560626040625797366])
-counter_contract id: "mtst1qpj0g3ke67tg5qqqqd2z4ffm9g8ezpf6"
-counter_contract storage: AccountStorage { slots: [Value([0, 0, 0, 0])] }
+one or more warnings were emitted
+counter_contract commitment: Word([3964727668949550262, 4265714847747507878, 5784293172192015964, 16803438753763367241])
+counter_contract id: "mtst1qre73e6qcrfevqqngx8wewvveacqqjh8p2a"
+counter_contract storage: AccountStorage { slots: [Value(Word([0, 0, 0, 0]))] }
 
 [STEP 2] Call Counter Contract With Script
-Stack state before step 2502:
+Stack state before step 2610:
 ├──  0: 1
 ├──  1: 0
 ├──  2: 0
@@ -758,8 +754,10 @@ Stack state before step 2502:
 ├── 18: 0
 └── 19: 0
 
-View transaction on MidenScan: https://testnet.midenscan.com/tx/0x645b89ebf39c7baa2a4264854f793736b7370d65ecf5f1a23c0169fda6a6a395
-counter contract storage: Ok(RpoDigest([0, 0, 0, 1]))
+└── (0 more items)
+
+View transaction on MidenScan: https://testnet.midenscan.com/tx/0x9767940bbed7bd3a74c24dc43f1ea8fe90a876dc7925621c217f648c63c4ab7a
+counter contract storage: Ok(Word([0, 0, 0, 1]))
 ```
 
 The line in the output `Stack state before step 2505` ouputs the stack state when we call "debug.stack" in the `counter.masm` file.

docs/src/rust-client/create_deploy_tutorial.md

@@ -98,11 +98,11 @@ async fn main() -> Result<(), ClientError> {
     let endpoint = Endpoint::testnet();
     let timeout_ms = 10_000;
     let rpc_api = Arc::new(TonicRpcClient::new(&endpoint, timeout_ms));
-    let keystore = FilesystemKeyStore::new("./keystore".into()).unwrap().into();
+    let keystore: FilesystemKeyStore<rand::prelude::StdRng> = FilesystemKeyStore::new("./keystore".into()).unwrap().into();
 
     let mut client = ClientBuilder::new()
         .rpc(rpc_api)
-        .authenticator(keystore)
+        .authenticator(keystore.clone().into())
         .in_debug_mode(true.into())
         .build()
         .await?;

docs/src/rust-client/foreign_procedure_invocation_tutorial.md

@@ -16,7 +16,7 @@ FPI is useful for developing smart contracts that extend the functionality of ex
 
 ## What We Will Build
 
-![count copy FPI diagram](../assets/count_copy_fpi_diagram.png)
+![count copy FPI diagram](./assets/count_copy_fpi_diagram.png)
 
 The diagram above depicts the "count copy" smart contract using foreign procedure invocation to read the count state of the counter contract. After reading the state via FPI, the "count copy" smart contract writes the value returned from the counter contract to storage.
 
@@ -364,7 +364,7 @@ println!("\n[STEP 2] Building counter contract from public state");
 
 // Define the Counter Contract account id from counter contract deploy
 let (_, counter_contract_address) =
-    Address::from_bech32("mtst1qrhk9zc2au2vxqzaynaz5ddhs4cqqghmajy").unwrap();
+    Address::from_bech32("mtst1qre73e6qcrfevqqngx8wewvveacqqjh8p2a").unwrap();
 let counter_contract_id = match counter_contract_address {
     Address::AccountId(account_id_address) => account_id_address.id(),
     _ => panic!("Expected AccountId address"),
@@ -520,7 +520,7 @@ Add this snippet to the end of your file in the `main()` function:
 #
 #     // Define the Counter Contract account id from counter contract deploy
 #     let (_, counter_contract_address) =
-#         Address::from_bech32("mtst1qrhk9zc2au2vxqzaynaz5ddhs4cqqghmajy").unwrap();
+#         Address::from_bech32("mtst1qre73e6qcrfevqqngx8wewvveacqqjh8p2a").unwrap();
 #     let counter_contract_id = match counter_contract_address {
 #         Address::AccountId(account_id_address) => account_id_address.id(),
 #         _ => panic!("Expected AccountId address"),
@@ -786,7 +786,7 @@ async fn main() -> Result<(), ClientError> {
 
     // Define the Counter Contract account id from counter contract deploy
     let (_, counter_contract_address) =
-        Address::from_bech32("mtst1qrhk9zc2au2vxqzaynaz5ddhs4cqqghmajy").unwrap();
+        Address::from_bech32("mtst1qre73e6qcrfevqqngx8wewvveacqqjh8p2a").unwrap();
     let counter_contract_id = match counter_contract_address {
         Address::AccountId(account_id_address) => account_id_address.id(),
         _ => panic!("Expected AccountId address"),
@@ -1006,4 +1006,4 @@ cargo run --release --bin counter_contract_fpi
 
 ### Continue learning
 
-Next tutorial: [How to Create Notes with Custom Logic](custom_note_how_to.md)
+Next tutorial: [How to Use Unauthenticated Notes](unauthenticated_note_how_to.md)

docs/src/rust-client/network_transactions_tutorial.md

@@ -84,9 +84,6 @@ export.get_count
 
     exec.account::get_item
     # => [count]
-
-    exec.sys::truncate_stack
-    # => []
 end
 
 # => []
@@ -928,9 +925,9 @@ Add this code to your `main()` function:
 #     // STEP 3: Deploy Network Account with Transaction Script
 #     // -------------------------------------------------------------------------
 #     println!("\n[STEP 3] Deploy network counter smart contract");
-#
+
 #     let script_code = fs::read_to_string(Path::new("./masm/scripts/counter_script.masm")).unwrap();
-#
+
 #     let account_code = fs::read_to_string(Path::new("./masm/accounts/counter.masm")).unwrap();
 #     let library_path = "external_contract::counter_contract";
 #
@@ -969,7 +966,7 @@ println!("\n[STEP 4] Creating a network note for network counter contract");
 let network_note_code =
     fs::read_to_string(Path::new("./masm/notes/network_increment_note.masm")).unwrap();
 let account_code =
-    fs::read_to_string(Path::new("./masm/accounts/network_counter.masm")).unwrap();
+    fs::read_to_string(Path::new("./masm/accounts/counter.masm")).unwrap();
 
 let library_path = "external_contract::counter_contract";
 let library = create_library(account_code, library_path).unwrap();
@@ -1281,7 +1278,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let network_note_code =
         fs::read_to_string(Path::new("./masm/notes/network_increment_note.masm")).unwrap();
     let account_code =
-        fs::read_to_string(Path::new("./masm/accounts/network_counter.masm")).unwrap();
+        fs::read_to_string(Path::new("./masm/accounts/counter.masm")).unwrap();
 
     let library_path = "external_contract::counter_contract";
     let library = create_library(account_code, library_path).unwrap();

docs/src/rust-client/public_account_interaction_tutorial.md

@@ -70,39 +70,38 @@ Inside of the `masm/accounts/` directory, create the `counter.masm` file:
 use.miden::account
 use.std::sys
 
+const.COUNTER_SLOT=0
+# => []
 export.get_count
-    # => []
-    push.0
-
+    push.COUNTER_SLOT
     # => [index]
-    exec.account::get_item
 
+    exec.account::get_item
     # => [count]
-    exec.sys::truncate_stack
 end
 
 # => []
 export.increment_count
-    # => []
-    push.0
-
+    push.COUNTER_SLOT
     # => [index]
-    exec.account::get_item
 
+    exec.account::get_item
     # => [count]
+
     push.1 add
+    # => [count+1]
 
     # debug statement with client
     debug.stack
 
-    # => [count+1]
-    push.0
-
+    push.COUNTER_SLOT
     # [index, count+1]
-    exec.account::set_item
 
+    exec.account::set_item
     # => []
+
     exec.sys::truncate_stack
+    # => []
 end
 ```
 
@@ -245,7 +244,7 @@ println!("\n[STEP 1] Reading data from public state");
 
 // Define the Counter Contract account id from counter contract deploy
 let (_network_id, address) =
-    Address::from_bech32("mtst1qrhk9zc2au2vxqzaynaz5ddhs4cqqghmajy").unwrap();
+    Address::from_bech32("mtst1qre73e6qcrfevqqngx8wewvveacqqjh8p2a").unwrap();
 let counter_contract_id = match address {
     Address::AccountId(account_id_address) => account_id_address.id(),
     _ => panic!("Expected AccountId address"),
@@ -347,7 +346,7 @@ Add the following code snippet to the end of your `src/main.rs` function:
 
 #     // Define the Counter Contract account id from counter contract deploy
 #     let (_network_id, address) =
-#         Address::from_bech32("mtst1qrhk9zc2au2vxqzaynaz5ddhs4cqqghmajy").unwrap();
+#         Address::from_bech32("mtst1qre73e6qcrfevqqngx8wewvveacqqjh8p2a").unwrap();
 #     let counter_contract_id = match address {
 #         Address::AccountId(account_id_address) => account_id_address.id(),
 #         _ => panic!("Expected AccountId address"),
@@ -376,6 +375,7 @@ Add the following code snippet to the end of your `src/main.rs` function:
 // -------------------------------------------------------------------------
 // STEP 2: Call the Counter Contract with a script
 // -------------------------------------------------------------------------
+println!("\n[STEP 2] Call the increment_count procedure in the counter contract");
 
 // Load the MASM script referencing the increment procedure
 let script_path = Path::new("./masm/scripts/counter_script.masm");
@@ -492,7 +492,7 @@ async fn main() -> Result<(), ClientError> {
 
     // Define the Counter Contract account id from counter contract deploy
     let (_network_id, address) =
-        Address::from_bech32("mtst1qrhk9zc2au2vxqzaynaz5ddhs4cqqghmajy").unwrap();
+        Address::from_bech32("mtst1qre73e6qcrfevqqngx8wewvveacqqjh8p2a").unwrap();
     let counter_contract_id = match address {
         Address::AccountId(account_id_address) => account_id_address.id(),
         _ => panic!("Expected AccountId address"),
@@ -637,4 +637,4 @@ cargo run --release --bin counter_contract_increment
 
 ### Continue learning
 
-Next tutorial: [Foreign Procedure Invocation](foreign_procedure_invocation_tutorial.md)
+Next tutorial: [Network Transactions on Miden](network_transactions_tutorial.md)

docs/src/web-client/counter_contract_tutorial.md

@@ -174,7 +174,7 @@ export async function incrementCounterContract(): Promise<void> {
 
   // Counter contract account id on testnet
   const counterContractId = AccountId.fromBech32(
-    "mtst1qrhk9zc2au2vxqzaynaz5ddhs4cqqghmajy",
+    "mtst1qre73e6qcrfevqqngx8wewvveacqqjh8p2a",
   );
 
   // Reading the public state of the counter contract from testnet,

masm/accounts/counter.masm

@@ -3,19 +3,22 @@ use.std::sys
 
 const.COUNTER_SLOT=0
 
-# => []
+#! Inputs:  []
+#! Outputs: [count]
 export.get_count
     push.COUNTER_SLOT
     # => [index]
 
     exec.account::get_item
     # => [count]
 
-    exec.sys::truncate_stack
-    # => []
+    # clean up stack
+    movdn.4 dropw
+    # => [count]
 end
 
-# => []
+#! Inputs:  []
+#! Outputs: []
 export.increment_count
     push.COUNTER_SLOT
     # => [index]
@@ -32,8 +35,8 @@ export.increment_count
     # [index, count+1]
 
     exec.account::set_item
-    # => []
+    # => [OLD_VALUE]
 
-    exec.sys::truncate_stack
+    dropw
     # => []
 end