SwapExecutionActionSignSmartChainTx<T>
type SwapExecutionActionSignSmartChainTx<T> = object;
Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:180
Swap execution action requiring the user to sign the provided smart chain transactions, these can then
be either broadcasted manually, or sent via the provided submitTransactions() function
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends ChainType | ChainType |
Properties
chain
chain: T["ChainId"];
Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:193
Chain identifier of the smart chain on which the corresponding transactions should be signed
description
description: string;
Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:189
Human-readable description of the action
name
name: "Initiate swap" | "Settle manually" | "Refund";
Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:185
Human-readable name of the action
requiredSigner
requiredSigner: string;
Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:213
The address of the signer that has to sign the transactions
submitTransactions()
submitTransactions: (txs, abortSignal?, idempotent?) => Promise<string[]>;
Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:209
Submits the signed transactions and waits for their confirmation
Parameters
| Parameter | Type |
|---|---|
txs | (T["SignedTXType"] | string)[] |
abortSignal? | AbortSignal |
idempotent? | boolean |
Returns
Promise<string[]>
Remarks
This might not do any validation on the submitted transactions, so returned txids are informational only and may not be persisted immediately. The swap may wait for an authoritative state transition before considering the submitted transactions accepted.
Make sure to only submit valid signed transactions obtained from this action object, and pass an AbortSignal if you need a timeout, otherwise this call can wait indefinitely when invalid transactions are submitted.
txs
txs: T["TX"][];
Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:198
Smart chain transactions that should be signed and either broadcasted manually or submitted back
to the provided submitTransactions() function
type
type: "SignSmartChainTransaction";
Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:181