Class(es) for interactiong with websocket API of Zilliqa node
npm install @zilliqa-js/subscriptionsJavaScript library for managing and handling subscription-based events with the
Zilliqa blockchain.
- Installation
- Usage
- Examples
- Supported Events
- Documentation
- License
``bash`
npm install @zilliqa-js/subscriptions --save
or
`bash`
yarn add @zilliqa-js/subscriptions
To start using the subscriptions package, first import the necessary components:
`javascript`
const { SubscriptionBuilder, Zilliqa } = require("@zilliqa-js/subscriptions");
or using ES6 imports:
`javascript`
import { SubscriptionBuilder, Zilliqa } from "@zilliqa-js/subscriptions";
`javascript
const zilliqa = new Zilliqa("https://api.zilliqa.com");
const subscription = zilliqa.subscriptionBuilder.buildNewBlockSubscriptions();
subscription.subscribe();
subscription.emitter.on(StatusType.SUBSCRIBE_NEW_BLOCK, (event) => {
console.log("New block:", event.value);
});
`
After subscribing, you can also unsubscribe from events:
`javascript`
subscription.unsubscribe();
- New Block Subscriptions (SUBSCRIBE_NEW_BLOCK)SUBSCRIBE_TX`)
- Transaction Subscriptions (
- [Add more supported events as per the library]
For comprehensive documentation, please refer to
Zilliqa Official Documentation.
This project is licensed under the GPL License. View LICENSE for
more information.