Upgrades the contract to new WASM bytecode.
fn upgrade(env: soroban_sdk::Env, new_wasm_hash: soroban_sdk::BytesN<32>)
Runs migration logic after an upgrade.
fn migrate(env: soroban_sdk::Env, migration_data: 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.
OwnerNotSet if no owner is currently setTransferInProgress if a 2-step transfer is in progressfn 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.
new_owner - The proposed new ownerttl - Number of ledgers the new owner has to accept.
Use 0 to cancel a pending transfer (new_owner must match pending).OwnerNotSet if no owner is currently setNoPendingTransfer when cancelling and no pending transfer existsInvalidTtl if ttl exceeds max TTLInvalidPendingOwner when cancelling with wrong new_owner addressfn 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.
NoPendingTransfer if there is no pending transfer (or it expired)fn accept_ownership(env: soroban_sdk::Env)
Permanently renounces ownership.
OwnerNotSet if no owner is currently setTransferInProgress if a 2-step transfer is in progress (cancel it first)fn renounce_ownership(env: soroban_sdk::Env)
Extends the instance TTL.
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)threshold <= extend_to <= MAX_TTLinstance - TTL config for instance storagepersistent - TTL config for persistent storageTtlConfigFrozen if configs are frozenInvalidTtlConfig if validation failsfn 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.
TtlConfigAlreadyFrozen if already frozenfn 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,
uln302: soroban_sdk::Address,
)
Returns the endpoint address.
fn endpoint(env: soroban_sdk::Env) -> soroban_sdk::Address
Returns the Uln302 address.
fn uln302(env: soroban_sdk::Env) -> soroban_sdk::Address
Returns the local endpoint ID.
fn local_eid(env: soroban_sdk::Env) -> u32
Checks if a messaging path can be initialized for the given origin and receiver.
fn initializable(
env: soroban_sdk::Env,
origin: Origin,
receiver: soroban_sdk::Address,
) -> bool
Checks if a message can be verified at the endpoint.
Verifies:
fn verifiable(
env: soroban_sdk::Env,
origin: Origin,
receiver: soroban_sdk::Address,
receive_lib: soroban_sdk::Address,
payload_hash: soroban_sdk::BytesN<32>,
) -> bool
Returns the execution state of a message.
fn executable(
env: soroban_sdk::Env,
origin: Origin,
receiver: soroban_sdk::Address,
) -> ExecutionState
Returns the combined verification state of a message.
This function checks:
fn uln_verifiable(
env: soroban_sdk::Env,
packet_header: soroban_sdk::Bytes,
payload_hash: soroban_sdk::BytesN<32>,
) -> VerificationState