[Libp2p] Add libp2p based P2P `Network` implementation (part 3) by bryanchriswhite · Pull Request #540 · pokt-network/pocket

bryanchriswhite · 2023-02-23T13:19:10Z

Description

This is another of a series of PRs split out from #500. Here we add a new implementation of typesP2P.Network in terms of libp2p abstractions, utilizing the helpers which were added in #534.

Issue

#347

Type of change

Please mark the relevant option(s):

List of changes

Added a new typesP2P.Network implementation to the libp2p module directory
Added embedded modules.InitializableModule to the P2P AddrBookProvider interface so that it can be dependency injected as a modules.Module via the bus registry.
Added PoktProtocolID for use within the libp2p module or by public API consumers

Testing

make develop_test
LocalNet w/ all of the steps outlined in the README

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 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 diagrams in the corresponding README(s)
I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)

(cherry picked from commit 27cfe05)

* pokt/main: [Tooling] Returning failed tests full output (#542) [Tooling] Update CLI to support key management (Issue #489) (#524)

(cherry picked from commit 2c8989f)

p2p/providers/addrbook_provider/addrbook_provider.go

libp2p/network/utils_test.go

libp2p/network/network_test.go

libp2p/network/network.go

deblasis · 2023-02-28T13:36:46Z

libp2p/network/network.go

+	// IMPROVE: receive context in interface methods.
+	ctx := context.Background()


Not actionable: 💯 it's something that we should do across the board more or less. I am dealing with this in persistence at the moment. It's fun!

➕ 1️⃣

deblasis

Nice one @bryanchriswhite! A couple minor changes but otherwise LGTM 🚀

libp2p/network/network.go

deblasis

There's a small typo but I trust you to fix it even if I am approving this. :)

* main: [Libp2p] Add libp2p module directories and helpers (part 1) (#534) [P2P, Runtime] Update P2P & base config (part 2) (#535) [Utility] Foundational bugs, tests, code cleanup and improvements (2/3) (#550) [CONSENSUS] Find issue with sending metadata request (#548) [Tooling] SLIP-0010 HD Child Key Generation (#510)

## Description This is another of a series of PRs split out from #500. Here we add a new `modules.P2PModule` implementation which utilizes the `typesP2P.Network` implementation which was added in #540. It will be utilized together with the config changes introduced by #535 in forthcoming changes to the node and debug CLI. ## Issue #347 ## Type of change Please mark the relevant option(s): - [x] New feature, functionality or library - [ ] Bug fix - [ ] Code health or cleanup - [ ] Major breaking change - [ ] Documentation - [ ] Other  ## List of changes - Added a new `modules.P2PModule` implementation to the `libp2p` module directory ## Testing - [x] `make develop_test` - [x] [LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md) w/ all of the steps outlined in the `README` ## Required Checklist - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [ ] I have tested my changes using the available tooling - [x] 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 · 2023-03-08T00:23:25Z

libp2p/protocol/protocol.go

+	// PoktProtocolID is the libp2p protocol ID used when opening a new stream
+	// to a remote peer and setting the stream handler for the local peer.
+	// Libp2p APIs use this to distinguish which multiplexed protocols/streams to consider.
+	PoktProtocolID = protocol.ID("pokt/v1.0.0")


One small line of code for a go package, one giant leap for the protocol

libp2p/network/network.go

Olshansk · 2023-03-09T01:58:13Z

libp2p/network/network.go

+	// IMPROVE: receive context in interface methods.
+	ctx := context.Background()


➕ 1️⃣

libp2p/network/network.go

libp2p/network/utils_test.go

libp2p/network/network_test.go

@Olshansk

## Description Due to circumstances and timing, @Olshansk's final review on #540 came in after merging. This PR implements improvements based on that review feedback. ## Issue Related to #347 ## 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  ## List of changes - Correct libp2p module tests - Improve libp2p code quality in response to post-merge review feedback ## Testing - [ ] `make develop_test` - [ ] [LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md) w/ all of the steps outlined in the `README` ## Required Checklist - [x] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] 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

## Description Due to circumstances and timing, @Olshansk's final review on #540 came in after merging. This PR implements improvements based on that review feedback. ## Issue Related to #347 ## 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  ## List of changes - Correct libp2p module tests - Improve libp2p code quality in response to post-merge review feedback ## Testing - [ ] `make develop_test` - [ ] [LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md) w/ all of the steps outlined in the `README` ## Required Checklist - [x] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] 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)

bryanchriswhite added 6 commits February 23, 2023 10:37

chore: prepare repo for new libp2p module

b62dd24

feat: add url <--> multiaddr conversion helpers

eef55e3

feat: add pokt --> libp2p identity helpers

da6a4a3

feat: add pokt --> libp2p crypto helpers

41d9a51

chore: update deps

1b2e32c

chore: add libp2p changelog

da417ed

bryanchriswhite added the p2p P2P specific changes label Feb 23, 2023

bryanchriswhite added this to the M1: Pocket PoS (Proof of Stake) milestone Feb 23, 2023

bryanchriswhite self-assigned this Feb 23, 2023

bryanchriswhite force-pushed the chore/libp2p-2 branch from 1cb3837 to a329579 Compare February 23, 2023 13:54

bryanchriswhite marked this pull request as ready for review February 23, 2023 13:55

bryanchriswhite requested review from Olshansk and deblasis and removed request for Olshansk February 23, 2023 13:56

bryanchriswhite force-pushed the chore/libp2p-1 branch from 6d71f72 to 27cfe05 Compare February 23, 2023 15:14

bryanchriswhite force-pushed the chore/libp2p-2 branch from a329579 to 1b30f05 Compare February 23, 2023 15:50

feat(tooling): return failed tests full output

01e970f

(cherry picked from commit 27cfe05)

bryanchriswhite force-pushed the chore/libp2p-1 branch from 27cfe05 to 01e970f Compare February 23, 2023 16:01

bryanchriswhite force-pushed the chore/libp2p-2 branch from 86b4161 to a329579 Compare February 23, 2023 16:08

bryanchriswhite added 8 commits February 24, 2023 09:20

Merge remote-tracking branch 'pokt/main' into chore/libp2p-1

8768593

* pokt/main: [Tooling] Returning failed tests full output (#542) [Tooling] Update CLI to support key management (Issue #489) (#524)

refactor: add decode error & unexport

7db5edc

chore: improve ip version check

2c33255

refactor: raise var scope

696b5fa

chore: rename protos vars to disambiguate

e001889

test: improve test names

ddc739e

chore: unexport test vars

79ab319

chore: update changelog

d2d5d8f

bryanchriswhite mentioned this pull request Feb 24, 2023

[Libp2p] Add Libp2p module (part 4) #545

Merged

16 tasks

fix: DNS issue in CI

568733f

(cherry picked from commit 2c8989f)

deblasis reviewed Feb 28, 2023

View reviewed changes

p2p/providers/addrbook_provider/addrbook_provider.go Outdated Show resolved Hide resolved

deblasis reviewed Feb 28, 2023

View reviewed changes

libp2p/network/utils_test.go Show resolved Hide resolved

deblasis reviewed Feb 28, 2023

View reviewed changes

libp2p/network/utils_test.go Show resolved Hide resolved

deblasis reviewed Feb 28, 2023

View reviewed changes

libp2p/network/network_test.go Outdated Show resolved Hide resolved

deblasis reviewed Feb 28, 2023

View reviewed changes

libp2p/network/network.go Outdated Show resolved Hide resolved

deblasis reviewed Feb 28, 2023

View reviewed changes

libp2p/network/network.go Outdated Show resolved Hide resolved

deblasis reviewed Feb 28, 2023

View reviewed changes

deblasis suggested changes Feb 28, 2023

View reviewed changes

bryanchriswhite added 4 commits February 28, 2023 18:01

chore: improve logger var name in test

ef43ffb

chore: simplify interface embedding

c5d2e54

chore: update default TTL to 2 weeks from 2 years

d34ad85

chore: update changelog

1aaef0c

bryanchriswhite requested a review from deblasis February 28, 2023 17:07

deblasis reviewed Feb 28, 2023

View reviewed changes

libp2p/network/network.go Outdated Show resolved Hide resolved

deblasis approved these changes Feb 28, 2023

View reviewed changes

fix: typo

ceb20c2

bryanchriswhite linked an issue Mar 1, 2023 that may be closed by this pull request

[P2P] Integrate LibP2P #347

Closed

6 tasks

This comment was marked as outdated.

Sign in to view

trigger CI

dbe9527

bryanchriswhite changed the base branch from chore/libp2p-1 to main March 3, 2023 11:20

fix: flakey test due to DNS

e55369b

bryanchriswhite merged commit 43d5c2b into main Mar 3, 2023

bryanchriswhite deleted the chore/libp2p-2 branch March 3, 2023 12:40

Olshansk reviewed Mar 9, 2023

View reviewed changes

bryanchriswhite mentioned this pull request Mar 16, 2023

[Libp2p] post-merge review improvements #590

Merged

16 tasks

reviewpad bot added the large Pull request is large label May 26, 2023

		// IMPROVE: receive context in interface methods.
		ctx := context.Background()

Conversation

bryanchriswhite commented Feb 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issue

Type of change

List of changes

Testing

Required Checklist

If Applicable Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

deblasis Feb 28, 2023

Choose a reason for hiding this comment

Uh oh!

Olshansk Mar 9, 2023

Choose a reason for hiding this comment

Uh oh!

deblasis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

deblasis left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Olshansk Mar 8, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Olshansk Mar 9, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bryanchriswhite commented Feb 23, 2023 •

edited

Loading