You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add new targets to the Makefile in order to generate a genesis.json file and a list of config.json files.
Origin Document
In order to test variousLocalNetconfigurations, especially as we start adding different types of protocol actors in the future, we need to be able to build such configurations easily.
Goals
An easy-to-use make target to dynamically generate genesis and config files for various LocalNet configurations. This will eventually be used for DevNet as well even though it is out of scope of this PR.
Deliverable
Documenting the list of parameters we need for the config generator
A separate PR only adding a new make target that outputs genesis.json and a list of config.json files
Unit tests (in Go) that validate the genesis and config files
Non-goals / Non-deliverables
Updating the docker-compose file so the new configurations can be
Anything to do with DevNet deployment
General issue deliverables
Update the appropriate CHANGELOG
Update any relevant READMEs (local and/or global)
Update any relevant global documentation & references
If applicable, update the source code tree explanation
If applicable, add or update a state, sequence or flowchart diagram using mermaid
Testing Methodology
Add unit tests to validate the generate genesis & config files in Go
## Description
In order to test various LocalNet configurations, especially as we start adding different types of protocol actors in the future, we need to be able to build such configurations easily.
An easy-to-use make target to dynamically generate genesis and config files for various LocalNet configurations. This will eventually be used for DevNet as well even though it is out of scope of this PR.
## Issue
Fixes#182
## Type of change
Please mark the options that are relevant.
- [x] New feature, functionality or library
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] Code health or cleanup
- [ ] Major breaking change
- [x] Documentation
- [ ] Other: <REPLACE_ME>
## List of changes
- [x] Added make target for genesis and config generation in `build/config`
- [x] Document parameters and usage with `README.md`
## Testing
- [x] `make test_all`
- [x] [LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md) w/ all of the steps outlined in the `README`
- [x] `make genesis_and_config`
## Checklist
- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have tested my changes using the available tooling
- [x] If applicable, I have made corresponding changes to related local or global README
Co-authored-by: Andrew Nguyen <andrewnguyen@Andrews-MacBook-Pro-2.local>
Co-authored-by: Daniel Olshansky <olshansky.daniel@gmail.com>
Objective
Add new targets to the
Makefile
in order to generate agenesis.json
file and a list ofconfig.json
files.Origin Document
In order to test various
LocalNet
configurations, especially as we start adding different types of protocol actors in the future, we need to be able to build such configurations easily.Goals
An easy-to-use make target to dynamically generate genesis and config files for various LocalNet configurations. This will eventually be used for DevNet as well even though it is out of scope of this PR.
Deliverable
genesis.json
and a list ofconfig.json
filesNon-goals / Non-deliverables
docker-compose
file so the new configurations can beDevNet
deploymentGeneral issue deliverables
Testing Methodology
Go
Creator: @Olshansk
Co-Owners: @andrewnguyen22
The text was updated successfully, but these errors were encountered: