Skip to content

Commit

Permalink
Update NodeRed
Browse files Browse the repository at this point in the history
- Merged milestones
- Consolidate documentation / test tasks into one
- Made milestones compliant with template
  • Loading branch information
johnuopini authored Nov 28, 2023
1 parent d7ec2b0 commit 6131f9c
Showing 1 changed file with 21 additions and 39 deletions.
60 changes: 21 additions & 39 deletions applications/NodeRed.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,73 +16,55 @@ Zooper Corp's Node Red Client for Polkadot is a project aimed at bridging the ga
- **Documentation:** Comprehensive documentation of core components and Node Red usage page
- **Prior Work:** https://flows.nodered.org/node/node-red-contrib-polkadot
- **Project Limitations:** Client supports Substrate only
- **Total Costs:** 25,000 DAI / 5,000 DOT
- **Total Costs:** 25,000 DAI
- **Total Milestones:** 2

### Milestone 1 — Basic Functionality

- **Estimated Duration:** None (delivered)
- **Estimated Duration:** 3 months
- **FTE:** 1
- **Costs:** 5000 DAI
- **Costs:** 10000 DAI

| Number | Deliverable | Specification |
| -----: | ----------- | ------------- |
| **0a.** | License | MIT |
| **0b.** | Documentation | Inline code documentation and a basic tutorial. |
| **0c.** | Testing Guide | Comprehensive unit tests for core functions. |
| **1.** | Node Red Integration | Development of basic Node Red nodes for Polkadot interaction. |

### Milestone 2 — Documentation and Base Examples

- **Estimated Duration:** 2 months
- **FTE:** 0.5
- **Costs:** 2500 DAI
| **0b.** | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can use the nodes with examples for each single node and screenshots. |
| **0c.** | Testing and Testing Guide | Core functions will be fully covered by comprehensive unit tests to ensure functionality and robustness. |
| 1. | Node Red Integration | Development of basic Node Red nodes for Polkadot interaction. |
| 2. | Address issues | Assign, triage or address any pending issue on the github repo. |

| Number | Deliverable | Specification |
| -----: | ----------- | ------------- |
| **2a.** | Documentation | Development of inline code documentation and basic tutorials. |
| **2b.** | Examples | Creation of base examples and screens to illustrate plugin usage. |
### Milestone 2 — Metadata and EVM Chain Support

### Milestone 3 — Issue Fixes and EVM Chain Support

- **Estimated Duration:** 2 months
- **Estimated Duration:** 3 months
- **FTE:** 0.5
- **Costs:** 2500 DAI
- **Costs:** 5000 DAI

| Number | Deliverable | Specification |
| -----: | ----------- | ------------- |
| **3a.** | Bug Fixes | Addressing and resolving issues in the current release (es big int / human convertions). |
| **3b.** | EVM Support | Adding support for EVM based chains, like Moonbeam. |
| 1. | EVM Support | Adding support for EVM based chains, like Moonbeam. |
| 2. | Metadata Loading | Implementing automatic metadata loading and basic chain information (e.g., decimals, token). |
| 3. | Metadata Node | Implementing basic metadata node that provides chain info. |

### Milestone 4Metadata Loading and Chain Info
### Milestone 3Block Event Subscription Node

- **Estimated Duration:** 2 months
- **Estimated Duration:** 3 months
- **FTE:** 0.5
- **Costs:** 2500 DAI
- **Costs:** 5000 DAI

| Number | Deliverable | Specification |
| -----: | ----------- | ------------- |
| **4a.** | Metadata Loading | Implementing automatic metadata loading and basic chain information (e.g., decimals, token). |
| 1. | Block Event Node | Development of a new node for subscribing to block events with extrinsic or address filtering. This could be very useful to use Node Red to be notified for a given transaction|

### Milestone 5Block Event Subscription Node
### Milestone 4Pallet/Function Selection and Payload Input

- **Estimated Duration:** 2 months
- **Estimated Duration:** 3 months
- **FTE:** 0.5
- **Costs:** 2500 DAI
- **Costs:** 5000 DAI

| Number | Deliverable | Specification |
| -----: | ----------- | ------------- |
| **5a.** | Block Event Node | Development of a new node for subscribing to block events. |
| 1. | Pallet/Function Node | Creating a node allowing users to query chain by selecting pallets/functions and input payload, similar to the JS client. |

### Milestone 6 — Pallet/Function Selection and Payload Input

- **Estimated Duration:** 2 months
- **FTE:** 0.5
- **Costs:** 2500 DAI

| Number | Deliverable | Specification |
| -----: | ----------- | ------------- |
| **6a.** | Pallet/Function Node | Creating a node allowing users to select pallets/functions and input payload, similar to the JS client. |

### Ecosystem Fit

Expand Down

0 comments on commit 6131f9c

Please sign in to comment.