Pushdrop-tokenator NPM

pushdrop-tokenator

A Tokenator for Exchanging PushDrop Tokens P2P

Overview

PushDropTokenator is a specialized derived class of Tokenator that enables the creation and transfer of Bitcoin tokens with arbitrary signed payloads stored on the stack. These tokens can be used to represent and transfer ownership of any type of digital asset, such as files, text, images, videos, and more.

Developers can easily use PushDropTokenator as a base class and derive specialized class with new functionalty for dealing with a particular token type. For example, EmailTokenator is a class that is derived from PushDropTokenator for sending and receiving email tokens peer-to-peer. ScribeTokenator is another example for exchanging Scribe notes

PushDropTokenator is a powerful tool for creating Bitcoin powered applications that involve the transfer of digital assets. It is an excellent example of how Tokenator's base-level class can be extended to create specialized tokens that solve real-world problems.

Example Usage

This example demonstrates sending and receiving PushDrop tokens with pushdrop-tokenator

const PushDropTokenator = require('pushdrop-tokenator')
const johnSmith = '022600d2ef37d123fdcac7d25d7a464ada7acd3fb65a0daf85412140ee20884311'

const init = async () => {
    // Create a new instance of the PushDropTokenator class
    // Configure the parameters according to the protocol being used
    const tokenator = new PushDropTokenator({
        peerServHost: 'https://staging-peerserv.babbage.systems',
        defaultTokenValue = 1,
        protocolID = 'customProtocol',
        protocolKeyID = 1,
        protocolBasketName = 'customProtocol',
        protocolMessageBox = 'customProtocol_inbox',
        protocolAddress = 'UNIQUE PROTOCOL ID HERE'
    })
    // Send a PushDrop token using Babbage
    await tokenator.sendPushDropToken({
        recipient: johnSmith,
        title: 'Example token with a title',
        contents: 'You can include any data you want inside this object.',
        htmlCode: '<html><body><h1>PUSHDROP TOKEN</h1></body></html>'
    })

    // Receive incoming tokens into your PushDrop basket
    const tokensReceived = await tokenator.receivePushDropTokens()
}

init()

API

PushDropTokenator

PushDropTokenator

Extends Tokenator

Extends the Tokenator class to enable sending PushDrop 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).
- obj.defaultTokenValue (optional, default 1)
- obj.protocolID
- obj.protocolKeyID
- obj.protocolBasketName
- obj.protocolMessageBox
- obj.protocolAddress

createPushDropToken

Parameters

data Object The data object with any data fields to send
- data.recipient String Who this data should be sent to (optional, default 'self')

redeemPushDropToken

Redeems a PushDrop Token by Spending the UTXO

Parameters

token Object the token object returned from createPushDropToken
description string? description of this action (optional, default `Delete a ${this.protocolID} token`)

Returns Object the result of the createAction call

sendPushDropToken

Sends a PushDrop token to a PeerServ recipient

Parameters

data Object The data object with any data fields to send
- data.recipient String Who this data should be sent to (optional, default 'self')