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

LocalNet documentation using playground #1535

Merged
merged 14 commits into from
Apr 5, 2023
Merged

LocalNet documentation using playground #1535

merged 14 commits into from
Apr 5, 2023

Conversation

Olshansk
Copy link
Member

@Olshansk Olshansk commented Mar 15, 2023

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

RealDemo.mov

@Olshansk Olshansk changed the title [WIP] LocalNet documentation LocalNet documentation using playground Mar 16, 2023
@Olshansk
Copy link
Member Author

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

@Olshansk Olshansk self-assigned this Mar 16, 2023
@Olshansk Olshansk added this to the Network Quality of Life milestone Mar 16, 2023
@Olshansk Olshansk mentioned this pull request Mar 16, 2023
@Olshansk Olshansk marked this pull request as ready for review March 29, 2023 02:04
@Olshansk
Copy link
Member Author

@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:
- Gain confidence into the changes being introduced
- Create some ability to develop locally

The non-goals are to:
- Invest in a great developer experience
- Build long-lasting infrastructure & tool

localnet.md Outdated Show resolved Hide resolved
@reviewpad reviewpad bot added large Pull request is large waiting-for-review labels Apr 4, 2023
@reviewpad
Copy link

reviewpad bot commented Apr 4, 2023

Reviewpad Report

⚠️ Warnings

  • Please link an issue to the pull request
  • Please rebase your pull request on the latest changes

localnet.md Outdated Show resolved Hide resolved
@Olshansk
Copy link
Member Author

Olshansk commented Apr 4, 2023

/reviewpad summarize

@reviewpad
Copy link

reviewpad bot commented Apr 4, 2023

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.

localnet.md Outdated Show resolved Hide resolved
localnet.md Outdated Show resolved Hide resolved
localnet.md Outdated Show resolved Hide resolved
localnet.md Outdated Show resolved Hide resolved
localnet.md Outdated Show resolved Hide resolved
Copy link
Contributor

@msmania msmania left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To make LocalNet work on WSL2, I made the following changes on dependent repos. With these, I confirmed the LocalNet handled relays and processed claim and proof.

@cr-gpt
Copy link

cr-gpt bot commented Apr 4, 2023

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

@Olshansk Olshansk removed the request for review from nodiesBlade April 4, 2023 23:46
@cr-gpt
Copy link

cr-gpt bot commented Apr 4, 2023

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
Copy link

reviewpad bot commented Apr 4, 2023

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 reviewpad bot requested a review from luyzdeleon April 4, 2023 23:47
@Olshansk Olshansk requested review from msmania and removed request for luyzdeleon April 4, 2023 23:48
@reviewpad
Copy link

reviewpad bot commented Apr 4, 2023

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
Copy link
Contributor

msmania commented Apr 5, 2023

Thanks! The document and video looks nice and clear.

msmania
msmania previously approved these changes Apr 5, 2023
@reviewpad reviewpad bot requested a review from luyzdeleon April 5, 2023 16:48
@reviewpad
Copy link

reviewpad bot commented Apr 5, 2023

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
Copy link

reviewpad bot commented Apr 5, 2023

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.

@Olshansk Olshansk merged commit fa1923f into staging Apr 5, 2023
@Olshansk Olshansk deleted the fixing_localnet branch April 5, 2023 19:02
nodiesBlade pushed a commit that referenced this pull request Jul 5, 2023
Olshansk pushed a commit that referenced this pull request Jul 5, 2023
## Description

The mainnet genesis file was changed as part of PR #1535 when adding misc changes for localnet. Since I believe the genesis file is generated anded loaded via `InitGenesis`  and `InitChainer`, this resulted in a different genesis from the rest of the network and ultimately a different generated app hash than what the other peers are synced to. As a result, this caused syncing issues when trying to produce the first block and onwards as reported in #1564.

This change reverts the changes made in the genesis json in #1535

Tested by applying this change and running 
```sh
pocket start --seeds="7c0d7ec36db6594c1ffaa99724e1f8300bbd52d0@seed1.mainnet.pokt.network:26662,cdcf936d70726dd724e0e6a8353d8e5ba5abdd20@seed2.mainnet.pokt.network:26663,74b4322a91c4a7f3e774648d0730c1e610494691@seed3.mainnet.pokt.network:26662,b3235089ff302c9615ba661e13e601d9d6265b15@seed4.mainnet.pokt.network:26663" --mainnet
```

<!-- reviewpad:summarize:start -->
### Summary generated by Reviewpad on 05 Jul 23 07:43 UTC
This pull request reverts the mainnet genesis file from #1535. It updates the service URLs for several nodes in the mainnetGenesis variable in the genesis.go file. The URLs are changed from the dev environment to the production environment for the poktnodes.com and pokt.net domains. Additionally, the URLs for the pokt.foundation domain are updated as well.
<!-- reviewpad:summarize:end -->


Co-authored-by: poktblade <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants