Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Config] Add make targets for config & genesis generation #182

Closed
9 tasks
Olshansk opened this issue Aug 28, 2022 · 0 comments · Fixed by #207
Closed
9 tasks

[Config] Add make targets for config & genesis generation #182

Olshansk opened this issue Aug 28, 2022 · 0 comments · Fixed by #207
Assignees
Labels
infra Core infrastructure - not protocol related tooling tooling to support development, testing et al

Comments

@Olshansk
Copy link
Member

Objective

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

Creator: @Olshansk
Co-Owners: @andrewnguyen22

@Olshansk Olshansk added infra Core infrastructure - not protocol related priority:high tooling tooling to support development, testing et al labels Aug 28, 2022
@Olshansk Olshansk moved this to Up Next in V1 Dashboard Sep 4, 2022
@Olshansk Olshansk moved this from Up Next to Rescope / decompose in V1 Dashboard Sep 5, 2022
@Olshansk Olshansk moved this from Rescope / decompose to TODO in V1 Dashboard Sep 7, 2022
@Olshansk Olshansk moved this from TODO to Up Next in V1 Dashboard Sep 7, 2022
andrewnguyen22 pushed a commit that referenced this issue Sep 12, 2022
andrewnguyen22 pushed a commit that referenced this issue Sep 15, 2022
andrewnguyen22 pushed a commit that referenced this issue Sep 17, 2022
## 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>
Repository owner moved this from Up Next to Done in V1 Dashboard Sep 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infra Core infrastructure - not protocol related tooling tooling to support development, testing et al
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants