Bridge SDK

for BTC-NEAR bridge

Install

npm install satoshi-bridge-sdk

Project Structure

satoshi-bridge-sdk/
├── src/
│   ├── handlers/
│   │   ├── BtcHandler.ts         # Handles ABTC deposits
│   │   ├── BtcOriginHandler.ts   # Handles NBTC deposits
│   │   ├── NearHandler.ts        # Handles ABTC withdrawals
│   │   └── NearOriginHandler.ts  # Handles NBTC withdrawals
│   ├── utils/
│   │   ├── estimateGas.ts        # Gas estimation utilities
│   │   ├── transactions.ts       # Transaction helpers
│   │   └── wallets.ts            # Wallet integration utilities
│   │   └── uploadHash.ts         # upload hash to services
│   ├── types.ts                  # Type definitions
│   ├── constants.ts              # SDK constants and configurations
│   └── index.ts                  # Main entry point
├── package.json
└── README.md

NEAR Wallet Types

The SDK supports various NEAR wallets:

• 'btc-wallet'
• 'my-near-wallet'
• 'meteor-wallet'
• And others

Parameter Description

Parameter	Description	Type	Default
fromAmount	The amount you want to bridge	number/string (without decimals)	-
fromAddress	Your source asset address	string	-
toAddress	Your destination address	string	-
feeRate	BTC transaction fee rate: - 5: fast - 6: average - 7: slow - 0: custom	number	6
env	Environment type: mainnet or testnet	string	'mainnet'
fromTokenDecimals	Source token decimals (ABTC/NBTC) for token swap	number	-
toTokenDecimals	Destination token decimals (ABTC/NBTC) for token swap	number	-
walletId	Your current wallet identifier	string	-

Usage

BTC->NEAR Bridge

Depositing NBTC

    import { executeBTCDepositAndAction, useBTCProvider } from 'btc-wallet'
    import { BtcOriginHandler, estimateBtcGas, receivePreDepositMsg,receiveDepositMsg } from 'satoshi-bridge-sdk'


    //you can estimate the gas fee
    const estimateResult: EstimateGasResultBTC = await estimateBtcGas({
        fromAmount, 
        feeRate, 
        fromAddress, 
        env, 
        useDecmials,
        tokenOutMetaData,
        isCustomToken: false, // optional
        slippage: 0.005 // optional
    } as EstimateBtcGasParams);
    
    if (nearWalletType === 'btc-wallet') {

        const respTransaction:RepParams | RepParamsNotBtc = await BtcOriginHandler.handle( {
            fromAmount,
            fromAddress,
            toAddress,
            feeRate = 6,
            env = 'mainnet',
            nearWalletType = 'btc-wallet' // your wallet id such as 'my-near-wallet' ,'btc-wallet' , 'meteor-wallet' eg.
        } as BtcOriginHandleParams)

         const hash: string = await executeBTCDepositAndAction({
            ...respTransaction.transaction
         })
        
        // executeBTCDepositAndAction has help to receivePreDepositMsg and receiveDepositMsg

    } else {
        const { accounts, sendBitcoin, provider, getPublicKey, signMessage } = useBTCProvider();
        const respTransaction = await BtcOriginHandler.handle( {
            fromAmount,
            fromAddress,
            toAddress,
            feeRate = 6,
            env = 'mainnet',
            nearWalletType = 'btc-wallet'
        } as BtcOriginHandleParams)
        const { btnTempAddress, _fromAmount,feeRate } = respTransaction.transaction
        await receivePreDepositMsg(params.receivePreDepositMsg)
        const hash: string = await sendBitcoin(btnTempAddress, _fromAmount, {
            feeRate
        })
        await receiveDepositMsg(hash)
    }

Depositing ABTC

    import { executeBTCDepositAndAction, useBTCProvider } from 'btc-wallet'
    import { BtcHandler, estimateBtcGas, receivePreDepositMsg,receiveDepositMsg } from 'satoshi-bridge-sdk'
  
     //you can estimate the gas fee
    const estimateResult: EstimateGasResultBTC = await estimateBtcGas({
        fromAmount, 
        feeRate, 
        fromAddress, 
        env, 
        useDecmials,
        isCustomToken: false, // optional
        slippage: 0.005 // optional
    } as EstimateBtcGasParams);

    // you must confrim the token is not registered in NEAR 
    // registerContractId: ABTC_ADDRESS 


    if (nearWalletType === 'btc-wallet') {

        const respTransaction:ContractRep = await BtcHandler.handle( {
            fromAmount,
            fromAddress,
            toAddress,
            slippage = 0.05,
            feeRate = 6,
            env = 'mainnet',
            nearWalletType = 'btc-wallet'
        } as BtcHandleParams)
      
         const hash: string = await executeBTCDepositAndAction({
                ...respTransaction.transaction,
        })

    } else {
        // you must confrim the token is not registered in NEAR 
        // registerContractId: ABTC_ADDRESS 
        // after you register the token, you can use the following code

        const { accounts, sendBitcoin, provider, getPublicKey, signMessage } = useBTCProvider();
        const respTransaction = await BtcHandler.handle( {
            fromAmount,
            fromAddress,
            toAddress,
            slippage = 0.05,
            feeRate = 6,
            env = 'mainnet',
            nearWalletType = 'btc-wallet'
        } as BtcHandleParams)
        const { btnTempAddress, _fromAmount,feeRate } = respTransaction.transaction
        await receivePreDepositMsg(params.receivePreDepositMsg)
        const hash: string = await sendBitcoin(btnTempAddress, _fromAmount, {
            feeRate
        })
        await receiveDepositMsg(hash)
    }

NEAR->BTC Bridge

Withdrawing NBTC

    import { NearOriginHandler, estimateNearGas, updateWithdraw } from 'satoshi-bridge-sdk'


    const estimateResult:EstimateGasResultNear | EstimateGasResultNearErr = await estimateNearGas({
        fromAmount, 
        fromAddress,
        toAddress, 
        walletType, 
        isCustomToken, feeRate, env, useDecimals,
    } as EstimateNearGasParams);

    const respTransaction:Promise<NearOriginHandleResp | {
        isError: boolean,
        errorMsg: string
    }> = await NearOriginHandler.handle({
        fromAmount,
        fromAddress,
        toAddress,
        walletId,
        feeRate,
        env,
    } as NearOriginHandleParams)
   const hash = await wallet.signAndSendTransaction(respTransaction)
   await updateWithdraw(hash)

Withdrawing ABTC

    import { NearHandler, estimateNearGas, updateWithdraw } from 'satoshi-bridge-sdk'


    const estimateResult:EstimateGasResultNear | EstimateGasResultNearErr = await estimateNearGas({
        fromAmount, fromAddress,toAddress, walletType, isCustomToken, feeRate, env, useDecimals,
        slippage
    } as EstimateNearGasParams);
    

    const respTransaction:Promise<Array<NearHandleResp> | {
        isError: boolean,
        errorMsg: string
    }> = await NearHandler.handle({
        fromAmount,
        fromAddress,
        toAddress,
        slippage = 0.05,
        walletId = 'my-near-wallet',
        feeRate = 6,
        env = 'mainnet'
    } as NearHandleParams)
    const hash = await wallet.signAndSendTransactions(respTransaction)
    await updateWithdraw(hash)

Status

 import { fetchTransactionStatus } from 'satoshi-bridge-sdk'

 const res = await fetchTransactionStatus({
    hash: '',
    chainId: '1' | '2' (btc to near: 1, near to btc: 2),
    signature:  // withdraw nbtc can get signature from viewMethod
 })

 success: res.result_data.Status === 4 

Get Fee Rate

 import {getBtcFeeRate} from 'satoshi-bridge-sdk'
 const res = await getBtcFeeRate('mainnet')