feat: evm sequencer (#316)

* add possibility to set state nonce * kakarot sequencer * add default constants used in the sequencer * add felt sequencer to avoid dep on rpc * setup for contract deployed, kakarot and funding * introduce kakarot as submodule * load contract classes in lazy static * init sequencer with all classes * transaction conversion * add test * correct make file * update ci to pull submodules * remove setup kakarot from setup * fixing checkout * answer comments * update based on comments * fix ci rebase * update extension * update ci * try CI with more cores * fix trunk * fix CI permissions * update trunk timeout * fix clippy
kkrt-labs · Oct 3, 2023 · 3ff4ed2 · 3ff4ed2
1 parent 409e1fd
commit 3ff4ed2
Show file tree

Hide file tree

Showing 22 changed files with 766 additions and 27 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,28 @@
+---
+name: Workflow - CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches:
+      - main
+
+permissions: read-all
+
+jobs:
+  trunk:
+    name: Trunk
+    uses: ./.github/workflows/trunk-check.yml
+    permissions:
+      checks: write
+      contents: read
+
+  submodules:
+    name: Compile Kakarot contracts
+    uses: ./.github/workflows/kakarot.yml
+
+  tests:
+    name: Rust tests
+    uses: ./.github/workflows/test.yml
+    needs: submodules
diff --git a/.github/workflows/kakarot.yml b/.github/workflows/kakarot.yml
@@ -0,0 +1,35 @@
+name: Kakarot compilation caching
+
+on:
+  workflow_call: {}
+
+permissions: read-all
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}-submodules
+  cancel-in-progress: true
+
+jobs:
+  submodules:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
+      - name: pull kakarot submodule and setup
+        run: make setup-kakarot
+      - name: Save compiled kakarot contracts
+        id: cached-contracts
+        uses: actions/cache/save@v3
+        with:
+          path: ./lib/kakarot/build
+          key: ${{ runner.os }}-contracts
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,23 +1,27 @@
 name: test
 
 on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
+  workflow_call: {}
 
 permissions: read-all
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
+  group: ${{ github.workflow }}-${{ github.ref }}-test
   cancel-in-progress: true
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    # trunk-ignore(actionlint/runner-label)
+    runs-on: ubuntu-latest-16-cores
     timeout-minutes: 120
     steps:
       - uses: actions/checkout@v3
+      - name: Load compiled kakarot contracts
+        id: cached-contracts
+        uses: actions/cache/restore@v3
+        with:
+          path: ./lib/kakarot/build
+          key: ${{ runner.os }}-contracts
       - name: Setup rust env
         uses: actions-rs/toolchain@v1
         with:
@@ -26,13 +30,10 @@ jobs:
           override: true
       - name: Retrieve cached dependencies
         uses: Swatinem/rust-cache@v2
-      # fetch ef tests
       - name: fetch ef tests
         run: make setup
-      # fetch dump
       - name: fetch dump
         run: GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }} make fetch-dump
       - uses: taiki-e/install-action@nextest
-      # run tests
       - name: run tests
         run: make ef-tests
diff --git a/.github/workflows/trunk-check.yaml → .github/workflows/trunk-check.yml b/.github/workflows/trunk-check.yaml → .github/workflows/trunk-check.yml
@@ -1,21 +1,17 @@
 name: Trunk
 
 on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
+  workflow_call: {}
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
+  group: ${{ github.workflow }}-${{ github.ref }}-trunk
   cancel-in-progress: true
 
-permissions: read-all
-
 jobs:
   trunk_check:
     name: Trunk Check Runner
     runs-on: ubuntu-latest
+    # trunk-ignore(checkov/CKV2_GHA_1)
     permissions:
       checks: write # For trunk to post annotations
       contents: read # For repo checkout

diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "kakarot"]
+	path = lib/kakarot
+	url = https://github.com/kkrt-labs/kakarot.git
diff --git a/.trunk/trunk.yaml b/.trunk/trunk.yaml
@@ -20,6 +20,7 @@ lint:
             cargo clippy --message-format json --locked --workspace
             --all-features --all-targets -- --cap-lints=warn --no-deps -D
             warnings
+      run_timeout: 20m
   enabled:
     - actionlint@1.6.26
     - checkov@2.4.9

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -34,6 +34,8 @@ kakarot-rpc-core = { git = "https://github.com/kkrt-labs/kakarot-rpc.git", rev =
 kakarot-test-utils = { git = "https://github.com/kkrt-labs/kakarot-rpc.git", rev = "ae5e220" }
 
 # Starknet deps
+cairo-vm = "0.8.2"
+blockifier = { package = "blockifier", git = "https://github.com/starkware-libs/blockifier.git", tag = "v0.3.0-rc0" }
 katana-core = { git = 'https://github.com/dojoengine/dojo', rev = "b924dac" }
 dojo-test-utils = { git = 'https://github.com/dojoengine/dojo', rev = "b924dac" }
 

diff --git a/Makefile b/Makefile
@@ -18,7 +18,13 @@ KAKAROT_COMMIT := .katana/remote_kakarot_sha
 
 # Ensures the commands for $(EF_TESTS_DIR) always run on `make setup`, regardless if the directory exists
 .PHONY: $(EF_TESTS_DIR)
-setup: $(EF_TESTS_DIR)
+setup: $(EF_TESTS_DIR) 
+
+setup-kakarot: pull-kakarot	
+	cd lib/kakarot && make setup && make build
+
+pull-kakarot:
+	git submodule update --init --recursive
 
 fetch-dump: fetch-kakarot-submodule-commit
 	cargo run --features dump --bin fetch-dump-katana

diff --git a/crates/ef-testing/Cargo.toml b/crates/ef-testing/Cargo.toml
@@ -20,8 +20,11 @@ reth-rlp = { workspace = true }
 # Kakarot deps
 kakarot-rpc-core = { workspace = true }
 kakarot-test-utils = { workspace = true }
+sequencer = { path = "../sequencer" }
 
 # Starknet deps
+blockifier = { workspace = true }
+cairo-vm = { workspace = true }
 dojo-test-utils = { workspace = true }
 katana-core = { workspace = true }
 starknet_api = { workspace = true }

diff --git a/crates/ef-testing/src/evm_sequencer/constants.rs b/crates/ef-testing/src/evm_sequencer/constants.rs
@@ -0,0 +1,100 @@
+use std::{collections::HashMap, sync::Arc};
+
+use blockifier::block_context::BlockContext;
+use lazy_static::lazy_static;
+use starknet::core::types::{contract::legacy::LegacyContractClass, FieldElement};
+use starknet_api::{
+    block::{BlockNumber, BlockTimestamp},
+    core::{ChainId, ClassHash, ContractAddress, PatriciaKey},
+    hash::StarkFelt,
+};
+
+lazy_static! {
+    // Chain params
+    pub static ref CHAIN_ID: u64 = 0x4b4b5254;
+
+    // Vm resources: maps resource name to fee cost.
+    pub static ref VM_RESOURCES: HashMap<String, f64> = [
+        (String::from("n_steps"), 1_f64),
+        ("pedersen_builtin".to_string(), 1_f64),
+        ("range_check_builtin".to_string(), 1_f64),
+        ("ecdsa_builtin".to_string(), 1_f64),
+        ("bitwise_builtin".to_string(), 1_f64),
+        ("poseidon_builtin".to_string(), 1_f64),
+        ("output_builtin".to_string(), 1_f64),
+        ("ec_op_builtin".to_string(), 1_f64),
+        ("keccak_builtin".to_string(), 1_f64),
+        ("segment_arena_builtin".to_string(), 1_f64),
+    ]
+    .into_iter()
+    .collect();
+
+    // Block context
+    pub static ref BLOCK_CONTEXT: BlockContext = BlockContext {
+            chain_id: ChainId(String::from_utf8(CHAIN_ID.to_be_bytes().to_vec()).unwrap()),
+            block_number: BlockNumber(0),
+            block_timestamp: BlockTimestamp(0),
+            sequencer_address: *SEQUENCER_ADDRESS,
+            fee_token_address: *FEE_TOKEN_ADDRESS,
+            vm_resource_fee_cost: Arc::new(VM_RESOURCES.clone()),
+            gas_price: 1,
+            invoke_tx_max_n_steps: 2_u32.pow(24),
+            validate_max_n_steps: 2_u32.pow(24),
+            max_recursion_depth: 1024,
+        };
+
+    // Main addresses
+    pub static ref SEQUENCER_ADDRESS: ContractAddress = ContractAddress(
+        TryInto::<PatriciaKey>::try_into(StarkFelt::from(
+            FieldElement::from_hex_be(
+                "0x01176a1bd84444c89232ec27754698e5d2e7e1a7f1539f12027f28b23ec9f3d8"
+            )
+            .unwrap()
+        ))
+        .unwrap()
+    );
+    pub static ref FEE_TOKEN_ADDRESS: ContractAddress = ContractAddress(
+        TryInto::<PatriciaKey>::try_into(StarkFelt::from(
+            FieldElement::from_hex_be(
+                "0x049D36570D4e46f48e99674bd3fcc84644DdD6b96F7C741B1562B82f9e004dC7"
+            )
+            .unwrap()
+        ))
+        .unwrap()
+    );
+    pub static ref KAKAROT_ADDRESS: ContractAddress =
+        ContractAddress(TryInto::<PatriciaKey>::try_into(StarkFelt::from(1_u8)).unwrap());
+    pub static ref KAKAROT_OWNER_ADDRESS: ContractAddress =
+        ContractAddress(TryInto::<PatriciaKey>::try_into(StarkFelt::from(2_u8)).unwrap());
+
+    // Main contract classes
+    pub static ref KAKAROT_CLASS: LegacyContractClass = serde_json::from_reader::<_, LegacyContractClass>(std::fs::File::open("../../lib/kakarot/build/kakarot.json").unwrap()).unwrap();
+    pub static ref CONTRACT_ACCOUNT_CLASS: LegacyContractClass = serde_json::from_reader::<_, LegacyContractClass>(std::fs::File::open("../../lib/kakarot/build/contract_account.json").unwrap()).unwrap();
+    pub static ref EOA_CLASS: LegacyContractClass = serde_json::from_reader::<_, LegacyContractClass>(std::fs::File::open("../../lib/kakarot/build/externally_owned_account.json").unwrap()).unwrap();
+    pub static ref PROXY_CLASS: LegacyContractClass = serde_json::from_reader::<_, LegacyContractClass>(std::fs::File::open("../../lib/kakarot/build/proxy.json").unwrap()).unwrap();
+
+    // Main class hashes
+    pub static ref KAKAROT_CLASS_HASH: ClassHash = ClassHash(KAKAROT_CLASS.class_hash().unwrap().into());
+    pub static ref CONTRACT_ACCOUNT_CLASS_HASH: ClassHash = ClassHash(CONTRACT_ACCOUNT_CLASS.class_hash().unwrap().into());
+    pub static ref EOA_CLASS_HASH: ClassHash = ClassHash(EOA_CLASS.class_hash().unwrap().into());
+    pub static ref PROXY_CLASS_HASH: ClassHash = ClassHash(PROXY_CLASS.class_hash().unwrap().into());
+
+}
+
+#[cfg(test)]
+pub mod tests {
+    use std::str::FromStr;
+
+    use lazy_static::lazy_static;
+    use reth_primitives::Address;
+    use revm_primitives::B256;
+
+    lazy_static! {
+        pub static ref PRIVATE_KEY: B256 =
+            B256::from_str("0x6ae82d865482a203603ecbf25c865e082396d7705a6bbce92c1ff1d6ab9b503c")
+                .unwrap();
+        pub static ref PUBLIC_KEY: Address =
+            Address::from_str("0x7513A12F74fFF533ee12F20EE524e4883CBd1945").unwrap();
+        pub static ref TEST_CONTRACT_ADDRESS: Address = Address::from_low_u64_be(10);
+    }
+}