Refactor tests

.github/workflows/tests.yml

@@ -44,10 +44,8 @@ jobs:
         run: |
           sudo apt install -y libgmp3-dev
           python -m pip install --upgrade pip
-          pip install starknet-devnet==0.2.1
-          pip install werkzeug==2.0.3
+          pip install starknet-devnet==0.2.2
           pip install openzeppelin-cairo-contracts
-          pip install marshmallow-dataclass==8.5.3 --force
 
       - name: Compile Contracts
         run: yarn compile

README.md

@@ -2,10 +2,60 @@
 
 # Snapshot X
 
-Programmable governance on StarkNet.
-
-#### [Documentation](https://docs.snapshotx.xyz)
+Programmable governance on StarkNet. Refer to the [documentation](https://docs.snapshotx.xyz) for more information.
+
+## Contracts Blueprint
+```ml
+contracts
+├─ starknet
+│   ├─ Authenticators
+│   │  ├─ EthTx.cairo — "Authenticate user via an Ethereum transaction"
+│   │  ├─ StarkTx.cairo — "Authenticate user via a StarkNet  transaction"
+│   │  ├─ StarkSig.cairo — "Authenticate user via a Starknet signature"
+│   │  └─ Vanilla.cairo — "Dummy authentication"
+│   ├─ VotingStrategies
+│   │  ├─ SingleSlotProof.cairo — "Enables the use of the contents of an Ethereum storage slot as voting power"
+│   │  ├─ Vanilla.cairo — "Voting power of 1 for every user"
+│   │  └─ Whitelist.cairo — "Predetermined voting power for members in a whitelist, otherwise zero"
+│   ├─ ExecutionStrategies
+│   │  ├─ Vanilla.cairo — "Dummy execution"
+│   │  └─ ZodiacRelayer.cairo — "Strategy to execute proposal transactions using an Ethereum Gnosis Safe"
+│   ├─ Interfaces
+│   │  ├─ IAuthenticator.cairo — "Interface for all authenticators"
+│   │  ├─ IExecutionStrategy.cairo — "Interface for all execution strategies"
+│   │  └─ IVotingStrategy.cairo — "Interface for all voting strategies"
+│   ├─ lib
+│   │  ├─ array2d.cairo — "For handling 2 dimensional arrays"
+│   │  ├─ choice.cairo — "The set of choices one can make for a vote"
+│   │  ├─ eth_address.cairo — "Ethereum address type"
+│   │  ├─ felt_to_uint256.cairo — "Convert a felt to a uint256"
+│   │  ├─ hash_array.cairo — "Wrapper function for pedersen hashing arrays"
+│   │  ├─ proposal.cairo — "Proposal metadata type"
+│   │  ├─ proposal_info.cairo — "Proposal vote data type"
+│   │  ├─ proposal_outcome.cairo — "The set of proposal outcomes"
+│   │  ├─ slot_key.cairo — "Function to find the slot key for a slot in the Ethereum state"
+│   │  ├─ vote.cairo.cairo — "User vote data type"
+│   │  └─ words.cairo — "Small 64 bit word library"
+│   ├─ TestContracts
+│   │  ├─ Test_array2d.cairo 
+│   │  ├─ Test_words.cairo 
+│   │  └─ Test_words_to_uint256.cairo 
+│   └─ Space.cairo - "The core contract for Snapshot X"
+└─ ethereum 
+    ├─ Interfaces
+    │  └─ IStarknetCore.sol — "Authenticate user via an Ethereum transaction"
+    ├─ StarkNetCommit
+    │  └─ StarknetCommit.sol — "Authenticate user via an Ethereum transaction"
+    ├─ ZodiacModule
+    │  ├─ ProposalRelayer.sol — "Authenticate user via an Ethereum transaction"
+    │  ├─ SnapshotXL1Executor.sol — "Authenticate user via an Ethereum transaction"
+    │  └─ deps.sol — "No authentication of users"
+    └─ TestContracts
+       ├─ MockStarknetMessaging.sol — "Authenticate user via an Ethereum transaction"
+       ├─ NamedStorage.sol — "Authenticate user via an Ethereum transaction"
+       └─ StarknetMessaging.sol — "No authentication of users"
 
+```
 
 ## Usage
 

contracts/ethereum/SnapshotXZodiacModule/ProposalRelayer.sol → contracts/ethereum/ZodiacModule/ProposalRelayer.sol

@@ -3,7 +3,9 @@
 pragma solidity 0.8.9;
 
 import '@gnosis.pm/zodiac/contracts/guard/Guardable.sol';
-import '../Interfaces/IStarknetCore.sol';
+// import '../Interfaces/IStarknetCore.sol';
+
+import 'contracts/ethereum/TestContracts/MockStarknetMessaging.sol';
 
 /**
  * @title Snapshot X L1 Proposal Relayer
@@ -12,7 +14,9 @@ import '../Interfaces/IStarknetCore.sol';
  */
 contract SnapshotXProposalRelayer is Guardable {
   /// The StarkNet Core contract
-  IStarknetCore public starknetCore;
+  // IStarknetCore public starknetCore;
+
+  MockStarknetMessaging public starknetCore;
 
   /// Address of the StarkNet contract that will send execution details to this contract in a L2 -> L1 message
   uint256 public l2ExecutionRelayer;
@@ -23,15 +27,22 @@ contract SnapshotXProposalRelayer is Guardable {
    */
   event ChangedL2ExecutionRelayer(uint256 _l2ExecutionRelayer);
 
-  /**
-   * @dev Initialization of the functionality. Called internally by the setUp function
-   * @param _starknetCore Address of the StarkNet Core contract
-   * @param _l2ExecutionRelayer Address of the new execution relayer contract
-   */
+  // /**
+  //  * @dev Initialization of the functionality. Called internally by the setUp function
+  //  * @param _starknetCore Address of the StarkNet Core contract
+  //  * @param _l2ExecutionRelayer Address of the new execution relayer contract
+  //  */
+  // function setUpSnapshotXProposalRelayer(address _starknetCore, uint256 _l2ExecutionRelayer)
+  //   internal
+  // {
+  //   starknetCore = IStarknetCore(_starknetCore);
+  //   l2ExecutionRelayer = _l2ExecutionRelayer;
+  // }
+
   function setUpSnapshotXProposalRelayer(address _starknetCore, uint256 _l2ExecutionRelayer)
     internal
   {
-    starknetCore = IStarknetCore(_starknetCore);
+    starknetCore = MockStarknetMessaging(_starknetCore);
     l2ExecutionRelayer = _l2ExecutionRelayer;
   }
 

contracts/ethereum/SnapshotXZodiacModule/SnapshotXL1Executor.sol → contracts/ethereum/ZodiacModule/SnapshotXL1Executor.sol

@@ -190,11 +190,12 @@ contract SnapshotXL1Executor is Module, SnapshotXProposalRelayer {
     uint256 executionHashHigh,
     bytes32[] memory _txHashes
   ) external {
-    //External call will fail if finalized proposal message was not received on L1.
-    _receiveFinalizedProposal(callerAddress, proposalOutcome, executionHashLow, executionHashHigh);
-    require(whitelistedSpaces[callerAddress] == true, 'Invalid caller');
     require(proposalOutcome != 0, 'Proposal did not pass');
     require(_txHashes.length > 0, 'proposal must contain transactions');
+    require(whitelistedSpaces[callerAddress] == true, 'Invalid caller');
+
+    //External call will fail if finalized proposal message was not received on L1.
+    _receiveFinalizedProposal(callerAddress, proposalOutcome, executionHashLow, executionHashHigh);
 
     // Re-assemble the lowest and highest bytes to get the full execution hash
     uint256 executionHash = (executionHashHigh << 128) + executionHashLow;

contracts/starknet/ExecutionStrategies/Vanilla.cairo

@@ -0,0 +1,13 @@
+%lang starknet
+
+from starkware.cairo.common.uint256 import Uint256
+
+@external
+func execute{syscall_ptr : felt*}(
+    proposal_outcome : felt,
+    execution_hash : Uint256,
+    execution_params_len : felt,
+    execution_params : felt*,
+):
+    return ()
+end

contracts/starknet/interfaces/i_authenticator.cairo → contracts/starknet/Interfaces/IAuthenticator.cairo

@@ -1,7 +1,7 @@
 %lang starknet
 
 @contract_interface
-namespace i_authenticator:
+namespace IAuthenticator:
     func execute(target : felt, function_selector : felt, calldata_len : felt, calldata : felt*):
     end
 end

contracts/starknet/interfaces/i_execution_strategy.cairo → contracts/starknet/Interfaces/IExecutionStrategy.cairo

@@ -4,7 +4,7 @@ from contracts.starknet.lib.eth_address import EthAddress
 from starkware.cairo.common.uint256 import Uint256
 
 @contract_interface
-namespace i_execution_strategy:
+namespace IExecutionStrategy:
     func execute(
         proposal_outcome : felt,
         execution_hash : Uint256,

contracts/starknet/interfaces/i_voting_strategy.cairo → contracts/starknet/Interfaces/IVotingStrategy.cairo

@@ -4,7 +4,7 @@ from contracts.starknet.lib.eth_address import EthAddress
 from starkware.cairo.common.uint256 import Uint256
 
 @contract_interface
-namespace i_voting_strategy:
+namespace IVotingStrategy:
     func get_voting_power(
         block : felt,
         voter_address : EthAddress,

contracts/starknet/space.cairo → contracts/starknet/Space.cairo

@@ -14,8 +14,8 @@ from starkware.cairo.common.math import (
     assert_lt_felt,
 )
 
-from contracts.starknet.interfaces.i_voting_strategy import i_voting_strategy
-from contracts.starknet.interfaces.i_execution_strategy import i_execution_strategy
+from contracts.starknet.Interfaces.IVotingStrategy import IVotingStrategy
+from contracts.starknet.Interfaces.IExecutionStrategy import IExecutionStrategy
 from contracts.starknet.lib.eth_address import EthAddress
 from contracts.starknet.lib.proposal import Proposal
 from contracts.starknet.lib.proposal_info import ProposalInfo
@@ -426,7 +426,7 @@ func get_cumulative_voting_power{syscall_ptr : felt*, pedersen_ptr : HashBuiltin
         user_voting_strategy_params_all, index
     )
 
-    let (user_voting_power) = i_voting_strategy.get_voting_power(
+    let (user_voting_power) = IVotingStrategy.get_voting_power(
         contract_address=voting_strategy,
         block=current_timestamp,
         voter_address=voter_address,
@@ -921,7 +921,7 @@ func finalize_proposal{syscall_ptr : felt*, pedersen_ptr : HashBuiltin*, range_c
         tempvar proposal_outcome = proposal_outcome
     end
 
-    i_execution_strategy.execute(
+    IExecutionStrategy.execute(
         contract_address=proposal.executor,
         proposal_outcome=proposal_outcome,
         execution_hash=proposal.execution_hash,
@@ -964,7 +964,7 @@ func cancel_proposal{syscall_ptr : felt*, pedersen_ptr : HashBuiltin*, range_che
 
     let proposal_outcome = ProposalOutcome.CANCELLED
 
-    i_execution_strategy.execute(
+    IExecutionStrategy.execute(
         contract_address=proposal.executor,
         proposal_outcome=proposal_outcome,
         execution_hash=proposal.execution_hash,

contracts/starknet/test_contracts/test_words64_to_uint256.cairo → contracts/starknet/TestContracts/Test_words_to_uint256.cairo

@@ -1,11 +1,11 @@
 %lang starknet
 from starkware.cairo.common.uint256 import Uint256
-from starknet.lib.words64_to_uint256 import words64_to_uint256
+from starknet.lib.words import words_to_uint256
 
 @view
-func test_words64_to_uint256{range_check_ptr}(
+func test_words_to_uint256{range_check_ptr}(
     word1 : felt, word2 : felt, word3 : felt, word4 : felt
 ) -> (uint256 : Uint256):
-    let (uint256) = words64_to_uint256(word1, word2, word3, word4)
+    let (uint256) = words_to_uint256(word1, word2, word3, word4)
     return (uint256)
 end

contracts/starknet/voting_strategies/single_slot_proof.cairo → contracts/starknet/VotingStrategies/SingleSlotProof.cairo

@@ -7,7 +7,7 @@ from starkware.cairo.common.math import unsigned_div_rem, assert_nn_le
 from contracts.starknet.fossil.contracts.starknet.types import StorageSlot
 from contracts.starknet.lib.eth_address import EthAddress
 from contracts.starknet.lib.slot_key import get_slot_key
-from contracts.starknet.lib.words64_to_uint256 import words64_to_uint256
+from contracts.starknet.lib.words import words_to_uint256
 
 # FactRegistry simplified interface
 @contract_interface
@@ -74,7 +74,7 @@ func get_voting_power{
 
     # Checking slot proof is for the correct slot
     let (valid_slot) = get_slot_key(slot_index, voter_address.value)
-    let (slot_uint256) = words64_to_uint256(slot.word_1, slot.word_2, slot.word_3, slot.word_4)
+    let (slot_uint256) = words_to_uint256(slot.word_1, slot.word_2, slot.word_3, slot.word_4)
     with_attr error_message("Invalid slot proof provided"):
         assert valid_slot = slot_uint256
     end

contracts/starknet/lib/array2d.cairo

@@ -21,7 +21,6 @@ func construct_array2d{range_check_ptr}(flat_array_len : felt, flat_array : felt
     return (array2d)
 end
 
-# Extracts sub array from 2d array at postion specified by index
 func get_sub_array{range_check_ptr}(array2d : Immutable2DArray, index : felt) -> (
     array_len : felt, array : felt*
 ):

contracts/starknet/lib/words.cairo

@@ -1,6 +1,7 @@
 from starkware.cairo.common.cairo_builtins import BitwiseBuiltin
 from starkware.cairo.common.math import unsigned_div_rem
 from starkware.cairo.common.bitwise import bitwise_and
+from starkware.cairo.common.uint256 import Uint256
 
 const MASK_4 = 2 ** 64 - 1
 const MASK_3 = 2 ** 128 - 2 ** 64
@@ -37,3 +38,13 @@ func felt_to_words{bitwise_ptr : BitwiseBuiltin*, range_check_ptr}(value : felt)
 
     return (Words(word_1, word_2, word_3, word_4))
 end
+
+# Convert 4 words of 8 bytes each to a Uint256
+# Word 1 is the most significant word and word 4 is the least significant word
+func words_to_uint256{range_check_ptr}(word1 : felt, word2 : felt, word3 : felt, word4 : felt) -> (
+    uint256 : Uint256
+):
+    let word1_shifted = word1 * SHIFT_64
+    let word3_shifted = word3 * SHIFT_64
+    return (Uint256(low=word3_shifted + word4, high=word1_shifted + word2))
+end

hardhat.config.ts

@@ -50,6 +50,7 @@ const config: HardhatUserConfig = {
     },
     ethereumLocal: {
       url: 'http://localhost:8545',
+      chainId: 31337,
     },
     starknetLocal: {
       url: 'http://localhost:8000',

package.json

@@ -14,7 +14,7 @@
     "test:crosschain": "'./scripts/test-crosschain.sh'",
     "test:crosschain:ci": "concurrently './scripts/chain.sh' './scripts/test-crosschain.sh'",
     "chain:l1": "hardhat node",
-    "chain:l2": "starknet-devnet -p 8000",
+    "chain:l2": "starknet-devnet -p 8000 --lite-mode",
     "chain": "concurrently 'yarn chain:l1' 'yarn chain:l2'",
     "format:l1": "prettier --write 'contracts/**/*.sol'",
     "check-format:l1": "prettier -c 'contracts/**/*.sol'",
@@ -43,7 +43,7 @@
     "@nomiclabs/hardhat-etherscan": "^3.0.3",
     "@nomiclabs/hardhat-solhint": "^2.0.1",
     "@nomiclabs/hardhat-waffle": "^2.0.2",
-    "@shardlabs/starknet-hardhat-plugin": "^0.5.3",
+    "@shardlabs/starknet-hardhat-plugin": "^0.5.5",
     "@typechain/ethers-v5": "^7.2.0",
     "@typechain/hardhat": "^2.3.1",
     "@types/chai": "^4.3.0",

scripts/test-crosschain.sh

@@ -2,9 +2,9 @@
 
 yarn wait-on tcp:8000 && 
 wait-on tcp:8545 && 
-yarn hardhat test test/crosschain/zodiac.ts --network 'ethereumLocal' --starknet-network 'starknetLocal' && 
+yarn hardhat test test/crosschain/ZodiacExecution.test.ts --network 'ethereumLocal' --starknet-network 'starknetLocal' && 
 sleep 10 && 
-yarn hardhat test test/crosschain/eth_tx_auth.ts --network 'ethereumLocal' --starknet-network 'starknetLocal'
+yarn hardhat test test/crosschain/EthTxAuth.test.ts --network 'ethereumLocal' --starknet-network 'starknetLocal'
 if [ $? -eq 0 ]
 then
   kill -9 $(lsof -t -i:8545)