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.

Sign up for GitHub

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

Jump to bottom

[P2P] Simplify P2P module implementation #553

Closed
1 of 9 tasks
jessicadaugherty opened this issue Feb 27, 2023 · 2 comments
Closed
1 of 9 tasks

[P2P] Simplify P2P module implementation #553

jessicadaugherty opened this issue Feb 27, 2023 · 2 comments
Assignees
@bryanchriswhite
Labels
p2p P2P specific changes
Milestone
M1: Pocket PoS (P...

Comments

@jessicadaugherty
Copy link
Contributor

jessicadaugherty commented Feb 27, 2023 •
edited by bryanchriswhite
Loading

Objective

Simplify the libp2p module implementation by refactoring the Transport and Network interfaces.

Origin Document

Next steps identified in #500

Goals

  • Reduce the complexity of the Transport and Network interfaces

Deliverable

  • Refactor the Transport and Network interfaces to improve readability
  • Consider renaming the Network object to better reflect its behavior as a Router but keep in mind that it may be replaced with a "raintree pubsub router" in future iterations

Non-goals / Non-deliverables

  • Adding new functionality to the LibP2P integration

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

  • All tests: make test_all
  • LocalNet: verify a LocalNet is still functioning correctly by following the instructions at docs/development/README.md

Creator: @jessicadaugherty
Co-owner: @bryanchriswhite
@jessicadaugherty jessicadaugherty converted this from a draft issue Feb 27, 2023
@jessicadaugherty jessicadaugherty added the p2p P2P specific changes label Feb 27, 2023
@jessicadaugherty
Copy link
Contributor Author

@bryanchriswhite @Olshansk this is ready for review

@jessicadaugherty jessicadaugherty moved this to Up Next in V1 Dashboard Mar 6, 2023
@bryanchriswhite bryanchriswhite changed the title [WIP][P2P] Simplify libp2p module implementation [P2P] Simplify libp2p module implementation Mar 6, 2023
@bryanchriswhite
Copy link
Contributor

Looks good to me 👍

@bryanchriswhite bryanchriswhite moved this from Up Next to In Progress in V1 Dashboard Mar 8, 2023
@jessicadaugherty jessicadaugherty moved this from In Progress to Up Next in V1 Dashboard Mar 8, 2023
@bryanchriswhite bryanchriswhite mentioned this issue Mar 10, 2023
Merged
16 tasks
@bryanchriswhite bryanchriswhite mentioned this issue Mar 28, 2023
Open
9 tasks
@bryanchriswhite bryanchriswhite moved this from Up Next to In Progress in V1 Dashboard Apr 19, 2023
@bryanchriswhite bryanchriswhite mentioned this issue Apr 21, 2023
Closed
7 tasks
@bryanchriswhite bryanchriswhite changed the title [P2P] Simplify libp2p module implementation [P2P] Simplify P2P module implementation Apr 27, 2023
@bryanchriswhite bryanchriswhite mentioned this issue Apr 27, 2023
Merged
18 tasks
bryanchriswhite added a commit that referenced this issue Apr 28, 2023
@bryanchriswhite
[P2P] chore: remove unnecessary stdnetwork package (#703)
09b2bce 
## Description

Removes the unneeded `stdnetwork` package.

## Issue

Covers removal goal of #266. The simplification goal is tracked by #553.
TLDR; should close #266.

## Type of change

Please mark the relevant option(s):

- [ ] New feature, functionality or library
- [ ] Bug fix
- [x] Code health or cleanup
- [ ] Major breaking change
- [ ] Documentation
- [ ] Other <!-- add details here if it a different type of change -->

## List of changes

- Removed unneeded `stdnetwork` package
- Removed unneeded `use_rain_tree` P2P config field

## Testing

- [ ] `make develop_test`; if any code changes were made
- [x] [Docker Compose
LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md);
if any major functionality was changed or introduced
- [x] [k8s
LocalNet](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md);
if any infrastructure or configuration changes were made

## Required Checklist

- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have added, or updated, [`godoc` format
comments](https://go.dev/blog/godoc) on touched members (see:
[tip.golang.org/doc/comment](https://tip.golang.org/doc/comment))
- [ ] I have tested my changes using the available tooling
- [ ] I have updated the corresponding CHANGELOG

### If Applicable Checklist

- [ ] I have updated the corresponding README(s); local and/or global
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have added, or updated,
[mermaid.js](https://mermaid-js.github.io) diagrams in the corresponding
README(s)
- [ ] I have added, or updated, documentation and
[mermaid.js](https://mermaid-js.github.io) diagrams in `shared/docs/*`
if I updated `shared/*`README(s)
Olshansk pushed a commit that referenced this issue Apr 28, 2023
@bryanchriswhite @Olshansk
[P2P] chore: remove unnecessary stdnetwork package (#703)
b83efc7 
Removes the unneeded `stdnetwork` package.

Covers removal goal of #266. The simplification goal is tracked by #553.
TLDR; should close #266.

Please mark the relevant option(s):

- [ ] New feature, functionality or library
- [ ] Bug fix
- [x] Code health or cleanup
- [ ] Major breaking change
- [ ] Documentation
- [ ] Other <!-- add details here if it a different type of change -->

- Removed unneeded `stdnetwork` package
- Removed unneeded `use_rain_tree` P2P config field

- [ ] `make develop_test`; if any code changes were made
- [x] [Docker Compose
LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md);
if any major functionality was changed or introduced
- [x] [k8s
LocalNet](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md);
if any infrastructure or configuration changes were made

- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have added, or updated, [`godoc` format
comments](https://go.dev/blog/godoc) on touched members (see:
[tip.golang.org/doc/comment](https://tip.golang.org/doc/comment))
- [ ] I have tested my changes using the available tooling
- [ ] I have updated the corresponding CHANGELOG

- [ ] I have updated the corresponding README(s); local and/or global
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have added, or updated,
[mermaid.js](https://mermaid-js.github.io) diagrams in the corresponding
README(s)
- [ ] I have added, or updated, documentation and
[mermaid.js](https://mermaid-js.github.io) diagrams in `shared/docs/*`
if I updated `shared/*`README(s)
@github-project-automation github-project-automation bot moved this from In Progress to Done in V1 Dashboard May 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bryanchriswhite bryanchriswhite

Labels
p2p P2P specific changes
Projects
V1 Dashboard
Status: Done
Milestone
M1: Pocket PoS (Proof of Stake)
Development

No branches or pull requests
2 participants
@bryanchriswhite @jessicadaugherty