Skip to content
  • Felix Lange's avatar
    30cd5c18
    all: new p2p node representation (#17643) · 30cd5c18
    Felix Lange authored
    Package p2p/enode provides a generalized representation of p2p nodes
    which can contain arbitrary information in key/value pairs. It is also
    the new home for the node database. The "v4" identity scheme is also
    moved here from p2p/enr to remove the dependency on Ethereum crypto from
    that package.
    
    Record signature handling is changed significantly. The identity scheme
    registry is removed and acceptable schemes must be passed to any method
    that needs identity. This means records must now be validated explicitly
    after decoding.
    
    The enode API is designed to make signature handling easy and safe: most
    APIs around the codebase work with enode.Node, which is a wrapper around
    a valid record. Going from enr.Record to enode.Node requires a valid
    signature.
    
    * p2p/discover: port to p2p/enode
    
    This ports the discovery code to the new node representation in
    p2p/enode. The wire protocol is unchanged, this can be considered a
    refactoring change. The Kademlia table can now deal with nodes using an
    arbitrary identity scheme. This requires a few incompatible API changes:
    
      - Table.Lookup is not available anymore. It used to take a public key
        as argument because v4 protocol requires one. Its replacement is
        LookupRandom.
      - Table.Resolve takes *enode.Node instead of NodeID. This is also for
        v4 protocol compatibility because nodes cannot be looked up by ID
        alone.
      - Types Node and NodeID are gone. Further commits in the series will be
        fixes all over the the codebase to deal with those removals.
    
    * p2p: port to p2p/enode and discovery changes
    
    This adapts package p2p to the changes in p2p/discover. All uses of
    discover.Node and discover.NodeID are replaced by their equivalents from
    p2p/enode.
    
    New API is added to retrieve the enode.Node instance of a peer. The
    behavior of Server.Self with discovery disabled is improved. It now
    tries much harder to report a working IP address, falling back to
    127.0.0.1 if no suitable address can be determined through other means.
    These changes were needed for tests of other packages later in the
    series.
    
    * p2p/simulations, p2p/testing: port to p2p/enode
    
    No surprises here, mostly replacements of discover.Node, discover.NodeID
    with their new equivalents. The 'interesting' API changes are:
    
     - testing.ProtocolSession tracks complete nodes, not just their IDs.
     - adapters.NodeConfig has a new method to create a complete node.
    
    These changes were needed to make swarm tests work.
    
    Note that the NodeID change makes the code incompatible with old
    simulation snapshots.
    
    * whisper/whisperv5, whisper/whisperv6: port to p2p/enode
    
    This port was easy because whisper uses []byte for node IDs and
    URL strings in the API.
    
    * eth: port to p2p/enode
    
    Again, easy to port because eth uses strings for node IDs and doesn't
    care about node information in any way.
    
    * les: port to p2p/enode
    
    Apart from replacing discover.NodeID with enode.ID, most changes are in
    the server pool code. It now deals with complete nodes instead
    of (Pubkey, IP, Port) triples. The database format is unchanged for now,
    but we should probably change it to use the node database later.
    
    * node: port to p2p/enode
    
    This change simply replaces discover.Node and discover.NodeID with their
    new equivalents.
    
    * swarm/network: port to p2p/enode
    
    Swarm has its own node address representation, BzzAddr, containing both
    an overlay address (the hash of a secp256k1 public key) and an underlay
    address (enode:// URL).
    
    There are no changes to the BzzAddr format in this commit, but certain
    operations such as creating a BzzAddr from a node ID are now impossible
    because node IDs aren't public keys anymore.
    
    Most swarm-related changes in the series remove uses of
    NewAddrFromNodeID, replacing it with NewAddr which takes a complete node
    as argument. ToOverlayAddr is removed because we can just use the node
    ID directly.
    30cd5c18
    all: new p2p node representation (#17643)
    Felix Lange authored
    Package p2p/enode provides a generalized representation of p2p nodes
    which can contain arbitrary information in key/value pairs. It is also
    the new home for the node database. The "v4" identity scheme is also
    moved here from p2p/enr to remove the dependency on Ethereum crypto from
    that package.
    
    Record signature handling is changed significantly. The identity scheme
    registry is removed and acceptable schemes must be passed to any method
    that needs identity. This means records must now be validated explicitly
    after decoding.
    
    The enode API is designed to make signature handling easy and safe: most
    APIs around the codebase work with enode.Node, which is a wrapper around
    a valid record. Going from enr.Record to enode.Node requires a valid
    signature.
    
    * p2p/discover: port to p2p/enode
    
    This ports the discovery code to the new node representation in
    p2p/enode. The wire protocol is unchanged, this can be considered a
    refactoring change. The Kademlia table can now deal with nodes using an
    arbitrary identity scheme. This requires a few incompatible API changes:
    
      - Table.Lookup is not available anymore. It used to take a public key
        as argument because v4 protocol requires one. Its replacement is
        LookupRandom.
      - Table.Resolve takes *enode.Node instead of NodeID. This is also for
        v4 protocol compatibility because nodes cannot be looked up by ID
        alone.
      - Types Node and NodeID are gone. Further commits in the series will be
        fixes all over the the codebase to deal with those removals.
    
    * p2p: port to p2p/enode and discovery changes
    
    This adapts package p2p to the changes in p2p/discover. All uses of
    discover.Node and discover.NodeID are replaced by their equivalents from
    p2p/enode.
    
    New API is added to retrieve the enode.Node instance of a peer. The
    behavior of Server.Self with discovery disabled is improved. It now
    tries much harder to report a working IP address, falling back to
    127.0.0.1 if no suitable address can be determined through other means.
    These changes were needed for tests of other packages later in the
    series.
    
    * p2p/simulations, p2p/testing: port to p2p/enode
    
    No surprises here, mostly replacements of discover.Node, discover.NodeID
    with their new equivalents. The 'interesting' API changes are:
    
     - testing.ProtocolSession tracks complete nodes, not just their IDs.
     - adapters.NodeConfig has a new method to create a complete node.
    
    These changes were needed to make swarm tests work.
    
    Note that the NodeID change makes the code incompatible with old
    simulation snapshots.
    
    * whisper/whisperv5, whisper/whisperv6: port to p2p/enode
    
    This port was easy because whisper uses []byte for node IDs and
    URL strings in the API.
    
    * eth: port to p2p/enode
    
    Again, easy to port because eth uses strings for node IDs and doesn't
    care about node information in any way.
    
    * les: port to p2p/enode
    
    Apart from replacing discover.NodeID with enode.ID, most changes are in
    the server pool code. It now deals with complete nodes instead
    of (Pubkey, IP, Port) triples. The database format is unchanged for now,
    but we should probably change it to use the node database later.
    
    * node: port to p2p/enode
    
    This change simply replaces discover.Node and discover.NodeID with their
    new equivalents.
    
    * swarm/network: port to p2p/enode
    
    Swarm has its own node address representation, BzzAddr, containing both
    an overlay address (the hash of a secp256k1 public key) and an underlay
    address (enode:// URL).
    
    There are no changes to the BzzAddr format in this commit, but certain
    operations such as creating a BzzAddr from a node ID are now impossible
    because node IDs aren't public keys anymore.
    
    Most swarm-related changes in the series remove uses of
    NewAddrFromNodeID, replacing it with NewAddr which takes a complete node
    as argument. ToOverlayAddr is removed because we can just use the node
    ID directly.
Loading