feat: claim/proof messages, relayer, & genesis #24

bryanchriswhite · 2023-09-18T07:20:59Z

Changes

Dependencies

Updated smt version in go.mod

Until pokt-network/smt#19 and pokt-network/smt#18 are merged, the go.mod needs to use a replace to point to a temporary version (poktroll-needs branch) of the smt package which includes ~~support for serialization of SparseMerkelTrees as well as implementation of the KV store and #ProveClosest().

On-chain servicer logic (module)

Generated Claim and Proof messages
Switched applicable fields' types from string to []byte due to ignite limitations (see: supported types)

Off-chain servicer logic (aka relayer)

Added relayer subcommand (i.e. poktrolld relayer -h) to isolate client-side / off-chain servicer logic
Relayer proxy component is proxying requests to/from the client and the service (relay-chain)
Session tracker component is using the ServiceClient to listen (via websocket) for new blocks

Genesis

Added localnet_regenesis make target which regenerates the localnet genesis.json, node_key.json, priv_validator_key.json, & test keyring
Uses ignite chain init (see: docs) to populate genesis & keyring according to config.yml (see: ignite docs)
All accounts have static mnemonics to minimize version control churn (i.e. generating all new keys ea. regenesis)

Running

Start celestia and the sequencer:

make localnet_down
rm -rf ~/.poktroll  # remove any existing local keyring
ignite chain init   # regenerate local genesis, keyring, & configs from config.yml
make localnet_up

Stake app1 & servicer1

make app1_stake && make servicer1_stake

Start the relayer:

poktrolld relayer \
--node tcp://localhost:36657 \
--signing-key servicer1 \
--keyring-backend test

Start anvil (mock relay-chain node):
(see: anvil docs)

anvil -p 8547 -b 5

Request a relay via cast (on the default port: 8545):
(see: cast docs)

cast block

Subscribe for new blocks:

wscat --connect ws://localhost:8546
Connected (press CTRL+C to quit)
> {"id":1,"jsonrpc":"2.0","method":"eth_subscribe","params":["newHeads"]}

Query for servicer1 claims:

poktrolld query servicer claims $(poktrolld keys show servicer1 -a --keyring-backend test)

* Implemented a servicer client * Relayminer aka Off-chain servicer as poktrolld sub-command * Generated Claim and Proof messages

- use `bytes` for binary data - update CLI usages to use hex-encoded input args

* pokt/main: chore: remove .pb.go & .pb.gw.go files from version control (already gitignored)

- move signal handling to cmd code - use cancellable context - add waitgroup to track goroutines

* pokt/relayer-with-ws: WIP: proxy sign replies

chore: protect session writes with mutexs

Olshansk

Still making my way through by just leaving a few comments.

Olshansk · 2023-09-26T23:01:58Z

Makefile

+
+.PHONY: localnet_regenesis
+localnet_regenesis:
+	# NOTE: intentionally not using --home <dir> flag to avoid overwriting the test keyring


Consider using --home=$(POKTROLLD_HOME) like we do in other places

Olshansk · 2023-09-26T23:04:44Z

localnet/genesis.json

          "pub_key": null,
          "account_number": "1",
          "sequence": "0"
-        },


I've not looked into ignite accounts yet but ignite chain init will generate all the accounts and genesis to match all the accounts in config.yml. It seems more straightforward and conventional to me to use it for this purpose.

Ccing @okdas who will likely be looking closer at best practices here.

Also, I was under the impression that after poktrolld add-genesis-account one would also have to run poktrolld gentx followed by poktrolld collect-gentxs.

My gut says no (an account is just a balance) but I haven't looked into it.

Olshansk · 2023-09-26T23:06:59Z

proto/poktroll/servicer/event.proto

+
+option go_package = "poktroll/x/servicer/types";
+
+message EventClaim {


Can you leave a comment on what/how/where this is used?

Can you link me to where this naming convention / pattern is the best practice?

Olshansk · 2023-09-27T16:08:53Z

relayer/client/client.go

+	keyName string
+	// wsURL is the URL of the websocket endpoint to connect to for RPC
+	// service over websocket transport (with /subscribe support).
+	wsURL string


Is this a cometbft endpoint? It's unclear from the comment as to who is providing this endpoint.

Olshansk · 2023-09-27T17:17:04Z

relayer/client/websockets.go

+// getNextRequestId increments and returns the JSON-RPC request ID which should
+// be used for the next request. These IDs are expected to be unique (per request).
+func (client *servicerClient) getNextRequestId() uint64 {
+	client.nextRequestId++


Two comments:

Does it have to be monotonically increasing or will random work as well? Jargon: entropy, distributed tracing, etc...

Do you think we need a lock around this to where we defer the unlock?

Olshansk

Overall, pretty good and clean. A few things for the main repo:

Need more comments related to the structs and the fields
Will need to spend more time on the types (protos & structs). We should:
1. Look at what was done in v0 (e.g. their version of the session manager)
2. Look at what we designed in v1 (e.g. the relay types)
Need a diagram showing the relationship in the components under relayer
The most confusing part right now is definitely the proxy and the session manager. Will take closer looks at those when we review them in smaller pieces.

Olshansk · 2023-09-27T19:44:50Z

relayer/sessionmanager/session.go

+type sessionWithTree struct {
+	sessionInfo  *types.Session
+	tree         *smt.SMST
+	treeStore    smt.KVStore


Why do we need to keep references to the store, the path AND the tree?

Olshansk · 2023-09-27T19:45:08Z

relayer/sessionmanager/session.go

+
+func (s *sessionWithTree) SessionTree() *smt.SMST {
+	// if the tree is closed, we need to re-open it from disk
+	if s.closed {


I'm a bit confused on when it's okay or not okay to reopen a tree. My assumption is that if it's closed, it's closed forever.

Olshansk

Works!

red-0ne and others added 6 commits September 15, 2023 15:13

WIP: Separate client and server commands

f39df3a

* Implemented a servicer client * Relayminer aka Off-chain servicer as poktrolld sub-command * Generated Claim and Proof messages

fix: re-generation artifacts

707abb5

chore: update Proof and Claim types

b119ce3

- use `bytes` for binary data - update CLI usages to use hex-encoded input args

chore: update SMT dep with go.mod replace

de6d5ac

feat: implement ServicerClient#SubmitProof() & #SubmitClaim()

be3fa80

Merge remote-tracking branch 'pokt/main' into relayminer

5dc911b

* pokt/main: chore: remove .pb.go & .pb.gw.go files from version control (already gitignored)

bryanchriswhite assigned red-0ne and bryanchriswhite Sep 18, 2023

bryanchriswhite mentioned this pull request Sep 18, 2023

feat: servicer module implementation #19

Closed

red-0ne and others added 11 commits September 18, 2023 12:45

chore: refactor relayer & new blocks WS client

5844282

refactor: relayer session type as interface

249f41c

debug: newBlocks observable

d7d946a

feat: Add new block event constructor

6fefe10

feat: Source servicer params from viper flags

d5265ab

fix: Observable relying on nil channel

48c9a35

fix: New blocks not getting reacted to

9705345

fix: handle websocket closed error in servicer client listener

d4dad85

fix: update defalut websocket URL port to poktrolld (not celestia)

6967f7d

fix: restructure tendermintBlockEvent to match

3c7b53c

chore: close servicer client websocket conn on teardown

191d01e

bryanchriswhite force-pushed the relayminer branch from 679a617 to 191d01e Compare September 19, 2023 06:56

bryanchriswhite and others added 5 commits September 19, 2023 09:25

refactor: relayer command

c6cbabc

- move signal handling to cmd code - use cancellable context - add waitgroup to track goroutines

WIP: proxy sign replies

e8666c6

Merge remote-tracking branch 'pokt/relayer-with-ws' into relayminer

c027161

* pokt/relayer-with-ws: WIP: proxy sign replies

refactor: Proxy#ServeHTTP()

ecfa7fb

chore: add keyring-backend flag to relayer cmd

9d1c664

bryanchriswhite changed the title ~~feat: Add relayminer & claim/proof msgs to servicer module~~ feat: claim/proof messages & relayer Sep 19, 2023

bryanchriswhite added 3 commits September 19, 2023 13:18

chore: add node flag to relayer subcommand

31185fd

chore: add "regenesis" make target

37dec27

chore: add mnemonics to test accounts

f263635

bryanchriswhite added 3 commits September 26, 2023 09:45

chore: add comments

89db148

feat: stub out on-chain proof verification & msg handling

a9c5fc3

refactor: simplify claim keys & claims query pagination filter

6516f68

bryanchriswhite force-pushed the relayminer branch from 7ae099c to 6516f68 Compare September 26, 2023 10:18

bryanchriswhite requested review from h5law and Olshansk September 26, 2023 10:22

bryanchriswhite and others added 14 commits September 26, 2023 12:30

chore: add incomplete comment

bb01047

chore: add SessionWithTree#GetSessionId()

731afe0

fix: include session ID in claim msg

6c31aa5

chore: add TODO comment

42e3a92

chore: protect session writes with mutexs

8f02bc9

Merge pull request #32 from pokt-network/relay-sockets

805c3de

chore: protect session writes with mutexs

Added TODO in relay.proto

f7afa36

fixup: remove useless mutex

e0c7de7

Added helpers from the PR description to the Makefile

f069034

Minor nits and TODOs

52f022a

s/handleBlocksFactory/blocksFactorHandler

4406c32

s/handleTxsFactory/txsFactoryHandler

b039f9f

Finished reviewing relayer/client subdirectory

a1f9877

Reviewed relayer/miner/miner.go

89bd295

Olshansk requested changes Sep 27, 2023

View reviewed changes

Olshansk added 3 commits September 27, 2023 15:03

s/signResponse/signResponseFn

d944ee8

Trying to get things working

68e6883

Autoformat

aad716d

Olshansk reviewed Sep 27, 2023

View reviewed changes

Olshansk added 2 commits September 27, 2023 18:48

Remove fallthrough

43687b6

update claims_query

1e7105f

Olshansk approved these changes Sep 27, 2023

View reviewed changes

Olshansk merged commit df351a6 into main Sep 27, 2023

Olshansk deleted the relayminer branch September 27, 2023 23:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: claim/proof messages, relayer, & genesis #24

feat: claim/proof messages, relayer, & genesis #24

bryanchriswhite commented Sep 18, 2023 •

edited by red-0ne

Olshansk left a comment

Olshansk Sep 26, 2023

Olshansk Sep 26, 2023

Olshansk Sep 26, 2023

Olshansk Sep 27, 2023

Olshansk Sep 27, 2023

Olshansk left a comment

Olshansk Sep 27, 2023

Olshansk Sep 27, 2023

Olshansk left a comment


		option go_package = "poktroll/x/servicer/types";

		message EventClaim {

feat: claim/proof messages, relayer, & genesis #24

feat: claim/proof messages, relayer, & genesis #24

Conversation

bryanchriswhite commented Sep 18, 2023 • edited by red-0ne

Changes

Dependencies

On-chain servicer logic (module)

Off-chain servicer logic (aka relayer)

Genesis

Running

Olshansk left a comment

Choose a reason for hiding this comment

Olshansk Sep 26, 2023

Choose a reason for hiding this comment

Olshansk Sep 26, 2023

Choose a reason for hiding this comment

Olshansk Sep 26, 2023

Choose a reason for hiding this comment

Olshansk Sep 27, 2023

Choose a reason for hiding this comment

Olshansk Sep 27, 2023

Choose a reason for hiding this comment

Olshansk left a comment

Choose a reason for hiding this comment

Olshansk Sep 27, 2023

Choose a reason for hiding this comment

Olshansk Sep 27, 2023

Choose a reason for hiding this comment

Olshansk left a comment

Choose a reason for hiding this comment

bryanchriswhite commented Sep 18, 2023 •

edited by red-0ne