codex-storage
/
nim-libp2p
mirror of https://github.com/codex-storage/nim-libp2p.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
nim-libp2p/libp2p/peerinfo.nim

154 lines
3.9 KiB
Nim
Raw Normal View History

initial commit for native libp2p implementation
2019-08-20 16:18:15 +00:00
## Nim-LibP2P
changed copyright year
2019-09-24 17:48:23 +00:00
## Copyright (c) 2019 Status Research & Development GmbH
initial commit for native libp2p implementation
2019-08-20 16:18:15 +00:00
## Licensed under either of
## * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE))
## * MIT license ([LICENSE-MIT](LICENSE-MIT))
## at your option.
## This file may not be copied, modified, or distributed except according to
## those terms.
peer hooks -> events (#320) * peer hooks -> events * peerinfo -> peerid * include connection direction in event * check connection status after event * lock connmanager lookup also when dialling peer * clean up un-upgraded connection when upgrade fails * await peer eventing * remove join/lifetime future from peerinfo Peerinfo instances are not unique per peer so the lifetime future is misleading - it fires when a random connection is closed, not the "last" one * document switch values * naming * peerevent->conneevent
2020-08-08 06:52:20 +00:00
{.push raises: [Defect].}
More raises cleanup (#575) * use toException to map errors * don't initialize address twice * better error messages * allow LPError to escape * allow LPError to escape
2021-05-22 18:27:30 +00:00
import std/[options, sequtils, hashes]
import pkg/[chronos, chronicles, stew/results]
import peerid, multiaddress, crypto/crypto, errors
initial commit for native libp2p implementation
2019-08-20 16:18:15 +00:00
More raises cleanup (#575) * use toException to map errors * don't initialize address twice * better error messages * allow LPError to escape * allow LPError to escape
2021-05-22 18:27:30 +00:00
export peerid, multiaddress, crypto, errors, results
export public field types (#248) * export public field types * one more
2020-07-01 07:22:29 +00:00
extract public and private keys fields from peerid (#44) * extract public and private keys fields from peerid * allow assigning a public key * cleaned up TODOs * make pubsub prefix a const * public key should be an `Option`
2019-12-07 16:36:39 +00:00
## A peer can be constructed in one of tree ways:
## 1) A local peer with a private key
## 2) A remote peer with a PeerID and it's public key stored
## in the ``id`` itself
## 3) A remote peer with a standalone public key, that isn't
## encoded in the ``id``
##
type
KeyType* = enum
HasPrivate,
HasPublic
More raises cleanup (#575) * use toException to map errors * don't initialize address twice * better error messages * allow LPError to escape * allow LPError to escape
2021-05-22 18:27:30 +00:00
PeerInfoError* = LPError
extract public and private keys fields from peerid (#44) * extract public and private keys fields from peerid * allow assigning a public key * cleaned up TODOs * make pubsub prefix a const * public key should be an `Option`
2019-12-07 16:36:39 +00:00
PeerInfo* = ref object of RootObj
peerId*: PeerID
Feat/conn cleanup (#41) Backporting proper connection cleanup from #36 to align with latest chronos changes. * add close event * use proper varint encoding * add proper channel cleanup in mplex * add connection cleanup in secio * tidy up * add dollar operator * fix tests * don't close connections prematurely * handle closing streams properly * misc * implement address filtering logic * adding pipe tests * don't use gcsafe if not needed * misc * proper connection cleanup and stream muxing * re-enable pubsub tests
2019-12-04 04:44:54 +00:00
addrs*: seq[MultiAddress]
protocols*: seq[string]
grab agentversion/protoversion (#211)
2020-06-09 18:42:52 +00:00
protoVersion*: string
agentVersion*: string
reuse single RNG instance for all crypto key generation (#249) * reuse single RNG instance for all crypto key generation * use foolproof rng * initRng -> newRng (because it's ref) * fix test * imports/exports, chat fix * fix rsa * imports and exports * work around threadvar issue * fixup * mac workaround test
2020-07-07 11:14:11 +00:00
secure*: string
extract public and private keys fields from peerid (#44) * extract public and private keys fields from peerid * allow assigning a public key * cleaned up TODOs * make pubsub prefix a const * public key should be an `Option`
2019-12-07 16:36:39 +00:00
case keyType*: KeyType:
of HasPrivate:
privateKey*: PrivateKey
of HasPublic:
key: Option[PublicKey]
simplify and unify logging (#353) * use short format for logging peerid * log peerid:oid for connections
2020-09-06 08:31:47 +00:00
func shortLog*(p: PeerInfo): auto =
grab agentversion/protoversion (#211)
2020-06-09 18:42:52 +00:00
(
simplify and unify logging (#353) * use short format for logging peerid * log peerid:oid for connections
2020-09-06 08:31:47 +00:00
peerId: $p.peerId,
grab agentversion/protoversion (#211)
2020-06-09 18:42:52 +00:00
addrs: mapIt(p.addrs, $it),
protocols: mapIt(p.protocols, $it),
protoVersion: p.protoVersion,
agentVersion: p.agentVersion,
)
simplify and unify logging (#353) * use short format for logging peerid * log peerid:oid for connections
2020-09-06 08:31:47 +00:00
chronicles.formatIt(PeerInfo): shortLog(it)
don't crash on double peerinfo close (#167)
2020-05-11 19:05:24 +00:00
Add peer lifetime feature for PeerInfo. (#77) * Add peer lifetime feature for PeerInfo. Refactor peerinfo to use openarrays instead of sequences. Fix tests and examples to use arrays instead of sequences. * Add access to lifetime Future[T] itself.
2020-02-11 17:53:39 +00:00
template postInit(peerinfo: PeerInfo,
addrs: openarray[MultiAddress],
protocols: openarray[string]) =
if len(addrs) > 0:
peerinfo.addrs = @addrs
if len(protocols) > 0:
peerinfo.protocols = @protocols
adding raises defect across the codebase (#572) * adding raises defect across the codebase * use unittest2 * add windows deps caching * update mingw link * die on failed peerinfo initialization * use result.expect instead of get * use expect more consistently and rework inits * use expect more consistently * throw on missing public key * remove unused closure annotation * merge master
2021-05-21 16:27:01 +00:00
proc init*(
p: typedesc[PeerInfo],
key: PrivateKey,
addrs: openarray[MultiAddress] = [],
protocols: openarray[string] = [],
protoVersion: string = "",
More raises cleanup (#575) * use toException to map errors * don't initialize address twice * better error messages * allow LPError to escape * allow LPError to escape
2021-05-22 18:27:30 +00:00
agentVersion: string = ""): PeerInfo
{.raises: [Defect, PeerInfoError].} =
adding raises defect across the codebase (#572) * adding raises defect across the codebase * use unittest2 * add windows deps caching * update mingw link * die on failed peerinfo initialization * use result.expect instead of get * use expect more consistently and rework inits * use expect more consistently * throw on missing public key * remove unused closure annotation * merge master
2021-05-21 16:27:01 +00:00
let peerInfo = PeerInfo(
keyType: HasPrivate,
More raises cleanup (#575) * use toException to map errors * don't initialize address twice * better error messages * allow LPError to escape * allow LPError to escape
2021-05-22 18:27:30 +00:00
peerId: PeerID.init(key).tryGet(),
adding raises defect across the codebase (#572) * adding raises defect across the codebase * use unittest2 * add windows deps caching * update mingw link * die on failed peerinfo initialization * use result.expect instead of get * use expect more consistently and rework inits * use expect more consistently * throw on missing public key * remove unused closure annotation * merge master
2021-05-21 16:27:01 +00:00
privateKey: key,
protoVersion: protoVersion,
agentVersion: agentVersion)
peerInfo.postInit(addrs, protocols)
return peerInfo
proc init*(
p: typedesc[PeerInfo],
peerId: PeerID,
addrs: openarray[MultiAddress] = [],
protocols: openarray[string] = [],
protoVersion: string = "",
agentVersion: string = ""): PeerInfo =
let peerInfo = PeerInfo(
keyType: HasPublic,
peerId: peerId,
protoVersion: protoVersion,
agentVersion: agentVersion)
peerInfo.postInit(addrs, protocols)
return peerInfo
proc init*(
p: typedesc[PeerInfo],
peerId: string,
addrs: openarray[MultiAddress] = [],
protocols: openarray[string] = [],
protoVersion: string = "",
More raises cleanup (#575) * use toException to map errors * don't initialize address twice * better error messages * allow LPError to escape * allow LPError to escape
2021-05-22 18:27:30 +00:00
agentVersion: string = ""): PeerInfo
{.raises: [Defect, PeerInfoError].} =
adding raises defect across the codebase (#572) * adding raises defect across the codebase * use unittest2 * add windows deps caching * update mingw link * die on failed peerinfo initialization * use result.expect instead of get * use expect more consistently and rework inits * use expect more consistently * throw on missing public key * remove unused closure annotation * merge master
2021-05-21 16:27:01 +00:00
let peerInfo = PeerInfo(
keyType: HasPublic,
More raises cleanup (#575) * use toException to map errors * don't initialize address twice * better error messages * allow LPError to escape * allow LPError to escape
2021-05-22 18:27:30 +00:00
peerId: PeerID.init(peerId).tryGet(),
adding raises defect across the codebase (#572) * adding raises defect across the codebase * use unittest2 * add windows deps caching * update mingw link * die on failed peerinfo initialization * use result.expect instead of get * use expect more consistently and rework inits * use expect more consistently * throw on missing public key * remove unused closure annotation * merge master
2021-05-21 16:27:01 +00:00
protoVersion: protoVersion,
agentVersion: agentVersion)
peerInfo.postInit(addrs, protocols)
return peerInfo
proc init*(
p: typedesc[PeerInfo],
key: PublicKey,
addrs: openarray[MultiAddress] = [],
protocols: openarray[string] = [],
protoVersion: string = "",
More raises cleanup (#575) * use toException to map errors * don't initialize address twice * better error messages * allow LPError to escape * allow LPError to escape
2021-05-22 18:27:30 +00:00
agentVersion: string = ""): PeerInfo
{.raises: [Defect, PeerInfoError].} =
adding raises defect across the codebase (#572) * adding raises defect across the codebase * use unittest2 * add windows deps caching * update mingw link * die on failed peerinfo initialization * use result.expect instead of get * use expect more consistently and rework inits * use expect more consistently * throw on missing public key * remove unused closure annotation * merge master
2021-05-21 16:27:01 +00:00
let peerInfo = PeerInfo(
keyType: HasPublic,
More raises cleanup (#575) * use toException to map errors * don't initialize address twice * better error messages * allow LPError to escape * allow LPError to escape
2021-05-22 18:27:30 +00:00
peerId: PeerID.init(key).tryGet(),
adding raises defect across the codebase (#572) * adding raises defect across the codebase * use unittest2 * add windows deps caching * update mingw link * die on failed peerinfo initialization * use result.expect instead of get * use expect more consistently and rework inits * use expect more consistently * throw on missing public key * remove unused closure annotation * merge master
2021-05-21 16:27:01 +00:00
key: some(key),
protoVersion: protoVersion,
agentVersion: agentVersion)
peerInfo.postInit(addrs, protocols)
return peerInfo
proc publicKey*(p: PeerInfo): Option[PublicKey] =
var res = none(PublicKey)
extract public and private keys fields from peerid (#44) * extract public and private keys fields from peerid * allow assigning a public key * cleaned up TODOs * make pubsub prefix a const * public key should be an `Option`
2019-12-07 16:36:39 +00:00
if p.keyType == HasPublic:
if p.peerId.hasPublicKey():
var pubKey: PublicKey
if p.peerId.extractPublicKey(pubKey):
adding raises defect across the codebase (#572) * adding raises defect across the codebase * use unittest2 * add windows deps caching * update mingw link * die on failed peerinfo initialization * use result.expect instead of get * use expect more consistently and rework inits * use expect more consistently * throw on missing public key * remove unused closure annotation * merge master
2021-05-21 16:27:01 +00:00
res = some(pubKey)
extract public and private keys fields from peerid (#44) * extract public and private keys fields from peerid * allow assigning a public key * cleaned up TODOs * make pubsub prefix a const * public key should be an `Option`
2019-12-07 16:36:39 +00:00
elif p.key.isSome:
adding raises defect across the codebase (#572) * adding raises defect across the codebase * use unittest2 * add windows deps caching * update mingw link * die on failed peerinfo initialization * use result.expect instead of get * use expect more consistently and rework inits * use expect more consistently * throw on missing public key * remove unused closure annotation * merge master
2021-05-21 16:27:01 +00:00
res = p.key
extract public and private keys fields from peerid (#44) * extract public and private keys fields from peerid * allow assigning a public key * cleaned up TODOs * make pubsub prefix a const * public key should be an `Option`
2019-12-07 16:36:39 +00:00
else:
Rename getKey -> getPublicKey (#621) * rename getKey to getPublicKey * use publicKey directly in gossipsub * update error messages
2021-09-02 10:03:40 +00:00
let pkeyRes = p.privateKey.getPublicKey()
adding raises defect across the codebase (#572) * adding raises defect across the codebase * use unittest2 * add windows deps caching * update mingw link * die on failed peerinfo initialization * use result.expect instead of get * use expect more consistently and rework inits * use expect more consistently * throw on missing public key * remove unused closure annotation * merge master
2021-05-21 16:27:01 +00:00
if pkeyRes.isOk:
res = some(pkeyRes.get())
return res
some light cleanup for pub/gossip sub (#273) * move peer table out to its own file * move peer table * cleanup `==` and add one to peerinfo * add peertable * missed equality check
2020-07-15 19:18:55 +00:00
Connection manager (#277) * splitting out connection management * wip * wip conn mngr tests * set peerinfo in contructor * comments and documentation * tests * wip * add `None` to detect untagged connections * use `PeerID` to index connections * fix tests * remove useless equality
2020-07-17 15:36:48 +00:00
func hash*(p: PeerInfo): Hash =
cast[pointer](p).hash