notiboy-js-sdk
v1.1.0
Published
JS SDK for Notiboy Notifications
Downloads
48
Readme
notiboy-js-sdk
The official JavaScript library for sending, receiving and storing on-chain notifications on algorand blockchain via notiboy smart contract.
Installation
Node.js
npm install notiboy-js-sdk
Import
ESM
import
import algosdk from "algosdk";
import Notiboy from "notiboy-js-sdk";
CJS
require
const algosdk = require('algosdk');
const Notiboy = require('notiboy-js-sdk').default;
Quick Start
const client = new algosdk.Algodv2("", "https://mainnet-api.algonode.cloud", "");
const indexer = new algosdk.Indexer("", "https://mainnet-idx.algonode.cloud", "");
const notiboy = new Notiboy(client, indexer);
SDK Development
Building
To build a new version of the library, run:
npm run build
Node.js
To run the mocha tests in Node.js, run:
npm run test
Example
Documentation with further explanation and examples can be found in Docs
Example implementation of the SDK can be seen in this vue.js webApp
License
notiboy-js-sdk is licensed under an MIT License. See the LICENSE file for details.