Installable via npm install --save ipld-bitcoin, it can also be used directly in the browser.

Download

The source is available for download from GitHub. Alternatively, you can install using npm:

$ npm install --save ipld-bitcoin

You can then require() ipld-bitcoin as normal:

const ipldBitcoin = require('ipld-bitcoin')

In the Browser

Ipld-bitcoin should work in any ES2015 environment out of the box.

Usage:

<script type="text/javascript" src="index.js"></script>

The portable versions of ipld-bitcoin, including index.js and index.min.js, are included in the /dist folder. Ipld-bitcoin can also be found on unkpkg.com under

• https://unpkg.com/ipld-bitcoin/dist/index.min.js
• https://unpkg.com/ipld-bitcoin/dist/index.js

Parameters

error: Error?:  
Error if path can't be resolved
result: Object:  
Result of the path it it was resolved successfully
result.value: any:  
Value the path resolves to
result.remainderPath: string:  
If the path resolves half-way to a link, then the remainderPath is the part after the link that can be used for further resolving.

Resolves a path in a Bitcoin block.

Returns the value or a link and the partial mising path. This way the IPLD Resolver can fetch the link and continue to resolve.

Parameters

binaryBlob: Buffer:  
Binary representation of a Bitcoin block
path: string (='/'):  
Path that should be resolved
callback: ResolveCallback:  
Callback that handles the return value

Returns

Parameters

error: Error?:  
Error if paths can't be retreived
result: (Array<string> | Array<Object<string, any>>):  
The result depends on options.values , whether it returns only the paths, or the paths with the corresponding values

Return all available paths of a block.

Parameters

binaryBlob: Buffer:  
Binary representation of a Bitcoin block
options: Object?:  
Possible options
options.values: boolean (=false):  
Retun only the paths by default. If it is true also return the values
callback: TreeCallback:  
Callback that handles the return value

Returns

Parameters

error: Error?:  
Error if serialization failed
binaryBlob: Buffer?:  
Binary Bitcoin block if serialization was successful

Serialize internal representation into a binary Bitcoin block.

Parameters

dagNode: BitcoinBlock:  
Internal representation of a Bitcoin block
callback: SerializeCallback:  
Callback that handles the return value

Returns

Parameters

error: Error?:  
Error if deserialization failed
dagNode: BitcoinBlock?:  
Internal representation of a Bitcoin block if deserialization was successful

Deserialize Bitcoin block into the internal representation,

Parameters

binaryBlob: Buffer:  
Binary representation of a Bitcoin block
callback: DeserializeCallback:  
Callback that handles the return value

Returns

Parameters

error: Error?:  
Error if getting the CID failed
cid: CID?:  
CID if call was successful

Get the CID of the DAG-Node.

Parameters

dagNode: BitcoinBlock:  
Internal representation of a Bitcoin block
options: Object?:  
Options to create the CID
options.version: number (=1):  
CID version number
options.hashAlg: string (='dbl-sha2-256'):  
Hashing algorithm
callback: CidCallback:  
Callback that handles the return value

Returns