bch-message-lib

An npm library for processing messages on the Bitcoin Cash blockchain using bch-js.

Usage no npm install needed!

<script type="module">
  import bchMessageLib from 'https://cdn.skypack.dev/bch-message-lib';
</script>

README

bch-message-lib

An npm library for processing messages on the Bitcoin Cash blockchain using bch-js.

This is a utility library that does processing of messages on the Bitcoin Cash blockchain. These messages primarily use the memo.cash protocol, and the end target for this library is the message.fullstack.cash web app.

These are the primary features provided by this library:

  • Push a normal memo.cash message to the blockchain.
  • Push an PS001 encrypt-msg message as a memo.cash message.
  • Retrieve the memo.cash name for a BCH address.
  • Retrieving message notifications and IPFS links from the blockchain that comply with PS001 specification.
  • Calculate the average coin age, merit, and PSF token balance for a BCH address.

Installation

npm install --save bch-message-lib

Usage

const BCHJS = require('@psf/bch-js')
const bchjs = new BCHJS()

const MsgLib = require('bch-message-lib')
const msgLib = new MsgLib({ bchjs })

async function start() {
  const addr = 'simpleledger:qrnn49rx0p4xh78tts79utf0zv26vyru6vvs577rn0'
  const tokenId = '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0'

  merit = await msgLib.merit.agMerit(addr, tokenId)
  console.log('merit: ', merit)
}
start()

Licence

MIT