[sui 3/x]: events, dynamic fields, update_price_feed, PriceInfoObject (#714)

* state getters and setters, change Move.toml dependency to sui/integration_v2

* finish state.move

* add new line to pyth

* use deployer cap pattern for state module

* sui pyth

* update price feeds, dynamic object fields, Sui object PriceInfoObject

* register price info object with pyth state after creation

* PriceFeedUpdateEvent

Author: optke3

target_chains/sui/contracts/Move.toml

@@ -4,8 +4,8 @@ version = "0.0.1"
 
 [dependencies.Sui]
 git = "https://github.com/MystenLabs/sui.git"
-subdir = "crates/sui-framework"
-rev = "157ac72030d014f17d76cefe81f3915b4afab2c9"
+subdir = "crates/sui-framework/packages/sui-framework"
+rev = "82c9c80c11488858f1d3930f47ec9f335a566683"
 
 [dependencies.Wormhole]
 git = "https://github.com/wormhole-foundation/wormhole.git"

target_chains/sui/contracts/sources/batch_price_attestation.move

@@ -153,7 +153,7 @@ module pyth::batch_price_attestation {
             ema_timestamp = prev_publish_time;
         };
 
-        price_info::new(
+        price_info::new_price_info(
             attestation_time,
             tx_context::epoch(ctx), //TODO - use Sui Clock to get timestamp in seconds
             price_feed::new(
@@ -172,7 +172,7 @@ module pyth::batch_price_attestation {
 
         // A batch price attestation with a magic number of 0x50325749
         let bytes = x"5032574900030000000102000400951436e0be37536be96f0896366089506a59763d036728332d3e3038047851aea7c6c75c89f14810ec1c54c03ab8f1864a4c4032791f05747f560faec380a695d1000000000000049a0000000000000008fffffffb00000000000005dc0000000000000003000000000100000001000000006329c0eb000000006329c0e9000000006329c0e400000000000006150000000000000007215258d81468614f6b7e194c5d145609394f67b041e93e6695dcc616faadd0603b9551a68d01d954d6387aff4df1529027ffb2fee413082e509feb29cc4904fe000000000000041a0000000000000003fffffffb00000000000005cb0000000000000003010000000100000001000000006329c0eb000000006329c0e9000000006329c0e4000000000000048600000000000000078ac9cf3ab299af710d735163726fdae0db8465280502eb9f801f74b3c1bd190333832fad6e36eb05a8972fe5f219b27b5b2bb2230a79ce79beb4c5c5e7ecc76d00000000000003f20000000000000002fffffffb00000000000005e70000000000000003010000000100000001000000006329c0eb000000006329c0e9000000006329c0e40000000000000685000000000000000861db714e9ff987b6fedf00d01f9fea6db7c30632d6fc83b7bc9459d7192bc44a21a28b4c6619968bd8c20e95b0aaed7df2187fd310275347e0376a2cd7427db800000000000006cb0000000000000001fffffffb00000000000005e40000000000000003010000000100000001000000006329c0eb000000006329c0e9000000006329c0e400000000000007970000000000000001";
-        destroy(deserialize(bytes, ctx(&mut test)));
+        let _ = destroy(deserialize(bytes, ctx(&mut test)));
         test_scenario::end(test);
     }
 
@@ -198,42 +198,38 @@ module pyth::batch_price_attestation {
             attestation_count: 4,
             attestation_size: 149,
             price_infos: vector<PriceInfo>[
-                price_info::new(
+                price_info::new_price_info(
                     1663680747,
                     arrival_time,
                     price_feed::new(
                         price_identifier::from_byte_vec(x"c6c75c89f14810ec1c54c03ab8f1864a4c4032791f05747f560faec380a695d1"),
                         price::new(i64::new(1557, false), 7, i64::new(5, true), 1663680740),
                         price::new(i64::new(1500, false), 3, i64::new(5, true), 1663680740),
-                    ),
-                ),
-                price_info::new(
+                    )                ),
+                price_info::new_price_info(
                     1663680747,
                     arrival_time,
                     price_feed::new(
                         price_identifier::from_byte_vec(x"3b9551a68d01d954d6387aff4df1529027ffb2fee413082e509feb29cc4904fe"),
                         price::new(i64::new(1050, false), 3, i64::new(5, true), 1663680745),
                         price::new(i64::new(1483, false), 3, i64::new(5, true), 1663680745),
-                    ),
-                ),
-                price_info::new(
+                    )                ),
+                price_info::new_price_info(
                     1663680747,
                     arrival_time,
                     price_feed::new(
                         price_identifier::from_byte_vec(x"33832fad6e36eb05a8972fe5f219b27b5b2bb2230a79ce79beb4c5c5e7ecc76d"),
                         price::new(i64::new(1010, false), 2, i64::new(5, true), 1663680745),
                         price::new(i64::new(1511, false), 3, i64::new(5, true), 1663680745),
-                    ),
-                ),
-                price_info::new(
+                    )                ),
+                price_info::new_price_info(
                     1663680747,
                     arrival_time,
                     price_feed::new(
                         price_identifier::from_byte_vec(x"21a28b4c6619968bd8c20e95b0aaed7df2187fd310275347e0376a2cd7427db8"),
                         price::new(i64::new(1739, false), 1, i64::new(5, true), 1663680745),
                         price::new(i64::new(1508, false), 3, i64::new(5, true), 1663680745),
-                    ),
-                ),
+                    )                ),
             ],
         };
 

target_chains/sui/contracts/sources/data_source.move

@@ -1,11 +1,53 @@
 module pyth::data_source {
+    use sui::dynamic_field::{Self};
+    use sui::object::{UID};
+    use sui::tx_context::{TxContext};
+
+    use pyth::set::{Self};
+
     use wormhole::external_address::ExternalAddress;
 
+    const KEY: vector<u8> = b"data_sources";
+
     struct DataSource has copy, drop, store {
         emitter_chain: u64,
         emitter_address: ExternalAddress,
     }
 
+    public fun new_data_source_registry(parent_id: &mut UID, ctx: &mut TxContext) {
+        assert!(
+            !dynamic_field::exists_(parent_id, KEY),
+            0 // TODO - add custom error type
+        );
+        dynamic_field::add(
+            parent_id,
+            KEY,
+            set::new<DataSource>(ctx)
+        )
+    }
+
+    public fun add(parent_id: &mut UID, data_source: DataSource) {
+        assert!(
+            !contains(parent_id, data_source),
+            0 // TODO - add custom error message
+        );
+        set::add(
+            dynamic_field::borrow_mut(parent_id, KEY),
+            data_source
+        )
+    }
+
+    public fun empty(parent_id: &mut UID){
+        set::empty<DataSource>(
+            dynamic_field::borrow_mut(parent_id, KEY)
+        )
+    }
+
+    public fun contains(parent_id: &UID, data_source: DataSource): bool {
+        let ref = dynamic_field::borrow(parent_id, KEY);
+        set::contains<DataSource>(ref, data_source)
+    }
+
     public fun new(emitter_chain: u64, emitter_address: ExternalAddress): DataSource {
         DataSource {
             emitter_chain: emitter_chain,

target_chains/sui/contracts/sources/event.move

@@ -0,0 +1,33 @@
+module pyth::event {
+    use sui::event::{Self};
+    use pyth::price_feed::{PriceFeed};
+
+    friend pyth::pyth;
+    friend pyth::state;
+
+    struct PythInitializationEvent has copy, drop {}
+
+    /// Signifies that a price feed has been updated
+    struct PriceFeedUpdateEvent has copy, store, drop {
+        /// Value of the price feed
+        price_feed: PriceFeed,
+        /// Timestamp of the update
+        timestamp: u64,
+    }
+
+    public(friend) fun emit_price_feed_update(price_feed: PriceFeed, timestamp: u64) {
+        event::emit(
+            PriceFeedUpdateEvent {
+                price_feed,
+                timestamp,
+            }
+        );
+    }
+
+    public(friend) fun emit_pyth_initialization_event() {
+        event::emit(
+            PythInitializationEvent {}
+        );
+    }
+
+}

target_chains/sui/contracts/sources/price_feed.move

@@ -23,8 +23,18 @@ module pyth::price_feed {
         }
     }
 
-    public fun get_price_identifier(price_feed: &PriceFeed): &PriceIdentifier {
-        &price_feed.price_identifier
+     public fun from(
+        price_feed: &PriceFeed
+    ): PriceFeed {
+        PriceFeed {
+            price_identifier: price_feed.price_identifier,
+            price: price_feed.price,
+            ema_price: price_feed.ema_price,
+        }
+    }
+
+    public fun get_price_identifier(price_feed: &PriceFeed): PriceIdentifier {
+        price_feed.price_identifier
     }
 
     public fun get_price(price_feed: &PriceFeed): Price {

target_chains/sui/contracts/sources/price_info.move

@@ -1,20 +1,104 @@
 module pyth::price_info {
-    use pyth::price_feed::PriceFeed;
+    use sui::object::{Self, UID, ID};
+    use sui::tx_context::{TxContext};
+    use sui::dynamic_object_field::{Self};
+    use sui::table::{Self};
 
+    use pyth::price_feed::{Self, PriceFeed};
+    use pyth::price_identifier::{PriceIdentifier};
+
+    const KEY: vector<u8> = b"price_info";
+
+    friend pyth::pyth;
+
+    /// Sui Object version of PriceInfo.
+    /// Has a key and lives in global store.
+    struct PriceInfoObject has key, store {
+        id: UID,
+        price_info: PriceInfo
+    }
+
+    /// Copyable and droppable.
     struct PriceInfo has copy, drop, store {
         attestation_time: u64,
         arrival_time: u64,
         price_feed: PriceFeed,
     }
 
-    public fun new(attestation_time: u64, arrival_time: u64, price_feed: PriceFeed): PriceInfo {
+    /// Creates a table which maps a PriceIdentifier to the
+    /// UID (in bytes) of the corresponding Sui PriceInfoObject.
+    public fun new_price_info_registry(parent_id: &mut UID, ctx: &mut TxContext) {
+        assert!(
+            !dynamic_object_field::exists_(parent_id, KEY),
+            0 // TODO - add custom error message
+        );
+        dynamic_object_field::add(
+            parent_id,
+            KEY,
+            table::new<PriceIdentifier, ID>(ctx)
+        )
+    }
+
+    public fun add(parent_id: &mut UID, price_identifier: PriceIdentifier, id: ID) {
+        assert!(
+            !contains(parent_id, price_identifier),
+            0 // TODO - add custom error message
+        );
+        table::add(
+            dynamic_object_field::borrow_mut(parent_id, KEY),
+            price_identifier,
+            id
+        )
+    }
+
+    public fun contains(parent_id: &UID, price_identifier: PriceIdentifier): bool {
+        let ref = dynamic_object_field::borrow(parent_id, KEY);
+        table::contains<PriceIdentifier, ID>(ref, price_identifier)
+    }
+
+    public fun new_price_info_object(
+        price_info: PriceInfo,
+        ctx: &mut TxContext
+    ): PriceInfoObject {
+        PriceInfoObject {
+            id: object::new(ctx),
+            price_info: price_info
+        }
+    }
+
+    public fun new_price_info(
+        attestation_time: u64,
+        arrival_time: u64,
+        price_feed: PriceFeed,
+    ): PriceInfo {
         PriceInfo {
             attestation_time: attestation_time,
             arrival_time: arrival_time,
             price_feed: price_feed,
         }
     }
 
+    #[test_only]
+    public fun destroy(price_info: PriceInfoObject){
+        let PriceInfoObject {
+            id: id,
+            price_info: _,
+        } = price_info;
+        object::delete(id);
+    }
+
+    public fun uid_to_inner(price_info: &PriceInfoObject): ID {
+        object::uid_to_inner(&price_info.id)
+    }
+
+    public fun get_price_info_from_price_info_object(price_info: &PriceInfoObject): PriceInfo {
+        price_info.price_info
+    }
+
+    public fun get_price_identifier(price_info: &PriceInfo): PriceIdentifier {
+        price_feed::get_price_identifier(&price_info.price_feed)
+    }
+
     public fun get_price_feed(price_info: &PriceInfo): &PriceFeed {
         &price_info.price_feed
     }
@@ -26,4 +110,11 @@ module pyth::price_info {
     public fun get_arrival_time(price_info: &PriceInfo): u64 {
         price_info.arrival_time
     }
+
+    public(friend) fun update_price_info_object(
+        price_info_object: &mut PriceInfoObject,
+        price_info: PriceInfo
+    ) {
+        price_info_object.price_info = price_info;
+    }
 }