status-im
/
nim-eth
mirror of https://github.com/status-im/nim-eth.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update discv5.md 

Update some documentation in the discv5 docs.
This commit is contained in:
Kim De Mey 2021-02-16 11:44:03 +01:00 committed by GitHub
parent dda2bec8aa
commit be92a68d4c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/discv5.md
View File

@ -1,18 +1,15 @@
# Discovery v5 # Node Discovery Protocol v5
## Introduction ## Introduction
This `eth/p2p/discoveryv5` directory holds a Nim implementation of the The `eth/p2p/discoveryv5` directory holds a Nim implementation of the
discovery v5 protocol specified [Node Discovery Protocol v5.1](https://github.com/ethereum/devp2p/blob/master/discv5/discv5.md).
[here](https://github.com/ethereum/devp2p/blob/master/discv5/discv5.md).
This specification is still in DRAFT and thus subject to change. In fact, it is The implemented specification is Protocol version v5.1.
likely that the current packet format will change, see
https://github.com/ethereum/devp2p/issues/152.
This implementation does not support "Topic Advertisement" yet. This implementation does not support "Topic Advertisement" yet as this part of
the specification is not complete.
The implementation relies on other modules in the `eth` package, namely: `keys`, The implementation relies on other modules in the `eth` package, namely: `keys`,
`rlp`, `async_utils` and `trie/db`. The latter is likely to change, see `rlp` and `async_utils`.
https://github.com/status-im/nim-eth/issues/242
## How to use ## How to use
@ -21,8 +18,7 @@ let
rng = keys.newRng rng = keys.newRng
privKey = PrivateKey.random(rng[]) privKey = PrivateKey.random(rng[])
(ip, tcpPort, udpPort) = setupNat(config) # Or fill in external IP/ports manually (ip, tcpPort, udpPort) = setupNat(config) # Or fill in external IP/ports manually
ddb = DiscoveryDB.init(newMemoryDB()) d = newProtocol(privKey, ip, tcpPort, udpPort, rng = rng)
d = newProtocol(privKey, ddb, ip, tcpPort, udpPort, rng = rng)
d.open() # Start listening d.open() # Start listening
``` ```
@ -35,7 +31,7 @@ other nodes in the network.
To initialize with a bootnode or a set of bootnodes, the ENRs need to be passed To initialize with a bootnode or a set of bootnodes, the ENRs need to be passed
as parameter in `newProtocol`. as parameter in `newProtocol`.
```Nim ```Nim
d = newProtocol(privKey, ddb, ip, tcpPort, udpPort, d = newProtocol(privKey, ip, tcpPort, udpPort,
bootstrapRecords = bootnodes) bootstrapRecords = bootnodes)
d.open() # Start listening and add bootstrap nodes to the routing table. d.open() # Start listening and add bootstrap nodes to the routing table.
``` ```
@ -60,8 +56,6 @@ or `lookup` calls for this. `randomNodes` can also be used to find nodes,
but this will only look into the current routing table and not actively but this will only look into the current routing table and not actively
search for nodes on the network. search for nodes on the network.
Or, one can decide not to run `d.start()` and do this manually within its Or, one can decide not to run `d.start()` and do this manually within its
application by using the available calls: application by using the available calls:
- `query`, `queryRandom` or `lookup` for discovering more peers. - `query`, `queryRandom` or `lookup` for discovering more peers.
@ -104,14 +98,11 @@ nim c -d:chronicles_log_level:trace -d:release --threads:on eth/p2p/discoveryv5/
``` ```
### Metrics ### Metrics
Metrics are available for `routing_table_nodes`, which holds the amount of nodes
in the routing table.
To compile in an HTTP endpoint for accessing the metrics add the `insecure` To compile in an HTTP endpoint for accessing the metrics add the `insecure`
compile time flag: compile time flag:
```sh ```sh
# Build dcli with metrics # Build dcli with metrics
nim c -d:insecure -d:chronicles_log_level:trace -d:release eth/p2p/discoveryv5/dcli nim c -d:insecure -d:chronicles_log_level:trace -d:release --threads:on eth/p2p/discoveryv5/dcli
# Run dcli with metrics # Run dcli with metrics
./eth/p2p/discoveryv5/dcli --metrics --bootnode:enr:<base64 encoding of ENR> ./eth/p2p/discoveryv5/dcli --metrics --bootnode:enr:<base64 encoding of ENR>
``` ```