search

pokt-network / pocket-core

Official implementation of the Pocket Network Protocol
http://www.pokt.network
MIT License
210 stars 103 forks source link

LocalNet documentation using playground #1535

Closed Olshansk closed 1 year ago

Olshansk commented 1 year ago

Description

Add documentation on how to use e2e-stack, tx-bot and local_playground to run a 4 node LocalNet that enables hot reloading of our Tendermint fork.

Import Note

Note that this is a hacky & ugly reuse of existing infrastructure and is not meant to be an elegant long-term solution. It is just enough to test & ship new features while v1 is in development.

Dependencies

Demo

https://user-images.githubusercontent.com/1892194/225497350-3817b262-f5d5-483b-bb8f-47fb0b614321.mov

Olshansk commented 1 year ago

@msmania Check out the video. This is the work I was telling you about a couple days ago.

Olshansk commented 1 year ago

@PoktBlade @msmania Can you guys give the LocalNet documentation a shot when you have a chance?

You might need to use this tendermint branch.

Note the following.

The goals of this are to:

The non-goals are to:

reviewpad[bot] commented 1 year ago

Reviewpad Report

:warning: Warnings

Olshansk commented 1 year ago

/reviewpad summarize

reviewpad[bot] commented 1 year ago

AI-Generated Pull Request Summary: This pull request includes changes across several files to improve documentation, update dependencies, modify configurations, and enhance code readability. Notable updates include adding an entry for output_*.dlv files to the .gitignore file, changing service URLs of nodes to development domains, updating the changelog, and modifying the go.mod and go.sum files to update dependency versions. Additionally, there are minor updates to formatting, comments, and file organization in various other documents and code snippets, as well as the addition of a new guide for setting up V0 LocalNet for experienced Pocket developers.

cr-gpt[bot] commented 1 year ago

Seems you are using me but didn't get OPENAI_API_KEY seted in Variables for this repo. you could follow readme for more information

cr-gpt[bot] commented 1 year ago

Seems you are using me but didn't get OPENAI_API_KEY seted in Variables for this repo. you could follow readme for more information

reviewpad[bot] commented 1 year ago

AI-Generated Pull Request Summary: This pull request includes a variety of changes across multiple files. Key updates involve:

  1. Adding localnet.md and "V0 LocalNet" guide to help set up local Pocket Networks for development and testing.
  2. Updating documentation, such as doc/guides/quickstart.md, hostedBlockchain.go, and version 8.0 documentation, to improve clarity and provide instructions for new features.
  3. Making modifications in files like mainnetGenesis, go.mod, and go.sum to update dependencies, module versions, and service URLs.
  4. Enhancing readability and fixing formatting issues in changelogs and documentation.
  5. Introducing code changes, such as renaming a variable in types/module/module.go and updating file patterns in the .gitignore file.

These updates cover documentation improvements, dependency updates, and code changes that enhance the user experience and ensure project compatibility.

reviewpad[bot] commented 1 year ago

AI-Generated Pull Request Summary: This pull request contains changes across several files, including minor updates to CONTRIBUTING.md, refactoring of variable names in the EndBlock function, updates to the doc/guides/quickstart.md and doc/guides/localnet.md files, improvements to the .gitignore file, and several dependency updates in the go.mod and go.sum files. Additionally, changes have been made to the service URLs for nodes, adjustments to import statements and comments, and updates to the changelog.md file. Notable updates include removal of the basic_auth object in JSON examples, the addition of a new non-custodial staking command, and a new tutorial for setting up and running a local Pocket-Core network. Please test changes thoroughly to ensure compatibility and maintain stability.

msmania commented 1 year ago

Thanks! The document and video looks nice and clear.

reviewpad[bot] commented 1 year ago

AI-Generated Pull Request Summary: This pull request introduces multiple changes affecting various aspects of the project, including updates to dependencies in go.mod and go.sum, documentation improvements, and code modifications. Key changes include:

  1. Updating the go.mod and go.sum files with new dependency versions and replacing/adding/removing directives.
  2. Removing the basic_auth object from configuration examples in doc/guides/quickstart.md and changesAndfeatures8.md.
  3. Updating the service URLs of multiple nodes in the mainnetGenesis variable to point to the development environment.
  4. Changing a variable name in types/module/module.go to follow Go naming conventions.
  5. Adding changes to changelog.md to document updates, fixes, and improvements made to the project.
  6. Reorganizing import statements and comments in the HostedBlockchain-related code.
  7. Updating the .gitignore file by adding a new pattern to ignore certain files.
  8. Making minor updates to the CONTRIBUTING.md file, such as removing an unnecessary newline.
  9. Adding a new file localnet.md to provide a guide on setting up a local V0 Pocket Network for development and testing purposes.
reviewpad[bot] commented 1 year ago

AI-Generated Pull Request Summary: This pull request includes several changes, such as the renaming of a variable in types/module/module.go, updates to the doc/guides/quickstart.md, modification of dependencies in go.sum and go.mod, code organization and readability improvements in hostedBlockchain.go, and URL updates for nodes. Additionally, it introduces a new markdown guide for setting up V0 LocalNet, updates the changelog.md file with the latest changes, features, and bug fixes, and makes changes to the changesAndfeatures8.md. Lastly, minor formatting updates are applied to the CONTRIBUTING.md and a new rule is added to the .gitignore file.