Skip to main content

IClaimableSwap<T, D, S>

Defined in: atomiq-sdk/src/swaps/IClaimableSwap.ts:23

Interface for swaps that can end up in a claimable state, requiring the user to claim the assets on the destination chain.

Extends​

Type Parameters​

Type ParameterDefault type
T extends ChainTypeChainType
D extends SwapTypeDefinition<T, ISwapWrapper<T, D>, IClaimableSwap<T, D, S>>SwapTypeDefinition<T, ISwapWrapper<T, any>, IClaimableSwap<T, any, any>>
S extends numbernumber

Properties​

chainIdentifier​

readonly chainIdentifier: T["ChainId"];

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

Smart chain identifier string corresponding to this swap

Inherited from​

ISwap.chainIdentifier

createdAt​

createdAt: number;

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

A UNIX milliseconds timestamps of when this swap was created

Inherited from​

IRefundableSwap.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

Inherited from​

ISwap.events

exactIn​

readonly exactIn: boolean;

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

Whether a swap is an exact input swap

Inherited from​

IRefundableSwap.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

Inherited from​

IRefundableSwap.url

TYPE​

abstract protected readonly TYPE: SwapType;

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

Swap type

Inherited from​

IRefundableSwap.TYPE

Methods​

claim()​

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

Defined in: atomiq-sdk/src/swaps/IClaimableSwap.ts:52

Settles the swap by claiming the funds on the destination chain if the swap requires manual settlement, you can check so with isClaimable

Parameters​

ParameterTypeDescription
_signer?T["Signer"] | T["NativeSigner"]Signer to use for signing the settlement transactions
abortSignal?AbortSignalAbort signal
onBeforeTxSent?(txId) => voidOptional callback triggered before the claim transaction is broadcasted

Returns​

Promise<string>

execute()​

abstract execute(...args): Promise<boolean>;

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

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​

ParameterTypeDescription
...argsany[]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

Inherited from​

ISwap.execute

getCurrentActions()​

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

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

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.

Returns​

Promise<SwapExecutionAction<T>[]>

Inherited from​

ISwap.getCurrentActions

getDirection()​

getDirection(): SwapDirection;

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

Returns the direction of the swap

Returns​

SwapDirection

Inherited from​

ISwap.getDirection

getFee()​

abstract getFee(): Fee;

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

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

Returns​

Fee

Inherited from​

ISwap.getFee

getFeeBreakdown()​

abstract getFeeBreakdown(): FeeBreakdown<T["ChainId"]>;

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

Returns the breakdown of all the fees paid

Returns​

FeeBreakdown<T["ChainId"]>

Inherited from​

ISwap.getFeeBreakdown

getId()​

abstract getId(): string;

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

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

Returns​

string

Inherited from​

ISwap.getId

getInput()​

abstract getInput(): TokenAmount;

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

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

Returns​

TokenAmount

Inherited from​

ISwap.getInput

getInputAddress()​

abstract getInputAddress(): string;

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

Returns source address of the swap

Returns​

string

Inherited from​

ISwap.getInputAddress

getInputToken()​

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

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

Returns the input token of the swap

Returns​

Token<T["ChainId"]>

Inherited from​

ISwap.getInputToken

getInputTxId()​

abstract getInputTxId(): string;

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

Returns swap input transaction ID on the source chain

Returns​

string

Inherited from​

ISwap.getInputTxId

getInputWithoutFee()​

abstract getInputWithoutFee(): TokenAmount;

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

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

Returns​

TokenAmount

Inherited from​

ISwap.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

Inherited from​

ISwap.getOutput

getOutputAddress()​

abstract getOutputAddress(): string;

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

Returns destination address of the swap

Returns​

string

Inherited from​

ISwap.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"]>

Inherited from​

ISwap.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

Inherited from​

ISwap.getOutputTxId

getPriceInfo()​

getPriceInfo(): object;

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

Returns pricing info about the swap

Returns​

object

NameTypeDefined in
differencePercentagePPMatomiq-sdk/src/swaps/ISwap.ts:349
marketPrice?numberatomiq-sdk/src/swaps/ISwap.ts:347
swapPricenumberatomiq-sdk/src/swaps/ISwap.ts:348

Inherited from​

ISwap.getPriceInfo

getQuoteExpiry()​

getQuoteExpiry(): number;

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

Returns quote expiry in UNIX millis

Returns​

number

Inherited from​

ISwap.getQuoteExpiry

getState()​

getState(): S;

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

Returns the current state of the swap

Returns​

S

Inherited from​

ISwap.getState

getStateInfo()​

getStateInfo(): SwapStateInfo<S>;

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<S>

Inherited from​

ISwap.getStateInfo

getType()​

getType(): SwapType;

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

Returns the type of the swap

Returns​

SwapType

Inherited from​

ISwap.getType

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

Inherited from​

ISwap.hasValidPrice

isClaimable()​

isClaimable(): boolean;

Defined in: atomiq-sdk/src/swaps/IClaimableSwap.ts:32

Checks whether a swap currently requires a manual claiming (settlement)

Returns​

boolean

isFailed()​

abstract isFailed(): boolean;

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

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

Returns​

boolean

Inherited from​

ISwap.isFailed

isFinished()​

abstract isFinished(): boolean;

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

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

Returns​

boolean

Inherited from​

ISwap.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

Inherited from​

ISwap.isInitiated

isInProgress()​

abstract isInProgress(): boolean;

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

Returns whether the swap is currently being processed

Returns​

boolean

Inherited from​

ISwap.isInProgress

isQuoteExpired()​

abstract isQuoteExpired(): boolean;

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

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

Returns​

boolean

Inherited from​

ISwap.isQuoteExpired

isQuoteSoftExpired()​

abstract isQuoteSoftExpired(): boolean;

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

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

Inherited from​

ISwap.isQuoteSoftExpired

isSuccessful()​

abstract isSuccessful(): boolean;

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

Returns whether the swap finished successful

Returns​

boolean

Inherited from​

ISwap.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>

Inherited from​

ISwap.refreshPriceData

requiresAction()​

abstract requiresAction(): boolean;

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

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

Returns​

boolean

Inherited from​

ISwap.requiresAction

serialize()​

serialize(): any;

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

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

Returns​

any

Inherited from​

ISwap.serialize

txsClaim()​

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

Defined in: atomiq-sdk/src/swaps/IClaimableSwap.ts:42

Returns transactions for settling (claiming) the swap if the swap requires manual settlement, you can check so with isClaimable. After sending the transaction manually be sure to call the waitTillClaimed function to wait till the claim transaction is observed, processed by the SDK and state of the swap properly updated.

Parameters​

ParameterTypeDescription
_signer?string | T["Signer"] | T["NativeSigner"]Address of the signer to create the settlement (claim) transactions for

Returns​

Promise<T["TX"][]>

txsExecute()​

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

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

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

Parameters​

ParameterTypeDescription
options?anyAdditional options for executing the swap

Returns​

Promise<SwapExecutionAction<T>[]>

Inherited from​

ISwap.txsExecute

waitTillClaimed()​

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

Defined in: atomiq-sdk/src/swaps/IClaimableSwap.ts:63

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​

ParameterTypeDescription
maxWaitTimeSeconds?numberMaximum time in seconds to wait for the swap to be settled
abortSignal?AbortSignalAbortSignal

Returns​

Promise<boolean>

whether the swap was claimed in time or not