Skip to content

Commit

Permalink
tighten comments
Browse files Browse the repository at this point in the history
  • Loading branch information
arnetheduck committed Feb 4, 2022
1 parent e8e52f3 commit adc1682
Showing 1 changed file with 24 additions and 16 deletions.
40 changes: 24 additions & 16 deletions beacon_chain/sync/sync_protocol.nim
Original file line number Diff line number Diff line change
Expand Up @@ -211,10 +211,12 @@ p2pProtocol BeaconSync(version = 1,
{.async, libp2pProtocol("beacon_blocks_by_range", 1).} =
# TODO Semantically, this request should return a non-ref, but doing so
# runs into extreme inefficiency due to the compiler introducing
# hidden copies - in future nim versions, this should be revisited
# TODO This code is more complicated than it needs to be, in order to please
# the libp2p macro and the type machinery it introduces, that we don't
# use
# hidden copies - in future nim versions with move support, this should
# be revisited
# TODO This code is more complicated than it needs to be, since the type
# of the multiple chunks response is not actually used in this server
# implementation (it's used to derive the signature of the client
# function, not in the code below!)
# TODO although you can't tell from this function definition, a magic
# client call that returns `seq[ref SignedBeaconBlock]` will
# will be generated by the libp2p macro - we guarantee that seq items
Expand Down Expand Up @@ -283,10 +285,12 @@ p2pProtocol BeaconSync(version = 1,
{.async, libp2pProtocol("beacon_blocks_by_root", 1).} =
# TODO Semantically, this request should return a non-ref, but doing so
# runs into extreme inefficiency due to the compiler introducing
# hidden copies - in future nim versions, this should be revisited
# TODO This code is more complicated than it needs to be, in order to please
# the libp2p macro and the type machinery it introduces, that we don't
# use
# hidden copies - in future nim versions with move support, this should
# be revisited
# TODO This code is more complicated than it needs to be, since the type
# of the multiple chunks response is not actually used in this server
# implementation (it's used to derive the signature of the client
# function, not in the code below!)
# TODO although you can't tell from this function definition, a magic
# client call that returns `seq[ref SignedBeaconBlock]` will
# will be generated by the libp2p macro - we guarantee that seq items
Expand Down Expand Up @@ -339,10 +343,12 @@ p2pProtocol BeaconSync(version = 1,
{.async, libp2pProtocol("beacon_blocks_by_range", 2).} =
# TODO Semantically, this request should return a non-ref, but doing so
# runs into extreme inefficiency due to the compiler introducing
# hidden copies - in future nim versions, this should be revisited
# TODO This code is more complicated than it needs to be, in order to please
# the libp2p macro and the type machinery it introduces, that we don't
# use
# hidden copies - in future nim versions with move support, this should
# be revisited
# TODO This code is more complicated than it needs to be, since the type
# of the multiple chunks response is not actually used in this server
# implementation (it's used to derive the signature of the client
# function, not in the code below!)
# TODO although you can't tell from this function definition, a magic
# client call that returns `seq[ref ForkedSignedBeaconBlock]` will
# will be generated by the libp2p macro - we guarantee that seq items
Expand Down Expand Up @@ -392,10 +398,12 @@ p2pProtocol BeaconSync(version = 1,
{.async, libp2pProtocol("beacon_blocks_by_root", 2).} =
# TODO Semantically, this request should return a non-ref, but doing so
# runs into extreme inefficiency due to the compiler introducing
# hidden copies - in future nim versions, this should be revisited
# TODO This code is more complicated than it needs to be, in order to please
# the libp2p macro and the type machinery it introduces, that we don't
# use
# hidden copies - in future nim versions with move support, this should
# be revisited
# TODO This code is more complicated than it needs to be, since the type
# of the multiple chunks response is not actually used in this server
# implementation (it's used to derive the signature of the client
# function, not in the code below!)
# TODO although you can't tell from this function definition, a magic
# client call that returns `seq[ref ForkedSignedBeaconBlock]` will
# will be generated by the libp2p macro - we guarantee that seq items
Expand Down

0 comments on commit adc1682

Please sign in to comment.