@gorillapool/js-junglebus
v0.4.4
Published
TypeScript library for connecting to a GorillaPool JungleBus server
Downloads
64
Readme
Gorilla Pool JungleBus: JS Client
Table of Contents
What is JungleBus?
Installation
Install the JungleBus library into your project:
$ npm install @gorillapool/js-junglebus
or, with yarn
$ yarn add @gorillapool/js-junglebus
Usage
Here's the getting started with JungleBus
import { JungleBusClient } from '@gorillapool/js-junglebus';
const server = "junglebus.gorillapool.io";
const jungleBusClient = new JungleBusClient(server, {
onConnected(ctx) {
// add your own code here
console.log(ctx);
},
onConnecting(ctx) {
// add your own code here
console.log(ctx);
},
onDisconnected(ctx) {
// add your own code here
console.log(ctx);
},
onError(ctx) {
// add your own code here
console.error(ctx);
}
});
// create subscriptions in the dashboard of the JungleBus website
const subId = "....";
const fromBlock = 750000;
const subscription = jungleBusClient.Subscribe(
subId,
fromBlock,
onPublish(tx) => {
// add your own code here
console.log(tx);
},
onStatus(ctx) => {
// add your own code here
console.log(ctx);
},
onError(ctx) => {
// add your own code here
console.log(ctx);
},
onMempool(tx) => {
// add your own code here
console.log(tx);
});
Lite Mode
JungleBus also supports a lite mode, which delivers only the transaction hash and block height. This is useful for applications that only need to know when a transaction is included in a block.
To use lite mode, just pass true as a final argument to the Subscribe method.
await client.Subscribe("a5e2fa655c41753331539a2a86546bf9335ff6d9b7a512dc9acddb00ab9985c0", 1550000, onPublish, onStatus, onError, onMempool, true);
Documentation
View more JungleBus documentation.
Code Standards
Please read our code standards document
Contributing
View the contributing guidelines and follow the code of conduct.
How can I help?
All kinds of contributions are welcome :raised_hands:! The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:. You can also support this project by becoming a sponsor on GitHub :clap:
Contributors ✨
Thank you to these wonderful people (emoji key):
This project follows the all-contributors specification.