Merge remote-tracking branch 'upstream' into sierra-explanation

Author: julio4

.github/workflows/verify_cairo_programs.yml

@@ -4,9 +4,16 @@ on:
   pull_request:
     branches:
       - dev
+      - main
   workflow_dispatch:
 
 jobs:
+  typos:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: crate-ci/typos@master
+
   compile_and_verify:
     runs-on: ubuntu-latest
 
@@ -19,21 +26,15 @@ jobs:
       - name: Configure upstream repository
         run: |
           git remote add upstream https://github.com/NethermindEth/StarknetByExample
-          git fetch upstream main
+          git fetch upstream
 
       - name: Install scarb
         uses: software-mansion/setup-scarb@v1
 
       - name: Install snforge
         uses: foundry-rs/setup-snfoundry@v3
 
-      - name: Run build script
+      - name: Verify changes
         run: |
           chmod +x scripts/cairo_programs_verifier.sh
           ./scripts/cairo_programs_verifier.sh
-
-  typos:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: crate-ci/typos@master

.gitignore

@@ -17,7 +17,3 @@ target/*
 src/**/*.md
 
 node_modules
-
-
-# windsurf rules
-.windsurfrules

CONTRIBUTING.md

@@ -2,7 +2,13 @@
 
 When contributing to this repository, please first discuss the change you wish to make via issue or in the telegram channel before making a change.
 
-Join the telegram channel: https://t.me/StarknetByExample
+Join the telegram channel: <https://t.me/StarknetByExample>
+
+The release branch is `main`. The development branch is `dev` and is considered stable (but not released yet).
+When you want to contribute, please create a new branch from `dev` and open a pull request to merge your changes back into `dev`.
+You should never open a pull request to merge your changes directly into `main`.
+
+The `dev` branch is deployed at <https://starknet-by-example-dev.voyager.online/>
 
 The release branch is `main`. The development branch is `dev` and is considered stable (but not released yet).
 When you want to contribute, please create a new branch from `dev` and open a pull request to merge your changes back into `dev`.
@@ -86,10 +92,10 @@ typos src/
 You can add or modify examples in the `listings` directory. Each listing is a scarb project.
 You can use `scarb init` to create a new scarb project, but be sure to remove the generated git repository with `rm -rf .git` and follow the instructions below for the correct `Scarb.toml` configuration.
 
-You can choose to use standard cairo with `cairo-test` or Starknet Foundry with `snforge_std`.
+We prefer to use Starknet Foundry with `snforge_std`, however you can still use `cairo-test` if desired.
 Please use the appropriate `Scarb.toml` configuration. `scarb test` will automatically resolve to `snforge test` if `snforge_std` is in the dependencies.
 
-Here's the required `Scarb.toml` configuration for **cairo-test**:
+Here's the required `Scarb.toml` configuration for **Starknet Foundry**:
 
 ```toml
 [package]
@@ -109,15 +115,21 @@ starknet.workspace = true
 # erc20 = { path = "../../getting-started/erc20" }
 
 [dev-dependencies]
-cairo_test.workspace = true
+assert_macros.workspace = true
+snforge_std.workspace = true
 
 [scripts]
 test.workspace = true
 
 [[target.starknet-contract]]
 ```
 
-Here's the required `Scarb.toml` configuration for **Starknet Foundry**:
+You also **NEED** to do the following:
+
+- Remove the generated git repository, `rm -rf .git` (this is important!)
+- Double check that the package name is the same as the name of the directory
+
+Here's the required `Scarb.toml` configuration for **cairo-test**:
 
 ```toml
 [package]
@@ -137,20 +149,14 @@ starknet.workspace = true
 # erc20 = { path = "../../getting-started/erc20" }
 
 [dev-dependencies]
-assert_macros.workspace = true
-snforge_std.workspace = true
+cairo_test.workspace = true
 
 [scripts]
 test.workspace = true
 
 [[target.starknet-contract]]
 ```
 
-You also NEED to do the following:
-
-- Remove the generated git repository, `rm -rf .git` (this is important!)
-- Double check that the package name is the same as the name of the directory
-
 ### Verification script
 
 The current book has script that verifies the compilation of all Cairo programs in the book.

README.md

@@ -1,5 +1,7 @@
 # Starknet by Example
 
+Dev preview at: https://starknet-by-example-dev.voyager.online/
+
 ## Description
 
 Starknet by Example is a collection of examples of how to use the [Cairo](https://github.com/starkware-libs/cairo) programming language to create smart contracts on Starknet.

Scarb.lock

@@ -2,25 +2,28 @@
 version = 1
 
 [[package]]
-name = "advanced_factory"
+name = "account_spending_limits"
 version = "0.1.0"
 dependencies = [
- "components",
- "crowdfunding",
+ "openzeppelin",
  "snforge_std",
 ]
 
 [[package]]
-name = "bytearray"
-version = "0.1.0"
-
-[[package]]
-name = "cairo_cheatsheet"
+name = "advanced_factory"
 version = "0.1.0"
+dependencies = [
+ "components",
+ "crowdfunding",
+ "snforge_std",
+]
 
 [[package]]
 name = "calling_other_contracts"
 version = "0.1.0"
+dependencies = [
+ "snforge_std",
+]
 
 [[package]]
 name = "coin_flip"
@@ -56,10 +59,16 @@ dependencies = [
 [[package]]
 name = "constructor"
 version = "0.1.0"
+dependencies = [
+ "snforge_std",
+]
 
 [[package]]
 name = "counter"
 version = "0.1.0"
+dependencies = [
+ "snforge_std",
+]
 
 [[package]]
 name = "crowdfunding"
@@ -71,8 +80,11 @@ dependencies = [
 ]
 
 [[package]]
-name = "custom_type_serde"
+name = "custom_type_entrypoints"
 version = "0.1.0"
+dependencies = [
+ "snforge_std",
+]
 
 [[package]]
 name = "ecdsa_verification"
@@ -85,10 +97,16 @@ version = "0.1.0"
 [[package]]
 name = "errors"
 version = "0.1.0"
+dependencies = [
+ "snforge_std",
+]
 
 [[package]]
 name = "events"
 version = "0.1.0"
+dependencies = [
+ "snforge_std",
+]
 
 [[package]]
 name = "factory"
@@ -102,17 +120,16 @@ version = "0.1.0"
 name = "hash_trait"
 version = "0.1.0"
 
-[[package]]
-name = "interfaces_traits"
-version = "0.1.0"
-
 [[package]]
 name = "library_calls"
 version = "0.1.0"
 
 [[package]]
 name = "mappings"
 version = "0.1.0"
+dependencies = [
+ "snforge_std",
+]
 
 [[package]]
 name = "merkle_tree"
@@ -296,6 +313,9 @@ dependencies = [
 [[package]]
 name = "storage"
 version = "0.1.0"
+dependencies = [
+ "snforge_std",
+]
 
 [[package]]
 name = "store_using_packing"
@@ -304,6 +324,9 @@ version = "0.1.0"
 [[package]]
 name = "storing_custom_types"
 version = "0.1.0"
+dependencies = [
+ "snforge_std",
+]
 
 [[package]]
 name = "struct_as_mapping_key"
@@ -329,10 +352,16 @@ version = "0.1.0"
 [[package]]
 name = "variables"
 version = "0.1.0"
+dependencies = [
+ "snforge_std",
+]
 
 [[package]]
 name = "visibility"
 version = "0.1.0"
+dependencies = [
+ "snforge_std",
+]
 
 [[package]]
 name = "write_to_any_slot"

components/useTracking.tsx

@@ -0,0 +1,22 @@
+import { useEffect } from "react";
+
+const CLARITY_ID = "q6bz69wquw";
+
+export const useTracking = () => {
+  useEffect(() => {
+    const script = document.createElement("script");
+    script.type = "text/javascript";
+    script.text = `
+      (function(c,l,a,r,i,t,y){
+        c[a]=c[a]||function(){(c[a].q=c[a].q||[]).push(arguments)};
+        t=l.createElement(r);t.async=1;
+        t.src="https://www.clarity.ms/tag/"+i;
+        y=l.getElementsByTagName(r)[0];y.parentNode.insertBefore(t,y);
+      })(window, document, "clarity", "script", "${CLARITY_ID}");
+    `;
+    document.head.appendChild(script);
+    return () => {
+      document.head.removeChild(script);
+    };
+  }, []);
+};

footer.tsx

@@ -8,7 +8,7 @@ export default function Footer() {
       />
       <div className="footer_text text-xs flex flex-col items-center">
         <span>Released under the MIT License.</span>
-        <span>© 2024 Nethermind. All Rights Reserved</span>
+        <span>© 2025 Nethermind. All Rights Reserved</span>
       </div>
     </div>
   );

layout.tsx

@@ -1,6 +1,8 @@
 import { useSidebarToggle } from "./components/useSidebarToggle";
+import { useTracking } from "./components/useTracking";
 
 export default function Root({ children }: { children: React.ReactNode }) {
+  useTracking();
   useSidebarToggle();
   return <div className="page-wrapper">{children}</div>;
 }

listings/advanced-concepts/account_spending_limits/Scarb.lock

@@ -0,0 +1,20 @@
+# Code generated by scarb DO NOT EDIT.
+version = 1
+
+[[package]]
+name = "aa_tutorial"
+version = "0.1.0"
+dependencies = [
+ "openzeppelin",
+ "snforge_std",
+]
+
+[[package]]
+name = "openzeppelin"
+version = "0.9.0"
+source = "git+https://github.com/OpenZeppelin/cairo-contracts.git?tag=v0.9.0#364db5b1aecc1335d2e65db887291d19aa28937d"
+
+[[package]]
+name = "snforge_std"
+version = "0.25.0"
+source = "git+https://github.com/foundry-rs/starknet-foundry.git?tag=v0.25.0#5b366e24821e530fea97f11b211d220e8493fbea"

listings/advanced-concepts/account_spending_limits/Scarb.toml

@@ -0,0 +1,18 @@
+[package]
+name = "account_spending_limits"
+version.workspace = true
+edition.workspace = true
+
+[dependencies]
+starknet.workspace = true
+openzeppelin.workspace = true
+
+[dev-dependencies]
+assert_macros.workspace = true
+snforge_std.workspace = true
+
+[scripts]
+test.workspace = true
+
+[[target.starknet-contract]]
+build-external-contracts = ["openzeppelin_presets::erc20::ERC20Upgradeable"]