# IFromBTCSelfInitSwap\ Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:20](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L20) Base class for legacy escrow-based Bitcoin (on-chain & lightning) -> Smart chain swaps, which require the user to manually initiate the escrow on the destination smart chain ## Extends * [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md)<`T`, `D`, `S`> ## Extended by * [`FromBTCLNSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/FromBTCLNSwap.md) * [`FromBTCSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/FromBTCSwap.md) ## Type Parameters | Type Parameter | Default type | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `T` *extends* [`ChainType`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/ChainType.md) | [`ChainType`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/ChainType.md) | | `D` *extends* `IFromBTCSelfInitDefinition`<`T`, [`IFromBTCWrapper`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IFromBTCWrapper.md)<`T`, `D`>, `IFromBTCSelfInitSwap`<`T`, `D`, `S`>> | `IFromBTCSelfInitDefinition`<`T`, [`IFromBTCWrapper`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IFromBTCWrapper.md)<`T`, `any`>, `IFromBTCSelfInitSwap`<`T`, `any`, `any`>> | | `S` *extends* `number` | `number` | ## Implements * [`IAddressSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IAddressSwap.md) * [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md)<`T`, `D`, `S`> ## Constructors ### Constructor ``` protected new IFromBTCSelfInitSwap(wrapper, init): IFromBTCSelfInitSwap; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:30](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L30) #### Parameters | Parameter | Type | | --------- | ----------------------------------------- | | `wrapper` | `D`\[`"Wrapper"`] | | `init` | `IEscrowSelfInitSwapInit`<`T`\[`"Data"`]> | #### Returns `IFromBTCSelfInitSwap`<`T`, `D`, `S`> #### Overrides [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`constructor`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#constructor) ### Constructor ``` protected new IFromBTCSelfInitSwap(wrapper, obj): IFromBTCSelfInitSwap; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:31](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L31) #### Parameters | Parameter | Type | | --------- | ----------------- | | `wrapper` | `D`\[`"Wrapper"`] | | `obj` | `any` | #### Returns `IFromBTCSelfInitSwap`<`T`, `D`, `S`> #### Overrides [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`constructor`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#constructor) ## Properties ### chainIdentifier ``` readonly chainIdentifier: T["ChainId"]; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:168](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L168) Smart chain identifier string corresponding to this swap #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`chainIdentifier`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#chainidentifier) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`chainIdentifier`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#chainidentifier) *** ### createdAt ``` createdAt: number; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:176](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L176) A UNIX milliseconds timestamps of when this swap was created #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`createdAt`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#createdat) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`createdAt`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#createdat) *** ### events ``` readonly events: EventEmitter<{ swapState: [D["Swap"]]; }>; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:160](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L160) Event emitter emitting `"swapState"` event when swap's state changes #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`events`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#events) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`events`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#events) *** ### exactIn ``` readonly exactIn: boolean; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:172](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L172) Whether a swap is an exact input swap #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`exactIn`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#exactin) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`exactIn`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#exactin) *** ### url? ``` readonly optional url: string; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:164](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L164) URL of the intermediary (LP) used for this swap, already has the swap service specific path appended #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`url`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#url) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`url`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#url) *** ### TYPE ``` abstract protected readonly TYPE: SwapType; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:62](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L62) Swap type #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`TYPE`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#type) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`TYPE`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#type) ## Methods ### \_verifyQuoteDefinitelyExpired() ``` _verifyQuoteDefinitelyExpired(): Promise; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/IEscrowSelfInitSwap.ts:178](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts#L178) 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 ``` IClaimableSwap._verifyQuoteDefinitelyExpired ``` #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`_verifyQuoteDefinitelyExpired`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#_verifyquotedefinitelyexpired) *** ### \_verifyQuoteValid() ``` _verifyQuoteValid(): Promise; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/IEscrowSelfInitSwap.ts:189](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts#L189) Checks if the swap's quote is still valid #### Returns `Promise`<`boolean`> #### Implementation of ``` IClaimableSwap._verifyQuoteValid ``` #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`_verifyQuoteValid`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#_verifyquotevalid) *** ### claim() ``` abstract claim(signer, abortSignal?): Promise; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:293](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L293) Settles the swap by claiming the funds on the destination chain if the swap requires manual settlement, you can check so with [isClaimable](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#isclaimable) #### Parameters | Parameter | Type | Description | | -------------- | ------------------------------------------ | ----------------------------------------------------- | | `signer` | `T`\[`"Signer"`] \| `T`\[`"NativeSigner"`] | Signer to use for signing the settlement transactions | | `abortSignal?` | `AbortSignal` | Abort signal | #### Returns `Promise`<`string`> #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`claim`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#claim) *** ### commit() ``` abstract commit( signer, abortSignal?, skipChecks?): Promise; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:266](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L266) Creates the escrow on the destination smart chain side, pre-locking the tokens from the intermediary (LP) into an escrow. #### 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) | #### Returns `Promise`<`string`> #### Throws If invalid signer is provided that doesn't match the swap data #### Overrides [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`commit`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#commit) *** ### execute() ``` abstract execute(...args): Promise; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:279](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L279) Executes the swap with the provided wallet, the exact arguments for this functions differ for various swap types. Check the `execute()` function signature in the respective swap class to see the required arguments. #### Parameters | Parameter | Type | Description | | --------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------- | | ...`args` | `any`\[] | Execution arguments, usually contains a source wallet object, callbacks and options, for exact syntax check the respective swap class. | #### Returns `Promise`<`boolean`> Whether a swap was successfully executed or not, if it wasn't the user can refund or claim manually #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`execute`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#execute) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`execute`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#execute) *** ### getAddress() ``` abstract getAddress(): string; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:58](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L58) An address to which the user needs to send funds on the source chain #### Returns `string` #### Implementation of [`IAddressSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IAddressSwap.md).[`getAddress`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IAddressSwap.md#getaddress) *** ### getClaimHash() ``` getClaimHash(): string; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/IEscrowSwap.ts:130](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/IEscrowSwap.ts#L130) 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`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getClaimHash`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getclaimhash) *** ### getClaimNetworkFee() ``` getClaimNetworkFee(): Promise, true>>; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:276](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L276) Returns the transaction fee required for the claim transaction to settle the escrow on the destination smart chain #### Returns `Promise`<[`TokenAmount`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/TokenAmount.md)<[`SCToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/SCToken.md)<`T`\[`"ChainId"`]>, `true`>> *** ### getDirection() ``` getDirection(): SwapDirection; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:560](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L560) Returns the direction of the swap #### Returns [`SwapDirection`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/enumerations/SwapDirection.md) #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getDirection`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getdirection) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getDirection`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getdirection) *** ### getEscrowClaimTxId() ``` getEscrowClaimTxId(): string; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/IEscrowSwap.ts:151](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/IEscrowSwap.ts#L151) Returns the smart chain transaction ID of the tx that claimed (settled) the escrow #### Returns `string` #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getEscrowClaimTxId`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getescrowclaimtxid) *** ### getEscrowHash() ``` getEscrowHash(): string; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/IEscrowSwap.ts:123](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/IEscrowSwap.ts#L123) Returns the escrow hash - i.e. hash of the escrow data #### Returns `string` #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getEscrowHash`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getescrowhash) *** ### getEscrowInitTxId() ``` getEscrowInitTxId(): string; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/IEscrowSwap.ts:144](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/IEscrowSwap.ts#L144) Returns the smart chain transaction ID of the tx that initiated the escrow #### Returns `string` #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getEscrowInitTxId`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getescrowinittxid) *** ### getEscrowRefundTxId() ``` getEscrowRefundTxId(): string; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/IEscrowSwap.ts:158](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/IEscrowSwap.ts#L158) Returns the smart chain transaction ID of the tx that refunded the escrow #### Returns `string` #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getEscrowRefundTxId`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getescrowrefundtxid) *** ### getExecutionAction() ``` abstract getExecutionAction(options?): Promise; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:586](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L586) Returns a current state-dependent action for the user to execute, or `undefined` if there is no more action required for this swap - this means that the swap is probably finished (either expired, failed or settled). #### Parameters | Parameter | Type | Description | | ---------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `options?` | `any` | Optional options argument for the additional action context (i.e. passing bitcoin wallet info to get funded PSBTs or passing the externally-generated swap secret), see the actual type in the respective swap classes | #### Returns `Promise`<[`SwapExecutionAction`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/SwapExecutionAction.md)> #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getExecutionAction`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getexecutionaction) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getExecutionAction`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getexecutionaction) *** ### getExecutionStatus() ``` abstract getExecutionStatus(options?): Promise<{ currentAction: SwapExecutionAction; stateInfo: SwapStateInfo; steps: SwapExecutionStep[]; }>; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:605](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L605) Returns the current action and the full execution steps for a given swap. Prefer this to calling [getExecutionSteps](#getexecutionsteps) and [getExecutionAction](#getexecutionaction) separately - if called sequentially they might return the respective steps/actions in different states if you hit the state transition boundary. #### Parameters | Parameter | Type | Description | | ---------- | ----- | ------------------------------------------------------------------------------------------------------------------------- | | `options?` | `any` | Optional options argument for the additional execution status context, see the actual type in the respective swap classes | #### Returns `Promise`<{ `currentAction`: [`SwapExecutionAction`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/SwapExecutionAction.md); `stateInfo`: [`SwapStateInfo`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/SwapStateInfo.md)<`S`>; `steps`: [`SwapExecutionStep`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/SwapExecutionStep.md)\[]; }> #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getExecutionStatus`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getexecutionstatus) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getExecutionStatus`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getexecutionstatus) *** ### getExecutionSteps() ``` abstract getExecutionSteps(options?): Promise; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:595](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L595) Returns a list of execution steps the user has to go through for a given swap, to see the possible execution steps check out [SwapExecutionStep](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/SwapExecutionStep.md). #### Parameters | Parameter | Type | Description | | ---------- | ----- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | `options?` | `any` | Optional options argument for the additional steps context (i.e. automatic settlement timeout), see the actual type in the respective swap classes | #### Returns `Promise`<[`SwapExecutionStep`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/SwapExecutionStep.md)\[]> #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getExecutionSteps`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getexecutionsteps) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getExecutionSteps`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getexecutionsteps) *** ### getFee() ``` getFee(): Fee; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:148](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L148) Returns total fee for the swap, the fee is represented in source currency & destination currency, but is paid only once #### Returns [`Fee`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/Fee.md) #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getFee`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getfee) #### Overrides [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getFee`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getfee) *** ### getFeeBreakdown() ``` getFeeBreakdown(): [{ fee: Fee>; type: SWAP; }]; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:155](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L155) Returns the breakdown of all the fees paid #### Returns \[{ `fee`: [`Fee`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/Fee.md)<`T`\[`"ChainId"`], [`BtcToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/BtcToken.md), [`SCToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/SCToken.md)<`T`\[`"ChainId"`]>>; `type`: [`SWAP`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/enumerations/FeeType.md#swap); }] #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getFeeBreakdown`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getfeebreakdown) #### Overrides [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getFeeBreakdown`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getfeebreakdown) *** ### getHyperlink() ``` abstract getHyperlink(): string; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:63](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L63) A hyperlink representation of the address + amount that the user needs to sends on the source chain. This is suitable to be displayed in a form of QR code. #### Returns `string` #### Implementation of [`IAddressSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IAddressSwap.md).[`getHyperlink`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IAddressSwap.md#gethyperlink) *** ### getId() ``` getId(): string; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/IEscrowSwap.ts:137](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/IEscrowSwap.ts#L137) Returns the ID of the swap, as used in the storage #### Returns `string` #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getId`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getid) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getId`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getid) *** ### getInput() ``` abstract getInput(): TokenAmount; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:179](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L179) Returns input amount of the swap, user needs to pay this much #### Returns [`TokenAmount`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/TokenAmount.md)<[`BtcToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/BtcToken.md)> #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getInput`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getinput) #### Overrides [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getInput`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getinput) *** ### getInputAddress() ``` abstract getInputAddress(): string; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:475](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L475) Returns source address of the swap #### Returns `string` #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getInputAddress`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getinputaddress) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getInputAddress`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getinputaddress) *** ### getInputToken() ``` abstract getInputToken(): Token; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:653](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L653) Returns the input token of the swap #### Returns [`Token`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/Token.md)<`T`\[`"ChainId"`]> #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getInputToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getinputtoken) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getInputToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getinputtoken) *** ### getInputTxId() ``` abstract getInputTxId(): string; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:485](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L485) Returns swap input transaction ID on the source chain #### Returns `string` #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getInputTxId`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getinputtxid) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getInputTxId`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getinputtxid) *** ### getInputWithoutFee() ``` getInputWithoutFee(): TokenAmount; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:184](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L184) Returns input amount of the swap without the fees (swap fee, network fee) #### Returns [`TokenAmount`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/TokenAmount.md)<[`BtcToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/BtcToken.md)> #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getInputWithoutFee`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getinputwithoutfee) #### Overrides [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getInputWithoutFee`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getinputwithoutfee) *** ### getOutput() ``` getOutput(): TokenAmount, true>; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:172](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L172) Returns output amount of the swap, user receives this much #### Returns [`TokenAmount`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/TokenAmount.md)<[`SCToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/SCToken.md)<`T`\[`"ChainId"`]>, `true`> #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getOutput`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getoutput) #### Overrides [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getOutput`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getoutput) *** ### getOutputAddress() ``` getOutputAddress(): string; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:94](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L94) Returns destination address of the swap #### Returns `string` #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getOutputAddress`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getoutputaddress) #### Overrides [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getOutputAddress`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getoutputaddress) *** ### getOutputToken() ``` getOutputToken(): SCToken; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:165](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L165) Returns the output token of the swap #### Returns [`SCToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/SCToken.md)<`T`\[`"ChainId"`]> #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getOutputToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getoutputtoken) #### Overrides [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getOutputToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getoutputtoken) *** ### getOutputTxId() ``` getOutputTxId(): string; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:87](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L87) Returns swap output transaction ID on the destination chain #### Returns `string` #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getOutputTxId`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getoutputtxid) #### Overrides [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getOutputTxId`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getoutputtxid) *** ### getPriceInfo() ``` getPriceInfo(): object; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:388](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L388) Returns pricing info about the swap #### Returns `object` | Name | Type | Defined in | | -------------- | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | `difference` | [`PercentagePPM`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/PercentagePPM.md) | [atomiq-sdk/src/swaps/ISwap.ts:391](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L391) | | `marketPrice?` | `number` | [atomiq-sdk/src/swaps/ISwap.ts:389](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L389) | | `swapPrice` | `number` | [atomiq-sdk/src/swaps/ISwap.ts:390](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L390) | #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getPriceInfo`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getpriceinfo) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getPriceInfo`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getpriceinfo) *** ### getQuoteExpiry() ``` getQuoteExpiry(): number; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:546](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L546) Returns quote expiry in UNIX millis #### Returns `number` #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getQuoteExpiry`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getquoteexpiry) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getQuoteExpiry`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getquoteexpiry) *** ### getSecurityDeposit() ``` getSecurityDeposit(): TokenAmount, true>; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:215](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L215) Returns the amount of native token of the destination chain locked up during initialization of the escrow to act as a security deposit that can be taken by the intermediary (LP) if the user doesn't go through with the swap #### Returns [`TokenAmount`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/TokenAmount.md)<[`SCToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/SCToken.md)<`T`\[`"ChainId"`]>, `true`> *** ### getSmartChainNetworkFee() ``` getSmartChainNetworkFee(): Promise, true>>; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/IEscrowSelfInitSwap.ts:115](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts#L115) Returns the transaction fee paid on the smart chain side to initiate the escrow #### Returns `Promise`<[`TokenAmount`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/TokenAmount.md)<[`SCToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/SCToken.md)<`T`\[`"ChainId"`]>, `true`>> #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getSmartChainNetworkFee`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getsmartchainnetworkfee) *** ### getState() ``` getState(): S; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:567](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L567) Returns the current state of the swap #### Returns `S` #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getState`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getstate) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getState`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getstate) *** ### getStateInfo() ``` getStateInfo(): SwapStateInfo; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:574](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L574) Returns the current state of the swap along with the human-readable description of the state #### Returns [`SwapStateInfo`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/SwapStateInfo.md)<`S`> #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getStateInfo`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#getstateinfo) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getStateInfo`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#getstateinfo) *** ### getTotalDeposit() ``` getTotalDeposit(): TokenAmount, true>; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:224](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L224) Returns the total amount of native token of the destination chain locked up during initialization of the escrow. This covers the security deposit and the watchtower fee (if applicable), it is calculated a maximum of those two values. #### Returns [`TokenAmount`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/TokenAmount.md)<[`SCToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/SCToken.md)<`T`\[`"ChainId"`]>, `true`> *** ### getType() ``` getType(): SwapType; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:553](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L553) Returns the type of the swap #### Returns [`SwapType`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/enumerations/SwapType.md) #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`getType`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#gettype) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`getType`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#gettype) *** ### hasEnoughForTxFees() ``` hasEnoughForTxFees(): Promise<{ balance: TokenAmount, true>; enoughBalance: boolean; required: TokenAmount, true>; }>; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:193](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L193) Checks if the initiator/sender has enough balance on the smart chain side to cover the transaction fee for processing the swap #### Returns `Promise`<{ `balance`: [`TokenAmount`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/TokenAmount.md)<[`SCToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/SCToken.md)<`T`\[`"ChainId"`]>, `true`>; `enoughBalance`: `boolean`; `required`: [`TokenAmount`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/TokenAmount.md)<[`SCToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/SCToken.md)<`T`\[`"ChainId"`]>, `true`>; }> #### Overrides [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`hasEnoughForTxFees`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#hasenoughfortxfees) *** ### hasValidPrice() ``` hasValidPrice(): boolean; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:380](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L380) Checks if the pricing for the swap is valid, according to max allowed price difference set in the ISwapPrice #### Returns `boolean` #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`hasValidPrice`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#hasvalidprice) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`hasValidPrice`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#hasvalidprice) *** ### isClaimable() ``` abstract isClaimable(): boolean; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:68](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L68) Checks whether a swap currently requires a manual claiming (settlement) #### Returns `boolean` #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`isClaimable`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#isclaimable) *** ### isFailed() ``` abstract isFailed(): boolean; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:526](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L526) Returns whether the swap failed (e.g. was refunded) #### Returns `boolean` #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`isFailed`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#isfailed) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`isFailed`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#isfailed) *** ### isFinished() ``` abstract isFinished(): boolean; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:505](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L505) Returns whether the swap is finished and in its terminal state (this can mean successful, refunded or failed) #### Returns `boolean` #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`isFinished`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#isfinished) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`isFinished`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#isfinished) *** ### isInitiated() ``` isInitiated(): boolean; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:539](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L539) 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 [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`isInitiated`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#isinitiated) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`isInitiated`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#isinitiated) *** ### isInProgress() ``` abstract isInProgress(): boolean; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:531](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L531) Returns whether the swap is currently being processed #### Returns `boolean` #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`isInProgress`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#isinprogress) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`isInProgress`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#isinprogress) *** ### isQuoteExpired() ``` abstract isQuoteExpired(): boolean; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:510](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L510) Checks whether the swap's quote has definitely expired and cannot be committed anymore, we can remove such swap #### Returns `boolean` #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`isQuoteExpired`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#isquoteexpired) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`isQuoteExpired`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#isquoteexpired) *** ### isQuoteSoftExpired() ``` abstract isQuoteSoftExpired(): boolean; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:516](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L516) 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 [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`isQuoteSoftExpired`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#isquotesoftexpired) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`isQuoteSoftExpired`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#isquotesoftexpired) *** ### isSuccessful() ``` abstract isSuccessful(): boolean; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:521](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L521) Returns whether the swap finished successful #### Returns `boolean` #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`isSuccessful`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#issuccessful) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`isSuccessful`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#issuccessful) *** ### refreshPriceData() ``` refreshPriceData(): Promise; ``` Defined in: [atomiq-sdk/src/swaps/ISwap.ts:336](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwap.ts#L336) Re-fetches & revalidates the price data based on the current market prices #### Returns `Promise`<`void`> #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`refreshPriceData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#refreshpricedata) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`refreshPriceData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#refreshpricedata) *** ### requiresAction() ``` requiresAction(): boolean; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:101](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L101) Checks whether there is some action required from the user for this swap - can mean either refundable or claimable #### Returns `boolean` #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`requiresAction`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#requiresaction) #### Overrides [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`requiresAction`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#requiresaction) *** ### serialize() ``` serialize(): any; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/IEscrowSelfInitSwap.ts:208](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts#L208) Serializes the swap to a JSON stringifiable representation (i.e. no bigints, buffers etc.) #### Returns `any` #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`serialize`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#serialize) #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`serialize`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#serialize) *** ### txsClaim() ``` abstract txsClaim(signer?): Promise; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:288](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L288) Returns transactions for settling (claiming) the swap if the swap requires manual settlement, you can check so with [isClaimable](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#isclaimable). After sending the transaction manually be sure to call the [waitTillClaimed](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#waittillclaimed) function to wait till the claim 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 settlement (claim) transactions for | #### Returns `Promise`<`T`\[`"TX"`]\[]> #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`txsClaim`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#txsclaim) *** ### txsCommit() ``` txsCommit(skipChecks?): Promise; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:241](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L241) Returns transactions for initiating (committing) the escrow on the destination smart chain side, pre-locking the tokens from the intermediary (LP) into an escrow. #### 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"`]\[]> #### Throws When in invalid state to commit the swap #### Overrides [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`txsCommit`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#txscommit) *** ### waitTillClaimed() ``` abstract waitTillClaimed(maxWaitTimeSeconds?, abortSignal?): Promise; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/frombtc/IFromBTCSelfInitSwap.ts:298](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts#L298) Waits till the swap is successfully settled (claimed), should be called after sending the claim (settlement) transactions manually to wait till the SDK processes the settlement and updates the swap state accordingly #### Parameters | Parameter | Type | Description | | --------------------- | ------------- | ---------------------------------------------------------- | | `maxWaitTimeSeconds?` | `number` | Maximum time in seconds to wait for the swap to be settled | | `abortSignal?` | `AbortSignal` | AbortSignal | #### Returns `Promise`<`boolean`> whether the swap was claimed in time or not #### Implementation of [`IClaimableSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md).[`waitTillClaimed`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/IClaimableSwap.md#waittillclaimed) *** ### waitTillCommited() ``` abstract waitTillCommited(abortSignal?): Promise; ``` Defined in: [atomiq-sdk/src/swaps/escrow\_swaps/IEscrowSelfInitSwap.ts:170](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts#L170) Waits till a swap is initiated (committed) on-chain, should be called after sending the commit transactions ([txsCommit](#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`> #### Inherited from [`IEscrowSelfInitSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md).[`waitTillCommited`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/IEscrowSelfInitSwap.md#waittillcommited)