fn upgrade(
env: soroban_sdk::Env,
new_wasm_hash: soroban_sdk::BytesN<32>,
operator: soroban_sdk::Address,
)Initialise the protocol. Sets the owner and the initial StreamConfig.
fn __constructor(
env: soroban_sdk::Env,
admin: soroban_sdk::Address,
config: StreamConfig,
) -> Result<(), StreamError>fn get_config(env: soroban_sdk::Env) -> StreamConfigfn is_sender_whitelisted(env: soroban_sdk::Env, sender: soroban_sdk::Address) -> boolfn whitelist_tokens(
env: soroban_sdk::Env,
tokens: soroban_sdk::Vec,
) -> Result<(), StreamError> fn remove_whitelisted_token(
env: soroban_sdk::Env,
token: soroban_sdk::Address,
) -> Result<(), StreamError>fn whitelist_senders(
env: soroban_sdk::Env,
senders: soroban_sdk::Vec,
) fn remove_whitelisted_sender(env: soroban_sdk::Env, sender: soroban_sdk::Address)fn set_fee_config(
env: soroban_sdk::Env,
fee_recipient: soroban_sdk::Address,
withdraw_account: soroban_sdk::Address,
platform_fee: i64,
base_fee: i64,
fee_tiers: soroban_sdk::Vec,
) -> Result<(), StreamError> fn set_frequencies(
env: soroban_sdk::Env,
frequencies: soroban_sdk::Vec,
) -> Result<(), StreamError> Atomically update all mutable config fields in one call.
fn update_config(
env: soroban_sdk::Env,
fee_recipient: soroban_sdk::Address,
withdraw_account: soroban_sdk::Address,
platform_fee: i64,
base_fee: i64,
fee_tiers: soroban_sdk::Vec,
frequencies: soroban_sdk::Vec,
) -> Result<(), StreamError> Read back the tenant fee config for sender. Returns None if not set (uses global).
fn get_tenant_config(
env: soroban_sdk::Env,
sender: soroban_sdk::Address,
) -> OptionSet (or overwrite) a per-tenant fee config for sender.
When set, streams created by sender will route fees to fee_recipient
using this fee schedule instead of the global config.
fn set_tenant_config(
env: soroban_sdk::Env,
sender: soroban_sdk::Address,
fee_recipient: soroban_sdk::Address,
withdraw_account: soroban_sdk::Address,
platform_fee: i64,
base_fee: i64,
fee_tiers: soroban_sdk::Vec,
) -> Result<(), StreamError> Remove the per-tenant fee config for sender. Streams will fall back to global config.
fn remove_tenant_config(env: soroban_sdk::Env, sender: soroban_sdk::Address)Create a new payment stream.
stream_id must be unique random bytes — generate with
crypto.getRandomValues(new Uint8Array(32)) on the client (same as Solana's
freshly generated account keypair). Duplicate IDs are rejected.
fn create_stream(
env: soroban_sdk::Env,
stream_id: soroban_sdk::BytesN<32>,
sender: soroban_sdk::Address,
receiver: soroban_sdk::Address,
token: soroban_sdk::Address,
params: CreateStreamParams,
) -> Result<(), StreamError>fn get_stream(
env: soroban_sdk::Env,
stream_id: soroban_sdk::BytesN<32>,
) -> PaymentStreamfn get_withdrawable_amount(
env: soroban_sdk::Env,
stream_id: soroban_sdk::BytesN<32>,
) -> i64fn pause_resume_stream(
env: soroban_sdk::Env,
stream_id: soroban_sdk::BytesN<32>,
) -> Result<(), StreamError>fn cancel_stream(
env: soroban_sdk::Env,
stream_id: soroban_sdk::BytesN<32>,
caller: soroban_sdk::Address,
) -> Result<(), StreamError>fn withdraw_stream(
env: soroban_sdk::Env,
stream_id: soroban_sdk::BytesN<32>,
caller: soroban_sdk::Address,
) -> Result<(), StreamError>fn change_recipient(
env: soroban_sdk::Env,
stream_id: soroban_sdk::BytesN<32>,
caller: soroban_sdk::Address,
new_receiver: soroban_sdk::Address,
) -> Result<(), StreamError>Manual top-up: sender must sign.
fn topup_stream(
env: soroban_sdk::Env,
stream_id: soroban_sdk::BytesN<32>,
amount: i64,
) -> Result<(), StreamError>Automatic top-up: any caller may trigger. Security gate is the SAC allowance.
fn trigger_topup(
env: soroban_sdk::Env,
stream_id: soroban_sdk::BytesN<32>,
amount: i64,
) -> Result<(), StreamError>Returns Some(Address) if ownership is set, or None if ownership has
been renounced.
e - Access to the Soroban environment.fn get_owner(env: soroban_sdk::Env) -> OptionInitiates a 2-step ownership transfer to a new address.
Requires authorization from the current owner. The new owner must later
call accept_ownership() to complete the transfer.
e - Access to the Soroban environment.new_owner - The proposed new owner.live_until_ledger - Ledger number until which the new owner can
accept. A value of 0 cancels any pending transfer.OwnableError::OwnerNotSet] - If the owner is not set.crate::role_transfer::RoleTransferError::NoPendingTransfer] - If
trying to cancel a transfer that doesn't exist.crate::role_transfer::RoleTransferError::InvalidLiveUntilLedger] -
If the specified ledger is in the past.crate::role_transfer::RoleTransferError::InvalidPendingAccount] -
If the specified pending account is not the same as the provided new
address.fn transfer_ownership(
env: soroban_sdk::Env,
new_owner: soroban_sdk::Address,
live_until_ledger: u32,
)Accepts a pending ownership transfer.
e - Access to the Soroban environment.crate::role_transfer::RoleTransferError::NoPendingTransfer] - If
there is no pending transfer to accept.["ownership_transfer_completed"][new_owner: Address]fn accept_ownership(env: soroban_sdk::Env)Renounces ownership of the contract.
Permanently removes the owner, disabling all functions gated by
#[only_owner].
e - Access to the Soroban environment.OwnableError::TransferInProgress] - If there is a pending ownership
transfer.OwnableError::OwnerNotSet] - If the owner is not set.fn renounce_ownership(env: soroban_sdk::Env)fn paused(env: soroban_sdk::Env) -> boolfn pause(env: soroban_sdk::Env, caller: soroban_sdk::Address)fn unpause(env: soroban_sdk::Env, caller: soroban_sdk::Address)