Skip to main content

TypedSwapperOptions<T>

type TypedSwapperOptions<T> = object & SwapperOptions;

Defined in: atomiq-sdk/src/swapper/SwapperFactory.ts:65

Configuration options for creating a Swapper instance

Type Declaration

NameTypeDescriptionDefined in
chainsGetAllOptions<T>A dictionary with chain-specific settings, like RPC URLs and othersatomiq-sdk/src/swapper/SwapperFactory.ts:69
chainStorageCtor()?<T>(storageName) => IStorageManager<T>A function callback to retrieve a specific named storage container for key-value persistency. If not present, the default browser Local Storage adapter is used. When you use the SDK in non-browser based environments you need to provide this callback such that the SDK is able to use a custom storage adapter.atomiq-sdk/src/swapper/SwapperFactory.ts:77
getPriceFn?CustomPriceFunctionOptional pricing function to use instead of default pricing APIs. See CustomPriceFunction for details.atomiq-sdk/src/swapper/SwapperFactory.ts:86
mempoolApi?| MempoolApi | MempoolBitcoinRpc | string | string[]Mempool API instance or URLs to use, if not provided the defaults will be used for the specified bitcoin networkatomiq-sdk/src/swapper/SwapperFactory.ts:90
messenger?MessengerData propagation messenger instance to use for broadcasting data to watchtowers. By default, a Nostr-based messenger is used.atomiq-sdk/src/swapper/SwapperFactory.ts:95
pricingFeeDifferencePPM?bigintMaximum allowed pricing difference between intermediary (LP) returned rate and current market rate. In parts-per-million, e.g. 2% is written as 20000.atomiq-sdk/src/swapper/SwapperFactory.ts:82

Type Parameters

Type Parameter
T extends readonly ChainInitializer<any, any, any>[]