@oraichain/bitcoin-bridge-lib-js

bitcoin-bridge-lib-js

A JavaScript library for accepting Bitcoin deposits with Interchain Deposits to any IBC-enabled blockchain, powered by Oraichain.

Installation

npm install @oraichain/bitcoin-bridge-lib-js

Oraichain Deposits

import { generateDepositAddress } from "nomic-bitcoin";

let depositInfo = await generateDepositAddress({
  relayers: ["https://btc.perfogic.store:443"],
  dest: {
    address: <orai-address>
  }
});

console.log(depositInfo);
/*
{
  code: 0,
  bitcoinAddress: "bc1q75ezz735ncd7alhlm7gwc0jyzdckfwe5ct7tfsld455nrtgdrt0qa2cu0y",
}
*/

Interchain Deposits (Currently not supporting on beta.oraidex.io yet)

import { generateDepositAddress } from "nomic-bitcoin";

let depositInfo = await generateDepositAddress({
  relayers: ["https://btc.perfogic.store:443"],
  dest: {
    ibc: {
      memo: "",
      receiver: "orai1ehmhqcn8erf3dgavrca69zgp4rtxj5kqgtcnyd",
      sender: "orai1rchnkdpsxzhquu63y6r4j4t57pnc9w8ehdhedx",
      source_channel: "channel-6", // Oraichain should have the src-channel to the destination chain
      source_port: "transfer",
      timeout_timestamp: 1735059744308000000,
    },
  },
});

console.log(depositInfo);
/*
{
  code: 0,
  bitcoinAddress: "bc1q75ezz735ncd7alhlm7gwc0jyzdckfwe5ct7tfsld455nrtgdrt0qa2cu0y",
}
*/

Capacity limit

The bridge currently has a capacity limit, which is the maximum amount of BTC that can be held in the bridge at any given time. When the capacity limit is reached, relayers will reject newly-broadcasted deposit addresses.

If the bridge is over capacity, the response code in depositInfo will be 2.

let depositInfo = await generateDepositAddress(opts);
if (depositInfo.code === 2) {
  console.error(`Capacity limit reached`);
}

Partner chains should communicate clearly to the user that a deposit address could not be safely generated because the bridge is currently over capacity.