@chakrachain/btc-settlement-sdk v1.0.0-beta.3

Intro

A JavaScript sdk for chakra btc settlement script builder

Usage

Install

npm install @chakrachain/btc-settlement-sdk

or

yarn add @chakrachain/btc-settlement-sdk

Prerequisites

:::tip

Before using the sdk, configure the supported projects and chains to ChakraBTCSettlement-ProjectsConfig

:::

buildTransferPsbt() : build Psbt for chakra btc settlement

Params :

1. amount:number, Required field, Amount to be settled.
2. network: string Required field, sMainnet or signet.
3. address: string Required field, BTC wallet address,
4. pubkey: string Required field, BTC wallet public key.
5. targetChainReceiverAddress: string Required field, Target address for settlement.
6. targetChainId: string Required field, Target chainId for settlement, Please make sure the chainid is configured in the chains.json first.
7. projectName: string Required field, Settlement project name, Please make sure the project is configured in the projects.json first.
8. feeRate: number Required field, Network fee rate.
9. skipVault: boolean Optional field, Skip Vault Contract transfer to Stake Contracts

Response : Promise: Psbt

Usage Examples

import { useEffect } from "react";


const psbt = await buildTransferPsbt(
    100000,
    'mainnet', 
    'tb1*****', // YOUR BTC WALLET ADDRESS
    '*****', // YOUR BTC WALLET PUBLIC KEY
    "0x1234567889", // RECEIVER ADDRESS
    '67', // RECEIVER CHAIN ID 
    "Pendle", // or  Lombard
    300
)