Aurras
  • Overview
  • Components
    • Core
      • Configuration
    • Event Feed
      • Event Feed - Substrate
        • Configuration
        • Deployment
          • Docker Compose
          • Kubernetes
  • Dependencies
    • Docker
      • Environments
        • Windows
        • macOS
        • Ubuntu
    • Docker Compose
      • Environments
        • Windows
        • macOS
        • Ubuntu
    • Kubernetes
      • Environments
        • Windows
        • macOS
        • Ubuntu
    • Helm
    • Openwhisk
      • Deployment
        • Docker Compose
        • Kubernetes
          • Environment
            • Windows
            • macOS
            • Ubuntu
Powered by GitBook
On this page
  • Introduction
  • Prerequisites
  • Components
  • Installation
  • Usage
  • Testing
  • License
  1. Components

Core

PreviousOverviewNextConfiguration

Last updated 3 years ago

Introduction

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.

The Event Manager as a core component of the aurras system is composed of multiple actions including using a database to store trigger URLs and their respective auth, and Kafka provider, consumer, and producer. Once the event manager receives an event from the event feed, this data is produced to a topic. The feed action in the manager lets the user hook into the system. That is, once an event is indexed to a particular topic, it can invoke a particular action. While creating the workflow, users can choose the event trigger as feed and provide necessary parameters from which chain it should be listening to.

Prerequisites

Components

Actions

  • Event Register

  • Event Receiver

  • Event Processor

  • Event Producer

  • Kafka Provider

  • Balance Filter

  • Balance Notification Register

  • Push Notification

Installation

  1. Clone the repository

git clone https://github.com/HugoByte/aurras.git

2. Navigate to the cloned directory

cd aurras
./deploy.sh

Usage

Generate Event Registration ID

./register_event_source.sh --name "Node Template Balance"

Testing

Run Unit test suites

To test push-notification action it is required to have a push notification token generated from the client and Firebase API Key in TEST_DEVICE_TOKEN and FIREBASE_API_KEY environment variable respectively

cargo test --all-features

License

Assuming basic dependency such as and already installed.

3. Generate server token from and add as env FIREBASE_API_KEY

4. Deploy the actions using the deploy script. The script supports optional parameters which can be found .

Licensed under

git
yarn
https://console.firebase.google.com/project/[project-name]/settings/cloudmessaging
here
Apache-2.0
Openwhisk
Openwhisk CLI
License