/aurras-event-feed-icon-js

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Event Feed - ICON

Aurras is a middleware that acts as an event processor and a low code workflow orchestration platform. Aurras is being pitched as a next-generation system for enabling decentralized push notification. This middleware solution listens to events from blockchain applications and propagates them to a registered pool of MQTT brokers. The broader architecture consists of parachain from which the middleware listens for the events.

This Event Feed package facilitates to source events from icon chains. The events will be posted to the OpenWhisk system. icon-sdk is used under the hood to establish the connection to blockchain nodes and receive events.

Installation

Assuming basic dependency such as git and yarn already installed.

  1. Clone the repository
git clone https://github.com/HugoByte/aurras-event-feed-icon-js.git
  1. Navigate to the cloned directory
cd aurras-event-feed-icon-js
  1. Install dependencies
npm install

Configuration

Configurations are passed through environment variables which can be found here.

For local development and testing create a .env file with respective configurations in the project root folder.

CHAIN_NAME=NodeTemplate
CHAIN_ENDPOINT=https://berlin.net.solidwallet.io/api/v3/
CONTRACT_ADRESS=cxf4958b242a264fc11d7d8d95f79035e35b21c1bb
EVENT_NAME=CallMessage;CallMessageSent
KAFKA_BROKERS=172.17.0.1:9092
OPENWHISK_API_KEY=23bc46b1-71f6-4ed5-8c54-816aa4f8c502:123zO3xZCLrMN6v2BKK1dXYFpXlPkccOFqm12CdAsMgRU4VrNZ9lyGVCGuMDGIwP
OPENWHISK_API_HOST=https://139.84.142.77:31001
OPENWHISK_NAMESPACE=guest
EVENT_RECEIVER=event-receiver
EVENT_PROCESSOR=icon-event-processor

Usage

Start the feed in development mode.

npx ts-node src/index.ts

or

npm run build
npm start

Docker Compose

docker-compose --project-name icon-aurras up -d

License

Licensed under Apache-2.0