Interface ReclaimTokensOptions

Options for reclaiming tokens accidentally sent directly to the contract address via OnboardingBridgeSDK.reclaimTokens.

Admin only. Intended as an emergency recovery mechanism — reclaims the contract's raw token balance minus any accrued fees for that asset.

await sdk.reclaimTokens(
  { asset: 'CD...', amount: '1000000', to: 'G...safeAddress' },
  adminKeypair,
);

interface ReclaimTokensOptions {
    amount: string;
    asset: string;
    nonce?: string | number | bigint;
    to: string;
}

Properties

amount: string

Amount to reclaim, in the token's smallest unit.

asset: string

Token contract address to reclaim from.

nonce?: string | number | bigint

Optional nonce for replay protection. When provided, the contract verifies that this call has not been made before with the same nonce.

to: string

Destination G-address that will receive the reclaimed tokens.