refactor: move shared interfaces in preparation of ownership trait ex…

…traction (#96)
axelarnetwork · Dec 4, 2024 · e63006a · e63006a
1 parent 7a410ca
commit e63006a
Show file tree

Hide file tree

Showing 19 changed files with 74 additions and 77 deletions.
diff --git a/contracts/axelar-gas-service/src/contract.rs b/contracts/axelar-gas-service/src/contract.rs
@@ -4,10 +4,8 @@ use crate::error::ContractError;
 use crate::event;
 use crate::interface::AxelarGasServiceInterface;
 use crate::storage_types::DataKey;
-use axelar_soroban_std::shared_interfaces::{
-    migrate, MigratableInterface, OwnableInterface, UpgradableInterface,
-};
-use axelar_soroban_std::{ensure, shared_interfaces, types::Token};
+use axelar_soroban_std::interfaces::{MigratableInterface, OwnableInterface, UpgradableInterface};
+use axelar_soroban_std::{ensure, interfaces, types::Token};
 
 #[contract]
 pub struct AxelarGasService;
@@ -16,7 +14,7 @@ pub struct AxelarGasService;
 impl AxelarGasService {
     /// Initialize the gas service contract with a gas_collector address.
     pub fn __constructor(env: Env, owner: Address, gas_collector: Address) {
-        shared_interfaces::set_owner(&env, &owner);
+        interfaces::set_owner(&env, &owner);
         env.storage()
             .instance()
             .set(&DataKey::GasCollector, &gas_collector);
@@ -34,7 +32,7 @@ impl MigratableInterface for AxelarGasService {
     type Error = ContractError;
 
     fn migrate(env: &Env, migration_data: ()) -> Result<(), ContractError> {
-        migrate::<Self>(env, || Self::run_migration(env, migration_data))
+        interfaces::migrate::<Self>(env, || Self::run_migration(env, migration_data))
             .map_err(|_| ContractError::MigrationNotAllowed)
     }
 }
@@ -46,15 +44,15 @@ impl UpgradableInterface for AxelarGasService {
     }
 
     fn upgrade(env: &Env, new_wasm_hash: BytesN<32>) {
-        shared_interfaces::upgrade::<Self>(env, new_wasm_hash);
+        interfaces::upgrade::<Self>(env, new_wasm_hash);
     }
 }
 
 #[contractimpl]
 impl OwnableInterface for AxelarGasService {
     // boilerplate necessary for the contractimpl macro to include function in the generated client
     fn owner(env: &Env) -> Address {
-        shared_interfaces::owner(env)
+        interfaces::owner(env)
     }
 }
 

diff --git a/contracts/axelar-gateway/src/contract.rs b/contracts/axelar-gateway/src/contract.rs
@@ -4,10 +4,11 @@ use crate::messaging_interface::AxelarGatewayMessagingInterface;
 use crate::storage_types::{DataKey, MessageApprovalKey, MessageApprovalValue};
 use crate::types::{CommandType, Message, Proof, WeightedSigners};
 use crate::{auth, event};
-use axelar_soroban_std::shared_interfaces::{migrate, UpgradableInterface};
-use axelar_soroban_std::shared_interfaces::{MigratableInterface, OwnableInterface};
+use axelar_soroban_std::interfaces::{
+    migrate, MigratableInterface, OwnableInterface, UpgradableInterface,
+};
 use axelar_soroban_std::ttl::{INSTANCE_TTL_EXTEND_TO, INSTANCE_TTL_THRESHOLD};
-use axelar_soroban_std::{ensure, shared_interfaces};
+use axelar_soroban_std::{ensure, interfaces};
 use soroban_sdk::xdr::ToXdr;
 use soroban_sdk::{contract, contractimpl, Address, Bytes, BytesN, Env, String, Vec};
 
@@ -35,15 +36,15 @@ impl UpgradableInterface for AxelarGateway {
 
     // boilerplate necessary for the contractimpl macro to include function in the generated client
     fn upgrade(env: &Env, new_wasm_hash: BytesN<32>) {
-        shared_interfaces::upgrade::<Self>(env, new_wasm_hash);
+        interfaces::upgrade::<Self>(env, new_wasm_hash);
     }
 }
 
 #[contractimpl]
 impl OwnableInterface for AxelarGateway {
     // boilerplate necessary for the contractimpl macro to include function in the generated client
     fn owner(env: &Env) -> Address {
-        shared_interfaces::owner(env)
+        interfaces::owner(env)
     }
 }
 
@@ -59,7 +60,7 @@ impl AxelarGateway {
         previous_signers_retention: u64,
         initial_signers: Vec<WeightedSigners>,
     ) -> Result<(), ContractError> {
-        shared_interfaces::set_owner(&env, &owner);
+        interfaces::set_owner(&env, &owner);
         env.storage().instance().set(&DataKey::Operator, &operator);
 
         auth::initialize_auth(
@@ -254,7 +255,7 @@ impl AxelarGatewayInterface for AxelarGateway {
         let owner: Address = Self::owner(&env);
         owner.require_auth();
 
-        shared_interfaces::set_owner(&env, &new_owner);
+        interfaces::set_owner(&env, &new_owner);
 
         event::transfer_ownership(&env, owner, new_owner);
     }

diff --git a/contracts/axelar-gateway/src/interface.rs b/contracts/axelar-gateway/src/interface.rs
@@ -3,7 +3,7 @@ use crate::{
     types::{Message, Proof, WeightedSigners},
     AxelarGatewayMessagingInterface,
 };
-use axelar_soroban_std::shared_interfaces::UpgradableInterface;
+use axelar_soroban_std::interfaces::UpgradableInterface;
 use soroban_sdk::{contractclient, Address, BytesN, Env, Vec};
 
 #[contractclient(name = "AxelarGatewayClient")]

diff --git a/contracts/axelar-operators/src/contract.rs b/contracts/axelar-operators/src/contract.rs
@@ -1,9 +1,8 @@
 use crate::error::ContractError;
 use crate::event;
 use crate::storage_types::DataKey;
-use axelar_soroban_std::shared_interfaces::{migrate, UpgradableInterface};
-use axelar_soroban_std::shared_interfaces::{MigratableInterface, OwnableInterface};
-use axelar_soroban_std::{ensure, shared_interfaces};
+use axelar_soroban_std::interfaces::{MigratableInterface, OwnableInterface, UpgradableInterface};
+use axelar_soroban_std::{ensure, interfaces};
 use soroban_sdk::{contract, contractimpl, Address, BytesN, Env, String, Symbol, Val, Vec};
 
 #[contract]
@@ -12,15 +11,15 @@ pub struct AxelarOperators;
 #[contractimpl]
 impl AxelarOperators {
     pub fn __constructor(env: Env, owner: Address) {
-        shared_interfaces::set_owner(&env, &owner);
+        interfaces::set_owner(&env, &owner);
     }
 
     pub fn transfer_ownership(env: Env, new_owner: Address) -> Result<(), ContractError> {
         let owner: Address = Self::owner(&env);
 
         owner.require_auth();
 
-        shared_interfaces::set_owner(&env, &new_owner);
+        interfaces::set_owner(&env, &new_owner);
 
         event::transfer_ownership(&env, owner, new_owner);
 
@@ -106,7 +105,7 @@ impl MigratableInterface for AxelarOperators {
     type Error = ContractError;
 
     fn migrate(env: &Env, migration_data: ()) -> Result<(), ContractError> {
-        migrate::<Self>(env, || Self::run_migration(env, migration_data))
+        interfaces::migrate::<Self>(env, || Self::run_migration(env, migration_data))
             .map_err(|_| ContractError::MigrationNotAllowed)
     }
 }
@@ -118,14 +117,14 @@ impl UpgradableInterface for AxelarOperators {
     }
 
     fn upgrade(env: &Env, new_wasm_hash: BytesN<32>) {
-        shared_interfaces::upgrade::<Self>(env, new_wasm_hash);
+        interfaces::upgrade::<Self>(env, new_wasm_hash);
     }
 }
 
 #[contractimpl]
 impl OwnableInterface for AxelarOperators {
     // boilerplate necessary for the contractimpl macro to include function in the generated client
     fn owner(env: &Env) -> Address {
-        shared_interfaces::owner(env)
+        interfaces::owner(env)
     }
 }
diff --git a/contracts/interchain-token-service/src/contract.rs b/contracts/interchain-token-service/src/contract.rs
@@ -1,5 +1,5 @@
 use axelar_soroban_std::types::Token;
-use axelar_soroban_std::{ensure, shared_interfaces};
+use axelar_soroban_std::{ensure, interfaces};
 use soroban_sdk::{bytes, contract, contractimpl, Address, Bytes, BytesN, Env, FromVal, String};
 
 use crate::error::ContractError;
@@ -12,17 +12,15 @@ use axelar_gas_service::AxelarGasServiceClient;
 use axelar_gateway::AxelarGatewayMessagingClient;
 
 use axelar_gateway::executable::AxelarExecutableInterface;
-use axelar_soroban_std::shared_interfaces::{
-    migrate, MigratableInterface, OwnableInterface, UpgradableInterface,
-};
+use axelar_soroban_std::interfaces::{MigratableInterface, OwnableInterface, UpgradableInterface};
 
 #[contract]
 pub struct InterchainTokenService;
 
 #[contractimpl]
 impl InterchainTokenService {
     pub fn __constructor(env: Env, owner: Address, gateway: Address, gas_service: Address) {
-        shared_interfaces::set_owner(&env, &owner);
+        interfaces::set_owner(&env, &owner);
         env.storage().instance().set(&DataKey::Gateway, &gateway);
         env.storage()
             .instance()
@@ -101,7 +99,7 @@ impl InterchainTokenServiceInterface for InterchainTokenService {
         let owner = Self::owner(env);
         owner.require_auth();
 
-        shared_interfaces::set_owner(env, &new_owner);
+        interfaces::set_owner(env, &new_owner);
 
         event::transfer_ownership(env, owner, new_owner);
     }
@@ -246,7 +244,7 @@ impl MigratableInterface for InterchainTokenService {
     type Error = axelar_gateway::error::ContractError;
 
     fn migrate(env: &Env, migration_data: ()) -> Result<(), axelar_gateway::error::ContractError> {
-        migrate::<Self>(env, || Self::run_migration(env, migration_data))
+        interfaces::migrate::<Self>(env, || Self::run_migration(env, migration_data))
             .map_err(|_| axelar_gateway::error::ContractError::MigrationNotAllowed)
     }
 }
@@ -258,14 +256,14 @@ impl UpgradableInterface for InterchainTokenService {
     }
 
     fn upgrade(env: &Env, new_wasm_hash: BytesN<32>) {
-        shared_interfaces::upgrade::<Self>(env, new_wasm_hash);
+        interfaces::upgrade::<Self>(env, new_wasm_hash);
     }
 }
 
 #[contractimpl]
 impl OwnableInterface for InterchainTokenService {
     // boilerplate necessary for the contractimpl macro to include function in the generated client
     fn owner(env: &Env) -> Address {
-        shared_interfaces::owner(env)
+        interfaces::owner(env)
     }
 }
diff --git a/contracts/interchain-token/src/contract.rs b/contracts/interchain-token/src/contract.rs
@@ -10,10 +10,8 @@ use crate::storage_types::DataKey;
 
 use crate::interface::InterchainTokenInterface;
 use crate::storage_types::{AllowanceDataKey, AllowanceValue};
-use axelar_soroban_std::shared_interfaces::{
-    migrate, MigratableInterface, OwnableInterface, UpgradableInterface,
-};
-use axelar_soroban_std::{ensure, shared_interfaces};
+use axelar_soroban_std::interfaces::{MigratableInterface, OwnableInterface, UpgradableInterface};
+use axelar_soroban_std::{ensure, interfaces};
 use soroban_sdk::token::TokenInterface;
 
 use soroban_sdk::{assert_with_error, contract, contractimpl, token, Address, BytesN, Env, String};
@@ -31,7 +29,7 @@ impl InterchainToken {
         token_id: BytesN<32>,
         token_meta_data: TokenMetadata,
     ) -> Result<(), ContractError> {
-        shared_interfaces::set_owner(&env, &owner);
+        interfaces::set_owner(&env, &owner);
 
         Self::validate_token_metadata(token_meta_data.clone())?;
 
@@ -114,7 +112,7 @@ impl InterchainTokenInterface for InterchainToken {
 
         owner.require_auth();
 
-        shared_interfaces::set_owner(&env, &new_owner);
+        interfaces::set_owner(&env, &new_owner);
 
         TokenUtils::new(&env)
             .events()
@@ -366,7 +364,7 @@ impl MigratableInterface for InterchainToken {
     type Error = ContractError;
 
     fn migrate(env: &Env, migration_data: ()) -> Result<(), ContractError> {
-        migrate::<Self>(env, || Self::run_migration(env, migration_data))
+        interfaces::migrate::<Self>(env, || Self::run_migration(env, migration_data))
             .map_err(|_| ContractError::MigrationNotAllowed)
     }
 }
@@ -378,14 +376,14 @@ impl UpgradableInterface for InterchainToken {
     }
 
     fn upgrade(env: &Env, new_wasm_hash: BytesN<32>) {
-        shared_interfaces::upgrade::<Self>(env, new_wasm_hash);
+        interfaces::upgrade::<Self>(env, new_wasm_hash);
     }
 }
 
 #[contractimpl]
 impl OwnableInterface for InterchainToken {
     // boilerplate necessary for the contractimpl macro to include function in the generated client
     fn owner(env: &Env) -> Address {
-        shared_interfaces::owner(env)
+        interfaces::owner(env)
     }
 }
diff --git a/contracts/upgrader/src/contract.rs b/contracts/upgrader/src/contract.rs
@@ -1,6 +1,6 @@
 use crate::error::ContractError;
 use axelar_soroban_std::ensure;
-use axelar_soroban_std::shared_interfaces::UpgradableClient;
+use axelar_soroban_std::interfaces::UpgradableClient;
 use soroban_sdk::{
     contract, contractimpl, symbol_short, Address, BytesN, Env, String, Symbol, Val,
 };

diff --git a/contracts/upgrader/tests/utils/dummy_contract.rs b/contracts/upgrader/tests/utils/dummy_contract.rs
@@ -1,7 +1,7 @@
 //! Dummy contract to test the [crate::Upgrader]
 
-use axelar_soroban_std::shared_interfaces;
-use axelar_soroban_std::shared_interfaces::{OwnableInterface, UpgradableInterface};
+use axelar_soroban_std::interfaces;
+use axelar_soroban_std::interfaces::{OwnableInterface, UpgradableInterface};
 use soroban_sdk::{contract, contracterror, contractimpl, contracttype, Address, BytesN, Env};
 
 #[contract]
@@ -23,14 +23,14 @@ impl UpgradableInterface for DummyContract {
 #[contractimpl]
 impl OwnableInterface for DummyContract {
     fn owner(env: &Env) -> Address {
-        shared_interfaces::owner(env)
+        interfaces::owner(env)
     }
 }
 
 #[contractimpl]
 impl DummyContract {
     pub fn __constructor(env: Env, owner: Address) {
-        shared_interfaces::set_owner(&env, &owner);
+        interfaces::set_owner(&env, &owner);
     }
 }
 

diff --git a/contracts/upgrader/tests/utils/dummy_contract_after_upgrade.rs b/contracts/upgrader/tests/utils/dummy_contract_after_upgrade.rs
@@ -1,7 +1,7 @@
 //! Base for the dummy.wasm file. This is the dummy contract after upgrade.
 
-use axelar_soroban_std::shared_interfaces;
-use axelar_soroban_std::shared_interfaces::{OwnableInterface, UpgradableInterface};
+use axelar_soroban_std::interfaces;
+use axelar_soroban_std::interfaces::{OwnableInterface, UpgradableInterface};
 use soroban_sdk::{contract, contracterror, contractimpl, contracttype, Address, BytesN, Env};
 
 #[contract]
@@ -23,14 +23,14 @@ impl UpgradableInterface for DummyContract {
 #[contractimpl]
 impl OwnableInterface for DummyContract {
     fn owner(env: &Env) -> Address {
-        shared_interfaces::owner(env)
+        interfaces::owner(env)
     }
 }
 
 #[contractimpl]
 impl DummyContract {
     pub fn __constructor(env: Env, owner: Address) {
-        shared_interfaces::set_owner(&env, &owner);
+        interfaces::set_owner(&env, &owner);
     }
 
     pub fn migrate(env: Env, migration_data: soroban_sdk::String) -> Result<(), ContractError> {

diff --git a/...ata/test_format_last_emitted_event.golden → ...ata/test_format_last_emitted_event.golden b/...ata/test_format_last_emitted_event.golden → ...ata/test_format_last_emitted_event.golden
diff --git a/packages/axelar-soroban-std/src/events.rs b/packages/axelar-soroban-std/src/events.rs
@@ -128,7 +128,7 @@ mod test {
     struct Contract;
 
     #[test]
-    fn test_format_last_emitted_event() {
+    fn format_last_emitted_event() {
         let env = Env::default();
         let expected = TestEvent {
             topic1: Symbol::new(&env, "topic1"),

diff --git a/packages/axelar-soroban-std/src/interfaces/mod.rs b/packages/axelar-soroban-std/src/interfaces/mod.rs
@@ -0,0 +1,5 @@
+#[cfg(test)]
+mod testdata;
+mod upgradable;
+
+pub use upgradable::*;
diff --git a/...elar-soroban-std/src/testdata/contract.rs → ...n-std/src/interfaces/testdata/contract.rs b/...elar-soroban-std/src/testdata/contract.rs → ...n-std/src/interfaces/testdata/contract.rs
@@ -1,5 +1,4 @@
-use crate::shared_interfaces;
-use crate::shared_interfaces::{MigratableInterface, OwnableInterface, UpgradableInterface};
+use crate::interfaces::{upgradable, MigratableInterface, OwnableInterface, UpgradableInterface};
 use soroban_sdk::testutils::arbitrary::std;
 use soroban_sdk::{
     contract, contracterror, contractimpl, contracttype, Address, BytesN, Env, String,
@@ -29,15 +28,15 @@ impl MigratableInterface for Contract {
     type Error = ContractError;
 
     fn migrate(env: &Env, migration_data: ()) -> Result<(), ContractError> {
-        shared_interfaces::migrate::<Self>(env, || Self::run_migration(env, migration_data))
+        upgradable::migrate::<Self>(env, || Self::run_migration(env, migration_data))
             .map_err(|_| ContractError::SomeFailure)
     }
 }
 
 #[contractimpl]
 impl OwnableInterface for Contract {
     fn owner(env: &Env) -> Address {
-        shared_interfaces::owner(env)
+        upgradable::owner(env)
     }
 }
 
@@ -48,7 +47,7 @@ impl UpgradableInterface for Contract {
     }
 
     fn upgrade(env: &Env, new_wasm_hash: BytesN<32>) {
-        shared_interfaces::upgrade::<Self>(env, new_wasm_hash);
+        upgradable::upgrade::<Self>(env, new_wasm_hash);
     }
 }
 

diff --git a/...ar-soroban-std/src/testdata/contract.wasm → ...std/src/interfaces/testdata/contract.wasm b/...ar-soroban-std/src/testdata/contract.wasm → ...std/src/interfaces/testdata/contract.wasm
diff --git a/...enticated_and_called_after_upgrade.golden → ...enticated_and_called_after_upgrade.golden b/...enticated_and_called_after_upgrade.golden → ...enticated_and_called_after_upgrade.golden
diff --git a/...es/axelar-soroban-std/src/testdata/mod.rs → ...oroban-std/src/interfaces/testdata/mod.rs b/...es/axelar-soroban-std/src/testdata/mod.rs → ...oroban-std/src/interfaces/testdata/mod.rs