# SpvFromBTCWrapper\ Defined in: [atomiq-sdk/src/swaps/spv\_swaps/SpvFromBTCWrapper.ts:104](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/spv_swaps/SpvFromBTCWrapper.ts#L104) New spv vault (UTXO-controlled vault) based swaps for Bitcoin -> Smart chain swaps not requiring any initiation on the destination chain, and with the added possibility for the user to receive a native token on the destination chain as part of the swap (a "gas drop" feature). ## Extends * [`ISwapWrapper`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md)<`T`, `SpvFromBTCTypeDefinition`<`T`>, `SpvFromBTCWrapperOptions`> ## Type Parameters | Type Parameter | | -------------------------------------------------------------------------------------------------------------------- | | `T` *extends* [`ChainType`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/ChainType.md) | ## Implements * `IClaimableSwapWrapper`<[`SpvFromBTCSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SpvFromBTCSwap.md)<`T`>> ## Constructors ### Constructor ``` new SpvFromBTCWrapper( chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, versionedContracts, versionedSynchronizer, btcRpc, lpApi, options?, events?): SpvFromBTCWrapper; ``` Defined in: [atomiq-sdk/src/swaps/spv\_swaps/SpvFromBTCWrapper.ts:212](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/spv_swaps/SpvFromBTCWrapper.ts#L212) #### Parameters | Parameter | Type | Description | | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | | `chainIdentifier` | `string` | | | `unifiedStorage` | [`UnifiedSwapStorage`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/UnifiedSwapStorage.md)<`T`> | Storage interface for the current environment | | `unifiedChainEvents` | `UnifiedSwapEventListener`<`T`> | On-chain event listener | | `chain` | `T`\[`"ChainInterface"`] | | | `prices` | [`ISwapPrice`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapPrice.md) | Pricing to use | | `tokens` | `WrapperCtorTokens` | | | `versionedContracts` | { \[`version`: `string`]: `object`; } | | | `versionedSynchronizer` | { \[`version`: `string`]: `object`; } | | | `btcRpc` | [`BitcoinRpcWithAddressIndex`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/interfaces/BitcoinRpcWithAddressIndex.md)<`any`> | Bitcoin RPC which also supports getting transactions by txoHash | | `lpApi` | `IntermediaryAPI` | | | `options?` | `AllOptional`<`SpvFromBTCWrapperOptions`> | | | `events?` | `EventEmitter`<{ `swapState`: \[[`ISwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwap.md)<[`ChainType`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/ChainType.md), `SwapTypeDefinition`<[`ChainType`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/ChainType.md), [`ISwapWrapper`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md)<[`ChainType`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/ChainType.md), `any`, `ISwapWrapperOptions`>, [`ISwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwap.md)<[`ChainType`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/ChainType.md), `any`, `any`>>, `number`>]; }> | Instance to use for emitting events | #### Returns `SpvFromBTCWrapper`<`T`> #### Overrides [`ISwapWrapper`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md).[`constructor`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md#constructor) ## Properties ### chainIdentifier ``` readonly chainIdentifier: T["ChainId"]; ``` Defined in: [atomiq-sdk/src/swaps/ISwapWrapper.ts:164](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwapWrapper.ts#L164) Chain identifier string of this wrapper #### Inherited from [`ISwapWrapper`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md).[`chainIdentifier`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md#chainidentifier) *** ### events ``` readonly events: EventEmitter<{ swapState: [SpvFromBTCSwap]; }>; ``` Defined in: [atomiq-sdk/src/swaps/ISwapWrapper.ts:168](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwapWrapper.ts#L168) Event emitter emitting `"swapState"` event when swap's state changes #### Inherited from [`ISwapWrapper`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md).[`events`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md#events) *** ### TYPE ``` readonly TYPE: SPV_VAULT_FROM_BTC = SwapType.SPV_VAULT_FROM_BTC; ``` Defined in: [atomiq-sdk/src/swaps/spv\_swaps/SpvFromBTCWrapper.ts:107](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/spv_swaps/SpvFromBTCWrapper.ts#L107) Swap type #### Overrides [`ISwapWrapper`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md).[`TYPE`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md#type) ## Methods ### checkPastSwaps() ``` checkPastSwaps(pastSwaps?, noSave?): Promise<{ changedSwaps: SpvFromBTCSwap[]; removeSwaps: SpvFromBTCSwap[]; }>; ``` Defined in: [atomiq-sdk/src/swaps/ISwapWrapper.ts:424](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwapWrapper.ts#L424) Runs checks on all the known pending swaps, syncing their state from on-chain data #### Parameters | Parameter | Type | Description | | ------------ | ------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | | `pastSwaps?` | [`SpvFromBTCSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SpvFromBTCSwap.md)<`T`>\[] | 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`: [`SpvFromBTCSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SpvFromBTCSwap.md)<`T`>\[]; `removeSwaps`: [`SpvFromBTCSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SpvFromBTCSwap.md)<`T`>\[]; }> #### Remarks Doesn't work properly if you pass non-persisted swaps #### Inherited from [`ISwapWrapper`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md).[`checkPastSwaps`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md#checkpastswaps) *** ### create() ``` create( recipient, amountData, lps, options?, additionalParams?, abortSignal?): object[]; ``` Defined in: [atomiq-sdk/src/swaps/spv\_swaps/SpvFromBTCWrapper.ts:630](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/spv_swaps/SpvFromBTCWrapper.ts#L630) Returns a newly created Bitcoin -> Smart chain swap using the SPV vault (UTXO-controlled vault) swap protocol, with the passed amount. Also allows specifying additional "gas drop" native token that the receipient receives on the destination chain in the `options` argument. #### Parameters | Parameter | Type | Description | | ------------------- | ---------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | | `recipient` | `string` | Recipient address on the destination smart chain | | `amountData` | [`AmountData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/type-aliases/AmountData.md) | Amount, token and exact input/output data for to swap | | `lps` | [`Intermediary`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/Intermediary.md)\[] | An array of intermediaries (LPs) to get the quotes from | | `options?` | `SpvFromBTCOptions` | Optional additional quote options | | `additionalParams?` | `Record`<`string`, `any`> | Optional additional parameters sent to the LP when creating the swap | | `abortSignal?` | `AbortSignal` | Abort signal | #### Returns `object`\[] *** ### getDummySwapPsbt() ``` getDummySwapPsbt(includeGasToken): Transaction; ``` Defined in: [atomiq-sdk/src/swaps/spv\_swaps/SpvFromBTCWrapper.ts:899](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/spv_swaps/SpvFromBTCWrapper.ts#L899) Returns a random dummy PSBT that can be used for fee estimation, the last output (the LP output) is omitted to allow for coinselection algorithm to determine maximum sendable amount there #### Parameters | Parameter | Type | Default value | Description | | ----------------- | --------- | ------------- | ------------------------------------------------------------------------------------ | | `includeGasToken` | `boolean` | `false` | Whether to return the PSBT also with the gas token amount (increases the vSize by 8) | #### Returns `Transaction` *** ### init() ``` init(noTimers, noCheckPastSwaps): Promise; ``` Defined in: [atomiq-sdk/src/swaps/ISwapWrapper.ts:360](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwapWrapper.ts#L360) 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`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md).[`init`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md#init) *** ### recoverFromState() ``` recoverFromState( state, contractVersion, vault?, lp?): Promise>; ``` Defined in: [atomiq-sdk/src/swaps/spv\_swaps/SpvFromBTCWrapper.ts:792](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/spv_swaps/SpvFromBTCWrapper.ts#L792) Recovers an SPV vault (UTXO-controlled vault) based swap from smart chain on-chain data #### Parameters | Parameter | Type | Description | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------- | | `state` | `SpvWithdrawalFrontedState` \| `SpvWithdrawalClaimedState` | State of the spv vault withdrawal recovered from on-chain data | | `contractVersion` | `string` | - | | `vault?` | [`SpvVaultData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SpvVaultData.md)<[`SpvWithdrawalTransactionData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SpvWithdrawalTransactionData.md)> | SPV vault processing the swap | | `lp?` | [`Intermediary`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/Intermediary.md) | Intermediary (LP) used as a counterparty for the swap | #### Returns `Promise`<[`SpvFromBTCSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SpvFromBTCSwap.md)<`T`>> *** ### stop() ``` stop(): Promise; ``` Defined in: [atomiq-sdk/src/swaps/ISwapWrapper.ts:401](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwapWrapper.ts#L401) Un-subscribes from event listeners on the smart chain, terminates the tick interval and stops this wrapper #### Returns `Promise`<`void`> #### Inherited from [`ISwapWrapper`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md).[`stop`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md#stop) *** ### tick() ``` tick(swaps?, abortSignal?): Promise; ``` Defined in: [atomiq-sdk/src/swaps/ISwapWrapper.ts:459](https://github.com/atomiqlabs/atomiq-sdk/blob/786509324f7f09c427e9ccfe527d82e496f06af5/src/swaps/ISwapWrapper.ts#L459) Invokes ISwap.\_tick on all the known swaps #### Parameters | Parameter | Type | Description | | -------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | | `swaps?` | [`SpvFromBTCSwap`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SpvFromBTCSwap.md)<`T`>\[] | Optional array of swaps to invoke `_tick()` on, otherwise all relevant swaps will be fetched from the persistent storage | | `abortSignal?` | `AbortSignal` | Abort signal | #### Returns `Promise`<`void`> #### Inherited from [`ISwapWrapper`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md).[`tick`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/ISwapWrapper.md#tick)