Skip to content

Latest commit

 

History

History
107 lines (74 loc) · 4.07 KB

README.md

File metadata and controls

107 lines (74 loc) · 4.07 KB
Raw

Aleph zero notification service

notification_service is Aleph Zero network client that subscribes to events and sends notification to variaty of channels (e.g. Telegram).

Repository structure

This repository contains:

  • cli.rs - command line application interface. Use -h option for the list of available commands.
  • events.rs - aleph node event subscriber
  • notifications - event notification channels, e.g. Telegram
  • subscriptions - aleph node Subscriptions smart contract client, listening for events e.g. NewSubscription, CancelledSubscription, CancelledSubscriptions
  • Makefile - helper commands used to build and test application. Use make help for the list of available commands

Setup

Prerequisites

rustup installation

$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
$ source ~/.cargo/env

Building and testing

The application is built using the --release flag to minimize the size of the binary.

$ make build-service

Telegram bot configuration

Telegram requires bot to be configured for using Telegram REST API. In order to create a new bot use @Botfather the the format 123456789:aaaabbbbcccc.

Find the Telegram chat_id or group_chat_id where notifications will be sent. In a future version, this feature will be dynamically configured as a part of subscription procedure. Use @RawDataBot to get your chat_id, e.g. 222222222 from the json message below (message/chat/id).

    "update_id": 111111111,
    "message": {
        "chat": {
            "id": 222222222,
            "first_name": "user.azero",
            "username": "username",
            "type": "private"
        },
    }
}

Find the aleph-notifications Telegram bot and start the channel. This step is required by the bot to send messages to your chat_id.

Command line options

Utilities to interact with Aleph Zero events

Usage: notification_service [OPTIONS] -c <SC_ADDRESS> <COMMAND>

Commands:
  transfer-event  Capture finalized transfer events for a given on-chain account
  rewarded-event  Capture finalized validator rewarded event for a given on-chain account
  help            Print this message or the help of the given subcommand(s)

Options:
  -l, --log-level <error|warn|info|debug|trace>
          Logging level [default: info]
  -n, --node <NODE_ADDRESS>
          Webservice endpoint address of the Aleph Zero node [default: ws://localhost:9944]
  -c <SC_ADDRESS>
          On chain address of KYB registry smart contract
  -m <SC_METADATA>
          Path to the contract's metadata json file [default: metadata.json]
  -h, --help
          Print help

Command line options for the transfer-event command:

Capture finalized transfer events for a given on-chain account

Usage: notification_service -c <SC_ADDRESS> transfer-event <COMMAND>

Commands:
  telegram  Notification are sent to the Telegram bot
  help      Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

Usage scenarios

Capture on-chain Transfer event and send notification about it to the Telegram channel

Send notifications about transfer event to the Telegram channel. Connect to the local node (version r-12.1).

$ ./notification-service/target/release/notification_service -n ws://127.0.0.1:9944 -c -m contracts/subscriptions/target/ink/subscriptions.json transfer-event telegram --token

Example transfer notification sent to the Telegram bot.

Example transfer notification event

Capture on-chain Rewarded event and send notification about it to the Telegram channel

Send notifications about nominator's Rewarded event to the Telegram channel. Connect to the local node (version r-12.1).

$ ./notification-service/target/release/notification_service -n ws://127.0.0.1:9944 -c -m contracts/subscriptions/target/ink/subscriptions.json rewarded-event telegram --token