@layerzerolabs/protocol-stellar-v2 0.2.19 → 0.2.20

package/contracts/upgrader/src/lib.rs

@@ -2,45 +2,25 @@
 
 //! # Upgrader Contract
 //!
-//! A stateless utility contract for performing upgrade and migrate operations on upgradeable contracts.
-//!
-//! This contract provides a convenient way to upgrade other contracts, especially useful for
-//! performing upgrade+migrate atomically in a single transaction.
+//! A stateless utility contract for performing atomic upgrade and migrate operations
+//! on contracts implementing the [`Upgradeable`](utils::upgradeable::Upgradeable) trait.
 //!
 //! ## Security Model
 //!
-//! The Upgrader is a permissionless utility - anyone can call it, but security is enforced
-//! by the target contract's authorization checks. When you call `upgrader.upgrade()`, the target
-//! contract's `#[only_auth]` guard ensures only the target's authorizer can successfully upgrade it.
+//! The Upgrader is permissionless - anyone can call it, but security is enforced by the
+//! target contract's authorization checks. The target contract's `#[only_auth]` guard
+//! ensures only its authorizer can successfully upgrade it.
 //!
 //! ## Usage
 //!
-//! Deploy this contract once, then anyone can use it to upgrade contracts they own.
-//!
 //! ```ignore
-//! // Deploy upgrader (no initialization needed)
-//! let upgrader_id = env.register(Upgrader, ());
 //! let upgrader = UpgraderClient::new(&env, &upgrader_id);
-//!
-//! // Upgrade a contract (you must be the target contract's owner)
-//! upgrader.upgrade(&target_contract, &new_wasm_hash);
-//!
-//! // Or upgrade and migrate in one transaction
-//! let migration_data = vec![&env, val1, val2];
-//! upgrader.upgrade_and_migrate(&target_contract, &new_wasm_hash, migration_data);
+//! let migration_data = my_data.to_xdr(&env);
+//! upgrader.upgrade_and_migrate(&target_contract, &new_wasm_hash, &migration_data);
 //! ```
 
-use soroban_sdk::{contract, contractclient, contractimpl, symbol_short, Address, BytesN, Env, Symbol, Vec};
-
-/// Symbol for the migrate function call
-pub const MIGRATE: Symbol = symbol_short!("migrate");
-
-/// Trait representing an upgradeable contract's interface
-#[contractclient(name = "UpgradeableContractClient")]
-pub trait UpgradeableContract {
-    /// Upgrades the contract to new WASM bytecode
-    fn upgrade(env: &Env, new_wasm_hash: BytesN<32>);
-}
+use soroban_sdk::{contract, contractimpl, xdr::ToXdr, Address, Bytes, BytesN, Env};
+use utils::upgradeable::UpgradeableClient;
 
 /// Upgrader contract for managing upgrades of other contracts.
 ///
@@ -51,46 +31,39 @@ pub struct Upgrader;
 
 #[contractimpl]
 impl Upgrader {
-    /// Upgrade a target contract and run its migration in a single transaction
+    /// Upgrades a target contract without custom migration data.
+    ///
+    /// This is a convenience wrapper that calls `upgrade_and_migrate` with empty migration data.
+    ///
+    /// # Arguments
+    /// * `contract_address` - The address of the contract to upgrade
+    /// * `wasm_hash` - The hash of the new WASM bytecode
+    pub fn upgrade(env: &Env, contract_address: &Address, wasm_hash: &BytesN<32>) {
+        Self::upgrade_and_migrate(env, contract_address, wasm_hash, &().to_xdr(env));
+    }
+
+    /// Upgrades a target contract and runs its migration in a single transaction.
     ///
     /// The caller must be authorized as the authorizer of the target contract.
     /// This is enforced by the target contract's `#[only_auth]` check.
     ///
-    /// This is useful for atomic upgrades where you want to ensure the migration
-    /// happens immediately after the upgrade, or the entire operation fails.
-    ///
     /// # Arguments
     /// * `contract_address` - The address of the contract to upgrade
     /// * `wasm_hash` - The hash of the new WASM bytecode
-    /// * `migration_data` - A vector of values to pass to the migrate function.
-    ///   The types of these values depend on the target contract's MigrationData type.
+    /// * `migration_data` - XDR-encoded bytes to pass to the migrate function.
+    ///   Use `value.to_xdr(&env)` to encode the target contract's MigrationData type.
     ///
     /// # Example
     /// ```ignore
-    /// // For a contract with MigrationData = (u32, bool)
-    /// let migration_data = vec![
-    ///     &env,
-    ///     42u32.into_val(&env),
-    ///     true.into_val(&env),
-    /// ];
-    /// upgrader.upgrade_and_migrate(&contract_addr, &wasm_hash, migration_data);
+    /// let migration_data = my_data.to_xdr(&env);
+    /// upgrader.upgrade_and_migrate(&contract_addr, &wasm_hash, &migration_data);
     /// ```
-    pub fn upgrade_and_migrate(
-        env: &Env,
-        contract_address: &Address,
-        wasm_hash: BytesN<32>,
-        migration_data: Vec<soroban_sdk::Val>,
-    ) {
-        let contract_client = UpgradeableContractClient::new(env, contract_address);
-
-        // First upgrade the contract
-        contract_client.upgrade(&wasm_hash);
-
-        // Then call migrate with the provided data
-        // We use invoke_contract because the migration data type is unknown to this contract
-        env.invoke_contract::<()>(contract_address, &MIGRATE, migration_data);
+    pub fn upgrade_and_migrate(env: &Env, contract_address: &Address, wasm_hash: &BytesN<32>, migration_data: &Bytes) {
+        let client = UpgradeableClient::new(env, contract_address);
+        client.upgrade(wasm_hash);
+        client.migrate(migration_data);
     }
 }
 
 #[cfg(test)]
-mod tests;
+mod tests;

package/contracts/upgrader/src/tests/test_upgrader.rs

@@ -1,6 +1,6 @@
 extern crate std;
 
-use soroban_sdk::{contractclient, testutils::Address as _, Address, BytesN, Env, TryIntoVal};
+use soroban_sdk::{contractclient, testutils::Address as _, xdr::ToXdr, Address, BytesN, Env};
 
 use crate::{Upgrader, UpgraderClient};
 
@@ -17,16 +17,20 @@ trait TestUpgradeableContract2 {
 }
 
 mod contract_v1 {
-    // #[contract]
-    // #[upgradeable]
-    // #[ownable]
-    // pub struct TestUpgradeableContract;
+    //#![no_std]
 
-    // impl UpgradeableInternal for TestUpgradeableContract {
-    //     type MigrationData = ();
+    // use soroban_sdk::{contractimpl, Env, Symbol, Address, contractclient};
+    // use utils::{ upgradeable::UpgradeableInternal};
+    // use common_macros::lz_contract;
 
-    //     fn _migrate(env: &Env, _migration_data: &Self::MigrationData) {
-    //         env.storage().instance().set(&Symbol::new(env, "counter"), &2);
+    // #[lz_contract(upgradeable)]
+    // pub struct DummyContract;
+
+    // impl UpgradeableInternal for DummyContract {
+    //     type MigrationData = u32;
+
+    //     fn __migrate(env: &Env, migration_data: &Self::MigrationData) {
+    //         env.storage().instance().set(&Symbol::new(env, "counter2"), migration_data);
     //     }
     // }
 
@@ -35,34 +39,37 @@ mod contract_v1 {
     //     fn counter(env: &Env) -> u32;
     // }
 
-    // #[contract_impl]
-    // impl TestUpgradeable for TestUpgradeableContract {
+    // #[contractimpl]
+    // impl TestUpgradeable for DummyContract {
     //     fn counter(env: &Env) -> u32 {
     //         env.storage().instance().get(&Symbol::new(env, "counter")).unwrap_or(0)
     //     }
     // }
 
-    // #[contract_impl]
-    // impl TestUpgradeableContract {
+    // #[contractimpl]
+    // impl DummyContract {
     //     pub fn __constructor(env: &Env, owner: &Address) {
     //         Self::init_owner(env, owner);
     //         env.storage().instance().set(&Symbol::new(env, "counter"), &1_u32);
     //     }
     // }
-    use super::MigrationData;
     soroban_sdk::contractimport!(file = "./src/tests/test_data/test_upgradeable_contract1.wasm");
 }
 mod contract_v2 {
-    // #[contract]
-    // #[upgradeable]
-    // #[ownable]
-    // pub struct TestUpgradeableContract;
+    //#![no_std]
+
+    // use soroban_sdk::{contractimpl, Env, Symbol, Address, contractclient};
+    // use utils::{ upgradeable::UpgradeableInternal};
+    // use common_macros::lz_contract;
+
+    // #[lz_contract(upgradeable)]
+    // pub struct DummyContract;
 
-    // impl UpgradeableInternal for TestUpgradeableContract {
-    //     type MigrationData = ();
+    // impl UpgradeableInternal for DummyContract {
+    //     type MigrationData = u32;
 
-    //     fn _migrate(env: &Env, _migration_data: &Self::MigrationData) {
-    //         env.storage().instance().set(&Symbol::new(env, "counter2"), &2_u32);
+    //     fn __migrate(env: &Env, migration_data: &Self::MigrationData) {
+    //         env.storage().instance().set(&Symbol::new(env, "counter2"), migration_data);
     //     }
     // }
 
@@ -72,8 +79,8 @@ mod contract_v2 {
     //     fn counter2(env: &Env) -> u32;
     // }
 
-    // #[contract_impl]
-    // impl TestUpgradeable for TestUpgradeableContract {
+    // #[contractimpl]
+    // impl TestUpgradeable for DummyContract {
     //     fn counter(env: &Env) -> u32 {
     //         env.storage().instance().get(&Symbol::new(env, "counter")).unwrap_or(0)
     //     }
@@ -82,7 +89,14 @@ mod contract_v2 {
     //         env.storage().instance().get(&Symbol::new(env, "counter2")).unwrap_or(0)
     //     }
     // }
-    use super::MigrationData;
+
+    // #[contractimpl]
+    // impl DummyContract {
+    //     pub fn __constructor(env: &Env, owner: &Address) {
+    //         Self::init_owner(env, owner);
+    //         env.storage().instance().set(&Symbol::new(env, "counter"), &1_u32);
+    //     }
+    // }
     soroban_sdk::contractimport!(file = "./src/tests/test_data/test_upgradeable_contract2.wasm");
 }
 
@@ -90,9 +104,6 @@ fn install_new_wasm(e: &Env) -> BytesN<32> {
     e.deployer().upload_contract_wasm(contract_v2::WASM)
 }
 
-#[allow(dead_code)]
-type MigrationData = ();
-
 #[test]
 fn test_upgrade_with_upgrader() {
     let e = Env::default();
@@ -107,14 +118,12 @@ fn test_upgrade_with_upgrader() {
     let upgrader_client = UpgraderClient::new(&e, &upgrader);
 
     let new_wasm_hash = install_new_wasm(&e);
-
-    upgrader_client.upgrade_and_migrate(
-        &contract_id,
-        &new_wasm_hash,
-        &soroban_sdk::vec![&e, ().try_into_val(&e).unwrap()],
-    );
+    let counter_value = 2_u32;
+    // Encode migration data as XDR bytes
+    let migration_data = counter_value.to_xdr(&e);
+    upgrader_client.upgrade_and_migrate(&contract_id, &new_wasm_hash, &migration_data);
 
     let client_v2 = TestUpgradeableContractClient2::new(&e, &contract_id);
 
-    assert_eq!(client_v2.counter2(), 2);
+    assert_eq!(client_v2.counter2(), counter_value);
 }

package/contracts/utils/src/buffer_reader.rs

@@ -92,6 +92,7 @@ impl<'a> BufferReader<'a> {
         value
     }
 
+    /// Reads all bytes from current position to the end of the buffer.
     pub fn read_bytes_until_end(&mut self) -> Bytes {
         self.read_bytes(self.remaining_len())
     }

package/contracts/utils/src/errors.rs

@@ -44,7 +44,9 @@ pub enum BytesExtError {
 /// UpgradeableError: 1050-1059
 #[contract_error]
 pub enum UpgradeableError {
-    MigrationNotAllowed = 1050,
+    InvalidMigrationData = 1050,
+    MigrationNotAllowed,
+    UpgradesFrozen,
 }
 
 /// MultisigError: 1060-1069