IToBTCSwap<T, D>

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:111

Base class for escrow-based Smart chain -> Bitcoin (on-chain & lightning) swaps

Extends

• IEscrowSelfInitSwap<T, D, ToBTCSwapState>

Extended by

• ToBTCLNSwap
• ToBTCSwap

Type Parameters

Type Parameter	Default type
T extends ChainType	ChainType
D extends IToBTCDefinition<T, IToBTCWrapper<T, D>, IToBTCSwap<T, D>>	IToBTCDefinition<T, IToBTCWrapper<T, any>, IToBTCSwap<T, any>>

Implements

• IRefundableSwap<T, D, ToBTCSwapState>

Constructors

Constructor

protected new IToBTCSwap<T, D>(wrapper, serializedObject): IToBTCSwap<T, D>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:142

Parameters

Parameter	Type
wrapper	D["Wrapper"]
serializedObject	any

Returns

IToBTCSwap<T, D>

Overrides

IEscrowSelfInitSwap.constructor

Constructor

protected new IToBTCSwap<T, D>(wrapper, init): IToBTCSwap<T, D>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:143

Parameters

Parameter	Type
wrapper	D["Wrapper"]
init	IToBTCSwapInit<T["Data"]>

Returns

IToBTCSwap<T, D>

Overrides

IEscrowSelfInitSwap.constructor

Properties

chainIdentifier

readonly chainIdentifier: T["ChainId"];

Defined in: atomiq-sdk/src/swaps/ISwap.ts:148

Smart chain identifier string corresponding to this swap

Implementation of

IRefundableSwap.chainIdentifier

Inherited from

IEscrowSelfInitSwap.chainIdentifier

---

createdAt

createdAt: number;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:156

A UNIX milliseconds timestamps of when this swap was created

Implementation of

IRefundableSwap.createdAt

Inherited from

IEscrowSelfInitSwap.createdAt

---

events

readonly events: EventEmitter<{
  swapState: [D["Swap"]];
}>;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:140

Event emitter emitting "swapState" event when swap's state changes

Implementation of

IRefundableSwap.events

Inherited from

IEscrowSelfInitSwap.events

---

exactIn

readonly exactIn: boolean;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:152

Whether a swap is an exact input swap

Implementation of

IRefundableSwap.exactIn

Inherited from

IEscrowSelfInitSwap.exactIn

---

url?

readonly optional url: string;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:144

URL of the intermediary (LP) used for this swap, already has the swap service specific path appended

Implementation of

IRefundableSwap.url

Inherited from

IEscrowSelfInitSwap.url

---

TYPE

abstract protected readonly TYPE: SwapType;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:60

Swap type

Implementation of

IRefundableSwap.TYPE

Inherited from

IEscrowSelfInitSwap.TYPE

Methods

_verifyQuoteDefinitelyExpired()

_verifyQuoteDefinitelyExpired(): Promise<boolean>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts:178

Checks if the swap's quote is expired for good (i.e. the swap strictly cannot be committed on-chain anymore)

Returns

Promise<boolean>

Implementation of

IRefundableSwap._verifyQuoteDefinitelyExpired

Inherited from

IEscrowSelfInitSwap._verifyQuoteDefinitelyExpired

---

_verifyQuoteValid()

_verifyQuoteValid(): Promise<boolean>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts:189

Checks if the swap's quote is still valid

Returns

Promise<boolean>

Implementation of

IRefundableSwap._verifyQuoteValid

Inherited from

IEscrowSelfInitSwap._verifyQuoteValid

---

commit()

commit(
   _signer, 
   abortSignal?, 
   skipChecks?, 
onBeforeTxSent?): Promise<string>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:614

Initiates (commits) the escrow on the smart chain side

Parameters

Parameter	Type	Description
_signer	T["Signer"] | T["NativeSigner"]	Signer to sign the transactions with, must be the same as used in the initialization
abortSignal?	AbortSignal	Abort signal
skipChecks?	boolean	Skip checks like making sure init signature is still valid and swap wasn't commited yet (this is handled on swap creation, if you commit right after quoting, you can use skipChecks=true)
onBeforeTxSent?	(txId) => void	Callback called before the transactions are broadcasted

Returns

Promise<string>

Overrides

IEscrowSelfInitSwap.commit

---

execute()

execute(
   signer, 
   callbacks?, 
options?): Promise<boolean>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:498

Executes the swap with the provided smart chain wallet/signer

Parameters

Parameter	Type	Description
signer	T["Signer"] | T["NativeSigner"]	Smart chain wallet/signer to use to sign the transaction on the source chain
callbacks?	{ onSourceTransactionConfirmed?: (sourceTxId) => void; onSourceTransactionSent?: (sourceTxId) => void; onSwapSettled?: (destinationTxId) => void; }	Callbacks to track the progress of the swap
callbacks.onSourceTransactionConfirmed?	(sourceTxId) => void	-
callbacks.onSourceTransactionSent?	(sourceTxId) => void	-
callbacks.onSwapSettled?	(destinationTxId) => void	-
options?	{ abortSignal?: AbortSignal; maxWaitTillSwapProcessedSeconds?: number; paymentCheckIntervalSeconds?: number; }	Optional options for the swap like feeRate, AbortSignal, and timeouts/intervals
options.abortSignal?	AbortSignal	-
options.maxWaitTillSwapProcessedSeconds?	number	-
options.paymentCheckIntervalSeconds?	number	-

Returns

Promise<boolean>

Whether the swap was successfully processed by the LP, in case false is returned the user can refund their funds back on the source chain by calling refund

Implementation of

IRefundableSwap.execute

Overrides

IEscrowSelfInitSwap.execute

---

getClaimHash()

getClaimHash(): string;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/IEscrowSwap.ts:123

Returns the claim data hash specifying the claim path of the escrow - i.e. hash passed to the claim handler

Returns

string

Inherited from

IEscrowSelfInitSwap.getClaimHash

---

getCurrentActions()

getCurrentActions(options?): Promise<SwapExecutionAction<T>[]>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:567

Returns a state-dependent set of actions for the user to execute, or empty array if there is currently no action required from the user to execute.

Parameters

Parameter	Type	Description
options?	{ refundSmartChainSigner?: string | T["Signer"] | T["NativeSigner"]; skipChecks?: boolean; }	-
options.refundSmartChainSigner?	string | T["Signer"] | T["NativeSigner"]	Optional smart chain signer to use when creating refunds transactions
options.skipChecks?	boolean	Skip checks like making sure init signature is still valid and swap wasn't commited yet (this is handled on swap creation, if you commit right after quoting, you can use skipChecks=true)

Returns

Promise<SwapExecutionAction<T>[]>

Implementation of

IRefundableSwap.getCurrentActions

Overrides

IEscrowSelfInitSwap.getCurrentActions

---

getDirection()

getDirection(): SwapDirection;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:506

Returns the direction of the swap

Returns

SwapDirection

Implementation of

IRefundableSwap.getDirection

Inherited from

IEscrowSelfInitSwap.getDirection

---

getEscrowClaimTxId()

getEscrowClaimTxId(): string;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/IEscrowSwap.ts:144

Returns the smart chain transaction ID of the tx that claimed (settled) the escrow

Returns

string

Inherited from

IEscrowSelfInitSwap.getEscrowClaimTxId

---

getEscrowHash()

getEscrowHash(): string;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/IEscrowSwap.ts:116

Returns the escrow hash - i.e. hash of the escrow data

Returns

string

Inherited from

IEscrowSelfInitSwap.getEscrowHash

---

getEscrowInitTxId()

getEscrowInitTxId(): string;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/IEscrowSwap.ts:137

Returns the smart chain transaction ID of the tx that initiated the escrow

Returns

string

Inherited from

IEscrowSelfInitSwap.getEscrowInitTxId

---

getEscrowRefundTxId()

getEscrowRefundTxId(): string;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/IEscrowSwap.ts:151

Returns the smart chain transaction ID of the tx that refunded the escrow

Returns

string

Inherited from

IEscrowSelfInitSwap.getEscrowRefundTxId

---

getExpiry()

getExpiry(): number;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:314

Returns the time (in UNIX milliseconds) at which the swap expires and the user is able to unilaterally refund it with the refund or txsRefund function.

Returns

number

---

getFee()

getFee(): Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:381

Returns total fee for the swap, the fee is represented in source currency & destination currency, but is paid only once

Returns

Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>

Implementation of

IRefundableSwap.getFee

Overrides

IEscrowSelfInitSwap.getFee

---

getFeeBreakdown()

getFeeBreakdown(): [{
  fee: Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
  type: SWAP;
}, {
  fee: Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
  type: NETWORK_OUTPUT;
}];

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:400

Returns the breakdown of all the fees paid

Returns

[{ fee: Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>; type: SWAP; }, { fee: Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>; type: NETWORK_OUTPUT; }]

Implementation of

IRefundableSwap.getFeeBreakdown

Overrides

IEscrowSelfInitSwap.getFeeBreakdown

---

getId()

getId(): string;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/IEscrowSwap.ts:130

Returns the ID of the swap, as used in the storage

Returns

string

Implementation of

IRefundableSwap.getId

Inherited from

IEscrowSelfInitSwap.getId

---

getInput()

getInput(): TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:426

Returns input amount of the swap, user needs to pay this much

Returns

TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>

Implementation of

IRefundableSwap.getInput

Overrides

IEscrowSelfInitSwap.getInput

---

getInputAddress()

getInputAddress(): string;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:243

Returns source address of the swap

Returns

string

Implementation of

IRefundableSwap.getInputAddress

Overrides

IEscrowSelfInitSwap.getInputAddress

---

getInputToken()

getInputToken(): SCToken<T["ChainId"]>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:419

Returns the input token of the swap

Returns

SCToken<T["ChainId"]>

Implementation of

IRefundableSwap.getInputToken

Overrides

IEscrowSelfInitSwap.getInputToken

---

getInputTxId()

getInputTxId(): string;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:250

Returns swap input transaction ID on the source chain

Returns

string

Implementation of

IRefundableSwap.getInputTxId

Overrides

IEscrowSelfInitSwap.getInputTxId

---

getInputWithoutFee()

getInputWithoutFee(): TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:436

Returns input amount of the swap without the fees (swap fee, network fee)

Returns

TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>

Implementation of

IRefundableSwap.getInputWithoutFee

Overrides

IEscrowSelfInitSwap.getInputWithoutFee

---

getOutput()

abstract getOutput(): TokenAmount;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:540

Returns output amount of the swap, user receives this much

Returns

TokenAmount

Implementation of

IRefundableSwap.getOutput

Inherited from

IEscrowSelfInitSwap.getOutput

---

getOutputAddress()

abstract getOutputAddress(): string;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:426

Returns destination address of the swap

Returns

string

Implementation of

IRefundableSwap.getOutputAddress

Inherited from

IEscrowSelfInitSwap.getOutputAddress

---

getOutputToken()

abstract getOutputToken(): Token<T["ChainId"]>;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:545

Returns the output token of the swap

Returns

Token<T["ChainId"]>

Implementation of

IRefundableSwap.getOutputToken

Inherited from

IEscrowSelfInitSwap.getOutputToken

---

getOutputTxId()

abstract getOutputTxId(): string;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:436

Returns swap output transaction ID on the destination chain

Returns

string

Implementation of

IRefundableSwap.getOutputTxId

Inherited from

IEscrowSelfInitSwap.getOutputTxId

---

getPriceInfo()

getPriceInfo(): object;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:346

Returns pricing info about the swap

Returns

object

Name	Type	Defined in
difference	PercentagePPM	atomiq-sdk/src/swaps/ISwap.ts:349
marketPrice?	number	atomiq-sdk/src/swaps/ISwap.ts:347
swapPrice	number	atomiq-sdk/src/swaps/ISwap.ts:348

Implementation of

IRefundableSwap.getPriceInfo

Inherited from

IEscrowSelfInitSwap.getPriceInfo

---

getQuoteExpiry()

getQuoteExpiry(): number;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:492

Returns quote expiry in UNIX millis

Returns

number

Implementation of

IRefundableSwap.getQuoteExpiry

Inherited from

IEscrowSelfInitSwap.getQuoteExpiry

---

getRefundNetworkFee()

getRefundNetworkFee(): Promise<TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:826

Get the estimated smart chain transaction fee of the refund transaction

Returns

Promise<TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>>

---

getSmartChainNetworkFee()

getSmartChainNetworkFee(): Promise<TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts:115

Returns the transaction fee paid on the smart chain side to initiate the escrow

Returns

Promise<TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>>

Inherited from

IEscrowSelfInitSwap.getSmartChainNetworkFee

---

getState()

getState(): ToBTCSwapState;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:513

Returns the current state of the swap

Returns

ToBTCSwapState

Implementation of

IRefundableSwap.getState

Inherited from

IEscrowSelfInitSwap.getState

---

getStateInfo()

getStateInfo(): SwapStateInfo<ToBTCSwapState>;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:520

Returns the current state of the swap along with the human-readable description of the state

Returns

SwapStateInfo<ToBTCSwapState>

Implementation of

IRefundableSwap.getStateInfo

Inherited from

IEscrowSelfInitSwap.getStateInfo

---

getType()

getType(): SwapType;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:499

Returns the type of the swap

Returns

SwapType

Implementation of

IRefundableSwap.getType

Inherited from

IEscrowSelfInitSwap.getType

---

hasEnoughBalance()

hasEnoughBalance(): Promise<{
  balance: TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;
  enoughBalance: boolean;
  required: TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;
}>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:446

Checks if the initiator/sender on the source chain has enough balance to go through with the swap

Returns

Promise<{ balance: TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>; enoughBalance: boolean; required: TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>; }>

---

hasEnoughForTxFees()

hasEnoughForTxFees(): Promise<{
  balance: TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;
  enoughBalance: boolean;
  required: TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;
}>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:468

Checks if the initiator/sender on the source chain has enough native token balance to cover the transaction fee of initiating the swap

Returns

Promise<{ balance: TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>; enoughBalance: boolean; required: TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>; }>

Overrides

IEscrowSelfInitSwap.hasEnoughForTxFees

---

hasValidPrice()

hasValidPrice(): boolean;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:338

Checks if the pricing for the swap is valid, according to max allowed price difference set in the ISwapPrice

Returns

boolean

Implementation of

IRefundableSwap.hasValidPrice

Inherited from

IEscrowSelfInitSwap.hasValidPrice

---

isFailed()

isFailed(): boolean;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:299

Returns whether the swap failed (e.g. was refunded)

Returns

boolean

Implementation of

IRefundableSwap.isFailed

Overrides

IEscrowSelfInitSwap.isFailed

---

isFinished()

isFinished(): boolean;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:264

Returns whether the swap is finished and in its terminal state (this can mean successful, refunded or failed)

Returns

boolean

Implementation of

IRefundableSwap.isFinished

Overrides

IEscrowSelfInitSwap.isFinished

---

isInitiated()

isInitiated(): boolean;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:485

Whether a swap was initialized, a swap is considered initialized on first interaction with it, i.e. calling commit() on a Smart chain -> Bitcoin swaps, calling waitForPayment() or similar on the other direction. Not initiated swaps are not saved to the persistent storage by default (see SwapperOptions.saveUninitializedSwaps)

Returns

boolean

Implementation of

IRefundableSwap.isInitiated

Inherited from

IEscrowSelfInitSwap.isInitiated

---

isInProgress()

isInProgress(): boolean;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:306

Returns whether the swap is currently being processed

Returns

boolean

Implementation of

IRefundableSwap.isInProgress

Overrides

IEscrowSelfInitSwap.isInProgress

---

isQuoteExpired()

isQuoteExpired(): boolean;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:278

Checks whether the swap's quote has definitely expired and cannot be committed anymore, we can remove such swap

Returns

boolean

Implementation of

IRefundableSwap.isQuoteExpired

Overrides

IEscrowSelfInitSwap.isQuoteExpired

---

isQuoteSoftExpired()

isQuoteSoftExpired(): boolean;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:285

Checks whether the swap's quote is soft expired (this means there is not enough time buffer for it to commit, but it still can happen)

Returns

boolean

Implementation of

IRefundableSwap.isQuoteSoftExpired

Overrides

IEscrowSelfInitSwap.isQuoteSoftExpired

---

isRefundable()

isRefundable(): boolean;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:271

Checks whether a swap is currently refundable

Returns

boolean

Implementation of

IRefundableSwap.isRefundable

---

isSuccessful()

isSuccessful(): boolean;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:292

Returns whether the swap finished successful

Returns

boolean

Implementation of

IRefundableSwap.isSuccessful

Overrides

IEscrowSelfInitSwap.isSuccessful

---

refreshPriceData()

refreshPriceData(): Promise<void>;

Defined in: atomiq-sdk/src/swaps/ISwap.ts:305

Re-fetches & revalidates the price data based on the current market prices

Returns

Promise<void>

Implementation of

IRefundableSwap.refreshPriceData

Inherited from

IEscrowSelfInitSwap.refreshPriceData

---

refund()

refund(_signer, abortSignal?): Promise<string>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:881

Refunds the swap if the swap is in refundable state, you can check so with isRefundable

Parameters

Parameter	Type	Description
_signer	T["Signer"] | T["NativeSigner"]	Signer to sign the transactions with, must be the same as used in the initialization
abortSignal?	AbortSignal	Abort signal

Returns

Promise<string>

Implementation of

IRefundableSwap.refund

---

requiresAction()

requiresAction(): boolean;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:257

Checks whether there is some action required from the user for this swap - can mean either refundable or claimable

Returns

boolean

Implementation of

IRefundableSwap.requiresAction

Overrides

IEscrowSelfInitSwap.requiresAction

---

serialize()

serialize(): any;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:944

Serializes the swap to a JSON stringifiable representation (i.e. no bigints, buffers etc.)

Returns

any

Implementation of

IRefundableSwap.serialize

Overrides

IEscrowSelfInitSwap.serialize

---

txsCommit()

txsCommit(skipChecks?): Promise<T["TX"][]>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:595

Returns transactions for initiating (committing) the escrow on the smart chain side. After sending the transactions manually be sure to call the waitTillCommited function to wait till the initiation transaction is observed, processed by the SDK and state of the swap properly updated.

Parameters

Parameter	Type	Description
skipChecks?	boolean	Skip checks like making sure init signature is still valid and swap wasn't commited yet (this is handled on swap creation, if you commit right after quoting, you can use skipChecks=true)

Returns

Promise<T["TX"][]>

Overrides

IEscrowSelfInitSwap.txsCommit

---

txsExecute()

txsExecute(options?): Promise<[SwapExecutionActionCommit<T>]>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:543

Returns a list of steps or transactions required to finish and settle the swap

Parameters

Parameter	Type	Description
options?	{ skipChecks?: boolean; }	Additional options for executing the swap
options.skipChecks?	boolean	Skip checks like making sure init signature is still valid and swap wasn't commited yet (this is handled on swap creation, if you commit right after quoting, you can use skipChecks=true)

Returns

Promise<[SwapExecutionActionCommit<T>]>

Implementation of

IRefundableSwap.txsExecute

Overrides

IEscrowSelfInitSwap.txsExecute

---

txsRefund()

txsRefund(_signer?): Promise<T["TX"][]>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:842

Returns transactions for refunding the swap if the swap is in refundable state, you can check so with isRefundable. After sending the transaction manually be sure to call the waitTillRefunded function to wait till the refund transaction is observed, processed by the SDK and state of the swap properly updated.

Parameters

Parameter	Type	Description
_signer?	string | T["Signer"] | T["NativeSigner"]	Address of the signer to create the refund transactions for

Returns

Promise<T["TX"][]>

Implementation of

IRefundableSwap.txsRefund

---

waitForPayment()

waitForPayment(
   maxWaitTimeSeconds?, 
   checkIntervalSeconds?, 
abortSignal?): Promise<boolean>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:759

A blocking promise resolving when swap was concluded by the intermediary (LP), rejecting in case of failure

Parameters

Parameter	Type	Description
maxWaitTimeSeconds?	number	Maximum time in seconds to wait for the swap to be settled, an error is thrown if the swap is taking too long to claim
checkIntervalSeconds?	number	How often to poll the intermediary for answer
abortSignal?	AbortSignal	Abort signal

Returns

Promise<boolean>

true if swap was successful, false if swap failed and we can refund

Throws

If a swap is determined expired by the intermediary, but it is actually still valid

Throws

If the swap should be cooperatively refundable but the intermediary returned invalid refund signature

Throws

When swap expires or if the swap has invalid state (must be ToBTCSwapState.COMMITED)

---

waitTillCommited()

waitTillCommited(abortSignal?): Promise<void>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:639

Waits till a swap is initiated (committed) on-chain, should be called after sending the commit transactions (txsCommit) manually to wait till the SDK processes the escrow initialization and updates the swap state accordingly

Parameters

Parameter	Type	Description
abortSignal?	AbortSignal	AbortSignal

Returns

Promise<void>

Overrides

IEscrowSelfInitSwap.waitTillCommited

---

waitTillRefunded()

waitTillRefunded(abortSignal?): Promise<void>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts:899

Waits till a swap is refunded, should be called after sending the refund transactions manually to wait till the SDK processes the refund and updates the swap state accordingly

Parameters

Parameter	Type	Description
abortSignal?	AbortSignal	AbortSignal

Returns

Promise<void>

Implementation of

IRefundableSwap.waitTillRefunded