mirror
/
go-ethereum
mirror of https://github.com/ethereum/go-ethereum
2
0
Fork 1
Code Issues Releases Wiki Activity

eth/protocols/eth: fix godoc comments (#24810)

Browse Source 
Co-authored-by: Martin Holst Swende <martin@swende.se>
pull/24824/head
s7v7nislands 3 years ago committed by GitHub
parent 7f6f01d46f
commit 1c90d97c1e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 13 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 4
      eth/protocols/eth/peer.go
  2. 22
      eth/protocols/eth/protocol.go

4
eth/protocols/eth/peer.go
Unescape View File

@ -296,7 +296,7 @@ func (p *Peer) AsyncSendNewBlock(block *types.Block, td *big.Int) {
} }
} }
// ReplyBlockHeaders is the eth/66 version of SendBlockHeaders. // ReplyBlockHeadersRLP is the eth/66 response to GetBlockHeaders.
func (p *Peer) ReplyBlockHeadersRLP(id uint64, headers []rlp.RawValue) error { func (p *Peer) ReplyBlockHeadersRLP(id uint64, headers []rlp.RawValue) error {
return p2p.Send(p.rw, BlockHeadersMsg, &BlockHeadersRLPPacket66{ return p2p.Send(p.rw, BlockHeadersMsg, &BlockHeadersRLPPacket66{
RequestId: id, RequestId: id,
@ -304,7 +304,7 @@ func (p *Peer) ReplyBlockHeadersRLP(id uint64, headers []rlp.RawValue) error {
}) })
} }
// ReplyBlockBodiesRLP is the eth/66 version of SendBlockBodiesRLP. // ReplyBlockBodiesRLP is the eth/66 response to GetBlockBodies.
func (p *Peer) ReplyBlockBodiesRLP(id uint64, bodies []rlp.RawValue) error { func (p *Peer) ReplyBlockBodiesRLP(id uint64, bodies []rlp.RawValue) error {
// Not packed into BlockBodiesPacket to avoid RLP decoding // Not packed into BlockBodiesPacket to avoid RLP decoding
return p2p.Send(p.rw, BlockBodiesMsg, &BlockBodiesRLPPacket66{ return p2p.Send(p.rw, BlockBodiesMsg, &BlockBodiesRLPPacket66{

22
eth/protocols/eth/protocol.go
Unescape View File

@ -169,7 +169,7 @@ func (hn *HashOrNumber) DecodeRLP(s *rlp.Stream) error {
// BlockHeadersPacket represents a block header response. // BlockHeadersPacket represents a block header response.
type BlockHeadersPacket []*types.Header type BlockHeadersPacket []*types.Header
// BlockHeadersPacket represents a block header response over eth/66. // BlockHeadersPacket66 represents a block header response over eth/66.
type BlockHeadersPacket66 struct { type BlockHeadersPacket66 struct {
RequestId uint64 RequestId uint64
BlockHeadersPacket BlockHeadersPacket
@ -179,7 +179,7 @@ type BlockHeadersPacket66 struct {
// have the headers rlp encoded. // have the headers rlp encoded.
type BlockHeadersRLPPacket []rlp.RawValue type BlockHeadersRLPPacket []rlp.RawValue
// BlockHeadersPacket represents a block header response over eth/66. // BlockHeadersRLPPacket66 represents a block header response over eth/66.
type BlockHeadersRLPPacket66 struct { type BlockHeadersRLPPacket66 struct {
RequestId uint64 RequestId uint64
BlockHeadersRLPPacket BlockHeadersRLPPacket
@ -207,7 +207,7 @@ func (request *NewBlockPacket) sanityCheck() error {
// GetBlockBodiesPacket represents a block body query. // GetBlockBodiesPacket represents a block body query.
type GetBlockBodiesPacket []common.Hash type GetBlockBodiesPacket []common.Hash
// GetBlockBodiesPacket represents a block body query over eth/66. // GetBlockBodiesPacket66 represents a block body query over eth/66.
type GetBlockBodiesPacket66 struct { type GetBlockBodiesPacket66 struct {
RequestId uint64 RequestId uint64
GetBlockBodiesPacket GetBlockBodiesPacket
@ -216,7 +216,7 @@ type GetBlockBodiesPacket66 struct {
// BlockBodiesPacket is the network packet for block content distribution. // BlockBodiesPacket is the network packet for block content distribution.
type BlockBodiesPacket []*BlockBody type BlockBodiesPacket []*BlockBody
// BlockBodiesPacket is the network packet for block content distribution over eth/66. // BlockBodiesPacket66 is the network packet for block content distribution over eth/66.
type BlockBodiesPacket66 struct { type BlockBodiesPacket66 struct {
RequestId uint64 RequestId uint64
BlockBodiesPacket BlockBodiesPacket
@ -255,7 +255,7 @@ func (p *BlockBodiesPacket) Unpack() ([][]*types.Transaction, [][]*types.Header)
// GetNodeDataPacket represents a trie node data query. // GetNodeDataPacket represents a trie node data query.
type GetNodeDataPacket []common.Hash type GetNodeDataPacket []common.Hash
// GetNodeDataPacket represents a trie node data query over eth/66. // GetNodeDataPacket66 represents a trie node data query over eth/66.
type GetNodeDataPacket66 struct { type GetNodeDataPacket66 struct {
RequestId uint64 RequestId uint64
GetNodeDataPacket GetNodeDataPacket
@ -264,7 +264,7 @@ type GetNodeDataPacket66 struct {
// NodeDataPacket is the network packet for trie node data distribution. // NodeDataPacket is the network packet for trie node data distribution.
type NodeDataPacket [][]byte type NodeDataPacket [][]byte
// NodeDataPacket is the network packet for trie node data distribution over eth/66. // NodeDataPacket66 is the network packet for trie node data distribution over eth/66.
type NodeDataPacket66 struct { type NodeDataPacket66 struct {
RequestId uint64 RequestId uint64
NodeDataPacket NodeDataPacket
@ -273,7 +273,7 @@ type NodeDataPacket66 struct {
// GetReceiptsPacket represents a block receipts query. // GetReceiptsPacket represents a block receipts query.
type GetReceiptsPacket []common.Hash type GetReceiptsPacket []common.Hash
// GetReceiptsPacket represents a block receipts query over eth/66. // GetReceiptsPacket66 represents a block receipts query over eth/66.
type GetReceiptsPacket66 struct { type GetReceiptsPacket66 struct {
RequestId uint64 RequestId uint64
GetReceiptsPacket GetReceiptsPacket
@ -282,7 +282,7 @@ type GetReceiptsPacket66 struct {
// ReceiptsPacket is the network packet for block receipts distribution. // ReceiptsPacket is the network packet for block receipts distribution.
type ReceiptsPacket [][]*types.Receipt type ReceiptsPacket [][]*types.Receipt
// ReceiptsPacket is the network packet for block receipts distribution over eth/66. // ReceiptsPacket66 is the network packet for block receipts distribution over eth/66.
type ReceiptsPacket66 struct { type ReceiptsPacket66 struct {
RequestId uint64 RequestId uint64
ReceiptsPacket ReceiptsPacket
@ -291,7 +291,7 @@ type ReceiptsPacket66 struct {
// ReceiptsRLPPacket is used for receipts, when we already have it encoded // ReceiptsRLPPacket is used for receipts, when we already have it encoded
type ReceiptsRLPPacket []rlp.RawValue type ReceiptsRLPPacket []rlp.RawValue
// ReceiptsPacket66 is the eth-66 version of ReceiptsRLPPacket // ReceiptsRLPPacket66 is the eth-66 version of ReceiptsRLPPacket
type ReceiptsRLPPacket66 struct { type ReceiptsRLPPacket66 struct {
RequestId uint64 RequestId uint64
ReceiptsRLPPacket ReceiptsRLPPacket
@ -311,13 +311,13 @@ type GetPooledTransactionsPacket66 struct {
// PooledTransactionsPacket is the network packet for transaction distribution. // PooledTransactionsPacket is the network packet for transaction distribution.
type PooledTransactionsPacket []*types.Transaction type PooledTransactionsPacket []*types.Transaction
// PooledTransactionsPacket is the network packet for transaction distribution over eth/66. // PooledTransactionsPacket66 is the network packet for transaction distribution over eth/66.
type PooledTransactionsPacket66 struct { type PooledTransactionsPacket66 struct {
RequestId uint64 RequestId uint64
PooledTransactionsPacket PooledTransactionsPacket
} }
// PooledTransactionsPacket is the network packet for transaction distribution, used // PooledTransactionsRLPPacket is the network packet for transaction distribution, used
// in the cases we already have them in rlp-encoded form // in the cases we already have them in rlp-encoded form
type PooledTransactionsRLPPacket []rlp.RawValue type PooledTransactionsRLPPacket []rlp.RawValue

Write Preview
Loading…
Cancel
Save