2.4.1 • Published 1 year ago

@quantnetwork/overledger-dlt-bitcoin v2.4.1

Weekly downloads
3
License
Apache-2.0
Repository
github
Last release
1 year ago

@quantnetwork/overledger-dlt-bitcoin

Overledger SDK module for interaction with the Bitcoin distributed ledger technology.

Installation

Install using npm:

npm install @quantnetwork/overledger-dlt-bitcoin

Or, if you prefer using yarn:

yarn add @quantnetwork/overledger-dlt-bitcoin

API Reference

Modules

Classes

overledger-dlt-bitcoin

overledger-dlt-bitcoin.default

Development package for Bitcoin blockchain.

overledger-dlt-bitcoin.log

Bitcoin

new Bitcoin(sdk, options)

ParamTypeDescription
sdkanythe sdk instance
optionsObjectany additional options to instantiate this dlt

bitcoin.name

Name of the DLT

bitcoin.symbol

Symbol of the DLT

bitcoin.createAccount()

Create a Bitcoin account

Returns: Account - the new Bitcoin account

bitcoin.setAccount(accountInfo)

ParamTypeDescription
accountInfoAccountThe standardised account information

Set an account for signing transactions for a specific DLT