SwapExecutionActionSendToAddress<Lightning>
type SwapExecutionActionSendToAddress<Lightning> = object;
Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:36
Swap execution action requiring the user to send assets to a specific LIGHTNING invoice or BITCOIN on-chain address
Type Parameters
| Type Parameter | Default type |
|---|---|
Lightning extends boolean | boolean |
Properties
chain
chain: Lightning extends true ? "LIGHTNING" : "BITCOIN";
Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:49
Chain on which the payment is expected, either LIGHTNING or BITCOIN for on-chain
description
description: string;
Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:45
Human-readable description of the action
name
name: Lightning extends true ? "Deposit on Lightning" : "Deposit on Bitcoin";
Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:41
Human-readable name of the action
txs
txs: object[];
Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:53
An array of payments that should be made to different addresses, usually only a single address is returned
address
address: string;
amount
amount: TokenAmount<BtcToken<Lightning>, true>;
hyperlink
hyperlink: string;
type
type: Lightning extends true ? "BOLT11_PAYMENT_REQUEST" : "BITCOIN_ADDRESS";
type
type: "SendToAddress";
Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:37
waitForTransactions()
waitForTransactions: (maxWaitTimeSeconds?, pollIntervalSeconds?, abortSignal?) => Promise<string>;
Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:64
Waits till the transaction is received, doesn't wait for the actual confirmation!
Parameters
| Parameter | Type |
|---|---|
maxWaitTimeSeconds? | number |
pollIntervalSeconds? | number |
abortSignal? | AbortSignal |
Returns
Promise<string>
A transaction ID of the received transaction