Contract 3501ce63f60937015868c1be897b9185f1aa6f31161685e522a9054516b18c9b

fn migrate(
    env: soroban_sdk::Env,
    migration_data: MigrationData,
    operator: soroban_sdk::Address,
)

Recovers tokens held by the contract to a specified address
Argumentscaller - Address calling the function (must be governor)
tokens - Array of token addresses to recover
to - Address that will receive the recovered tokens
NotesOnly callable by governor
Transfers the entire balance of each token held by the contract
WARNING: Be extremely careful not to withdraw tokens that have been predeposited by users via increase_token_balance
Withdrawing predeposited user tokens will break the accounting system and cause loss of funds for users
This function should only be used to recover tokens accidentally sent to the contract or accumulated protocol fees
Always verify that the amount being recovered does not exceed fees and does not include user predeposits

fn recover(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    tokens: soroban_sdk::Vec,
    to: soroban_sdk::Address,
) -> Result<(), soroban_sdk::Error>

fn upgrade(
    env: soroban_sdk::Env,
    new_wasm_hash: soroban_sdk::BytesN<32>,
    operator: soroban_sdk::Address,
)

Updates the default fee rate applied to campaign creation
Argumentscaller - Address calling the function (must be governor or guardian)
default_fees - New default fee rate in base 10^9
NotesOnly callable by governor or guardian
Fee rate must be less than BASE_9 (100%)

fn set_fees(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    default_fees: i128,
) -> Result<(), soroban_sdk::Error>

Returns the terms and conditions message
ReturnsOption<String> - The message, or None if not set

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

Updates the terms and conditions that users must accept before creating campaigns
Argumentscaller - Address calling the function (must be governor or guardian)
message - New terms and conditions message text
NotesOnly callable by governor or guardian
Automatically computes and stores the keccak256 hash
The message may be a link to the full terms hosted offchain

fn set_message(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    message: soroban_sdk::String,
) -> Result<(), soroban_sdk::Error>

Returns the original parameters of a campaign
Argumentscampaign_id - ID of the campaign to retrieve
ReturnsCampaignParameters - Campaign parameters as originally created
NotesReturns original parameters even if the campaign has been overridden

fn get_campaign(
    env: soroban_sdk::Env,
    campaign_id: soroban_sdk::BytesN<32>,
) -> Result

Initializes the contract with access control, distributor, and default fees
Argumentsaccess_control_manager - Address of the access control manager contract
distributor - Address of the Distributor contract
default_fees - Default fee rate in base 10^9 (must be less than BASE_9)

fn __constructor(
    env: soroban_sdk::Env,
    access_control_manager: soroban_sdk::Address,
    distributor: soroban_sdk::Address,
    default_fees: i128,
) -> Result<(), soroban_sdk::Error>

Returns the fee rebate for a specific user
Argumentsuser - The user address to query
Returnsi128 - The fee rebate percentage for the user in base 10^9

fn get_fee_rebate(env: soroban_sdk::Env, user: soroban_sdk::Address) -> i128

Returns the array index of a campaign in the campaign list
Argumentscampaign_id - ID of the campaign to look up
Returnsu32 - Zero-based index of the campaign in the campaignList array
NotesReverts if the campaign does not exist

fn campaign_lookup(
    env: soroban_sdk::Env,
    campaign_id: soroban_sdk::BytesN<32>,
) -> Result

Creates a new reward distribution campaign
Argumentscaller - Address creating the campaign
new_campaign - Parameters defining the campaign structure and rewards
ReturnsBytesN<32> - Unique identifier for the newly created campaign
NotesCampaigns with invalid formatting may not be processed by the reward engine, potentially losing rewards
Reward tokens must be whitelisted and amounts must exceed the token-specific minimum threshold
Reverts if the sender has not accepted the terms and conditions via accept_conditions()

fn create_campaign(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    new_campaign: CampaignParameters,
) -> Result, soroban_sdk::Error>

Returns the Distributor contract address
ReturnsAddress - The Distributor contract address

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

Creates multiple reward distribution campaigns in a single transaction
Argumentscaller - Address creating the campaigns
campaigns - Array of campaign parameters to create
ReturnsVec<BytesN<32>> - Array of campaign IDs for all newly created campaigns

fn create_campaigns(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    campaigns: soroban_sdk::Vec,
) -> Result>, soroban_sdk::Error>

Returns the default fee rate
Returnsi128 - The default fee rate in base 10^9

fn get_default_fees(env: soroban_sdk::Env) -> i128

Returns the hash of the terms and conditions
ReturnsOption<BytesN<32>> - The message hash, or None if not set

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

Allows a user to accept Merkl's terms and conditions to enable campaign creation
Argumentscaller - User accepting the conditions
NotesIf the conditions change (through set_message), users must accept again the new terms
If the messageHash is not set, it means that there are no conditions to accept

fn accept_conditions(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
) -> Result<(), soroban_sdk::Error>

Returns a campaign from the campaign list by its array index
Argumentsarray_index - The zero-based index in the campaign list
ReturnsCampaignParameters - The campaign at the specified index
NotesReturns the original campaign parameters even if overridden

fn get_campaign_list(
    env: soroban_sdk::Env,
    array_index: u32,
) -> Result

Returns the fee recipient address
ReturnsOption<Address> - The fee recipient address, or None if not set

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

Returns the complete list of all reward tokens (including those no longer whitelisted)
ReturnsVec<Address> - Array of all reward token addresses

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

Updates parameters of an existing campaign while preserving core immutable fields
Argumentscaller - Address requesting the override (must be creator or authorized operator)
campaign_id - ID of the campaign to override
new_campaign - New campaign parameters (some fields will be ignored or validated)
NotesCannot change rewardToken, amount, or creator address — caller-provided values for these fields are silently ignored
Can only update startTimestamp if the campaign has not yet started
The amount per hour must meet the reward token minimum (amount * HOUR >= minAmount * duration)
The Merkl engine validates overrides and rejects invalid modifications, including attempts to circumvent campaign-specific fee rates
The rejection of invalid modifications leads to the campaign being parsed as invalid and the leftover reward tokens allocated to the campaign creator address
Invalid overrides may result in the campaign not being processed while fees are still deducted

fn override_campaign(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    campaign_id: soroban_sdk::BytesN<32>,
    new_campaign: CampaignParameters,
) -> Result<(), soroban_sdk::Error>

Sets campaign-type-specific fee rates that override the default fee
Argumentscaller - Address calling the function (must be governor or guardian)
campaign_type - Type identifier for the campaign
fees - Fee rate for this campaign type in base 10^9
NotesOnly callable by governor or guardian
Set fee to 1 to effectively waive fees for a campaign type
Fee rate must be less than BASE_9 (100%)

fn set_campaign_fees(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    campaign_type: u32,
    fees: i128,
) -> Result<(), soroban_sdk::Error>

Updates the address that receives protocol fees from campaign creation
Argumentscaller - Address calling the function (must be governor)
fee_recipient - New fee recipient address
NotesOnly callable by governor

fn set_fee_recipient(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    fee_recipient: soroban_sdk::Address,
) -> Result<(), soroban_sdk::Error>

Returns the total number of campaigns in the campaign list
Returnsu32 - The total count of campaigns

fn get_campaign_count(env: soroban_sdk::Env) -> u32

Returns the hash of the conditions a user has accepted
Argumentsuser - The user address to query
ReturnsOption<BytesN<32>> - The hash of accepted conditions, or None if user hasn't signed

fn get_user_signature(
    env: soroban_sdk::Env,
    user: soroban_sdk::Address,
) -> Option>

Computes the unique campaign ID for a given set of campaign parameters
Argumentscampaign - Campaign parameters to hash
ReturnsBytesN<32> - Unique campaign ID derived from hashing key parameters
NotesCampaign ID is computed as keccak256 of the campaign parameters

fn compute_campaign_id(
    env: soroban_sdk::Env,
    campaign: CampaignParameters,
) -> soroban_sdk::BytesN<32>

Extends the TTL of the contract instance, code, and key persistent entries
NotesCallable by anyone — keeping the contract alive is a public good
Extends instance storage (which includes all Instance entries and the contract code)
Extends global persistent entries (RewardTokenCount, CampaignCount) that are shared across all users
Individual Campaign(i) and RewardToken(i) entries are extended when accessed
For bulk TTL extension of campaign entries, use extend_campaign_ttl_batch()

fn extend_contract_ttl(env: soroban_sdk::Env)

Returns the predeposited balance for a creator and reward token
Argumentscreator - The creator address to query
token - The reward token address to query
Returnsi128 - The predeposited balance amount

fn get_creator_balance(
    env: soroban_sdk::Env,
    creator: soroban_sdk::Address,
    token: soroban_sdk::Address,
) -> i128

Updates the Distributor contract address that receives and distributes rewards
Argumentscaller - Address calling the function (must be governor)
distributor - New Distributor contract address
NotesOnly callable by governor

fn set_new_distributor(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    distributor: soroban_sdk::Address,
) -> Result<(), soroban_sdk::Error>

Sets a fee rebate for a specific user
Argumentscaller - Address calling the function (must be governor or guardian)
user - User address receiving the fee rebate
user_fee_rebate - Rebate amount in base 10^9
NotesOnly callable by governor or guardian
Rebate must be less than BASE_9 (100%), same bound as fee rates

fn set_user_fee_rebate(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    user: soroban_sdk::Address,
    user_fee_rebate: i128,
) -> Result<(), soroban_sdk::Error>

Returns whether an operator is authorized to create campaigns on behalf of a user
Argumentsuser - The user address to query
operator - The operator address to query
Returnsbool - True if operator is authorized, false otherwise

fn get_campaign_operator(
    env: soroban_sdk::Env,
    user: soroban_sdk::Address,
    operator: soroban_sdk::Address,
) -> bool

Returns the override parameters for a campaign
Argumentscampaign_id - The campaign ID to query
ReturnsOption<CampaignParameters> - The override parameters, or None if no override exists

fn get_campaign_override(
    env: soroban_sdk::Env,
    campaign_id: soroban_sdk::BytesN<32>,
) -> Option

Returns the allowance for an operator to spend a creator's predeposited tokens
Argumentscreator - The creator address to query
operator - The operator address to query
token - The reward token address to query
Returnsi128 - The allowance amount

fn get_creator_allowance(
    env: soroban_sdk::Env,
    creator: soroban_sdk::Address,
    operator: soroban_sdk::Address,
    token: soroban_sdk::Address,
) -> i128

Permanently disables contract upgradeability

fn revoke_upgradeability(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
) -> Result<(), soroban_sdk::Error>

Decreases a user's predeposited token balance and transfers tokens out
Argumentscaller - Address requesting the withdrawal (must be user or governor)
user - Address whose balance will be decreased
reward_token - Token to withdraw
to - Address that will receive the withdrawn tokens
amount - Amount to withdraw
NotesOnly callable by the user themselves or a governor

fn decrease_token_balance(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    user: soroban_sdk::Address,
    reward_token: soroban_sdk::Address,
    to: soroban_sdk::Address,
    amount: i128,
) -> Result<(), soroban_sdk::Error>

Increases a user's predeposited token balance for campaign funding
Argumentscaller - Address initiating the deposit
user - Address whose balance will be increased
reward_token - Token to deposit
amount - Amount to deposit
NotesWhen called by a governor, the user must have sent tokens to the contract beforehand
Can be used to deposit on behalf of another user
WARNING: Do not use with any non strictly standard tokens (like rebasing tokens) as they will cause accounting issues

fn increase_token_balance(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    user: soroban_sdk::Address,
    reward_token: soroban_sdk::Address,
    amount: i128,
) -> Result<(), soroban_sdk::Error>

Returns the persisted storage schema version (0 if unversioned legacy state).

fn contract_schema_version(env: soroban_sdk::Env) -> u32

Returns all whitelisted reward tokens and their minimum required amounts
ReturnsVec<RewardTokenAmount> - Array of reward tokens with their minimum amounts per epoch
NotesNot optimized for onchain queries; intended for off-chain/API use

fn get_valid_reward_tokens(
    env: soroban_sdk::Env,
) -> Result, soroban_sdk::Error>

Decreases an operator's allowance to spend a user's predeposited tokens
Argumentscaller - Address reducing the allowance (must be user or governor)
user - User reducing the allowance
operator - Operator whose allowance is being reduced
reward_token - Token for which allowance is reduced
amount - Amount to decrease the allowance by
NotesOnly callable by the user themselves or a governor

fn decrease_token_allowance(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    user: soroban_sdk::Address,
    operator: soroban_sdk::Address,
    reward_token: soroban_sdk::Address,
    amount: i128,
) -> Result<(), soroban_sdk::Error>

Increases an operator's allowance to spend a user's predeposited tokens
Argumentscaller - Address granting the allowance (must be user or governor)
user - User granting the allowance
operator - Operator receiving spending permission
reward_token - Token for which allowance is granted
amount - Amount to increase the allowance by
NotesOnly callable by the user themselves or a governor

fn increase_token_allowance(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    user: soroban_sdk::Address,
    operator: soroban_sdk::Address,
    reward_token: soroban_sdk::Address,
    amount: i128,
) -> Result<(), soroban_sdk::Error>

Toggles an operator's authorization to create and manage campaigns on behalf of a user
Argumentscaller - Address toggling the authorization (must be user or governor)
user - User granting or revoking operator access
operator - Operator whose authorization is being toggled
NotesOnly callable by the user themselves or a governor
Toggles between authorized (1) and unauthorized (0)

fn toggle_campaign_operator(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    user: soroban_sdk::Address,
    operator: soroban_sdk::Address,
) -> Result<(), soroban_sdk::Error>

Toggles whether a user must sign the terms message before creating campaigns
Argumentscaller - Address calling the function (must be governor or guardian)
user - User address whose whitelist status is being toggled
NotesOnly callable by governor or guardian
Whitelisted users (status = 1) can create campaigns without accepting Merkl terms

fn toggle_signing_whitelist(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    user: soroban_sdk::Address,
) -> Result<(), soroban_sdk::Error>

Extends TTL for a batch of campaign entries
Argumentsstart - Start index (inclusive)
end - End index (exclusive)
NotesCallable by anyone — keeping campaign data alive is a public good
With 100k campaigns, extending all TTLs requires multiple transactions
due to the read limit per tx (~20 campaigns per batch)

fn extend_campaign_ttl_batch(env: soroban_sdk::Env, start: u32, end: u32)

Returns the reallocation target for a specific address within a campaign
Argumentscampaign_id - The campaign ID to query
from - The address whose rewards were reallocated
ReturnsOption<Address> - The target address receiving the reallocated rewards, or None if no reallocation exists

fn get_campaign_reallocation(
    env: soroban_sdk::Env,
    campaign_id: soroban_sdk::BytesN<32>,
    from: soroban_sdk::Address,
) -> Option

Returns the AccessControlManager contract address
ReturnsAddress - The AccessControlManager contract address

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

Returns the specific fee rate for a campaign type
Argumentscampaign_type - The campaign type identifier
ReturnsOption<i128> - The fee rate for this campaign type, or None if using default fees

fn get_campaign_specific_fees(
    env: soroban_sdk::Env,
    campaign_type: u32,
) -> Option

Returns the most up-to-date campaign parameters, including any override.
Argumentscampaign_id - ID of the campaign to retrieve
ReturnsCampaignParameters - The override if one exists, otherwise the original
NotesUsed internally by override_campaign (validates nested overrides against the
latest state) and reallocate_campaign_rewards (gates reallocation on the
effective end timestamp).
Even an invalid override is returned: the off-chain Merkl engine treats invalid
overrides as parsing failures and routes leftover rewards back to the creator.

fn get_latest_campaign_params(
    env: soroban_sdk::Env,
    campaign_id: soroban_sdk::BytesN<32>,
) -> Result

Points this contract at a new AccessControlManager (ACM).
Argumentscaller - Address calling the function (must be a governor in both ACMs)
new_access_control_manager - Address of the ACM to trust going forward
NotesThe caller must be governor according to the current ACM stored on this contract.
The caller must also be governor in new_access_control_manager.
Governor-set parity (all old ACM governors exist in the new ACM) is enforced on-chain.
Migration flow: call old ACM set_access_control_manager(...) first, then call this setter.

fn set_access_control_manager(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    new_access_control_manager: soroban_sdk::Address,
) -> Result<(), soroban_sdk::Error>

Returns the minimum required amount for a reward token
Argumentstoken - The reward token address to query
Returnsi128 - The minimum amount required per epoch, or 0 if token is not whitelisted

fn get_reward_token_min_amount(
    env: soroban_sdk::Env,
    token: soroban_sdk::Address,
) -> i128

Reallocates unclaimed rewards from specific addresses to a new recipient after campaign ends
Argumentscaller - Address requesting the reallocation (must be creator or authorized operator)
campaign_id - ID of the completed campaign to reallocate from
froms - Array of addresses whose unclaimed rewards should be reallocated
to - Address that will receive the reallocated rewards
NotesCan only be called after the campaign has ended. If the campaign has been overridden,
the override's start_timestamp + duration is used as the effective end.
Reallocation validity is determined by the Merkl engine; invalid reallocations are ignored

fn reallocate_campaign_rewards(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    campaign_id: soroban_sdk::BytesN<32>,
    froms: soroban_sdk::Vec,
    to: soroban_sdk::Address,
) -> Result<(), soroban_sdk::Error>

Returns whether a user is whitelisted from signature requirements
Argumentsuser - The user address to query
Returnsbool - True if user is whitelisted, false otherwise

fn get_user_signature_whitelist(
    env: soroban_sdk::Env,
    user: soroban_sdk::Address,
) -> bool

Configures minimum reward amounts per epoch for whitelisted tokens
Argumentscaller - Address calling the function (must be governor or guardian)
tokens - Array of reward token addresses
amounts - Array of minimum amounts (0 = remove from whitelist, >0 = add/update)
NotesOnly callable by governor or guardian
Setting amount to 0 effectively removes the token from the whitelist
Prevents duplicate entries when adding previously removed tokens

fn set_reward_token_min_amounts(
    env: soroban_sdk::Env,
    caller: soroban_sdk::Address,
    tokens: soroban_sdk::Vec,
    amounts: soroban_sdk::Vec,
) -> Result<(), soroban_sdk::Error>

Returns a paginated list of whitelisted reward tokens
Argumentsskip - Number of tokens to skip
first - Maximum number of tokens to return
ReturnsVec<RewardTokenAmount> - Array of reward tokens and their minimum amounts
NotesNot optimized for onchain queries; intended for off-chain/API use

fn get_valid_reward_tokens_paged(
    env: soroban_sdk::Env,
    skip: u32,
    first: u32,
) -> Result, soroban_sdk::Error>

Returns all addresses from which rewards were reallocated for a campaign
Argumentscampaign_id - ID of the campaign
ReturnsVec<Address> - Array of addresses that had rewards reallocated away from them

fn get_campaign_list_reallocation(
    env: soroban_sdk::Env,
    campaign_id: soroban_sdk::BytesN<32>,
) -> Result, soroban_sdk::Error>

Returns whether upgradeability is deactivated
Returnsbool - True if upgradeability is deactivated, false otherwise

fn get_upgradeability_deactivated(env: soroban_sdk::Env) -> bool

Returns all timestamps when a campaign was overridden
Argumentscampaign_id - ID of the campaign
ReturnsVec<u64> - Array of block timestamps when overrides occurred

fn get_campaign_overrides_timestamp(
    env: soroban_sdk::Env,
    campaign_id: soroban_sdk::BytesN<32>,
) -> Result, soroban_sdk::Error>

binver	0.1.0
cliver	25.1.0#
rssdkver	23.4.1#e671b396f8bacf1370925f722df158b31c0baae5
rsver	1.95.0

Contract 3501ce63f60937015868c1be897b9185f1aa6f31161685e522a9054516b18c9b

Meta

Instances

Interface

Arguments

Notes

Arguments

Notes

Returns

Arguments

Notes

Arguments

Returns

Notes

Arguments

Arguments

Returns

Arguments

Returns

Notes

Arguments

Returns

Notes

Returns

Arguments

Returns

Returns

Returns

Arguments

Notes

Arguments

Returns

Notes

Returns

Returns

Arguments

Notes

Arguments

Notes

Arguments

Notes

Returns

Arguments

Returns

Arguments

Returns

Notes

Notes

Arguments

Returns

Arguments

Notes

Arguments

Notes

Arguments

Returns

Arguments

Returns

Arguments

Returns

Arguments

Notes

Arguments

Notes

Returns

Notes

Arguments

Notes

Arguments

Notes

Arguments

Notes

Arguments

Notes

Arguments

Notes

Arguments

Returns

Returns

Arguments