# Core

[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)

### 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

1. [Openwhisk](/dependencies/openwhisk.md)
2. [Openwhisk CLI](https://github.com/apache/openwhisk-cli)

### Components

#### Actions

* Event Register
* Event Receiver
* Event Processor
* Event Producer
* Kafka Provider
* Balance Filter
* Balance Notification Register
* Push Notification

### Installation

Assuming basic dependency such as [git](https://git-scm.com/) and [yarn](https://yarnpkg.com/) already installed.

1. Clone the repository

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

  2\. Navigate to the cloned directory

```
cd aurras
```

  3\. Generate server token from [https://console.firebase.google.com/project/\[project-name\]/settings/cloudmessaging](https://console.firebase.google.com/project/%5Bproject-name%5D/settings/cloudmessaging) and add as env FIREBASE\_API\_KEY

  4\. Deploy the actions using the deploy script. The script supports optional parameters which can be found [here](/components/event-manager/configuration.md).

```
./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

Licensed under [Apache-2.0](https://github.com/HugoByte/aurras-documentation/tree/f07f6727f0cb01cccf04f15ec446e2d310ca1cb9/components/event-feed/substrate-event-feed/LICENSE/README.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.aurras.hugobyte.com/components/event-manager.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.