babbage-historian v0.1.2

historian

Token history interpreter for interacting with a Bitcoin overlay network

API

Table of Contents

• Historian
  • Parameters
  • interpret
    • Parameters
  • decodeTokenValue
    • Parameters

Historian

Interprets the history of a token BRC-8 envelope

Parameters

• correctOwnerKey string the ownerKey used in pushdrop to create the locking script
• correctSigningKey string the signing key that should have been used
• validate any? dynamic validation function to filter history

interpret

Recursive function for interpreting the history of a token

Parameters

• currentEnvelope
• currentDepth

Returns Promise[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>

decodeTokenValue

Decodes a pushdrop token TODO: Update to support other data structures! --> Currently coded for kvstore tokens

Parameters

• inputEnvelope

License & Confidentiality

The license for the code in this repository is the Open BSV License