Interface FundCAddressWithReferralOptions

Options for funding a single C-address via OnboardingBridgeSDK.fundCAddress.

Example

const result = await sdk.fundCAddress(
  {
    source: keypair.publicKey(),   // G-address of the sender
    target: 'CC...',               // destination C-address
    asset:  'CD...',               // token contract (e.g. USDC)
    amount: '10000000',            // 1 USDC (7 decimal places)
  },
  keypair,
);
interface FundCAddressWithReferralOptions {
    amount: string;
    asset: string;
    deadline?: string | number | bigint;
    nonce?: string | number | bigint;
    referrer?: string;
    source: string;
    target: string;
}

Hierarchy (view full)

Properties

amount asset deadline? nonce? referrer? source target

Properties

amount

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

asset: string

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

Optionaldeadline

deadline?: string | number | bigint

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

Optionalnonce

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).

Optionalreferrer

referrer?: string

Optional referrer address that receives a configured share of the fee.

source

source: string

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

target

target: string

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

Settings

Member Visibility

On This Page

Properties