Libraries for Cryptographic Sortition and VRF by Olshansk · Pull Request #37 · pokt-network/pocket

Olshansk · 2022-03-02T01:32:05Z

Description

This PR is meant to partially address the V1 consensus prototype: #28.

It is a set of libraries that are meant to be used for leader election as described in the consensus spec.

Please note that these are just standalone libraries that do not make any changes to the existing prototype and can be reviewed independently from other changes.

Details

Implement a light VRF wrapper around https://github.com/ProtonMail/go-ecvrf
Implement cryptographic sortition as described in section 5 of the Algorand whitepaper
Heavily refer to the Algorand implementation as a reference.
Minor changes to types and the crypto library to support the changes above.

Testing

1. Pull changes (if not already local):

$ git clone git@github.com:pokt-network/pocket.git pocket
$ cd pocket
$ gco -b issue28/prototype/consensus_sortition_lib origin/issue28/prototype/consensus_sortition_lib

2. Run unit tests

$ make test_vrf
$ make test_sortition
$ make benchmark_sortition

[Optional] The log statement in TestSortitionBasic can be commented out for some visibility as to what make test_sortition does.

- Support 4 validators + 1 local debugging client - Debug ports are specified but disabled

…es are added

…s used by the Dockerfile

luyzdeleon · 2022-03-02T12:45:09Z

Please note that these are just standalone libraries that do make any changes to the existing prototype.

@Olshansk Did you mean to say "don't make any changes to the existing prototype?"

Olshansk · 2022-03-02T19:47:33Z

Yup, thanks for the catch @luyzdeleon! Updated.

andrewnguyen22 · 2022-03-08T13:51:02Z

 )

-type EventsChannel chan types.Event
+type EventsChannel chan types.PocketEvent


Pocket should not be used as a prefix IMO

andrewnguyen22 · 2022-03-08T13:59:32Z

+// The key is a hex encoded representation of the validator byte address.
+type ValMap map[string]*Validator
+
+type Validator struct {


There's going to be a lot of contention around this structure as at this time there's not good justification to have a shared Validator type

It needs to be made more explicit that this is a temp

luyzdeleon

I think this PR is in a good direction, if I might summarize my pending questions are:

Staked amounts being handled as float types when they should be ints (uPOKT vs POKT denominations).
Why is there PreP2P module code included in this PR?
Some shared data structures like the Validator would be more appropiate inside of the consensus_types

luyzdeleon · 2022-03-08T21:05:11Z

+	}
+
+	networkMessage := types.PocketEvent{}
+	if err := proto.Unmarshal(data, &networkMessage); err != nil {


I agree with having a single "Encoder/Decoder" interface and let that use anything it needs underneath.

Olshansk

@luyzdeleon @andrewnguyen22 Please take another look when you have a chance. Some things to keep in mind:

Since our git histories are a little messy right now, the original PR extended more than just the base crypto libraries here, but that is mostly resolved and the PR is much smaller.
I refactored the tests and added a lot more documentation in sortition.go and sortition_test.go, so that can be the focus of the re-review.
I added details as to why I chose this VRF library over others, but ultimately I don't have super strong reasoning one way or another.

Olshansk

@andrewnguyen22 Tended to the last set of comments.

PTAL at the README again as I added some interesting points there.

Olshansk · 2022-03-24T17:39:42Z

@luyzdeleon Please take a look again when you have a chance. The two places I'd focus on per your comments are:

The updated README
The changes in the test files

luyzdeleon

Habemus approval

Olshansk added 30 commits February 23, 2022 13:47

Added per validator config.json files

3781422

Added genesis.json file

cf10666

Added docker-compose file

cccb017

- Support 4 validators + 1 local debugging client - Debug ports are specified but disabled

Added all the Dockerfiles

d9acffa

Added the shared crypto primitives

36f112b

Replaced 'errors.New(fmt.Sprintf' with 'fmt.Errorf'

510a49b

Added config.json parser and unit test

920a5a2

Added interfaces for the pocket bus and modules

106f229

Added events.go

1dd7dd9

Updated dependencies after setting everything to Go 1.17

8a0b6d7

Added PocketBus and PocketNode - not functional until module interfac…

d8130b3

…es are added

Added scripts for hot reloading and debugging

3aa7372

Updated Makefile with some targets removed and refactored some target…

419c68f

…s used by the Dockerfile

Added placeholder implementations of all the modules

d94b894

Validators that do nothing running locally

c985887

Fix module type assertion TODOs

8eb65d2

Fixed mock generation

4e78bf4

Modularized mockgen

7609a95

Fixed proto generation

8db3199

Updated Makefile outputs

a206001

Adding forgotten TODO related to protoc from #27

c05798c

Ran go mod vendor && go mod tidy

44775e6

Added gofmt make target and ran it

ed79161

Removed HandleTransaction from consensus module

b2d1d69

Rename pocketBus to bus

c3dea62

Replace all instances of network* with p2p*

3842028

Properly use pre2p where appropriate

4b72e72

make config annonymous if not used

10a9de8

Enforce interface via type inference

e5d1005

Added pre2p proto types

fe776fc

Olshansk added 2 commits March 2, 2022 16:42

Add small comment

3350270

Removed pre2p/genesis.go and added small test

d9da3a8

Base automatically changed from issue32/prototype/pre2p to milestone/v1-prototype March 4, 2022 02:17

andrewnguyen22 suggested changes Mar 8, 2022

View reviewed changes

luyzdeleon suggested changes Mar 8, 2022

View reviewed changes

Olshansk added 8 commits March 14, 2022 13:20

Merge with milestone/v1-prototype

4cdf383

Minor fixes to 'make test_all' work again

dfecc00

Replied to comments on sortition.go

6e155e5

Replied to comments under shared/crypto

c27eba5

Refactored sortition_test.go and updates comments all over the place

a67889d

Moved VRF errors to a constants file

b99ed6d

Added documentation as to why ProtonMail's VRF library wa used

f43ae77

Minor fix to test and types

d0cff91

Olshansk commented Mar 15, 2022

View reviewed changes

Olshansk requested review from andrewnguyen22 and luyzdeleon March 15, 2022 22:46

Olshansk linked an issue Mar 16, 2022 that may be closed by this pull request

V1 Consensus Module - First Iteration #28

Closed

9 tasks

andrewnguyen22 suggested changes Mar 17, 2022

View reviewed changes

Comment thread docs/deps/README.md

Comment thread shared/crypto/ed25519.go Outdated

Comment thread shared/crypto/ed25519.go Outdated

Olshansk added 2 commits March 18, 2022 16:11

Update README with security notice

55a0069

Move error in ed25519.go to the shared error file

88c46fb

Olshansk commented Mar 18, 2022

View reviewed changes

Comment thread docs/deps/README.md

Comment thread shared/crypto/ed25519.go Outdated

Comment thread shared/crypto/ed25519.go Outdated

Olshansk requested a review from andrewnguyen22 March 18, 2022 23:13

andrewnguyen22 approved these changes Mar 24, 2022

View reviewed changes

Merge with milestone/v1-prototype

3f55ac2

luyzdeleon approved these changes Mar 31, 2022

View reviewed changes

Olshansk merged commit 7994b37 into milestone/v1-prototype Mar 31, 2022

Olshansk deleted the issue28/prototype/consensus_sortition_lib branch March 31, 2022 19:59

Conversation

Olshansk commented Mar 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Details

Testing

1. Pull changes (if not already local):

2. Run unit tests

Uh oh!

luyzdeleon commented Mar 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Olshansk commented Mar 2, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andrewnguyen22 Mar 8, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

andrewnguyen22 Mar 8, 2022

Choose a reason for hiding this comment

Uh oh!

luyzdeleon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

luyzdeleon Mar 8, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Olshansk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Olshansk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Olshansk commented Mar 24, 2022

Uh oh!

luyzdeleon left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Olshansk commented Mar 2, 2022 •

edited

Loading

luyzdeleon commented Mar 2, 2022 •

edited

Loading