Contract fb3b11042a126ff4b28846ebf439eb6877da62b9033f5cceab4e0f65a943575b

← Back to Index 📥 Download WASM

Meta

cliver 25.1.0#a048a57a75762458b487052e0021ea704a926bee
rssdkver 25.1.1#94c2a3b3a5ded6b9cf9cef0c207bf8804f3eb294
rsver 1.90.0

Instances

  • CB6V7VT2K6GIZ5SCY63VC3SDE3JWKNG5YENRTKSV5FP442XQL5S47G2Z
  • CBOS5YIVTGSX4XRFWOBB67D5O2Z7TBO3JDUPMMRDQZY5AJX22GSVSCPZ
  • CDGYJDTBFE5CFWAJX4AYHDDGNDUOFRCHNPEHDGRCQHWSAXN6PDXVRG3E
  • CDJZFWRYS2NLGVNDIN2BUUTP5UB27GFGKZE5QE3BPCEOWVDRPSDOX5QM

Interface

Retrieves the OApp version information.

Returns

A tuple containing:

  • sender_version: The version of the OAppSender
  • receiver_version: The version of the OAppReceiver
fn oapp_version(env: soroban_sdk::Env) -> (u64, u64)

Retrieves the LayerZero endpoint address associated with the OApp.

Returns

The LayerZero endpoint address

fn endpoint(env: soroban_sdk::Env) -> soroban_sdk::Address

Retrieves the peer (OApp) associated with a corresponding endpoint.

Arguments

  • eid - The endpoint ID

Returns

The peer address (OApp instance) associated with the corresponding endpoint

fn peer(env: soroban_sdk::Env, eid: u32) -> Option>

Sets or removes the peer address (OApp instance) for a corresponding endpoint.

Arguments

  • eid - The endpoint ID
  • peer - The address of the peer to be associated with the corresponding endpoint, or None to remove the peer
  • operator - The authorizer address
fn set_peer(
    env: soroban_sdk::Env,
    eid: u32,
    peer: Option>,
    operator: soroban_sdk::Address,
)

Sets the delegate address for the OApp Core.

Arguments

  • delegate - The address of the delegate to be set, or None to remove the delegate
  • operator - The authorizer address
fn set_delegate(
    env: soroban_sdk::Env,
    delegate: Option,
    operator: soroban_sdk::Address,
)

Grants a role to an account. Caller must be owner or have the role's admin role.

Arguments

  • account - The account to grant the role to.
  • role - The role to grant.
  • caller - The account that is granting the role. Must be owner or have the role's admin role.
fn grant_role(
    env: soroban_sdk::Env,
    account: soroban_sdk::Address,
    role: soroban_sdk::Symbol,
    caller: soroban_sdk::Address,
)

Revokes a role from an account. Caller must be owner or have the role's admin role.

Arguments

  • account - The account to revoke the role from.
  • role - The role to revoke.
  • caller - The account that is revoking the role. Must be owner or have the role's admin role.
fn revoke_role(
    env: soroban_sdk::Env,
    account: soroban_sdk::Address,
    role: soroban_sdk::Symbol,
    caller: soroban_sdk::Address,
)

Allows an account to renounce a role assigned to itself. Users can only renounce roles for their own account.

Arguments

  • role - The role to renounce.
  • caller - The account that is renouncing the role. Must be the account itself.
fn renounce_role(
    env: soroban_sdk::Env,
    role: soroban_sdk::Symbol,
    caller: soroban_sdk::Address,
)

Sets admin_role as the admin role of role. Caller must be the authorizer.

Arguments

  • role - The role to set the admin for.
  • admin_role - The admin role to set for the role.

Notes

The admin role can be any Symbol, including one with no members. If the admin role has no members, only the authorizer can grant/revoke the role.

fn set_role_admin(
    env: soroban_sdk::Env,
    role: soroban_sdk::Symbol,
    admin_role: soroban_sdk::Symbol,
)

Removes the admin role for a specified role. Caller must be the authorizer.

Arguments

  • role - The role to remove the admin for.

Errors

  • RbacError::AdminRoleNotFound - If no admin role is set for the role.
fn remove_role_admin(env: soroban_sdk::Env, role: soroban_sdk::Symbol)

Returns Some(index) if the account has the specified role, where index is the index of the account in the role. Returns None if not.

Arguments

  • account - The account to check the role for.
  • role - The role to check the account for.
fn has_role(
    env: soroban_sdk::Env,
    account: soroban_sdk::Address,
    role: soroban_sdk::Symbol,
) -> Option

Returns the admin role for a specific role, or None if not set.

Arguments

  • role - The role to get the admin for.
fn get_role_admin(
    env: soroban_sdk::Env,
    role: soroban_sdk::Symbol,
) -> Option

Returns the number of accounts that have the specified role.

Arguments

  • role - The role to get the member count for.
fn get_role_member_count(env: soroban_sdk::Env, role: soroban_sdk::Symbol) -> u32

Returns the account at the specified index for a given role.

Arguments

  • role - The role to get the member for.
  • index - The index of the member to get.

Errors

  • RbacError::IndexOutOfBounds if the index is out of bounds.
fn get_role_member(
    env: soroban_sdk::Env,
    role: soroban_sdk::Symbol,
    index: u32,
) -> soroban_sdk::Address

Returns all roles that currently have at least one member. Defaults to empty vector if no roles exist.

Notes

This function returns all roles that currently have at least one member. The maximum number of roles is limited by [MAX_ROLES].

fn get_existing_roles(env: soroban_sdk::Env) -> soroban_sdk::Vec

Retrieves the enforced options for a given endpoint and message type.

Arguments

  • eid - The endpoint ID
  • msg_type - The OApp message type

Returns

The enforced options for the given endpoint and message type

fn enforced_options(
    env: soroban_sdk::Env,
    eid: u32,
    msg_type: u32,
) -> Option

Sets or removes the enforced options for specific endpoint and message type combinations.

Only the authorizer of the OApp can call this function. Provides a way for the OApp to enforce things like paying for PreCrime, AND/OR minimum dst lzReceive gas amounts etc. These enforced options can vary as the potential options/execution on the remote may differ as per the msg_type. e.g. Amount of lzReceive() gas necessary to deliver a lzCompose() message adds overhead you don't want to pay if you are only making a standard LayerZero message ie. lzReceive() WITHOUT sendCompose().

Arguments

  • options - A vector of EnforcedOptionParam structures specifying enforced options
  • operator - The authorizer address
fn set_enforced_options(
    env: soroban_sdk::Env,
    options: soroban_sdk::Vec,
    operator: soroban_sdk::Address,
)

Combines options for a given endpoint and message type.

If there is an enforced lzReceive option:

  • {gas_limit: 200k, value: 1 XLM} AND a caller supplies a lzReceive option: {gas_limit: 100k, value: 0.5 XLM}
  • The resulting options will be {gas_limit: 300k, value: 1.5 XLM} when the message is executed on the remote lz_receive() function. The presence of duplicated options is handled off-chain in the verifier/executor.

Arguments

  • eid - The endpoint ID
  • msg_type - The OApp message type
  • extra_options - Additional options passed by the caller

Returns

The combination of caller specified options AND enforced options

fn combine_options(
    env: soroban_sdk::Env,
    eid: u32,
    msg_type: u32,
    extra_options: soroban_sdk::Bytes,
) -> soroban_sdk::Bytes
fn authorizer(env: soroban_sdk::Env) -> Option

Returns the current owner address, or None if no owner is set.

fn owner(env: soroban_sdk::Env) -> Option

Returns the pending owner address for 2-step transfer, or None if no transfer is pending.

fn pending_owner(env: soroban_sdk::Env) -> Option

Transfers ownership immediately to a new address.

Use with caution - if you transfer to a wrong address, ownership is lost forever. Consider using begin_ownership_transfer instead.

Panics

  • OwnerNotSet if no owner is currently set
  • TransferInProgress if a 2-step transfer is in progress
fn transfer_ownership(env: soroban_sdk::Env, new_owner: soroban_sdk::Address)

Begins an ownership transfer to a new address.

The new owner must call accept_ownership() within ttl ledgers to complete the transfer. The pending transfer will automatically expire after.

Arguments

  • new_owner - The proposed new owner
  • ttl - Number of ledgers the new owner has to accept. Use 0 to cancel a pending transfer (new_owner must match pending).

Panics

  • OwnerNotSet if no owner is currently set
  • NoPendingTransfer when cancelling and no pending transfer exists
  • InvalidTtl if ttl exceeds max TTL
  • InvalidPendingOwner when cancelling with wrong new_owner address
fn begin_ownership_transfer(
    env: soroban_sdk::Env,
    new_owner: soroban_sdk::Address,
    ttl: u32,
)

Accepts a pending 2-step ownership transfer.

Must be called by the pending owner before the TTL expires.

Panics

  • NoPendingTransfer if there is no pending transfer (or it expired)
fn accept_ownership(env: soroban_sdk::Env)

Permanently renounces ownership.

Panics

  • OwnerNotSet if no owner is currently set
  • TransferInProgress if a 2-step transfer is in progress (cancel it first)
fn renounce_ownership(env: soroban_sdk::Env)

Extends the instance TTL.

Arguments

  • threshold - The threshold to extend the TTL (if current TTL is below this, extend).
  • extend_to - The TTL to extend to.
fn extend_instance_ttl(env: soroban_sdk::Env, threshold: u32, extend_to: u32)

Sets TTL configs for instance and persistent storage.

  • None values remove the corresponding config (disables auto-extension for that type)
  • Validates that threshold <= extend_to <= MAX_TTL

Arguments

  • instance - TTL config for instance storage
  • persistent - TTL config for persistent storage

Panics

  • TtlConfigFrozen if configs are frozen
  • InvalidTtlConfig if validation fails
fn set_ttl_configs(
    env: soroban_sdk::Env,
    instance: Option,
    persistent: Option,
)

Returns the current TTL configs as (instance_config, persistent_config).

fn ttl_configs(env: soroban_sdk::Env) -> (Option, Option)

Permanently freezes TTL configs, preventing any future modifications.

This is irreversible and provides immutability guarantees to users. Emits TtlConfigsFrozen event.

Panics

  • TtlConfigAlreadyFrozen if already frozen
fn freeze_ttl_configs(env: soroban_sdk::Env)

Returns whether TTL configs are frozen.

fn is_ttl_configs_frozen(env: soroban_sdk::Env) -> bool
fn __constructor(
    env: soroban_sdk::Env,
    owner: soroban_sdk::Address,
    endpoint: soroban_sdk::Address,
    delegate: soroban_sdk::Address,
)
fn quote(
    env: soroban_sdk::Env,
    dst_eid: u32,
    msg_type: u32,
    options: soroban_sdk::Bytes,
    pay_in_zro: bool,
) -> MessagingFee
fn increment(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    dst_eid: u32,
    msg_type: u32,
    options: soroban_sdk::Bytes,
    fee: MessagingFee,
)
fn set_ordered_nonce(env: soroban_sdk::Env, ordered_nonce: bool)
fn skip_inbound_nonce(
    env: soroban_sdk::Env,
    src_eid: u32,
    sender: soroban_sdk::BytesN<32>,
    nonce: u64,
)
fn withdraw(env: soroban_sdk::Env, to: soroban_sdk::Address, amount: i128)
fn eid(env: soroban_sdk::Env) -> u32
fn count(env: soroban_sdk::Env) -> u64
fn composed_count(env: soroban_sdk::Env) -> u64
fn inbound_count(env: soroban_sdk::Env, eid: u32) -> u64
fn outbound_count(env: soroban_sdk::Env, eid: u32) -> u64
fn next_nonce(
    env: soroban_sdk::Env,
    src_eid: u32,
    sender: soroban_sdk::BytesN<32>,
) -> u64

Checks if a messaging path can be initialized for the given origin.

Arguments

  • origin - The origin of the message

Returns

True if the path can be initialized, false otherwise

fn allow_initialize_path(env: soroban_sdk::Env, origin: Origin) -> bool

Entry point for receiving messages or packets from the LayerZero endpoint.

The default implementation calls clear_payload_and_transfer to validate the message and clear it from the endpoint, then delegates to __lz_receive for application logic.

Arguments

  • executor - The address of the executor for the received message
  • origin - The origin information containing the source endpoint and sender address:
  • src_eid: The source chain endpoint ID
  • sender: The sender address on the source chain
  • nonce: The nonce of the message
  • guid - The unique identifier for the received LayerZero message
  • message - The payload of the received message
  • extra_data - Additional arbitrary data provided by the corresponding executor
  • value - The native token value sent with the message
fn lz_receive(
    env: soroban_sdk::Env,
    executor: soroban_sdk::Address,
    origin: Origin,
    guid: soroban_sdk::BytesN<32>,
    message: soroban_sdk::Bytes,
    extra_data: soroban_sdk::Bytes,
    value: i128,
)

Indicates whether an address is an approved composeMsg sender to the Endpoint.

Applications can optionally choose to implement separate composeMsg senders that are NOT the bridging layer. The default sender IS the OAppReceiver implementer.

Arguments

  • origin - The origin information containing the source endpoint and sender address
  • message - The lzReceive payload
  • sender - The sender address to check

Returns

True if the sender is a valid composeMsg sender, false otherwise

fn is_compose_msg_sender(
    env: soroban_sdk::Env,
    origin: Origin,
    message: soroban_sdk::Bytes,
    sender: soroban_sdk::Address,
) -> bool
fn lz_compose(
    env: soroban_sdk::Env,
    executor: soroban_sdk::Address,
    from: soroban_sdk::Address,
    guid: soroban_sdk::BytesN<32>,
    index: u32,
    message: soroban_sdk::Bytes,
    extra_data: soroban_sdk::Bytes,
    value: i128,
)

Imports

WebAssembly Text (WAT) ▶