feat(target_chains/starknet): add all possible derives (#1667)

Author: Riateche

target_chains/starknet/contracts/src/byte_buffer.cairo

@@ -4,7 +4,7 @@ use super::util::one_shift_left_bytes_u256;
 
 /// A byte array with storage format similar to `core::ByteArray`, but
 /// suitable for reading data from it.
-#[derive(Drop, Clone, Serde)]
+#[derive(Drop, Clone, PartialEq, Serde)]
 pub struct ByteBuffer {
     // Number of bytes stored in the last item of `self.data` (or 0 if it's empty).
     num_last_bytes: u8,
@@ -27,6 +27,12 @@ impl DebugByteBuffer of Debug<ByteBuffer> {
     }
 }
 
+impl DefaultByteBuffer of Default<ByteBuffer> {
+    fn default() -> ByteBuffer {
+        ByteBufferImpl::new(array![], 0)
+    }
+}
+
 #[generate_trait]
 pub impl ByteBufferImpl of ByteBufferTrait {
     /// Creates a byte array with the data.

target_chains/starknet/contracts/src/hash.cairo

@@ -8,7 +8,7 @@ use pyth::util::{
 
 /// Allows to push data as big endian to a buffer and apply
 /// the keccak256 hash.
-#[derive(Drop, Debug)]
+#[derive(Drop, Clone, Debug, PartialEq, Serde)]
 pub struct Hasher {
     // Inputs in little endian.
     inputs_le: Array<u64>,

target_chains/starknet/contracts/src/merkle_tree.cairo

@@ -9,7 +9,7 @@ const MERKLE_LEAF_PREFIX: u8 = 0;
 const MERKLE_NODE_PREFIX: u8 = 1;
 const MERKLE_EMPTY_LEAF_PREFIX: u8 = 2;
 
-#[derive(Copy, Drop, Debug, Serde, PartialEq)]
+#[derive(Drop, Copy, Debug, PartialEq, Serde, Hash)]
 pub enum MerkleVerificationError {
     Reader: super::reader::Error,
     DigestMismatch,

target_chains/starknet/contracts/src/pyth.cairo

@@ -43,11 +43,12 @@ mod pyth {
     use super::governance;
     use super::governance::GovernancePayload;
     use openzeppelin::token::erc20::interface::{IERC20CamelDispatcherTrait, IERC20CamelDispatcher};
-    use pyth::util::ResultMapErrInto;
+    use pyth::util::{ResultMapErrInto, write_i64};
     use core::nullable::{NullableTrait, match_nullable, FromNullableResult};
+    use core::fmt::{Debug, Formatter};
 
     #[event]
-    #[derive(Drop, PartialEq, starknet::Event)]
+    #[derive(Drop, Clone, Debug, PartialEq, Serde, starknet::Event)]
     pub enum Event {
         PriceFeedUpdated: PriceFeedUpdated,
         FeeSet: FeeSet,
@@ -57,41 +58,60 @@ mod pyth {
         ContractUpgraded: ContractUpgraded,
     }
 
-    #[derive(Drop, PartialEq, starknet::Event)]
+    #[derive(Drop, Clone, PartialEq, Serde, starknet::Event)]
     pub struct PriceFeedUpdated {
         #[key]
         pub price_id: u256,
-        pub publish_time: u64,
         pub price: i64,
         pub conf: u64,
+        pub publish_time: u64,
+    }
+
+    // TODO: use derives after upgrading cairo
+    impl DebugPriceFeedUpdated of Debug<PriceFeedUpdated> {
+        fn fmt(self: @PriceFeedUpdated, ref f: Formatter) -> Result<(), core::fmt::Error> {
+            write!(f, "PriceFeedUpdated {{ price_id: {}, price: ", self.price_id)?;
+            write_i64(ref f, *self.price)?;
+            write!(f, ", conf: {}, publish_time: {} }}", self.conf, self.publish_time)
+        }
+    }
+
+    #[cfg(test)]
+    #[test]
+    fn test_debug_price_feed_updated() {
+        let value = PriceFeedUpdated { price_id: 1, price: 2, conf: 3, publish_time: 5, };
+        let expected = "PriceFeedUpdated { price_id: 1, price: 2, conf: 3, publish_time: 5 }";
+        let actual = format!("{:?}", value);
+        assert!(actual == expected);
     }
 
-    #[derive(Drop, PartialEq, starknet::Event)]
+
+    #[derive(Drop, Clone, Debug, PartialEq, Serde, starknet::Event)]
     pub struct FeeSet {
         pub old_fee: u256,
         pub new_fee: u256,
     }
 
-    #[derive(Drop, PartialEq, starknet::Event)]
+    #[derive(Drop, Clone, Debug, PartialEq, Serde, starknet::Event)]
     pub struct DataSourcesSet {
         pub old_data_sources: Array<DataSource>,
         pub new_data_sources: Array<DataSource>,
     }
 
-    #[derive(Drop, PartialEq, starknet::Event)]
+    #[derive(Drop, Clone, Debug, PartialEq, Serde, starknet::Event)]
     pub struct WormholeAddressSet {
         pub old_address: ContractAddress,
         pub new_address: ContractAddress,
     }
 
-    #[derive(Drop, PartialEq, starknet::Event)]
+    #[derive(Drop, Clone, Debug, PartialEq, Serde, starknet::Event)]
     pub struct GovernanceDataSourceSet {
         pub old_data_source: DataSource,
         pub new_data_source: DataSource,
         pub last_executed_governance_sequence: u64,
     }
 
-    #[derive(Drop, PartialEq, starknet::Event)]
+    #[derive(Drop, Clone, Debug, PartialEq, Serde, starknet::Event)]
     pub struct ContractUpgraded {
         pub new_class_hash: ClassHash,
     }

target_chains/starknet/contracts/src/pyth/errors.cairo

@@ -1,4 +1,4 @@
-#[derive(Copy, Drop, Debug, Serde, PartialEq)]
+#[derive(Drop, Copy, Debug, PartialEq, Serde, Hash)]
 pub enum GetPriceUnsafeError {
     PriceFeedNotFound,
 }
@@ -11,7 +11,7 @@ impl GetPriceUnsafeErrorIntoFelt252 of Into<GetPriceUnsafeError, felt252> {
     }
 }
 
-#[derive(Copy, Drop, Debug, Serde, PartialEq)]
+#[derive(Drop, Copy, Debug, PartialEq, Serde, Hash)]
 pub enum GetPriceNoOlderThanError {
     PriceFeedNotFound,
     StalePrice,
@@ -36,7 +36,7 @@ impl GetPriceUnsafeErrorIntoGetPriceNoOlderThanError of Into<
     }
 }
 
-#[derive(Copy, Drop, Debug, Serde, PartialEq)]
+#[derive(Drop, Copy, Debug, PartialEq, Serde, Hash)]
 pub enum GovernanceActionError {
     Wormhole: pyth::wormhole::ParseAndVerifyVmError,
     InvalidGovernanceDataSource,
@@ -59,7 +59,7 @@ impl GovernanceActionErrorIntoFelt252 of Into<GovernanceActionError, felt252> {
     }
 }
 
-#[derive(Copy, Drop, Debug, Serde, PartialEq)]
+#[derive(Drop, Copy, Debug, PartialEq, Serde, Hash)]
 pub enum UpdatePriceFeedsError {
     Reader: pyth::reader::Error,
     Wormhole: pyth::wormhole::ParseAndVerifyVmError,
@@ -80,7 +80,7 @@ impl UpdatePriceFeedsErrorIntoFelt252 of Into<UpdatePriceFeedsError, felt252> {
     }
 }
 
-#[derive(Copy, Drop, Debug, Serde, PartialEq)]
+#[derive(Drop, Copy, Debug, PartialEq, Serde, Hash)]
 pub enum UpdatePriceFeedsIfNecessaryError {
     Update: UpdatePriceFeedsError,
     NoFreshUpdate,
@@ -97,7 +97,7 @@ impl UpdatePriceFeedsIfNecessaryErrorIntoFelt252 of Into<
     }
 }
 
-#[derive(Copy, Drop, Debug, Serde, PartialEq)]
+#[derive(Drop, Copy, Debug, PartialEq, Serde, Hash)]
 pub enum ParsePriceFeedsError {
     Update: UpdatePriceFeedsError,
     PriceFeedNotFoundWithinRange,
@@ -112,7 +112,7 @@ impl ParsePriceFeedsErrorIntoFelt252 of Into<ParsePriceFeedsError, felt252> {
     }
 }
 
-#[derive(Copy, Drop, Debug, Serde, PartialEq)]
+#[derive(Drop, Copy, Debug, PartialEq, Serde, Hash)]
 pub enum GetSingleUpdateFeeError {
     UnsupportedToken,
 }

target_chains/starknet/contracts/src/pyth/governance.cairo

@@ -10,7 +10,7 @@ use super::DataSource;
 const MAGIC: u32 = 0x5054474d;
 const MODULE_TARGET: u8 = 1;
 
-#[derive(Drop, Debug)]
+#[derive(Drop, Copy, Debug, PartialEq, Serde, Hash)]
 pub enum GovernanceAction {
     UpgradeContract,
     AuthorizeGovernanceDataSourceTransfer,
@@ -37,13 +37,13 @@ impl U8TryIntoGovernanceAction of TryInto<u8, GovernanceAction> {
     }
 }
 
-#[derive(Drop, Debug)]
+#[derive(Drop, Clone, Debug, PartialEq, Serde)]
 pub struct GovernanceInstruction {
     pub target_chain_id: u16,
     pub payload: GovernancePayload,
 }
 
-#[derive(Drop, Debug)]
+#[derive(Drop, Clone, Debug, PartialEq, Serde)]
 pub enum GovernancePayload {
     UpgradeContract: UpgradeContract,
     AuthorizeGovernanceDataSourceTransfer: AuthorizeGovernanceDataSourceTransfer,
@@ -54,38 +54,38 @@ pub enum GovernancePayload {
     SetWormholeAddress: SetWormholeAddress,
 }
 
-#[derive(Drop, Debug)]
+#[derive(Drop, Clone, Debug, PartialEq, Serde)]
 pub struct SetFee {
     pub value: u64,
     pub expo: u64,
 }
 
-#[derive(Drop, Debug)]
+#[derive(Drop, Clone, Debug, PartialEq, Serde)]
 pub struct SetDataSources {
     pub sources: Array<DataSource>,
 }
 
-#[derive(Drop, Debug)]
+#[derive(Drop, Clone, Debug, PartialEq, Serde)]
 pub struct SetWormholeAddress {
     pub address: ContractAddress,
 }
 
-#[derive(Drop, Debug)]
+#[derive(Drop, Clone, Debug, PartialEq, Serde)]
 pub struct RequestGovernanceDataSourceTransfer {
     // Index is used to prevent replay attacks
     // So a claimVaa cannot be used twice.
     pub governance_data_source_index: u32,
 }
 
-#[derive(Drop, Debug)]
+#[derive(Drop, Clone, Debug, PartialEq, Serde)]
 pub struct AuthorizeGovernanceDataSourceTransfer {
     // Transfer governance control over this contract to another data source.
     // The claim_vaa field is a VAA created by the new data source; using a VAA prevents mistakes
     // in the handoff by ensuring that the new data source can send VAAs (i.e., is not an invalid address).
     pub claim_vaa: ByteBuffer,
 }
 
-#[derive(Drop, Debug)]
+#[derive(Drop, Clone, Debug, PartialEq, Serde)]
 pub struct UpgradeContract {
     // Class hash of the new contract class. The contract class must already be deployed on the network
     // (e.g. with `starkli declare`). Class hash is a Poseidon hash of all properties

target_chains/starknet/contracts/src/pyth/interface.cairo

@@ -2,6 +2,8 @@ use super::{GetPriceUnsafeError, GetPriceNoOlderThanError};
 use pyth::byte_buffer::ByteBuffer;
 use pyth::wormhole::VerifiedVM;
 use core::starknet::ContractAddress;
+use core::fmt::{Debug, Formatter};
+use pyth::util::write_i64;
 
 #[starknet::interface]
 pub trait IPyth<T> {
@@ -55,7 +57,7 @@ pub trait IPyth<T> {
     fn pyth_upgradable_magic(self: @T) -> u32;
 }
 
-#[derive(Drop, Debug, Clone, Copy, PartialEq, Hash, Default, Serde, starknet::Store)]
+#[derive(Drop, Copy, Debug, PartialEq, Serde, Hash, Default, starknet::Store)]
 pub struct DataSource {
     pub emitter_chain_id: u16,
     pub emitter_address: u256,
@@ -73,22 +75,48 @@ impl GetDataSourceFromVerifiedVM of GetDataSource<VerifiedVM> {
     }
 }
 
-#[derive(Drop, Copy, PartialEq, Serde)]
+#[derive(Drop, Copy, PartialEq, Serde, Hash, starknet::Store)]
 pub struct Price {
     pub price: i64,
     pub conf: u64,
     pub expo: i32,
     pub publish_time: u64,
 }
 
-#[derive(Drop, Clone, Serde)]
+// TODO: use derives after upgrading cairo
+impl DebugPrice of Debug<Price> {
+    fn fmt(self: @Price, ref f: Formatter) -> Result<(), core::fmt::Error> {
+        write!(f, "Price {{ price: ")?;
+        write_i64(ref f, *self.price)?;
+        write!(f, ", conf: {}, expo: ", self.conf)?;
+        write_i64(ref f, (*self.expo).into())?;
+        write!(f, ", publish_time: {} }}", self.publish_time)
+    }
+}
+
+#[cfg(test)]
+#[test]
+fn test_debug_price() {
+    let value = Price { price: 2, conf: 3, expo: -4, publish_time: 5, };
+    let expected = "Price { price: 2, conf: 3, expo: -4, publish_time: 5 }";
+    let actual = format!("{:?}", value);
+    assert!(actual == expected);
+}
+
+impl DefaultPrice of Default<Price> {
+    fn default() -> Price {
+        Price { price: 0, conf: 0, expo: 0, publish_time: 0 }
+    }
+}
+
+#[derive(Drop, Copy, Debug, PartialEq, Serde, Hash, starknet::Store)]
 pub struct PriceFeedPublishTime {
     pub price_id: u256,
     pub publish_time: u64,
 }
 
 // PriceFeed represents a current aggregate price from pyth publisher feeds.
-#[derive(Drop, Copy, PartialEq, Serde)]
+#[derive(Drop, Copy, Debug, PartialEq, Serde, Hash, starknet::Store)]
 pub struct PriceFeed {
     // The price ID.
     pub id: u256,