feat: ProtocolHandler

.github/workflows/cairo-ci.yml

@@ -0,0 +1,45 @@
+name: cairo-CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - "*"
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+concurrency:
+  group: cairo-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions: read-all
+
+jobs:
+  paths-filter:
+    runs-on: ubuntu-latest
+    outputs:
+      protocol_handler: ${{ steps.filter.outputs.protocol_handler }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            protocol_handler:
+              - 'cairo/protocol_handler/**'
+
+  tests-unit:
+    runs-on: ubuntu-latest
+    needs: paths-filter
+    if: needs.paths-filter.outputs.protocol_handler == 'true'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: foundry-rs/setup-snfoundry@v3
+      - uses: software-mansion/setup-scarb@v1
+        with:
+          tool-versions: ./cairo/protocol_handler/.tool-versions
+
+      - name: Run tests
+        run: cd cairo/protocol_handler && scarb test

.trunk/trunk.yaml

@@ -73,6 +73,8 @@ lint:
         - cairo/token
         - cairo/utils
         - cairo/kakarot-ssj/crates
+        - cairo/protocol_handler
+        - cairo/snforge_utils
     - linters: [ALL]
       paths:
         - logs*

cairo/kakarot-ssj/Scarb.lock

@@ -59,10 +59,6 @@ dependencies = [
 [[package]]
 name = "snforge_utils"
 version = "0.1.0"
-dependencies = [
- "evm",
- "snforge_std",
-]
 
 [[package]]
 name = "utils"

cairo/kakarot-ssj/crates/contracts/Scarb.toml

@@ -25,7 +25,7 @@ name = "contracts"
 [dev-dependencies]
 snforge_std = { git = "https://github.com/foundry-rs/starknet-foundry.git", tag = "v0.31.0" }
 assert_macros = "2.8.2"
-snforge_utils = { path = "../snforge_utils" }
+snforge_utils = { path = "../../../snforge_utils" }
 
 [scripts]
 test = "snforge test --max-n-steps 4294967295"

cairo/kakarot-ssj/crates/evm/Scarb.toml

@@ -14,7 +14,7 @@ garaga = { git = "https://github.com/keep-starknet-strange/garaga.git" }
 
 [dev-dependencies]
 snforge_std = { git = "https://github.com/foundry-rs/starknet-foundry.git", tag = "v0.31.0" }
-snforge_utils = { path = "../snforge_utils" }
+snforge_utils = { path = "../../../snforge_utils" }
 assert_macros = "2.8.2"
 
 [tool]

cairo/protocol_handler/.gitignore

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

cairo/protocol_handler/.tool-versions

@@ -0,0 +1,2 @@
+scarb 2.8.3
+starknet-foundry 0.31.0

cairo/protocol_handler/Scarb.lock

@@ -0,0 +1,130 @@
+# Code generated by scarb DO NOT EDIT.
+version = 1
+
+[[package]]
+name = "openzeppelin"
+version = "0.17.0"
+source = "git+https://github.com/OpenZeppelin/cairo-contracts.git?tag=v0.17.0#bf5d02c25c989ccc24f3ab42ec649617d3f21289"
+dependencies = [
+ "openzeppelin_access",
+ "openzeppelin_account",
+ "openzeppelin_finance",
+ "openzeppelin_governance",
+ "openzeppelin_introspection",
+ "openzeppelin_merkle_tree",
+ "openzeppelin_presets",
+ "openzeppelin_security",
+ "openzeppelin_token",
+ "openzeppelin_upgrades",
+ "openzeppelin_utils",
+]
+
+[[package]]
+name = "openzeppelin_access"
+version = "0.17.0"
+source = "git+https://github.com/OpenZeppelin/cairo-contracts.git?tag=v0.17.0#bf5d02c25c989ccc24f3ab42ec649617d3f21289"
+dependencies = [
+ "openzeppelin_introspection",
+ "openzeppelin_utils",
+]
+
+[[package]]
+name = "openzeppelin_account"
+version = "0.17.0"
+source = "git+https://github.com/OpenZeppelin/cairo-contracts.git?tag=v0.17.0#bf5d02c25c989ccc24f3ab42ec649617d3f21289"
+dependencies = [
+ "openzeppelin_introspection",
+ "openzeppelin_utils",
+]
+
+[[package]]
+name = "openzeppelin_finance"
+version = "0.17.0"
+source = "git+https://github.com/OpenZeppelin/cairo-contracts.git?tag=v0.17.0#bf5d02c25c989ccc24f3ab42ec649617d3f21289"
+dependencies = [
+ "openzeppelin_access",
+ "openzeppelin_token",
+]
+
+[[package]]
+name = "openzeppelin_governance"
+version = "0.17.0"
+source = "git+https://github.com/OpenZeppelin/cairo-contracts.git?tag=v0.17.0#bf5d02c25c989ccc24f3ab42ec649617d3f21289"
+dependencies = [
+ "openzeppelin_access",
+ "openzeppelin_introspection",
+]
+
+[[package]]
+name = "openzeppelin_introspection"
+version = "0.17.0"
+source = "git+https://github.com/OpenZeppelin/cairo-contracts.git?tag=v0.17.0#bf5d02c25c989ccc24f3ab42ec649617d3f21289"
+
+[[package]]
+name = "openzeppelin_merkle_tree"
+version = "0.17.0"
+source = "git+https://github.com/OpenZeppelin/cairo-contracts.git?tag=v0.17.0#bf5d02c25c989ccc24f3ab42ec649617d3f21289"
+
+[[package]]
+name = "openzeppelin_presets"
+version = "0.17.0"
+source = "git+https://github.com/OpenZeppelin/cairo-contracts.git?tag=v0.17.0#bf5d02c25c989ccc24f3ab42ec649617d3f21289"
+dependencies = [
+ "openzeppelin_access",
+ "openzeppelin_account",
+ "openzeppelin_finance",
+ "openzeppelin_introspection",
+ "openzeppelin_token",
+ "openzeppelin_upgrades",
+]
+
+[[package]]
+name = "openzeppelin_security"
+version = "0.17.0"
+source = "git+https://github.com/OpenZeppelin/cairo-contracts.git?tag=v0.17.0#bf5d02c25c989ccc24f3ab42ec649617d3f21289"
+
+[[package]]
+name = "openzeppelin_token"
+version = "0.17.0"
+source = "git+https://github.com/OpenZeppelin/cairo-contracts.git?tag=v0.17.0#bf5d02c25c989ccc24f3ab42ec649617d3f21289"
+dependencies = [
+ "openzeppelin_account",
+ "openzeppelin_governance",
+ "openzeppelin_introspection",
+]
+
+[[package]]
+name = "openzeppelin_upgrades"
+version = "0.17.0"
+source = "git+https://github.com/OpenZeppelin/cairo-contracts.git?tag=v0.17.0#bf5d02c25c989ccc24f3ab42ec649617d3f21289"
+
+[[package]]
+name = "openzeppelin_utils"
+version = "0.17.0"
+source = "git+https://github.com/OpenZeppelin/cairo-contracts.git?tag=v0.17.0#bf5d02c25c989ccc24f3ab42ec649617d3f21289"
+
+[[package]]
+name = "protocol_handler"
+version = "0.1.0"
+dependencies = [
+ "openzeppelin",
+ "snforge_std",
+ "snforge_utils",
+]
+
+[[package]]
+name = "snforge_scarb_plugin"
+version = "0.31.0"
+source = "git+https://github.com/foundry-rs/starknet-foundry.git?tag=v0.31.0#72ea785ca354e9e506de3e5d687da9fb2c1b3c67"
+
+[[package]]
+name = "snforge_std"
+version = "0.31.0"
+source = "git+https://github.com/foundry-rs/starknet-foundry.git?tag=v0.31.0#72ea785ca354e9e506de3e5d687da9fb2c1b3c67"
+dependencies = [
+ "snforge_scarb_plugin",
+]
+
+[[package]]
+name = "snforge_utils"
+version = "0.1.0"

cairo/protocol_handler/Scarb.toml

@@ -0,0 +1,21 @@
+[package]
+name = "protocol_handler"
+version = "0.1.0"
+edition = "2024_07"
+
+# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest.html
+
+[dependencies]
+starknet = "2.8.2"
+openzeppelin = { git = "https://github.com/OpenZeppelin/cairo-contracts.git", tag = "v0.17.0" }
+
+[dev-dependencies]
+snforge_std = { git = "https://github.com/foundry-rs/starknet-foundry.git", tag = "v0.31.0" }
+snforge_utils = { path = "../snforge_utils" }
+
+[[target.starknet-contract]]
+casm = true
+casm-add-pythonic-hints = true
+
+[scripts]
+test = "snforge test"

cairo/protocol_handler/src/kakarot_interface.cairo

@@ -0,0 +1,10 @@
+use starknet::{ContractAddress, ClassHash};
+
+#[starknet::interface]
+pub trait IKakarot<TContractState> {
+    fn upgrade(ref self: TContractState, new_class_hash: ClassHash);
+    fn transfer_ownership(ref self: TContractState, new_owner: ContractAddress);
+    fn pause(ref self: TContractState);
+    fn unpause(ref self: TContractState);
+    fn set_base_fee(ref self: TContractState, new_base_fee: felt252);
+}

cairo/protocol_handler/src/lib.cairo

@@ -0,0 +1,6 @@
+mod protocol_handler;
+pub use protocol_handler::{
+    ProtocolHandler, IProtocolHandlerDispatcher, IProtocolHandlerDispatcherTrait,
+    IProtocolHandlerSafeDispatcher, IProtocolHandlerSafeDispatcherTrait
+};
+mod kakarot_interface;