Options for creating a timelocked C-address funding entry via OnboardingBridgeSDK.fundCAddressTimelocked.

interface FundCTimelockedOptions {
    amount: string;
    asset: string;
    cliffTime?: number;
    deadline?: string | number | bigint;
    nonce?: string | number | bigint;
    releaseTime: number;
    source: string;
    target: string;
}

Hierarchy (view full)

Properties

amount: string

Gross transfer amount in the token's smallest unit. For a token with 7 decimal places, "10000000" equals 1 token. The protocol fee is deducted from this before crediting the target.

asset: string

Token contract address for the asset being transferred. The asset must be whitelisted on the bridge contract.

cliffTime?: number

Optional informational cliff timestamp in seconds. Use 0 when no cliff is needed. If set, it must be less than or equal to releaseTime.

deadline?: string | number | bigint

Optional Unix timestamp (seconds) deadline. If provided and the ledger timestamp exceeds this value, the contract will reject the transaction.

nonce?: string | number | bigint

Optional sequential nonce for replay protection. Pass undefined to skip nonce enforcement (standard Stellar tx replay protection via sequence number applies).

releaseTime: number

Unix timestamp in seconds after which the target can claim the locked funds. Must be strictly in the future when submitted to the contract.

source: string

Source account that authorises the token transfer. Must be a valid G-address (Ed25519 public key).

target: string

Destination C-address (smart contract account) to receive the net funds. Must start with C and be a valid Stellar contract address.