@lifi/sdk-provider-bitcoin 4.0.1-alpha.0 → 4.0.1

package/dist/types/client/publicClient.d.ts

@@ -1,12 +0,0 @@
-import { type Account, type Chain, type Client, type FallbackTransport, type HttpTransport, type PublicActions, type UTXOSchema, type WalletActions } from '@bigmi/core';
-import type { SDKClient } from '@lifi/sdk';
-type PublicClient = Client<FallbackTransport<readonly HttpTransport[]>, Chain, Account | undefined, UTXOSchema, PublicActions & WalletActions>;
-/**
- * Get an instance of a provider for a specific chain
- * @param client - The SDK client
- * @param chainId - Id of the chain the provider is for
- * @returns The public client for the given chain
- */
-export declare const getBitcoinPublicClient: (client: SDKClient, chainId: number) => Promise<PublicClient>;
-export {};
-//# sourceMappingURL=publicClient.d.ts.map

package/dist/types/client/publicClient.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"publicClient.d.ts","sourceRoot":"","sources":["../../../src/client/publicClient.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EAGZ,KAAK,KAAK,EACV,KAAK,MAAM,EAEX,KAAK,iBAAiB,EAEtB,KAAK,aAAa,EAGlB,KAAK,aAAa,EAGlB,KAAK,UAAU,EACf,KAAK,aAAa,EAEnB,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAG1C,KAAK,YAAY,GAAG,MAAM,CACxB,iBAAiB,CAAC,SAAS,aAAa,EAAE,CAAC,EAC3C,KAAK,EACL,OAAO,GAAG,SAAS,EACnB,UAAU,EACV,aAAa,GAAG,aAAa,CAC9B,CAAA;AAKD;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,GACjC,QAAQ,SAAS,EACjB,SAAS,MAAM,KACd,OAAO,CAAC,YAAY,CA0CtB,CAAA"}

package/dist/types/errors/parseBitcoinErrors.d.ts

@@ -1,3 +0,0 @@
-import { type ExecutionAction, type LiFiStep, SDKError } from '@lifi/sdk';
-export declare const parseBitcoinErrors: (e: Error, step?: LiFiStep, action?: ExecutionAction) => Promise<SDKError>;
-//# sourceMappingURL=parseBitcoinErrors.d.ts.map

package/dist/types/errors/parseBitcoinErrors.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"parseBitcoinErrors.d.ts","sourceRoot":"","sources":["../../../src/errors/parseBitcoinErrors.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,eAAe,EAEpB,KAAK,QAAQ,EACb,QAAQ,EAGT,MAAM,WAAW,CAAA;AAElB,eAAO,MAAM,kBAAkB,GAC7B,GAAG,KAAK,EACR,OAAO,QAAQ,EACf,SAAS,eAAe,KACvB,OAAO,CAAC,QAAQ,CAUlB,CAAA"}

package/dist/types/index.d.ts

@@ -1,4 +0,0 @@
-export { BitcoinProvider } from './BitcoinProvider.js';
-export type { BitcoinProviderOptions, BitcoinSDKProvider } from './types.js';
-export { isBitcoinProvider } from './types.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,YAAY,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAC5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA"}

package/dist/types/types.d.ts

@@ -1,10 +0,0 @@
-import type { Client } from '@bigmi/core';
-import { type SDKProvider } from '@lifi/sdk';
-export interface BitcoinProviderOptions {
-    getWalletClient?: () => Promise<Client>;
-}
-export interface BitcoinSDKProvider extends SDKProvider {
-    setOptions(options: BitcoinProviderOptions): void;
-}
-export declare function isBitcoinProvider(provider: SDKProvider): provider is BitcoinSDKProvider;
-//# sourceMappingURL=types.d.ts.map

package/dist/types/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAAa,KAAK,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD,MAAM,WAAW,sBAAsB;IACrC,eAAe,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;CACxC;AAED,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,UAAU,CAAC,OAAO,EAAE,sBAAsB,GAAG,IAAI,CAAA;CAClD;AAED,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,WAAW,GACpB,QAAQ,IAAI,kBAAkB,CAEhC"}

package/dist/types/utils/generateRedeemScript.d.ts

@@ -1,7 +0,0 @@
-/**
- * Generate redeem script for P2SH addresses
- * @param publicKey
- * @returns redeem script
- */
-export declare const generateRedeemScript: (publicKey: Uint8Array) => Uint8Array<ArrayBufferLike> | undefined;
-//# sourceMappingURL=generateRedeemScript.d.ts.map

package/dist/types/utils/generateRedeemScript.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generateRedeemScript.d.ts","sourceRoot":"","sources":["../../../src/utils/generateRedeemScript.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,WAAW,UAAU,4CAEX,CAAA"}

package/dist/types/utils/isPsbtFinalized.d.ts

@@ -1,3 +0,0 @@
-import type { Psbt } from 'bitcoinjs-lib';
-export declare function isPsbtFinalized(psbt: Psbt): boolean;
-//# sourceMappingURL=isPsbtFinalized.d.ts.map

package/dist/types/utils/isPsbtFinalized.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"isPsbtFinalized.d.ts","sourceRoot":"","sources":["../../../src/utils/isPsbtFinalized.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AAEzC,wBAAgB,eAAe,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAOnD"}

package/dist/types/utils/toBigmiChainId.d.ts

@@ -1,4 +0,0 @@
-import { ChainId as BigmiChainId } from '@bigmi/core';
-import { ChainId } from '@lifi/sdk';
-export declare const toBigmiChainId: (chainId: ChainId) => BigmiChainId;
-//# sourceMappingURL=toBigmiChainId.d.ts.map

package/dist/types/utils/toBigmiChainId.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"toBigmiChainId.d.ts","sourceRoot":"","sources":["../../../src/utils/toBigmiChainId.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,aAAa,CAAA;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC,eAAO,MAAM,cAAc,GAAI,SAAS,OAAO,KAAG,YAOjD,CAAA"}

package/dist/types/utils/toXOnly.d.ts

@@ -1,2 +0,0 @@
-export declare const toXOnly: (pubKey: Uint8Array) => Uint8Array<ArrayBufferLike>;
-//# sourceMappingURL=toXOnly.d.ts.map

package/dist/types/utils/toXOnly.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"toXOnly.d.ts","sourceRoot":"","sources":["../../../src/utils/toXOnly.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,OAAO,GAAI,QAAQ,UAAU,gCACc,CAAA"}

package/dist/types/version.d.ts

@@ -1,3 +0,0 @@
-export declare const name = "@lifi/sdk-provider-bitcoin";
-export declare const version = "4.0.1-alpha.0";
-//# sourceMappingURL=version.d.ts.map

package/dist/types/version.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,IAAI,+BAA+B,CAAA;AAChD,eAAO,MAAM,OAAO,kBAAkB,CAAA"}

package/src/BitcoinStepExecutor.ts

@@ -1,333 +0,0 @@
-import type { Client, ReplacementReason } from '@bigmi/core'
-import {
-  AddressType,
-  getAddressInfo,
-  hexToUnit8Array,
-  signPsbt,
-  waitForTransaction,
-  withTimeout,
-} from '@bigmi/core'
-import * as ecc from '@bitcoinerlab/secp256k1'
-import {
-  BaseStepExecutor,
-  ChainId,
-  checkBalance,
-  getStepTransaction,
-  LiFiErrorCode,
-  type LiFiStepExtended,
-  type SDKClient,
-  type StepExecutorOptions,
-  stepComparison,
-  TransactionError,
-  type TransactionParameters,
-  waitForDestinationChainTransaction,
-} from '@lifi/sdk'
-import { address, initEccLib, networks, Psbt } from 'bitcoinjs-lib'
-import { getBitcoinPublicClient } from './client/publicClient.js'
-import { parseBitcoinErrors } from './errors/parseBitcoinErrors.js'
-import { generateRedeemScript } from './utils/generateRedeemScript.js'
-import { isPsbtFinalized } from './utils/isPsbtFinalized.js'
-import { toXOnly } from './utils/toXOnly.js'
-
-interface BitcoinStepExecutorOptions extends StepExecutorOptions {
-  client: Client
-}
-
-export class BitcoinStepExecutor extends BaseStepExecutor {
-  private client: Client
-
-  constructor(options: BitcoinStepExecutorOptions) {
-    super(options)
-    this.client = options.client
-  }
-
-  checkClient = (step: LiFiStepExtended) => {
-    // TODO: check chain and possibly implement chain switch?
-    // Prevent execution of the quote by wallet different from the one which requested the quote
-    if (this.client.account?.address !== step.action.fromAddress) {
-      throw new TransactionError(
-        LiFiErrorCode.WalletChangedDuringExecution,
-        'The wallet address that requested the quote does not match the wallet address attempting to sign the transaction.'
-      )
-    }
-  }
-
-  executeStep = async (
-    client: SDKClient,
-    step: LiFiStepExtended
-  ): Promise<LiFiStepExtended> => {
-    step.execution = this.statusManager.initExecutionObject(step)
-
-    const fromChain = await client.getChainById(step.action.fromChainId)
-    const toChain = await client.getChainById(step.action.toChainId)
-
-    const isBridgeExecution = fromChain.id !== toChain.id
-    const currentActionType = isBridgeExecution ? 'CROSS_CHAIN' : 'SWAP'
-
-    let action = this.statusManager.findOrCreateAction({
-      step,
-      type: currentActionType,
-      chainId: fromChain.id,
-    })
-
-    const publicClient = await getBitcoinPublicClient(client, ChainId.BTC)
-
-    if (action.status !== 'DONE') {
-      try {
-        let txHash: string
-        let txHex: string
-        if (action.txHash) {
-          // Make sure that the chain is still correct
-          this.checkClient(step)
-
-          // Wait for exiting transaction
-          txHash = action.txHash
-          txHex = action.txHex
-        } else {
-          action = this.statusManager.updateAction(step, action.type, 'STARTED')
-
-          // Check balance
-          await checkBalance(client, this.client.account!.address, step)
-
-          // Create new transaction
-          if (!step.transactionRequest) {
-            const { execution, ...stepBase } = step
-            const updatedStep = await getStepTransaction(client, stepBase)
-            const comparedStep = await stepComparison(
-              this.statusManager,
-              step,
-              updatedStep,
-              this.allowUserInteraction,
-              this.executionOptions
-            )
-            Object.assign(step, {
-              ...comparedStep,
-              execution: step.execution,
-            })
-          }
-
-          if (!step.transactionRequest?.data) {
-            throw new TransactionError(
-              LiFiErrorCode.TransactionUnprepared,
-              'Unable to prepare transaction.'
-            )
-          }
-
-          action = this.statusManager.updateAction(
-            step,
-            action.type,
-            'ACTION_REQUIRED'
-          )
-
-          if (!this.allowUserInteraction) {
-            return step
-          }
-
-          let transactionRequest: TransactionParameters = {
-            data: step.transactionRequest.data,
-          }
-
-          if (this.executionOptions?.updateTransactionRequestHook) {
-            const customizedTransactionRequest: TransactionParameters =
-              await this.executionOptions.updateTransactionRequestHook({
-                requestType: 'transaction',
-                ...transactionRequest,
-              })
-
-            transactionRequest = {
-              ...transactionRequest,
-              ...customizedTransactionRequest,
-            }
-          }
-
-          if (!transactionRequest.data) {
-            throw new TransactionError(
-              LiFiErrorCode.TransactionUnprepared,
-              'Unable to prepare transaction.'
-            )
-          }
-
-          this.checkClient(step)
-
-          const psbtHex = transactionRequest.data
-
-          // Initialize ECC library required for Taproot operations
-          // https://github.com/bitcoinjs/bitcoinjs-lib?tab=readme-ov-file#using-taproot
-          initEccLib(ecc)
-
-          const psbt = Psbt.fromHex(psbtHex, { network: networks.bitcoin })
-
-          psbt.data.inputs.forEach((input, index) => {
-            const accountAddress = input.witnessUtxo
-              ? address.fromOutputScript(
-                  input.witnessUtxo.script,
-                  networks.bitcoin
-                )
-              : (this.client.account?.address as string)
-            const addressInfo = getAddressInfo(accountAddress)
-            if (addressInfo.type === AddressType.p2tr) {
-              // Taproot (P2TR) addresses require specific PSBT fields for proper signing
-
-              // tapInternalKey: Required for Taproot key-path spending
-              // Most wallets  / libraries usually handle this already
-              if (!input.tapInternalKey) {
-                const pubKey = this.client.account?.publicKey
-                if (pubKey) {
-                  const tapInternalKey = toXOnly(hexToUnit8Array(pubKey))
-                  psbt.updateInput(index, {
-                    tapInternalKey,
-                  })
-                }
-              }
-              // sighashType: Required by bitcoinjs-lib even though the bitcoin protocol allows defaults
-              // check if sighashType is default (0) or not set (undefined)
-              if (!input.sighashType) {
-                psbt.updateInput(index, {
-                  sighashType: 1, // Default to Transaction.SIGHASH_ALL - 1
-                })
-              }
-            }
-            // redeemScript: Required by Pay-to-Script-Hash (P2SH) addresses for proper spending
-            if (addressInfo.type === AddressType.p2sh) {
-              if (!input.redeemScript) {
-                const pubKey = this.client.account?.publicKey
-                if (pubKey) {
-                  psbt.updateInput(index, {
-                    redeemScript: generateRedeemScript(hexToUnit8Array(pubKey)),
-                  })
-                }
-              }
-            }
-          })
-
-          const inputsToSign = Array.from(
-            psbt.data.inputs
-              .reduce((map, input, index) => {
-                const accountAddress = input.witnessUtxo
-                  ? address.fromOutputScript(
-                      input.witnessUtxo.script,
-                      networks.bitcoin
-                    )
-                  : (this.client.account?.address as string)
-                if (map.has(accountAddress)) {
-                  map.get(accountAddress).signingIndexes.push(index)
-                } else {
-                  map.set(accountAddress, {
-                    address: accountAddress,
-                    sigHash: 1, // Default to Transaction.SIGHASH_ALL - 1
-                    signingIndexes: [index],
-                  })
-                }
-                return map
-              }, new Map())
-              .values()
-          )
-
-          // We give users 10 minutes to sign the transaction or it should be considered expired
-          const signedPsbtHex = await withTimeout(
-            () =>
-              signPsbt(this.client, {
-                psbt: psbt.toHex(),
-                inputsToSign: inputsToSign,
-                finalize: false,
-              }),
-            {
-              timeout: 600_000,
-              errorInstance: new TransactionError(
-                LiFiErrorCode.TransactionExpired,
-                'Transaction has expired.'
-              ),
-            }
-          )
-
-          const signedPsbt = Psbt.fromHex(signedPsbtHex)
-
-          if (!isPsbtFinalized(signedPsbt)) {
-            signedPsbt.finalizeAllInputs()
-          }
-
-          txHex = signedPsbt.extractTransaction().toHex()
-
-          txHash = await publicClient.sendUTXOTransaction({
-            hex: txHex,
-          })
-
-          action = this.statusManager.updateAction(
-            step,
-            action.type,
-            'PENDING',
-            {
-              txHash: txHash,
-              txLink: `${fromChain.metamask.blockExplorerUrls[0]}tx/${txHash}`,
-              txHex,
-            }
-          )
-        }
-
-        let replacementReason: ReplacementReason | undefined
-        const transaction = await waitForTransaction(publicClient, {
-          txId: txHash,
-          txHex,
-          senderAddress: this.client.account?.address,
-          onReplaced: (response) => {
-            replacementReason = response.reason
-            action = this.statusManager.updateAction(
-              step,
-              action.type,
-              'PENDING',
-              {
-                txHash: response.transaction.txid,
-                txLink: `${fromChain.metamask.blockExplorerUrls[0]}tx/${response.transaction.txid}`,
-              }
-            )
-          },
-        })
-
-        if (replacementReason === 'cancelled') {
-          throw new TransactionError(
-            LiFiErrorCode.TransactionCanceled,
-            'User canceled transaction.'
-          )
-        }
-
-        if (transaction.txid !== txHash) {
-          action = this.statusManager.updateAction(
-            step,
-            action.type,
-            'PENDING',
-            {
-              txHash: transaction.txid,
-              txLink: `${fromChain.metamask.blockExplorerUrls[0]}tx/${transaction.txid}`,
-            }
-          )
-        }
-
-        if (isBridgeExecution) {
-          action = this.statusManager.updateAction(step, action.type, 'DONE')
-        }
-      } catch (e: any) {
-        const error = await parseBitcoinErrors(e, step, action)
-        action = this.statusManager.updateAction(step, action.type, 'FAILED', {
-          error: {
-            message: error.cause.message,
-            code: error.code,
-          },
-        })
-        throw error
-      }
-    }
-
-    await waitForDestinationChainTransaction(
-      client,
-      step,
-      action,
-      fromChain,
-      toChain,
-      this.statusManager,
-      10_000
-    )
-
-    // DONE
-    return step
-  }
-}