scribe-tokenator v0.1.31

scribe-tokenator

A Tokenator for Scribe Notes

API

Table of Contents

• ScribeTokenator
  • Parameters
  • createScribeToken
    • Parameters
  • sendScribeToken
    • Parameters
  • decryptNotes
  • handleRedeem
    • Parameters

ScribeTokenator

Extends PushDropTokenator

Extends the Tokenator class to enable sending Scribe tokens with custom instructions Peer-to-Peer

Parameters

• obj object? All parameters are given in an object (optional, default {})

  • obj.peerServHost String? The PeerServ host you want to connect to (optional, default 'https://staging-peerserv.babbage.systems')
  • obj.dojoHost String? The Dojo to use for UTXO management (optional, default 'https://staging-dojo.babbage.systems')
  • obj.clientPrivateKey String? A private key to use for mutual authentication with Authrite. (Optional - Defaults to Babbage signing strategy).

createScribeToken

Parameters

• note Object The note object

  • note.title string The recipient of the payment
  • note.contents Number The amount in satoshis to send
  • note.recipient String Who this note should be sent to

sendScribeToken

Sends a Scribe token to a PeerServ recipient

Parameters

• note Object The note object

  • note.title string The title of this note
  • note.contents Number The contents of the note
  • note.recipient String Who this note should be sent to

decryptNotes

Decrypts all available notes in a user's Scribe basket

Returns Array of decrypted note objects

handleRedeem

Deletes or updates a note token

Parameters

• selectedNote Object the note to update or delete
• shouldUpdate Boolean whether additional outputs should be redeemed (optional, default false)