Connect SDK

Appearance

@swapped/connect-sdk / core / SendWalletTransactionRequest

Type Alias: SendWalletTransactionRequest ​

SendWalletTransactionRequest = object

Defined in: src/types/wallets.types.ts:174

Properties ​

amount ​

amount: string

Defined in: src/types/wallets.types.ts:179

Human-readable token amount. The host converts to chain base units.

chainId ​

chainId: ChainId

Defined in: src/types/wallets.types.ts:176

clientTxId? ​

optional clientTxId?: string

Defined in: src/types/wallets.types.ts:186

Frontend correlation id for status events. Generated by the SDK when omitted - see onClientTxId.

decimals? ​

optional decimals?: number

Defined in: src/types/wallets.types.ts:191

forcePopup? ​

optional forcePopup?: boolean

Defined in: src/types/wallets.types.ts:198

Always run this send in the Swapped popup.

isSponsored? ​

optional isSponsored?: boolean

Defined in: src/types/wallets.types.ts:194

Widget-equivalent gasless decision. Host honors this when set.

onClientTxId? ​

optional onClientTxId?: (clientTxId) => void

Defined in: src/types/wallets.types.ts:188

Called with the id that will be used (provided or generated).

Parameters ​

clientTxId ​

string

Returns ​

void

onStatus? ​

optional onStatus?: (event) => void

Defined in: src/types/wallets.types.ts:196

Per-call host send progress. Not published as a client event.

Parameters ​

event ​

WalletTransactionStatusEvent

Returns ​

void

popupIfUnavailable? ​

optional popupIfUnavailable?: boolean

Defined in: src/types/wallets.types.ts:202

If the iframe cannot see this wallet, open the popup instead of failing.

sessionId? ​

optional sessionId?: string

Defined in: src/types/wallets.types.ts:190

Swapped session id. Defaults to the active client session.

symbol? ​

optional symbol?: string

Defined in: src/types/wallets.types.ts:192

to ​

to: string

Defined in: src/types/wallets.types.ts:177

tokenAddress? ​

optional tokenAddress?: string

Defined in: src/types/wallets.types.ts:181

EVM only: transfer this ERC-20 instead of native value.

walletId ​

walletId: WalletId

Defined in: src/types/wallets.types.ts:175