@keep-network/tbtc-v2.ts v2.4.1

tBTC v2 SDK

tBTC SDK is a TypeScript library that provides effortless access to the fundamental features of the tBTC Bitcoin bridge. The SDK allows developers to integrate tBTC into their own applications and offer the power of trustless tokenized Bitcoin to their users.

Table of contents:

• Quickstart
  • Installation
  • Usage
• Contributing
  • Prerequisites
  • Install dependencies
  • Build
  • Test
  • Format
  • Auto-generated API reference
• Documentation

Quickstart

Here you can find instructions explaining how to use the SDK in your own project.

Installation

To install the tBTC SDK in your project using yarn, run:

yarn add @keep-network/tbtc-v2.ts

If you prefer to use npm, do:

npm i @keep-network/tbtc-v2.ts

Please note that you will also need to install the ethers v5 library to initialize a signer or provider. To do so using yarn, invoke:

yarn add ethers@legacy-v5

To do the same using npm, run:

npm i ethers@legacy-v5

The SDK depends on ethers v5. Proper support for newer ethers versions is not guaranteed right now.

Usage

Here is a short example demonstrating SDK usage:

// Import SDK entrypoint component.
import { TBTC } from "@keep-network/tbtc-v2.ts"

// Create an instance of ethers signer.
const signer = (...)

// Initialize the SDK.
const sdk = await TBTC.initializeMainnet(signer)

// Access SDK features.
sdk.deposits.(...)
sdk.redemptions.(...)

// Access tBTC smart contracts directly.
sdk.tbtcContracts.(...)

// Access Bitcoin client directly.
sdk.bitcoinClient.(...)

Contributing

Contributions are always welcome! Feel free to open any issue or send a pull request. Please refer the repository-level CONTRIBUTING.adoc document for general contribution guidelines. Below, you can find how to set up the SDK module for development.

Prerequisites

Please make sure you have the following prerequisites installed on your machine:

• node.js >=16
• yarn >=1.22 or npm >=8.11

Although the below commands use yarn you can easily use npm instead.

Install dependencies

To install dependencies, run:

yarn install

Build

To build the library, invoke:

yarn build

A dist directory containing the resulting artifacts will be created.

Test

To run unit tests, do:

yarn test

Format

To format code automatically, invoke:

yarn format:fix

Auto-generated API reference

There is an auto-generated API reference documentation that must be re-generated in case of modifications in the source code. This can be done automatically using a pre-commit hook or manually using:

yarn docs

Generated API reference in form of Markdown files is saved to the api-reference directory.

Documentation

This README provides just a basic guidance. Comprehensive documentation for this SDK can be found on the Threshold Network Docs website.