@layerzerolabs/protocol-stellar-v2 0.2.8 → 0.2.10

package/contracts/workers/executor/src/executor.rs

@@ -1,347 +0,0 @@
-use crate::{
-    events::{DstConfigSet, NativeDropApplied},
-    interfaces::{DstConfig, ExecutionParams, IExecutor, NativeDropParams, SetDstConfigParam},
-    storage::ExecutorData,
-    ComposeParams,
-};
-use endpoint_v2::{
-    FeeRecipient, LayerZeroComposerClient, LayerZeroEndpointV2Client, LayerZeroReceiverClient, MessagingComposerClient,
-};
-use message_lib_common::ILayerZeroExecutor;
-use soroban_sdk::{assert_with_error, bytes, contract, contractimpl, token, vec, Address, Bytes, Env, Vec};
-use stellar_access::access_control::AccessControl;
-use stellar_macros::{default_impl, only_role, when_not_paused};
-use worker_common::{ExecutorFeeLibClient, FeeParams, IWorker, WorkerCommon, WorkerError};
-
-// ============================================================================
-// Executor Contract
-// ============================================================================
-
-#[contract]
-pub struct LzExecutor;
-
-// ============================================================================
-// Constructor
-// ============================================================================
-
-#[contractimpl()]
-impl LzExecutor {
-    /// Constructor - Initialize the executor contract
-    /// Follows the EVM pattern: initialize(endpoint, messageLibs, priceFeed, roleAdmin, admins)
-    pub fn __constructor(
-        env: &Env,
-        endpoint: &Address,
-        message_libs: &Vec<Address>,
-        price_feed: &Address,
-        default_multiplier_bps: u32,
-        role_admin: &Address,
-        admins: &Vec<Address>,
-    ) {
-        // Initialize WorkerCommon (handles access control and basic worker setup)
-        WorkerCommon::initialize(env, role_admin, message_libs, price_feed, default_multiplier_bps, admins);
-
-        // Store executor-specific data
-        ExecutorData::set_endpoint(env, endpoint);
-
-        // Get and store the local EID from the endpoint
-        let endpoint_client = LayerZeroEndpointV2Client::new(env, endpoint);
-        let local_eid = endpoint_client.eid();
-        ExecutorData::set_local_eid(env, &local_eid);
-    }
-
-    pub(crate) fn endpoint(env: &Env) -> Address {
-        ExecutorData::endpoint(env).unwrap()
-    }
-}
-
-// ============================================================================
-// IWorker Implementation (delegate to WorkerCommon)
-// ============================================================================
-
-#[contractimpl]
-impl IWorker for LzExecutor {
-    // ========================================================================
-    // Mutable Functions
-    // ========================================================================
-
-    fn set_paused(env: &Env, paused: bool) {
-        WorkerCommon::set_paused(env, paused);
-    }
-
-    fn set_default_multiplier_bps(env: &Env, admin: &Address, multiplier_bps: u32) {
-        WorkerCommon::set_default_multiplier_bps(env, admin, multiplier_bps);
-    }
-
-    fn set_deposit_address(env: &Env, admin: &Address, deposit_address: &Address) {
-        WorkerCommon::set_deposit_address(env, admin, deposit_address);
-    }
-
-    fn set_price_feed(env: &Env, admin: &Address, price_feed: &Address) {
-        WorkerCommon::set_price_feed(env, admin, price_feed);
-    }
-
-    fn set_supported_option_types(env: &Env, admin: &Address, eid: u32, option_types: Bytes) {
-        WorkerCommon::set_supported_option_types(env, admin, eid, option_types);
-    }
-
-    fn set_worker_fee_lib(env: &Env, admin: &Address, worker_fee_lib: &Address) {
-        WorkerCommon::set_worker_fee_lib(env, admin, worker_fee_lib);
-    }
-
-    // ========================================================================
-    // View Functions
-    // ========================================================================
-
-    fn paused(env: &Env) -> bool {
-        WorkerCommon::paused(env)
-    }
-
-    fn default_multiplier_bps(env: &Env) -> u32 {
-        WorkerCommon::default_multiplier_bps(env)
-    }
-
-    fn deposit_address(env: &Env) -> Address {
-        WorkerCommon::deposit_address(env)
-    }
-
-    fn price_feed(env: &Env) -> Address {
-        WorkerCommon::price_feed(env)
-    }
-
-    fn get_supported_option_types(env: &Env, eid: u32) -> Bytes {
-        WorkerCommon::get_supported_option_types(env, eid)
-    }
-
-    fn worker_fee_lib(env: &Env) -> Address {
-        WorkerCommon::worker_fee_lib(env)
-    }
-
-    fn has_acl(env: &Env, sender: &Address) -> bool {
-        WorkerCommon::has_acl(env, sender)
-    }
-
-    fn allowlist_size(env: &Env) -> u32 {
-        WorkerCommon::allowlist_size(env)
-    }
-}
-
-// ============================================================================
-// IExecutor Implementation
-// ============================================================================
-
-#[contractimpl]
-impl IExecutor for LzExecutor {
-    // === Destination Configuration ===
-
-    #[only_role(admin, "ADMIN")]
-    fn set_dst_config(env: &Env, admin: &Address, params: &Vec<SetDstConfigParam>) {
-        for param in params.iter() {
-            ExecutorData::set_dst_config(env, param.dst_eid, &param.dst_config);
-        }
-        DstConfigSet { params: params.clone() }.publish(env);
-    }
-
-    // === Execution Functions ===
-
-    #[only_role(admin, "ADMIN")]
-    fn native_drop(
-        env: &Env,
-        admin: &Address,
-        origin: &endpoint_v2::Origin,
-        dst_eid: u32,
-        oapp: &Address,
-        native_drop_params: &Vec<NativeDropParams>,
-    ) {
-        let endpoint = Self::endpoint(env);
-        let native_token_client =
-            token::TokenClient::new(env, &LayerZeroEndpointV2Client::new(env, &endpoint).native_token());
-
-        let mut success = vec![env];
-
-        for param in native_drop_params.iter() {
-            // Attempt to transfer native tokens to the receiver
-            // In Stellar, we use the token client to transfer
-            let transfer_success = native_token_client
-                .try_transfer(&env.current_contract_address(), &param.receiver, &param.amount)
-                .is_ok();
-
-            success.push_back(transfer_success);
-        }
-
-        NativeDropApplied {
-            origin: origin.clone(),
-            dst_eid,
-            oapp: oapp.clone(),
-            native_drop_params: native_drop_params.clone(),
-            success,
-        }
-        .publish(env);
-    }
-
-    #[only_role(admin, "ADMIN")]
-    fn execute(env: &Env, admin: &Address, execution_params: &ExecutionParams) {
-        let endpoint = Self::endpoint(env);
-        let endpoint_client = LayerZeroEndpointV2Client::new(env, &endpoint);
-        let native_token_client = token::TokenClient::new(env, &endpoint_client.native_token());
-
-        // Transfer value to receiver if needed (matching EVM pattern)
-        if execution_params.value > 0 {
-            native_token_client.transfer(admin, env.current_contract_address(), &execution_params.value);
-        }
-
-        // Call lz_receive on the receiver
-        let receiver_client = LayerZeroReceiverClient::new(env, &execution_params.receiver);
-
-        // Try to execute lz_receive (matching EVM try-catch pattern)
-        let result = receiver_client.try_lz_receive(
-            &env.current_contract_address(),
-            &execution_params.origin,
-            &execution_params.guid,
-            &execution_params.message,
-            &execution_params.extra_data,
-            &execution_params.value,
-        );
-
-        // If execution failed, call lz_receive_alert on endpoint (matching EVM catch block)
-        if result.is_err() {
-            // Get the error reason - in Stellar we just use an empty bytes for simplicity
-            let reason = bytes![env];
-            endpoint_client.lz_receive_alert(
-                &env.current_contract_address(),
-                &execution_params.origin,
-                &execution_params.receiver,
-                &execution_params.guid,
-                &execution_params.gas_limit,
-                &execution_params.value,
-                &execution_params.message,
-                &execution_params.extra_data,
-                &reason,
-            );
-        }
-    }
-
-    #[only_role(admin, "ADMIN")]
-    fn compose(env: &Env, admin: &Address, compose_params: &ComposeParams) {
-        let endpoint = ExecutorData::endpoint(env).expect("endpoint not set");
-        let endpoint_client = LayerZeroEndpointV2Client::new(env, &endpoint);
-        let native_token_client = token::TokenClient::new(env, &endpoint_client.native_token());
-
-        // Transfer value to composer if needed (matching EVM pattern)
-        if compose_params.value > 0 {
-            native_token_client.transfer(admin, env.current_contract_address(), &compose_params.value);
-        }
-
-        // Call lz_compose on the composer
-        let composer_client = LayerZeroComposerClient::new(env, &compose_params.to);
-
-        // Try to execute lz_compose (matching EVM try-catch pattern)
-        let result = composer_client.try_lz_compose(
-            &env.current_contract_address(),
-            &compose_params.from,
-            &compose_params.guid,
-            &compose_params.index,
-            &compose_params.message,
-            &compose_params.extra_data,
-            &compose_params.value,
-        );
-
-        // If execution failed, call lz_compose_alert on endpoint (matching EVM catch block)
-        if result.is_err() {
-            // Get the error reason - in Stellar we just use an empty bytes for simplicity
-            let reason = bytes![env];
-
-            // lz_compose_alert is on MessagingComposerClient, not LayerZeroEndpointV2Client
-            let composer_client = MessagingComposerClient::new(env, &endpoint);
-            composer_client.lz_compose_alert(
-                &env.current_contract_address(),
-                &compose_params.from,
-                &compose_params.to,
-                &compose_params.guid,
-                &compose_params.index,
-                &compose_params.gas_limit,
-                &compose_params.value,
-                &compose_params.message,
-                &compose_params.extra_data,
-                &reason,
-            );
-        }
-    }
-
-    // View Functions
-
-    fn dst_config(env: &Env, dst_eid: u32) -> Option<DstConfig> {
-        ExecutorData::dst_config(env, dst_eid)
-    }
-}
-
-// ============================================================================
-// IMsgLibExecutor Implementation (for message libraries)
-// ============================================================================
-
-#[contractimpl]
-impl ILayerZeroExecutor for LzExecutor {
-    #[only_role(_send_lib, "MSG_LIB")]
-    #[when_not_paused()]
-    fn assign_job(
-        env: &Env,
-        _send_lib: &Address,
-        sender: &Address,
-        dst_eid: u32,
-        calldata_size: u32,
-        options: &Bytes,
-    ) -> FeeRecipient {
-        let fee = Self::get_fee(env, _send_lib, sender, dst_eid, calldata_size, options);
-        let recipient = WorkerCommon::deposit_address(env);
-        FeeRecipient { amount: fee, address: recipient }
-    }
-
-    #[when_not_paused()]
-    fn get_fee(
-        env: &Env,
-        _send_lib: &Address,
-        sender: &Address,
-        dst_eid: u32,
-        calldata_size: u32,
-        options: &Bytes,
-    ) -> i128 {
-        // Check ACL
-        assert_with_error!(env, WorkerCommon::has_acl(env, sender), WorkerError::NotAllowed);
-
-        // Get the dst_config
-        let dst_config = Self::dst_config(env, dst_eid).unwrap_or(DstConfig {
-            lz_receive_base_gas: 0,
-            multiplier_bps: 0,
-            floor_margin_usd: 0,
-            native_cap: 0,
-            lz_compose_base_gas: 0,
-        });
-
-        // Build FeeParams for the executor fee lib
-        let fee_params = FeeParams {
-            sender: sender.clone(),
-            dst_eid,
-            calldata_size,
-            options: options.clone(),
-            price_feed: WorkerCommon::price_feed(env),
-            default_multiplier_bps: WorkerCommon::default_multiplier_bps(env),
-            lz_receive_base_gas: dst_config.lz_receive_base_gas,
-            lz_compose_base_gas: dst_config.lz_compose_base_gas,
-            floor_margin_usd: dst_config.floor_margin_usd,
-            native_cap: dst_config.native_cap,
-            multiplier_bps: dst_config.multiplier_bps,
-        };
-
-        // Call the executor fee lib to get the fee
-        let fee_lib = WorkerCommon::worker_fee_lib(env);
-        let fee_lib_client = ExecutorFeeLibClient::new(env, &fee_lib);
-        fee_lib_client.get_fee(&fee_lib, &fee_params)
-    }
-}
-
-// ============================================================================
-// AccessControl Implementation (default from stellar-access)
-// ============================================================================
-
-#[default_impl]
-#[contractimpl]
-impl AccessControl for LzExecutor {}

package/contracts/workers/executor/src/interfaces/types.rs

@@ -1,51 +0,0 @@
-use endpoint_v2::Origin;
-use soroban_sdk::{contracttype, Address, Bytes, BytesN};
-
-#[contracttype]
-#[derive(Clone, Debug)]
-pub struct DstConfig {
-    pub lz_receive_base_gas: u64,
-    pub multiplier_bps: u32,
-    pub floor_margin_usd: u128,
-    pub native_cap: u128,
-    pub lz_compose_base_gas: u64,
-}
-
-#[contracttype]
-#[derive(Clone, Debug)]
-pub struct SetDstConfigParam {
-    pub dst_eid: u32,
-    pub dst_config: DstConfig,
-}
-
-#[contracttype]
-#[derive(Clone, Debug)]
-pub struct ExecutionParams {
-    pub receiver: Address,
-    pub origin: Origin,
-    pub guid: BytesN<32>,
-    pub message: Bytes,
-    pub extra_data: Bytes,
-    pub value: i128,
-    pub gas_limit: i128,
-}
-
-#[contracttype]
-#[derive(Clone, Debug)]
-pub struct NativeDropParams {
-    pub receiver: Address,
-    pub amount: i128,
-}
-
-#[contracttype]
-#[derive(Clone, Debug)]
-pub struct ComposeParams {
-    pub from: Address,
-    pub to: Address,
-    pub guid: BytesN<32>,
-    pub index: u32,
-    pub message: Bytes,
-    pub extra_data: Bytes,
-    pub value: i128,
-    pub gas_limit: i128,
-}

package/contracts/workers/worker-common/src/constants.rs

@@ -1,17 +0,0 @@
-use soroban_sdk::{symbol_short, Symbol};
-
-// ============================================================================
-// Role Constants (matching EVM Worker.sol)
-// ============================================================================
-
-/// MESSAGE_LIB_ROLE - Role for message libraries that can interact with the worker
-pub const MESSAGE_LIB_ROLE: Symbol = symbol_short!("MSG_LIB");
-
-/// ALLOWLIST - Role for addresses allowed to use the worker
-pub const ALLOWLIST: Symbol = symbol_short!("ALLOW");
-
-/// DENYLIST - Role for addresses denied from using the worker
-pub const DENYLIST: Symbol = symbol_short!("DENY");
-
-/// ADMIN_ROLE - Role for admins who can configure worker settings
-pub const ADMIN_ROLE: Symbol = symbol_short!("ADMIN");

package/contracts/workers/worker-common/src/errors.rs

@@ -1,6 +0,0 @@
-use common_macros::contract_error;
-
-#[contract_error]
-pub enum WorkerError {
-    NotAllowed = 12000,
-}

package/contracts/workers/worker-common/src/events.rs

@@ -1,34 +0,0 @@
-use soroban_sdk::{contractevent, Address, Bytes};
-
-// === Worker Events ===
-// Note: Role-related events (RoleGranted, RoleRevoked, etc.) are emitted by OpenZeppelin AccessControl
-#[contractevent(topics = ["SetDefaultMultiplierBps"])]
-#[derive(Clone, Debug, Eq, PartialEq)]
-pub struct SetDefaultMultiplierBps {
-    pub multiplier_bps: u32,
-}
-
-#[contractevent(topics = ["SetDepositAddress"])]
-#[derive(Clone, Debug, Eq, PartialEq)]
-pub struct SetDepositAddress {
-    pub deposit_address: Address,
-}
-
-#[contractevent(topics = ["SetPriceFeed"])]
-#[derive(Clone, Debug, Eq, PartialEq)]
-pub struct SetPriceFeed {
-    pub price_feed: Address,
-}
-
-#[contractevent(topics = ["SetSupportedOptionTypes"])]
-#[derive(Clone, Debug, Eq, PartialEq)]
-pub struct SetSupportedOptionTypes {
-    pub dst_eid: u32,
-    pub option_types: Bytes,
-}
-
-#[contractevent(topics = ["SetWorkerFeeLib"])]
-#[derive(Clone, Debug, Eq, PartialEq)]
-pub struct SetWorkerFeeLib {
-    pub fee_lib: Address,
-}

package/contracts/workers/worker-common/src/interfaces/executor_fee_lib.rs

@@ -1,35 +0,0 @@
-use soroban_sdk::{contractclient, contracttype, Address, Bytes, Env};
-
-/// FeeParams - Parameters for standard fee calculation same with the Sui
-#[contracttype]
-#[derive(Clone, Debug)]
-pub struct FeeParams {
-    // message params
-    pub sender: Address,
-    pub dst_eid: u32,
-    pub calldata_size: u32,
-    pub options: Bytes,
-    // common configed params
-    pub price_feed: Address,
-    pub default_multiplier_bps: u32,
-    // by dst_eid configed params
-    pub lz_receive_base_gas: u64,
-    pub lz_compose_base_gas: u64,
-    pub floor_margin_usd: u128,
-    pub native_cap: u128,
-    pub multiplier_bps: u32,
-}
-
-/// IExecutorFeeLib - Interface for calculating executor fees
-/// This interface is called by the Executor contract to calculate fees
-/// It uses the PriceFeed interface to get price information
-#[contractclient(name = "ExecutorFeeLibClient")]
-pub trait IExecutorFeeLib {
-    /// Calculate fee (view function, standard params)
-    /// Called by get_fee in the Executor contract
-    fn get_fee(env: &Env, fee_lib: &Address, params: &FeeParams) -> i128;
-
-    /// Returns the current contract version.
-    /// Because not allow return u8, use u32 instead.
-    fn version(env: &Env) -> (u64, u32);
-}

package/contracts/workers/worker-common/src/interfaces/price_feed.rs

@@ -1,40 +0,0 @@
-use soroban_sdk::{contractclient, contracttype, Address, Env};
-
-/// Struct to encapsulate the return values of estimate_fee_by_eid
-#[contracttype]
-#[derive(Clone, Debug)]
-pub struct EstimateFeeResult {
-    pub fee: i128,
-    pub price_ratio: u128,
-    pub price_ratio_denominator: u128,
-    pub native_price_usd: u128,
-}
-
-/// ILayerZeroPriceFeed - Interface for price feed contract
-/// This interface provides price information for fee calculation
-/// Called by ExecutorFeeLib to get pricing data
-#[contractclient(name = "LayerZeroPriceFeedClient")]
-pub trait ILayerZeroPriceFeed {
-    /// Estimate fee with detailed breakdown by endpoint ID
-    /// This is the main function called by ExecutorFeeLib
-    /// @param dst_eid - Destination endpoint ID
-    /// @param calldata_size - Size of the calldata in bytes
-    /// @param gas - Gas amount needed for execution
-    /// @return (fee, price_ratio, price_ratio_denominator, native_price_usd)
-    fn estimate_fee_by_eid(
-        env: &Env,
-        fee_lib: &Address,
-        dst_eid: u32,
-        calldata_size: u64,
-        gas: u128,
-    ) -> EstimateFeeResult;
-
-    /// Get the native token price in USD
-    /// @return native_token_price_usd - The price of the native token in USD
-    fn native_token_price_usd(env: &Env) -> u128;
-
-    /// Set the native token price in USD
-    /// @param price_updater - The address of the price updater
-    /// @param native_token_price_usd - The new price of the native token in USD
-    fn set_native_token_price_usd(env: &Env, price_updater: &Address, native_token_price_usd: u128);
-}

package/contracts/workers/worker-common/src/interfaces/worker.rs

@@ -1,60 +0,0 @@
-use soroban_sdk::{contractclient, Address, Bytes, Env};
-
-/// IWorker - Base worker interface for managing fees, price feeds, and admin operations
-/// Uses OpenZeppelin AccessControl for role-based access management
-#[contractclient(name = "WorkerClient")]
-pub trait IWorker {
-    // ========================================================================
-    // Mutable Functions
-    // ========================================================================
-
-    /// Set the paused state of the worker (requires DEFAULT_ADMIN_ROLE)
-    fn set_paused(env: &Env, paused: bool);
-
-    /// Set the default multiplier in basis points (ADMIN_ROLE only)
-    fn set_default_multiplier_bps(env: &Env, admin: &Address, multiplier_bps: u32);
-
-    /// Set the deposit address where fees are collected (admin only)
-    fn set_deposit_address(env: &Env, admin: &Address, deposit_address: &Address);
-
-    /// Set the price feed address (admin only)
-    fn set_price_feed(env: &Env, admin: &Address, price_feed: &Address);
-
-    /// Set supported option types for a destination endpoint (ADMIN_ROLE only)
-    fn set_supported_option_types(env: &Env, admin: &Address, eid: u32, option_types: Bytes);
-
-    /// Set the worker fee library address (ADMIN_ROLE only)
-    fn set_worker_fee_lib(env: &Env, admin: &Address, worker_fee_lib: &Address);
-
-    // ========================================================================
-    // View Functions
-    // ========================================================================
-
-    /// Check if the worker is paused
-    fn paused(env: &Env) -> bool;
-
-    /// Get the default multiplier in basis points
-    fn default_multiplier_bps(env: &Env) -> u32;
-
-    /// Get the deposit address
-    fn deposit_address(env: &Env) -> Address;
-
-    /// Get the current price feed address
-    fn price_feed(env: &Env) -> Address;
-
-    /// Get supported option types for a destination endpoint
-    fn get_supported_option_types(env: &Env, eid: u32) -> Bytes;
-
-    /// Get the worker fee library address
-    fn worker_fee_lib(env: &Env) -> Address;
-
-    /// Check if an address has ACL permission
-    /// ACL logic (matching EVM Worker.sol):
-    /// 1) if address has DENYLIST role -> deny
-    /// 2) else if allowlist is empty (size == 0) OR address has ALLOWLIST role -> allow
-    /// 3) else deny
-    fn has_acl(env: &Env, sender: &Address) -> bool;
-
-    /// Get the size of the allowlist (number of accounts with ALLOWLIST role)
-    fn allowlist_size(env: &Env) -> u32;
-}

package/contracts/workers/worker-common/src/lib.rs

@@ -1,19 +0,0 @@
-#![no_std]
-
-mod interfaces;
-mod worker_common;
-
-pub mod constants;
-pub mod errors;
-pub mod events;
-pub mod storage;
-
-pub use constants::*;
-pub use errors::*;
-pub use events::*;
-pub use interfaces::*;
-pub use storage::*;
-pub use worker_common::*;
-
-// #[cfg(test)]
-// mod tests;

package/contracts/workers/worker-common/src/storage.rs

@@ -1,32 +0,0 @@
-use common_macros::storage;
-use soroban_sdk::{Address, Bytes};
-use utils::ttl::DefaultTtlConfigProvider;
-
-// ============================================================================
-// Worker Storage
-// ============================================================================
-// Note: Access control (roles) are managed by OpenZeppelin AccessControl module
-// We only keep worker-specific data here
-
-#[storage(DefaultTtlConfigProvider)]
-pub enum WorkerData {
-    /// Address where fees are deposited
-    #[instance(Address)]
-    DepositAddress,
-
-    /// Price feed address for fee calculation
-    #[instance(Address)]
-    PriceFeed,
-
-    /// Worker fee library address
-    #[instance(Address)]
-    WorkerFeeLib,
-
-    /// Default multiplier in basis points for fee calculation
-    #[instance(u32)]
-    DefaultMultiplierBps,
-
-    /// Supported option types for a destination EID
-    #[persistent(Bytes)]
-    SupportedOptionTypes { eid: u32 },
-}