feat(relayer_discovery)!: added events to relayer discovery (#198)

Co-authored-by: Milap Sheth <[email protected]>

.changeset/late-goats-smell.md

@@ -0,0 +1,5 @@
+---
+'@axelar-network/axelar-cgp-sui': minor
+---
+
+Add events to register and remove transaction on relayer discovery

move/relayer_discovery/sources/discovery.move

@@ -18,7 +18,8 @@ use version_control::version_control::{Self, VersionControl};
 /// -------
 /// This is the version of the package that should change every package upgrade.
 const VERSION: u64 = 0;
-/// This is the version of the data that should change when we need to migrate `Versioned` type (e.g. from `RelayerDiscovery_v0` to `RelayerDiscoveryV1`)
+/// This is the version of the data that should change when we need to migrate
+/// `Versioned` type (e.g. from `RelayerDiscovery_v0` to `RelayerDiscovery_v1`)
 const DATA_VERSION: u64 = 0;
 
 /// -------

move/relayer_discovery/sources/events.move

@@ -0,0 +1,37 @@
+module relayer_discovery::events;
+
+use relayer_discovery::transaction::Transaction;
+use sui::event;
+
+/// ------
+/// Events
+/// ------
+// Emitted when a transaction is registered
+public struct TransactionRegistered has copy, drop {
+    channel_id: ID,
+    transaction: Transaction,
+}
+
+// Emitted when a transaction is removed
+public struct TransactionRemoved has copy, drop {
+    channel_id: ID,
+}
+
+/// -----------------
+/// Package Functions
+/// -----------------
+public(package) fun transaction_registered(
+    channel_id: ID,
+    transaction: Transaction,
+) {
+    event::emit(TransactionRegistered {
+        channel_id,
+        transaction,
+    })
+}
+
+public(package) fun transaction_removed(channel_id: ID) {
+    event::emit(TransactionRemoved {
+        channel_id,
+    })
+}

move/relayer_discovery/sources/versioned/relayer_discovery_v0.move

@@ -1,5 +1,6 @@
 module relayer_discovery::relayer_discovery_v0;
 
+use relayer_discovery::events;
 use relayer_discovery::transaction::Transaction;
 use sui::table::{Self, Table};
 use version_control::version_control::VersionControl;
@@ -46,14 +47,17 @@ public(package) fun set_transaction(
         self.configurations.remove(id);
     };
     self.configurations.add(id, transaction);
+    events::transaction_registered(id, transaction);
 }
 
 public(package) fun remove_transaction(
     self: &mut RelayerDiscovery_v0,
     id: ID,
 ): Transaction {
     assert!(self.configurations.contains(id), EChannelNotFound);
-    self.configurations.remove(id)
+    let tx = self.configurations.remove(id);
+    events::transaction_removed(id);
+    tx
 }
 
 public(package) fun get_transaction(

test/testdata/interface_relayer_discovery_events.json

@@ -0,0 +1,35 @@
+{
+  "structs": {
+    "TransactionRegistered": {
+      "name": "TransactionRegistered",
+      "abilities": [
+        "copy",
+        "drop"
+      ],
+      "fields": [
+        {
+          "name": "channel_id",
+          "type": "ID"
+        },
+        {
+          "name": "transaction",
+          "type": "Transaction"
+        }
+      ]
+    },
+    "TransactionRemoved": {
+      "name": "TransactionRemoved",
+      "abilities": [
+        "copy",
+        "drop"
+      ],
+      "fields": [
+        {
+          "name": "channel_id",
+          "type": "ID"
+        }
+      ]
+    }
+  },
+  "publicFunctions": {}
+}