@quantnetwork/overledger-dlt-bitcoin
v2.4.1
Published
Quant Network Overledger Bitcoin software development kit (SDK) for the JavaScript (JS) programming language.
Downloads
20
Keywords
Readme
@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)
| Param | Type | Description | | --- | --- | --- | | sdk | any | the sdk instance | | options | Object | any 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)
| Param | Type | Description | | --- | --- | --- | | accountInfo | Account | The standardised account information |
Set an account for signing transactions for a specific DLT