IEscrowSwapWrapper<T, D, O>

Defined in: atomiq-sdk/src/swaps/escrow_swaps/IEscrowSwapWrapper.ts:27

Base class for wrappers of escrow-based swaps (i.e. swaps utilizing PrTLC and HTLC primitives)

Extends

• ISwapWrapper<T, D, O>

Extended by

• IFromBTCWrapper
• IToBTCWrapper

Type Parameters

Type Parameter	Default type
T extends ChainType	-
D extends IEscrowSwapDefinition<T, IEscrowSwapWrapper<T, D>, IEscrowSwap<T, D>>	-
O extends ISwapWrapperOptions	ISwapWrapperOptions

Constructors

Constructor

new IEscrowSwapWrapper<T, D, O>(
   chainIdentifier, 
   unifiedStorage, 
   unifiedChainEvents, 
   chain, 
   contract, 
   prices, 
   tokens, 
   swapDataDeserializer, 
   options, 
events?): IEscrowSwapWrapper<T, D, O>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/IEscrowSwapWrapper.ts:43

Parameters

Parameter	Type
chainIdentifier	string
unifiedStorage	UnifiedSwapStorage<T>
unifiedChainEvents	UnifiedSwapEventListener<T>
chain	T["ChainInterface"]
contract	T["Contract"]
prices	ISwapPrice
tokens	WrapperCtorTokens
swapDataDeserializer	(data) => T["Data"]
options	O
events?	EventEmitter<{ swapState: [ISwap<ChainType, SwapTypeDefinition<ChainType, ISwapWrapper<ChainType, any, ISwapWrapperOptions>, ISwap<ChainType, any, any>>, number>]; }>

Returns

IEscrowSwapWrapper<T, D, O>

Overrides

ISwapWrapper.constructor

Properties

chainIdentifier

readonly chainIdentifier: T["ChainId"];

Defined in: atomiq-sdk/src/swaps/ISwapWrapper.ts:142

Chain identifier string of this wrapper

Inherited from

ISwapWrapper.chainIdentifier

---

events

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

Defined in: atomiq-sdk/src/swaps/ISwapWrapper.ts:146

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

Inherited from

ISwapWrapper.events

---

TYPE

abstract readonly TYPE: SwapType;

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

Swap type

Overrides

ISwapWrapper.TYPE

Methods

checkPastSwaps()

checkPastSwaps(pastSwaps?, noSave?): Promise<{
  changedSwaps: D["Swap"][];
  removeSwaps: D["Swap"][];
}>;

Defined in: atomiq-sdk/src/swaps/ISwapWrapper.ts:369

Runs checks on all the known pending swaps, syncing their state from on-chain data

Parameters

Parameter	Type	Description
pastSwaps?	D["Swap"][]	Optional array of past swaps to check, otherwise all relevant swaps will be fetched from the persistent storage
noSave?	boolean	Whether to skip saving the swap changes in the persistent storage

Returns

Promise<{ changedSwaps: D["Swap"][]; removeSwaps: D["Swap"][]; }>

Inherited from

ISwapWrapper.checkPastSwaps

---

init()

init(noTimers, noCheckPastSwaps): Promise<void>;

Defined in: atomiq-sdk/src/swaps/ISwapWrapper.ts:314

Initializes the swap wrapper, needs to be called before any other action can be taken

Parameters

Parameter	Type	Default value	Description
noTimers	boolean	false	Whether to skip scheduling a tick timer for the swaps, if the tick timer is not initiated the swap states depending on e.g. expiry can be out of sync with the actual expiration of the swap
noCheckPastSwaps	boolean	false	Whether to skip checking past swaps on initialization (by default all pending swaps are re-checked on init, and their state is synchronized from the on-chain data)

Returns

Promise<void>

Inherited from

ISwapWrapper.init

---

recoverFromSwapDataAndState()

abstract recoverFromSwapDataAndState(
   init, 
   state, 
lp?): Promise<D["Swap"]>;

Defined in: atomiq-sdk/src/swaps/escrow_swaps/IEscrowSwapWrapper.ts:231

Recovers a swap from smart chain on-chain data, please note that not all values for the recovered swaps might be populated, as some data is purely off-chain and can never be recovered purely from on-chain data.

Parameters

Parameter	Type	Description
init	{ data: T["Data"]; getInitTxId: () => Promise<string>; getTxBlock: () => Promise<{ blockHeight: number; blockTime: number; }>; }	Swap escrow initialization transaction and swap data
init.data	T["Data"]	-
init.getInitTxId	() => Promise<string>	-
init.getTxBlock?	() => Promise<{ blockHeight: number; blockTime: number; }>	-
state?	SwapCommitState	Current on-chain state of the swap
lp?	Intermediary	Intermediary (LP) used as a counterparty for the swap

Returns

Promise<D["Swap"]>

---

stop()

stop(): Promise<void>;

Defined in: atomiq-sdk/src/swaps/ISwapWrapper.ts:355

Un-subscribes from event listeners on the smart chain, terminates the tick interval and stops this wrapper

Returns

Promise<void>

Inherited from

ISwapWrapper.stop

---

tick()

tick(swaps?): Promise<void>;

Defined in: atomiq-sdk/src/swaps/ISwapWrapper.ts:396

Invokes ISwap._tick on all the known swaps

Parameters

Parameter	Type	Description
swaps?	D["Swap"][]	Optional array of swaps to invoke _tick() on, otherwise all relevant swaps will be fetched from the persistent storage

Returns

Promise<void>

Inherited from

ISwapWrapper.tick