add SingleSlotProofImpl as embeddable

snapshot-labs · Oct 17, 2024 · 250b40c · 250b40c
1 parent 7b21f43
commit 250b40c
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 90 deletions.
diff --git a/starknet/src/interfaces/i_single_slot_proof.cairo b/starknet/src/interfaces/i_single_slot_proof.cairo
@@ -0,0 +1,28 @@
+use sx::external::herodotus::BinarySearchTree;
+
+/// Optional trait that execution strategies can decide to implement.
+#[starknet::interface]
+trait ISingleSlotProof<TContractState> {
+    /// Queries the Timestamp Remapper contract for the closest L1 block number that occurred before
+    /// the given timestamp and then caches the result. If the queried timestamp is less than the earliest
+    /// timestamp or larger than the latest timestamp in the mapper then the transaction will revert.
+    /// This function should be used to cache a remapped timestamp before it's used when calling the 
+    /// `get_storage_slot` function with the same timestamp.
+    ///
+    /// # Arguments
+    ///
+    /// * `timestamp` - The timestamp at which to query.
+    /// * `tree` - The tree proof required to query the remapper.
+    fn cache_timestamp(ref self: TContractState, timestamp: u32, tree: BinarySearchTree);
+
+    /// View function exposing the cached remapped timestamps. Reverts if the timestamp is not cached.
+    ///
+    /// # Arguments
+    ///
+    /// * `timestamp` - The timestamp to query.
+    /// 
+    /// # Returns
+    ///
+    /// * `u256` - The cached L1 block number corresponding to the timestamp.
+    fn cached_timestamps(self: @TContractState, timestamp: u32) -> u256;
+}
diff --git a/starknet/src/lib.cairo b/starknet/src/lib.cairo
@@ -72,6 +72,11 @@ mod interfaces {
         IVotingStrategy, IVotingStrategyDispatcher, IVotingStrategyDispatcherTrait
     };
 
+    mod i_single_slot_proof;
+    use i_single_slot_proof::{
+        ISingleSlotProof, ISingleSlotProofDispatcher, ISingleSlotProofDispatcherTrait
+    };
+
     mod i_space;
     use i_space::{ISpace, ISpaceDispatcher, ISpaceDispatcherTrait};
 

diff --git a/starknet/src/utils/single_slot_proof.cairo b/starknet/src/utils/single_slot_proof.cairo
@@ -6,6 +6,7 @@ mod SingleSlotProofComponent {
         ITimestampRemappersDispatcherTrait, IEVMFactsRegistryDispatcher,
         IEVMFactsRegistryDispatcherTrait
     };
+    use sx::interfaces::i_single_slot_proof::ISingleSlotProof;
 
     #[storage]
     struct Storage {
@@ -46,7 +47,12 @@ mod SingleSlotProofComponent {
 
             slot_value
         }
+    }
 
+    #[embeddable_as(SingleSlotProofImpl)]
+    impl SimpleQuorum<
+        TContractState, +HasComponent<TContractState>
+    > of ISingleSlotProof<ComponentState<TContractState>> {
         fn cache_timestamp(
             ref self: ComponentState<TContractState>, timestamp: u32, tree: BinarySearchTree
         ) {

diff --git a/starknet/src/voting_strategies/evm_slot_value.cairo b/starknet/src/voting_strategies/evm_slot_value.cairo
@@ -11,6 +11,8 @@ mod EvmSlotValueVotingStrategy {
         path: SingleSlotProofComponent, storage: single_slot_proof, event: SingleSlotProofEvent
     );
 
+    #[abi(embed_v0)]
+    impl SingleSlotProofImpl = SingleSlotProofComponent::SingleSlotProofImpl<ContractState>;
     impl SingleSlotProofInternalImpl = SingleSlotProofComponent::InternalImpl<ContractState>;
 
     #[storage]
@@ -74,36 +76,6 @@ mod EvmSlotValueVotingStrategy {
         }
     }
 
-    #[generate_trait]
-    impl SingleSlotProofImpl of SingleSlotProofTrait {
-        /// Queries the Timestamp Remapper contract for the closest L1 block number that occurred before
-        /// the given timestamp and then caches the result. If the queried timestamp is less than the earliest
-        /// timestamp or larger than the latest timestamp in the mapper then the transaction will revert.
-        /// This function should be used to cache a remapped timestamp before it's used when calling the 
-        /// `get_storage_slot` function with the same timestamp.
-        ///
-        /// # Arguments
-        ///
-        /// * `timestamp` - The timestamp at which to query.
-        /// * `tree` - The tree proof required to query the remapper.
-        fn cache_timestamp(ref self: ContractState, timestamp: u32, tree: BinarySearchTree) {
-            self.single_slot_proof.cache_timestamp(timestamp, tree);
-        }
-
-        /// View function exposing the cached remapped timestamps. Reverts if the timestamp is not cached.
-        ///
-        /// # Arguments
-        ///
-        /// * `timestamp` - The timestamp to query.
-        /// 
-        /// # Returns
-        ///
-        /// * `u256` - The cached L1 block number corresponding to the timestamp.
-        fn cached_timestamps(self: @ContractState, timestamp: u32) -> u256 {
-            self.single_slot_proof.cached_timestamps(timestamp)
-        }
-    }
-
     #[generate_trait]
     impl InternalImpl of InternalTrait {
         fn get_mapping_slot_key(mapping_key: u256, slot_index: u256) -> u256 {

diff --git a/starknet/src/voting_strategies/oz_votes_storage_proof.cairo b/starknet/src/voting_strategies/oz_votes_storage_proof.cairo
@@ -11,6 +11,9 @@ mod OZVotesStorageProofVotingStrategy {
         path: SingleSlotProofComponent, storage: single_slot_proof, event: SingleSlotProofEvent
     );
 
+    #[abi(embed_v0)]
+    impl SingleSlotProofImpl =
+        SingleSlotProofComponent::SingleSlotProofImpl<ContractState>;
     impl SingleSlotProofInternalImpl = SingleSlotProofComponent::InternalImpl<ContractState>;
 
 
@@ -96,36 +99,6 @@ mod OZVotesStorageProofVotingStrategy {
         }
     }
 
-    #[generate_trait]
-    impl SingleSlotProofImpl of SingleSlotProofTrait {
-        /// Queries the Timestamp Remapper contract for the closest L1 block number that occurred before
-        /// the given timestamp and then caches the result. If the queried timestamp is less than the earliest
-        /// timestamp or larger than the latest timestamp in the mapper then the transaction will revert.
-        /// This function should be used to cache a remapped timestamp before it's used when calling the 
-        /// `get_storage_slot` function with the same timestamp.
-        ///
-        /// # Arguments
-        ///
-        /// * `timestamp` - The timestamp at which to query.
-        /// * `tree` - The tree proof required to query the remapper.
-        fn cache_timestamp(ref self: ContractState, timestamp: u32, tree: BinarySearchTree) {
-            self.single_slot_proof.cache_timestamp(timestamp, tree);
-        }
-
-        /// View function exposing the cached remapped timestamps. Reverts if the timestamp is not cached.
-        ///
-        /// # Arguments
-        ///
-        /// * `timestamp` - The timestamp to query.
-        /// 
-        /// # Returns
-        ///
-        /// * `u256` - The cached L1 block number corresponding to the timestamp.
-        fn cached_timestamps(self: @ContractState, timestamp: u32) -> u256 {
-            self.single_slot_proof.cached_timestamps(timestamp)
-        }
-    }
-
     #[generate_trait]
     impl InternalImpl of InternalTrait {
         fn final_checkpoint_slot_key(mapping_key: u256, slot_index: u256, offset: u32) -> u256 {

diff --git a/starknet/src/voting_strategies/oz_votes_trace_208_storage_proof.cairo b/starknet/src/voting_strategies/oz_votes_trace_208_storage_proof.cairo
@@ -11,6 +11,9 @@ mod OZVotesTrace208StorageProofVotingStrategy {
         path: SingleSlotProofComponent, storage: single_slot_proof, event: SingleSlotProofEvent
     );
 
+    #[abi(embed_v0)]
+    impl SingleSlotProofImpl =
+        SingleSlotProofComponent::SingleSlotProofImpl<ContractState>;
     impl SingleSlotProofInternalImpl = SingleSlotProofComponent::InternalImpl<ContractState>;
 
     #[storage]
@@ -93,36 +96,6 @@ mod OZVotesTrace208StorageProofVotingStrategy {
         }
     }
 
-    #[generate_trait]
-    impl SingleSlotProofImpl of SingleSlotProofTrait {
-        /// Queries the Timestamp Remapper contract for the closest L1 block number that occurred before
-        /// the given timestamp and then caches the result. If the queried timestamp is less than the earliest
-        /// timestamp or larger than the latest timestamp in the mapper then the transaction will revert.
-        /// This function should be used to cache a remapped timestamp before it's used when calling the 
-        /// `get_storage_slot` function with the same timestamp.
-        ///
-        /// # Arguments
-        ///
-        /// * `timestamp` - The timestamp at which to query.
-        /// * `tree` - The tree proof required to query the remapper.
-        fn cache_timestamp(ref self: ContractState, timestamp: u32, tree: BinarySearchTree) {
-            self.single_slot_proof.cache_timestamp(timestamp, tree);
-        }
-
-        /// View function exposing the cached remapped timestamps. Reverts if the timestamp is not cached.
-        ///
-        /// # Arguments
-        ///
-        /// * `timestamp` - The timestamp to query.
-        /// 
-        /// # Returns
-        ///
-        /// * `u256` - The cached L1 block number corresponding to the timestamp.
-        fn cached_timestamps(self: @ContractState, timestamp: u32) -> u256 {
-            self.single_slot_proof.cached_timestamps(timestamp)
-        }
-    }
-
     #[generate_trait]
     impl InternalImpl of InternalTrait {
         fn final_checkpoint_slot_key(mapping_key: u256, slot_index: u256, offset: u32) -> u256 {