From cef9b5aa446b0a9cd22a5af8349c1188a677b3b4 Mon Sep 17 00:00:00 2001 From: Muhammed Irfan K Date: Mon, 16 Aug 2021 19:21:00 +0530 Subject: [PATCH 1/5] Initial Draft --- ...roject_aurras_mvp_phase_1_milestone-2-3.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 deliveries/project_aurras_mvp_phase_1_milestone-2-3.md diff --git a/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md b/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md new file mode 100644 index 0000000000..cb7dce45eb --- /dev/null +++ b/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md @@ -0,0 +1,19 @@ +# Milestone Delivery :mailbox: + +**The [invoice form :pencil:](https://forms.gle/8Wx7nxtq8fKrsuEz8) has been filled out correctly for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/General-Grants-Program/blob/master/grants/milestone-deliverables-guidelines.md).** + +* **PR Link:** https://github.com/w3f/Open-Grants-Program/pull/163 +* **Milestone Number:** [Milestone #2](https://github.com/w3f/Grants-Program/blob/master/applications/project_aurras_mvp_phase_1.md#milestone-2--event-manager---part-1) [Milestone #3](hhttps://github.com/w3f/Grants-Program/blob/master/applications/project_aurras_mvp_phase_1.md#milestone-3--event-manager---part-2) + +Please provide a list of all deliverables of the milestone extracted from the initial application and a link to the deliverable itself. Ideally all links inside the below table should include a commit hash, which should be used for testing. + +## Milestone 2 +| Number | Deliverable | Link | Notes | +| ------------- | ------------- | ------------- |------------- | +| 0a. | License || All the packages uses the Apache 2.0 license. | + + +## Milestone 3 +| Number | Deliverable | Link | Notes | +| ------------- | ------------- | ------------- |------------- | +| 0a. | License || All the packages uses the Apache 2.0 license. | From 30af9e36c3a3c845afaf1db6c6ca2230fbd9218b Mon Sep 17 00:00:00 2001 From: Muhammed Irfan K Date: Mon, 16 Aug 2021 19:25:36 +0530 Subject: [PATCH 2/5] Update template --- deliveries/project_aurras_mvp_phase_1_milestone-2-3.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md b/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md index cb7dce45eb..47f808fd66 100644 --- a/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md +++ b/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md @@ -1,19 +1,17 @@ # Milestone Delivery :mailbox: -**The [invoice form :pencil:](https://forms.gle/8Wx7nxtq8fKrsuEz8) has been filled out correctly for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/General-Grants-Program/blob/master/grants/milestone-deliverables-guidelines.md).** +**The [invoice form :pencil:](https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp-hd8mhIiO0A/viewform) has been filled out correctly for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/milestone-deliverables-guidelines.md).** * **PR Link:** https://github.com/w3f/Open-Grants-Program/pull/163 -* **Milestone Number:** [Milestone #2](https://github.com/w3f/Grants-Program/blob/master/applications/project_aurras_mvp_phase_1.md#milestone-2--event-manager---part-1) [Milestone #3](hhttps://github.com/w3f/Grants-Program/blob/master/applications/project_aurras_mvp_phase_1.md#milestone-3--event-manager---part-2) +* **Milestone Number:** [Milestone #2](https://github.com/w3f/Grants-Program/blob/master/applications/project_aurras_mvp_phase_1.md#milestone-2--event-manager---part-1) +https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp-hd8mhIiO0A/viewform -Please provide a list of all deliverables of the milestone extracted from the initial application and a link to the deliverable itself. Ideally all links inside the below table should include a commit hash, which should be used for testing. - -## Milestone 2 | Number | Deliverable | Link | Notes | | ------------- | ------------- | ------------- |------------- | | 0a. | License || All the packages uses the Apache 2.0 license. | +* **Milestone Number:** [Milestone #3](https://github.com/w3f/Grants-Program/blob/master/applications/project_aurras_mvp_phase_1.md#milestone-3--event-manager---part-2) -## Milestone 3 | Number | Deliverable | Link | Notes | | ------------- | ------------- | ------------- |------------- | | 0a. | License || All the packages uses the Apache 2.0 license. | From e25d347d664f3bcf7bfc8f6f344eeb15e6d285d3 Mon Sep 17 00:00:00 2001 From: Muhammed Irfan K Date: Thu, 2 Sep 2021 01:43:58 +0530 Subject: [PATCH 3/5] Update Deliveries --- ...roject_aurras_mvp_phase_1_milestone-2-3.md | 32 +++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md b/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md index 47f808fd66..da0d36adaf 100644 --- a/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md +++ b/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md @@ -8,10 +8,38 @@ https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp- | Number | Deliverable | Link | Notes | | ------------- | ------------- | ------------- |------------- | -| 0a. | License || All the packages uses the Apache 2.0 license. | +| 0a. | License |[aurras-event-feed-substrate-js](https://github.com/HugoByte/aurras-event-feed-substrate-js/blob/master/LICENSE)
[aurras](https://github.com/HugoByte/aurras/blob/master/LICENSE)
[aurras-documentation](https://github.com/HugoByte/aurras-documentation/blob/master/LICENSE)
[aurras-deployment-docker-compose](https://github.com/HugoByte/aurras-deployment-docker-compose/blob/master/LICENSE)
[aurras-deployment-kubernetes](https://github.com/HugoByte/aurras-deployment-kubernetes/blob/master/LICENSE)| All the packages uses the Apache 2.0 license. | +| 0c. | Testing Guide | [aurras-event-feed-substrate](https://github.com/HugoByte/aurras-event-feed-substrate-js/tree/master#testing)
[aurras](https://github.com/HugoByte/aurras#testing)
[Integration Test](https://github.com/HugoByte/aurras-event-manager/blob/next/docs/integration-testing.md) | Unit Tests:
[Aurras Actions](https://github.com/HugoByte/aurras/tree/next/actions) | +| 1a. | Kafka Provider: Fork | Fork Existing [openwhisk-package-kafka](https://github.com/apache/openwhisk-package-kafka/) | [kafka-provider-feed](https://github.com/HugoByte/aurras/tree/next/actions/kafka-provider-feed)
[kafka-provider-web](https://github.com/HugoByte/aurras/tree/next/actions/kafka-provider-web)
[event-producer](https://github.com/HugoByte/aurras/tree/next/actions/event-producer)
[NOTICE](https://github.com/HugoByte/aurras/blob/next/NOTICE#L1) | +| 2. | Database Service | Implement DB Service, DB Integration, Connect DB provided through configuration variables | [Source](https://github.com/HugoByte/aurras/blob/next/actions/common/src/types/context.rs)| +| 3a. | Event Manager: Event Source Registration | Integrate with DB service - CouchDB, Register Source with Chain Name, Chain Specification, Create Unique topic for provided Section-Method, Return created topics - Section-Method Map | [event-receiver](https://github.com/HugoByte/aurras/tree/next/actions/event-receiver)
[event-processor](https://github.com/HugoByte/aurras/tree/next/actions/substrate-event-processor)
[event-registration](https://github.com/HugoByte/aurras/tree/next/actions/event-registration)
[Registration Script](https://github.com/HugoByte/aurras/blob/next/register_event_source.sh) | +| 3b. | Event Manager: Kafka provider feed action | Integrate with DB service - CouchDB, Add CREATE, READ, UPDATE, DELETE lifecycle methods for trigger, Validate parameters (Section-Method, broker, isJSONData, isBinaryValue, isBinaryKey), Get unique topic from DB using Section-Method param,Record topic and related trigger to DB on CREATE lifecycle | [kafka-provider-feed](https://github.com/HugoByte/aurras/tree/next/actions/kafka-provider-feed)
[event-registration](https://github.com/HugoByte/aurras/tree/next/actions/event-registration) | * **Milestone Number:** [Milestone #3](https://github.com/w3f/Grants-Program/blob/master/applications/project_aurras_mvp_phase_1.md#milestone-3--event-manager---part-2) | Number | Deliverable | Link | Notes | | ------------- | ------------- | ------------- |------------- | -| 0a. | License || All the packages uses the Apache 2.0 license. | +| 0a. | License |[aurras-event-feed-substrate-js](https://github.com/HugoByte/aurras-event-feed-substrate-js/blob/master/LICENSE)
[aurras](https://github.com/HugoByte/aurras/blob/master/LICENSE)
[aurras-documentation](https://github.com/HugoByte/aurras-documentation/blob/master/LICENSE)
[aurras-deployment-docker-compose](https://github.com/HugoByte/aurras-deployment-docker-compose/blob/master/LICENSE)
[aurras-deployment-kubernetes](https://github.com/HugoByte/aurras-deployment-kubernetes/blob/master/LICENSE)| All the packages uses the Apache 2.0 license. | +| 0c. | Testing Guide | The code will have unit-test coverage (min. 50%) to ensure functionality and robustness. In the guide we will describe how to run these tests | [Source](https://github.com/HugoByte/aurras-event-feed-substrate-js/tree/next/tests) | +| 0d. | Article | We will write a Medium article that explains the work done as part of the grant. | Article to be added to medium upon approval from grants team, [link](https://docs.google.com/document/d/1NQP6cO1A3k60JivtbYClxHjdu4j1qqSfwj-bCnaLAFg/edit?usp=sharing) | +| 1a. | Event Manager: Kafka Produce Action | Validate for parameters, Connect to provided brokers, Produce data to provided topic | [Source](https://github.com/HugoByte/aurras/tree/next/actions/event-producer) | +| 1b. | Event Manager: Kafka provider feed action | Integrate with DB service - CouchDB, Delete trigger from DB on DELETE lifecycle, Read trigger from DB on READ lifecycle, Update trigger from DB on UPDATE lifecycle | [Source](https://github.com/HugoByte/aurras/tree/next/actions/kafka-provider-feed) | +| 2a. | Substrate Event Feed: Configuration | Config for Sections of the chain to create unique topics | [Source](https://github.com/HugoByte/aurras-event-feed-substrate-js) | +| 2b. | Substrate Event Feed: Event Source Registration | Event Source Registration | [Source](https://github.com/HugoByte/aurras/blob/next/register_event_source.sh) | + +**Note** + +* Considering the comments from first milestone delivery we have added below components that where not in scope inorder bring a utility for this delivery + * Push Notification + * Balance Filter + * Minimal UI for Registering Balance Notification + +* Below Components has been scoped out + * Kafka and Zookeeper Deployment guide - As the deployment is done through Docker Compose and Helm Chart + * wskdeploy , Event Manager: Intermediate Container as the rust action has to be pre compiled and existing runtime was not compatible we had to customise the runtime for our need. runtime used https://github.com/HugoByte/openwhisk-runtime-rust. + * Kafka Provider: Helm Chart Configuration as openwhisk helm chart contains the Kafka Provider + +**Known Issues** +* Actions might fail if the device has less than 8GB ram +* Connecting to live chain for a long time is not feasible as the Runtime need to be optimized for concurrency +* Push notifications will not be visible if the substrate-push-notification page is on focus. It should either be closed or should be in background after notification registration From cd095cf444634899a328338c8f16e870ca106e16 Mon Sep 17 00:00:00 2001 From: Muhammed Irfan K Date: Thu, 2 Sep 2021 01:46:31 +0530 Subject: [PATCH 4/5] Minor fixes --- deliveries/project_aurras_mvp_phase_1_milestone-2-3.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md b/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md index da0d36adaf..e6cfdf5bd7 100644 --- a/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md +++ b/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md @@ -4,7 +4,6 @@ * **PR Link:** https://github.com/w3f/Open-Grants-Program/pull/163 * **Milestone Number:** [Milestone #2](https://github.com/w3f/Grants-Program/blob/master/applications/project_aurras_mvp_phase_1.md#milestone-2--event-manager---part-1) -https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp-hd8mhIiO0A/viewform | Number | Deliverable | Link | Notes | | ------------- | ------------- | ------------- |------------- | @@ -29,7 +28,7 @@ https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp- **Note** -* Considering the comments from first milestone delivery we have added below components that where not in scope inorder bring a utility for this delivery +* Considering the comments from first milestone delivery we have added below components that where not in scope inorder to bring a utility for this delivery * Push Notification * Balance Filter * Minimal UI for Registering Balance Notification From b5ca7044a2e4c95679cfae57e07ff30ab25f9e81 Mon Sep 17 00:00:00 2001 From: Muhammed Irfan K Date: Sat, 25 Sep 2021 11:06:58 +0530 Subject: [PATCH 5/5] Add medium article link --- deliveries/project_aurras_mvp_phase_1_milestone-2-3.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md b/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md index e6cfdf5bd7..448fb34a2f 100644 --- a/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md +++ b/deliveries/project_aurras_mvp_phase_1_milestone-2-3.md @@ -20,7 +20,7 @@ | ------------- | ------------- | ------------- |------------- | | 0a. | License |[aurras-event-feed-substrate-js](https://github.com/HugoByte/aurras-event-feed-substrate-js/blob/master/LICENSE)
[aurras](https://github.com/HugoByte/aurras/blob/master/LICENSE)
[aurras-documentation](https://github.com/HugoByte/aurras-documentation/blob/master/LICENSE)
[aurras-deployment-docker-compose](https://github.com/HugoByte/aurras-deployment-docker-compose/blob/master/LICENSE)
[aurras-deployment-kubernetes](https://github.com/HugoByte/aurras-deployment-kubernetes/blob/master/LICENSE)| All the packages uses the Apache 2.0 license. | | 0c. | Testing Guide | The code will have unit-test coverage (min. 50%) to ensure functionality and robustness. In the guide we will describe how to run these tests | [Source](https://github.com/HugoByte/aurras-event-feed-substrate-js/tree/next/tests) | -| 0d. | Article | We will write a Medium article that explains the work done as part of the grant. | Article to be added to medium upon approval from grants team, [link](https://docs.google.com/document/d/1NQP6cO1A3k60JivtbYClxHjdu4j1qqSfwj-bCnaLAFg/edit?usp=sharing) | +| 0d. | Article | We will write a Medium article that explains the work done as part of the grant. | [link](https://medium.com/hugobyte/completion-of-aurras-mvp-a-middleware-for-the-web3-ecosystem-ee4f666be6aa) | | 1a. | Event Manager: Kafka Produce Action | Validate for parameters, Connect to provided brokers, Produce data to provided topic | [Source](https://github.com/HugoByte/aurras/tree/next/actions/event-producer) | | 1b. | Event Manager: Kafka provider feed action | Integrate with DB service - CouchDB, Delete trigger from DB on DELETE lifecycle, Read trigger from DB on READ lifecycle, Update trigger from DB on UPDATE lifecycle | [Source](https://github.com/HugoByte/aurras/tree/next/actions/kafka-provider-feed) | | 2a. | Substrate Event Feed: Configuration | Config for Sections of the chain to create unique topics | [Source](https://github.com/HugoByte/aurras-event-feed-substrate-js) |