Skip to main content

SwapExecutionActionSignPSBT<T>

type SwapExecutionActionSignPSBT<T> = object;

Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:109

Swap execution action requiring the user to sign the provided PSBT and then submit it back via the provided submitPsbt() function, has two variations:

  • "FUNDED_PSBT" - A ready to sign PSBT with the inputs populated from the provided bitcoin wallet address
  • "RAW_PSBT" - Raw PSBT without the inputs, the implementor needs to add the input UTXOs before signing the transaction (also make sure to set the nSequence field of the 2nd input, index 1, to the provided in1sequence value)

Type Parameters​

Type ParameterDefault type
T extends "FUNDED_PSBT" | "RAW_PSBT""FUNDED_PSBT" | "RAW_PSBT"

Properties​

chain​

chain: "BITCOIN";

Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:124

Chain is always bitcoin


description​

description: string;

Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:120

Human-readable description of the action


name​

name: "Deposit on Bitcoin";

Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:116

Human-readable name of the action


submitPsbt()​

submitPsbt: (signedPsbt, idempotent?) => Promise<string[]>;

Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:148

Submit a signed PSBT, accepts hexadecimal, base64 and @scure/btc-signer Transaction object.

Parameters​

ParameterType
signedPsbtstring | Transaction | (string | Transaction)[]
idempotent?boolean

Returns​

Promise<string[]>

An array of transaction IDs of the submitted Bitcoin transactions


txs​

txs: T extends "FUNDED_PSBT" ? object[] : object[];

Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:128

An array of PSBTs that need to be signed, usually contains only a single PSBT


type​

type: "SignPSBT";

Defined in: atomiq-sdk/src/types/SwapExecutionAction.ts:112