---
# System prepended metadata

title: Revenue Sharing 2022 Q3/Q4 Planning
tags: [PM]

---

---
tags: PM
---

# Revenue Sharing 2022 Q3/Q4 Planning

This document lists out both the proposed monthly work plans as well as all possible work streams to which time can be allocated. Work streams present on the chart may be low priority or not within scope, but it is meant to be exhaustive of all possible projects that can be undertaken.

## July Proposed Plan

1. [Sean + Itamar] Switch debits from DATA to a withdraw queue
2. [Sean] Re-write the example scenarios for withdraw queue
3. [Itamar] Implement re-written example scenarios
4. [Sean] Docker integration for the model
5. [Sean] Research and iterations on outstanding issues + disccusion topics
6. [Itamar] Iterate on github issues, especially those that the example scenarios bring to light
7. [Itamar] Provide support/review to Sean's docker integration
8. [Sean] Project management tasks including code reviews, agenda setting, meetings, etc.

## Workstreams [All Possible]


| Math Spec                         | Streamr cadCAD Model              | Spec x cadCAD                         | General                       |
| --------------------------------- | ------------------- | ------------------------------------- | ----------------------------- |
| [Revisions Log](#Revisions-Log)   | [Docker Integration](#Docker-Integration)  | [Example Scenarios](#Example-Scenarios) | [Outstanding Issue Discussions](#Outstanding-Issue-Discussions) |
| [Policy Options](#Policy-Options) | [Integration Testing](#Integration-Testing) | [Parameter Selection Under Uncertainty](#Parameter-Selection-Under-Uncertainty) | [Communications/PM](#Communications/PM) |
|[Auto-Documentation](#Auto-Documentation)| [Github Issues](#Github-Issues) | [Digital Twin](#Digital-Twin) ||
|| [Add Stream Agreements](#Add-Stream-Agreements) |||

### Revisions Log

There is a log full of revisions for the mathematical specification that would make it better to iterate through. Log available [here](https://hackmd.io/v7nLGvGjSIG6HoR8PiEpMQ?view).


### Policy Options

The sheet of different candidate policy options can be further built out to both cover a wider variety of functions while also possibly being cleaned up. Options sheet available [here](https://hackmd.io/Wbzd_SRYQnSXHlB6_j8ZSA).

### Docker Integration

- "Docker is a set of platform as a service products that use OS-level virtualization to deliver software in packages called containers. Containers are isolated from one another and bundle their own software, libraries and configuration files; they can communicate with each other through well-defined channels."
- Configurations for docker would need to be added to the project which then allow users to spin up a docker container, or cloud service providers to take a docker container for use in the cloud.
- Possible benefits:
1. Replication of the enviroment for any end users who use the model in the future lowering barriers to entry.
2. Integration with github actions for integration testing
3. Seamless integration into cloud service providers aiding the transition to an operational digital twin if that path is chosen

### Integration Testing

- For the longer term stability of the system, integration testing (after docker integration) can be built to run tests with github actions

### Github Issues

- There is a list of github issues to tackle within the repository over time

### Example Scenarios

- Example Scenarios are built out for two purposes: 1. to validate the different actions from a mechanical point of view 2. to check and find failure modes and possible issues for the system
- For each example scenario, the idea is to write the specification first then build out cadCAD testing for validation
- The link to the scenarios is [here](https://hackmd.io/QFmCXi8oT_SMeQ111qe6LQ)

### Parameter Selection Under Uncertainty

- PSUU is useful for identifying which variables lead to better system stability
- KPIs and metrics for system stability would first be established
- A sweep of parameters would be run in monte carlo simulations to see the impacts of different policies and parameterizations
- Analysis would be conducted to identify which policies and variables look like the best candidates for a stable system

### Digital Twin

- A digital twin model would take the cadCAD model and wrap it in a format that allows for backtesting of historical data and extrapolation of future data
- This step is generally best done once there is a running model as then it can be used to ensure the actual system reflects what was supposed to happen
- The digital twin also is useful for extensions into monitoring in an automated/cloud enviroment
- While streamr does not have revenue sharing currently, starting on the digital twin now would lead to it being ready when the system is operational

### Outstanding Issue Discussions

- There are open discussion questions to continue researching and iterating on.
- The link is [here](https://hackmd.io/SFHwNrfESsSoGXEdbL5jvg)


### Communications/PM

- This is a catch all for any project management and communication related work

### Auto-Documentation

Write scripts for auto-documentation in the future. Basically would be definitions of all the policies, mechanisms, behavioral actions, etc. and how they are graphically related. This would then make it so that one could iterate over the graph relationships and re-create the diagrams and specifications (what type inputs are etc) automatically allowing for easy switching of names, expansions of documentation, etc.

### Add Stream Agreements

- In the current cadCAD model, we make no assumptions on the stream agreement end except that we put stake there and then that we also receive revenue based on total stake
- This likely can benefit from further specification, two options for it:
1. Make a simplistic model of different stream agreements
2. Do a full integration with the stream agreements model
