refactor: book structure & CI

.github/workflows/install-mdbook/action.yml

@@ -13,7 +13,3 @@ runs:
     - name: Install mdbook-i18n-helpers
       run: cargo install mdbook-i18n-helpers --locked --version 0.1.0
       shell: bash
-
-    - name: Install cairo programs verifier
-      run: cargo install --path mdbook-cairo --locked
-      shell: bash

.github/workflows/verify-cairo-programs/action.yml

@@ -5,20 +5,16 @@ description: Verify if all Cairo programs extracted from markdown can be compile
 runs:
   using: composite
   steps:
+    - name: Install scarb
+      run: |
+        curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | bash -s -- -v 0.4.0
+
     - name: Copy Cairo program verifier script
       shell: bash
       run: |
-        cp mdbook-cairo/scripts/cairo_programs_verifier.sh book/cairo/cairo-programs/
-
-    - name: Verify Cairo programs
-      uses: addnab/docker-run-action@v3
-      with:
-        image: starknet/cairo:1.1.0
-        options: -v ${{ github.workspace }}/book/cairo/cairo-programs:/cairo
-        run: |
-          sh /cairo/cairo_programs_verifier.sh false > /cairo/summary.md
+        mkdir -p book/listings && cp scripts/cairo_programs_verifier.sh book/listings && cp listings book/listings
 
-    - name: Generate job summary
-      shell: bash
-      run: cat book/cairo/cairo-programs/summary.md >> $GITHUB_STEP_SUMMARY
-      if: always()
+    - name: Run build script
+      run: |
+        chmod +x scripts/cairo_programs_verifier.sh
+        ./scripts/cairo_programs_verifier.sh

.github/workflows/verify_cairo_programs.yml

@@ -0,0 +1,26 @@
+name: Verify Cairo programs compilation
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  compile_and_verify:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Rust cache
+        uses: ./.github/workflows/setup-rust-cache
+
+      - name: Install scarb
+        run: |
+          curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | bash -s -- -v 0.4.0
+
+      - name: Run build script
+        run: |
+          chmod +x scripts/cairo_programs_verifier.sh
+          ./scripts/cairo_programs_verifier.sh

listings/ch00-introduction/calling_other_contracts/.gitignore

@@ -0,0 +1 @@
+target

listings/ch00-introduction/calling_other_contracts/Scarb.toml

@@ -0,0 +1,10 @@
+[package]
+name = "calling_other_contracts"
+version = "0.1.0"
+
+# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest
+
+[dependencies]
+starknet = "1.1.0"
+
+[[target.starknet-contract]]

listings/ch00-introduction/calling_other_contracts/src/lib.cairo

@@ -0,0 +1,2 @@
+mod callee;
+mod caller;

listings/ch00-introduction/errors/.gitignore

@@ -0,0 +1 @@
+target

listings/ch00-introduction/errors/Scarb.toml

@@ -0,0 +1,10 @@
+[package]
+name = "errors"
+version = "0.1.0"
+
+# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest
+
+[dependencies]
+starknet = "1.1.0"
+
+[[target.starknet-contract]]

listings/ch00-introduction/errors/src/lib.cairo

@@ -0,0 +1,3 @@
+mod simple_errors;
+mod custom_errors;
+mod vault_errors;

listings/ch00-introduction/storing_arrays/.gitignore

@@ -0,0 +1 @@
+target

listings/ch00-introduction/storing_arrays/Scarb.toml

@@ -0,0 +1,11 @@
+[package]
+name = "storing_arrays"
+version = "0.1.0"
+
+# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest
+
+[dependencies]
+starknet = "1.1.0"
+
+[[target.starknet-contract]]
+allowed-libfuncs-list.name = "experimental_v0.1.0"

listings/ch00-introduction/storing_arrays/src/lib.cairo

@@ -0,0 +1 @@
+mod storing_arrays;

listings/ch00-introduction/variables/.gitignore

@@ -0,0 +1 @@
+target

listings/ch00-introduction/variables/Scarb.toml

@@ -0,0 +1,10 @@
+[package]
+name = "variables"
+version = "0.1.0"
+
+# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest
+
+[dependencies]
+starknet = "1.1.0"
+
+[[target.starknet-contract]]

listings/ch00-introduction/variables/src/lib.cairo

@@ -0,0 +1,3 @@
+mod storage_variables;
+mod local_variables;
+mod global_variables;

listings/ch00-introduction/write_to_any_slot/.gitignore

@@ -0,0 +1 @@
+target

listings/ch00-introduction/write_to_any_slot/Scarb.toml

@@ -0,0 +1,11 @@
+[package]
+name = "write_to_any_slot"
+version = "0.1.0"
+
+# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest
+
+[dependencies]
+starknet = "1.1.0"
+
+[[target.starknet-contract]]
+allowed-libfuncs-list.name = "experimental_v0.1.0"

listings/ch00-introduction/write_to_any_slot/src/lib.cairo

@@ -0,0 +1,2 @@
+mod test_write_any_slot;
+mod write_any_slot;

listings/ch00-introduction/write_to_any_slot/src/test_write_any_slot.cairo

@@ -0,0 +1,42 @@
+use write_to_any_slot::write_any_slot::WriteToAnySlot;
+
+#[abi]
+trait IWriteToAnySlot {
+    fn write_slot(value: u32);
+    fn read_slot() -> u32;
+}
+
+#[cfg(test)]
+mod tests {
+    use super::WriteToAnySlot::{get_address_from_name};
+    use super::WriteToAnySlot;
+    use super::{IWriteToAnySlotDispatcher, IWriteToAnySlotDispatcherTrait};
+    use debug::PrintTrait;
+    use starknet::deploy_syscall;
+    use option::OptionTrait;
+    use array::ArrayTrait;
+    use traits::{Into, TryInto};
+    use starknet::class_hash::Felt252TryIntoClassHash;
+    use result::ResultTrait;
+
+    #[test]
+    #[available_gas(2000000000)]
+    fn test_read_write() {
+        // Set up.
+        let mut calldata: Array<felt252> = ArrayTrait::new();
+        let (address0, _) = deploy_syscall(
+            WriteToAnySlot::TEST_CLASS_HASH.try_into().unwrap(), 0, calldata.span(), false
+        )
+            .unwrap();
+        let mut contract = IWriteToAnySlotDispatcher { contract_address: address0 };
+
+        // Write to slot.
+        let value: u32 = 42;
+        contract.write_slot(value);
+
+        // Read from slot.
+        let read_value = contract.read_slot();
+        assert(read_value == value, 'wrong value read');
+    }
+}
+

listings/ch01-applications/upgradeable_contract/.gitignore

@@ -0,0 +1 @@
+target

listings/ch01-applications/upgradeable_contract/Scarb.toml

@@ -0,0 +1,10 @@
+[package]
+name = "upgradeable_contract"
+version = "0.1.0"
+
+# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest
+
+[dependencies]
+starknet = "1.1.0"
+
+[[target.starknet-contract]]

listings/ch01-applications/upgradeable_contract/src/lib.cairo

@@ -0,0 +1,2 @@
+mod upgradeable_contract_v0;
+mod upgradeable_contract_v1;

src/applications/upgradeable_contract/upgradeable_contract_v0.cairo → listings/ch01-applications/upgradeable_contract/src/upgradeable_contract_v0.cairo

@@ -2,6 +2,8 @@
 mod UpgradeableContract_V0 {
     use starknet::class_hash::ClassHash;
     use zeroable::Zeroable;
+    use result::ResultTrait;
+    use starknet::SyscallResult;
 
     struct Storage {}
 

src/applications/upgradeable_contract/upgradeable_contract_v1.cairo → listings/ch01-applications/upgradeable_contract/src/upgradeable_contract_v1.cairo

@@ -2,6 +2,8 @@
 mod UpgradeableContract_V1 {
     use starknet::class_hash::ClassHash;
     use zeroable::Zeroable;
+    use result::ResultTrait;
+    use starknet::SyscallResult;
 
     struct Storage {}