Documentation
¶
Index ¶
- Constants
- Variables
- func BuildGossipMessage(codec codec.Manager, msg GossipMessage) ([]byte, error)
- func RequestToBytes(codec codec.Manager, request Request) ([]byte, error)
- type AtomicTxGossip
- type BlockRequest
- type BlockResponse
- type CodeRequest
- type CodeResponse
- type CrossChainRequest
- type CrossChainRequestHandler
- type EthCallRequest
- type EthCallResponse
- type EthTxsGossip
- type GossipHandler
- type GossipMessage
- type LeafsRequest
- type LeafsResponse
- type NodeType
- type NoopCrossChainRequestHandler
- type NoopMempoolGossipHandler
- type NoopRequestHandler
- func (NoopRequestHandler) HandleAtomicTrieLeafsRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, ...) ([]byte, error)
- func (NoopRequestHandler) HandleBlockRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, request BlockRequest) ([]byte, error)
- func (NoopRequestHandler) HandleCodeRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, ...) ([]byte, error)
- func (NoopRequestHandler) HandleStateTrieLeafsRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, ...) ([]byte, error)
- type Request
- type RequestHandler
- type ResponseHandler
- type SyncSummary
Constants ¶
const ( // EthMsgSoftCapSize is the ideal size of encoded transaction bytes we send in // any [EthTxsGossip] or [AtomicTxGossip] message. We do not limit inbound messages to // this size, however. Max inbound message size is enforced by the codec // (512KB). EthMsgSoftCapSize = 64 * units.KiB )
const (
Version = uint16(0)
)
Variables ¶
var ( Codec codec.Manager CrossChainCodec codec.Manager )
Functions ¶
func BuildGossipMessage ¶
func BuildGossipMessage(codec codec.Manager, msg GossipMessage) ([]byte, error)
Types ¶
type AtomicTxGossip ¶
type AtomicTxGossip struct {
Tx []byte `serialize:"true"`
}
func (AtomicTxGossip) Handle ¶
func (msg AtomicTxGossip) Handle(handler GossipHandler, nodeID ids.NodeID) error
func (AtomicTxGossip) String ¶
func (msg AtomicTxGossip) String() string
type BlockRequest ¶
type BlockRequest struct { Hash common.Hash `serialize:"true"` Height uint64 `serialize:"true"` Parents uint16 `serialize:"true"` }
BlockRequest is a request to retrieve Parents number of blocks starting from Hash from newest-oldest manner
func (BlockRequest) Handle ¶
func (b BlockRequest) Handle(ctx context.Context, nodeID ids.NodeID, requestID uint32, handler RequestHandler) ([]byte, error)
func (BlockRequest) String ¶
func (b BlockRequest) String() string
type BlockResponse ¶
type BlockResponse struct {
Blocks [][]byte `serialize:"true"`
}
BlockResponse is a response to a BlockRequest Blocks is slice of RLP encoded blocks starting with the block requested in BlockRequest.Hash. The next block is the parent, etc. handler: handlers.BlockRequestHandler
type CodeRequest ¶
type CodeRequest struct { // Hashes is a list of contract code hashes Hashes []common.Hash `serialize:"true"` }
CodeRequest is a request to retrieve a contract code with specified Hash
func NewCodeRequest ¶
func NewCodeRequest(hashes []common.Hash) CodeRequest
func (CodeRequest) Handle ¶
func (c CodeRequest) Handle(ctx context.Context, nodeID ids.NodeID, requestID uint32, handler RequestHandler) ([]byte, error)
func (CodeRequest) String ¶
func (c CodeRequest) String() string
type CodeResponse ¶
type CodeResponse struct {
Data [][]byte `serialize:"true"`
}
CodeResponse is a response to a CodeRequest crypto.Keccak256Hash of each element in Data is expected to equal the corresponding element in CodeRequest.Hashes handler: handlers.CodeRequestHandler
type CrossChainRequest ¶
type CrossChainRequest interface { // CrossChainRequest should implement String() for logging. fmt.Stringer // Handle allows [CrossChainRequest] to call respective methods on handler to handle // this particular request type Handle(ctx context.Context, requestingChainID ids.ID, requestID uint32, handler CrossChainRequestHandler) ([]byte, error) }
CrossChainRequest represents the interface a cross chain request should implement
type CrossChainRequestHandler ¶
type CrossChainRequestHandler interface {
HandleEthCallRequest(ctx context.Context, requestingchainID ids.ID, requestID uint32, ethCallRequest EthCallRequest) ([]byte, error)
}
CrossChainRequestHandler interface handles incoming requests from another chain
func NewCrossChainHandler ¶
func NewCrossChainHandler(b ethapi.Backend, codec codec.Manager) CrossChainRequestHandler
NewCrossChainHandler creates and returns a new instance of CrossChainRequestHandler
type EthCallRequest ¶
type EthCallRequest struct {
RequestArgs []byte `serialize:"true"`
}
EthCallRequest has the JSON Data necessary to execute a new DELTA call on the blockchain
func (EthCallRequest) Handle ¶
func (e EthCallRequest) Handle(ctx context.Context, requestingChainID ids.ID, requestID uint32, handler CrossChainRequestHandler) ([]byte, error)
Handle returns the encoded EthCallResponse by executing DELTA call with the given EthCallRequest
func (EthCallRequest) String ¶
func (e EthCallRequest) String() string
String converts EthCallRequest to a string
type EthCallResponse ¶
type EthCallResponse struct {
ExecutionResult []byte `serialize:"true"`
}
EthCallResponse represents the JSON return value of the executed DELTA call
type EthTxsGossip ¶
type EthTxsGossip struct {
Txs []byte `serialize:"true"`
}
func (EthTxsGossip) Handle ¶
func (msg EthTxsGossip) Handle(handler GossipHandler, nodeID ids.NodeID) error
func (EthTxsGossip) String ¶
func (msg EthTxsGossip) String() string
type GossipHandler ¶
type GossipHandler interface { HandleAtomicTx(nodeID ids.NodeID, msg AtomicTxGossip) error HandleEthTxs(nodeID ids.NodeID, msg EthTxsGossip) error }
GossipHandler handles incoming gossip messages
type GossipMessage ¶
type GossipMessage interface { // types implementing GossipMessage should also implement fmt.Stringer for logging purposes. fmt.Stringer // Handle this gossip message with the gossip handler. Handle(handler GossipHandler, nodeID ids.NodeID) error }
func ParseGossipMessage ¶
func ParseGossipMessage(codec codec.Manager, bytes []byte) (GossipMessage, error)
type LeafsRequest ¶
type LeafsRequest struct { Root common.Hash `serialize:"true"` Account common.Hash `serialize:"true"` Start []byte `serialize:"true"` End []byte `serialize:"true"` Limit uint16 `serialize:"true"` NodeType NodeType `serialize:"true"` }
LeafsRequest is a request to receive trie leaves at specified Root within Start and End byte range Limit outlines maximum number of leaves to returns starting at Start NodeType outlines which trie to read from state/atomic.
func (LeafsRequest) Handle ¶
func (l LeafsRequest) Handle(ctx context.Context, nodeID ids.NodeID, requestID uint32, handler RequestHandler) ([]byte, error)
func (LeafsRequest) String ¶
func (l LeafsRequest) String() string
type LeafsResponse ¶
type LeafsResponse struct { // Keys and Vals provides the key-value pairs in the trie in the response. Keys [][]byte `serialize:"true"` Vals [][]byte `serialize:"true"` // More indicates if there are more leaves to the right of the last value in this response. // // This is not serialized since it is set in the client after verifying the response via // VerifyRangeProof and determining if there are in fact more leaves to the right of the // last value in this response. More bool // ProofVals contain the edge merkle-proofs for the range of keys included in the response. // The keys for the proof are simply the keccak256 hashes of the values, so they are not included in the response to save bandwidth. ProofVals [][]byte `serialize:"true"` }
LeafsResponse is a response to a LeafsRequest Keys must be within LeafsRequest.Start and LeafsRequest.End and sorted in lexicographical order.
ProofVals must be non-empty and contain a valid range proof unless the key-value pairs in the response are the entire trie. If the key-value pairs make up the entire trie, ProofVals should be empty since the root will be sufficient to prove that the leaves are included in the trie.
More is a flag set in the client after verifying the response, which indicates if the last key-value pair in the response has any more elements to its right within the trie.
type NodeType ¶
type NodeType uint8
NodeType outlines the trie that a leaf node belongs to handlers.LeafsRequestHandler uses this information to determine which of the two tries (state/atomic) to fetch the information from
type NoopCrossChainRequestHandler ¶
type NoopCrossChainRequestHandler struct{}
func (NoopCrossChainRequestHandler) HandleEthCallRequest ¶
func (NoopCrossChainRequestHandler) HandleEthCallRequest(ctx context.Context, requestingchainID ids.ID, requestID uint32, ethCallRequest EthCallRequest) ([]byte, error)
type NoopMempoolGossipHandler ¶
type NoopMempoolGossipHandler struct{}
func (NoopMempoolGossipHandler) HandleAtomicTx ¶
func (NoopMempoolGossipHandler) HandleAtomicTx(nodeID ids.NodeID, msg AtomicTxGossip) error
func (NoopMempoolGossipHandler) HandleEthTxs ¶
func (NoopMempoolGossipHandler) HandleEthTxs(nodeID ids.NodeID, msg EthTxsGossip) error
type NoopRequestHandler ¶
type NoopRequestHandler struct{}
func (NoopRequestHandler) HandleAtomicTrieLeafsRequest ¶
func (NoopRequestHandler) HandleAtomicTrieLeafsRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, leafsRequest LeafsRequest) ([]byte, error)
func (NoopRequestHandler) HandleBlockRequest ¶
func (NoopRequestHandler) HandleBlockRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, request BlockRequest) ([]byte, error)
func (NoopRequestHandler) HandleCodeRequest ¶
func (NoopRequestHandler) HandleCodeRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, codeRequest CodeRequest) ([]byte, error)
func (NoopRequestHandler) HandleStateTrieLeafsRequest ¶
func (NoopRequestHandler) HandleStateTrieLeafsRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, leafsRequest LeafsRequest) ([]byte, error)
type Request ¶
type Request interface { // Requests should implement String() for logging. fmt.Stringer // Handle allows `Request` to call respective methods on handler to handle // this particular request type Handle(ctx context.Context, nodeID ids.NodeID, requestID uint32, handler RequestHandler) ([]byte, error) }
Request represents a Network request type
type RequestHandler ¶
type RequestHandler interface { HandleStateTrieLeafsRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, leafsRequest LeafsRequest) ([]byte, error) HandleAtomicTrieLeafsRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, leafsRequest LeafsRequest) ([]byte, error) HandleBlockRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, request BlockRequest) ([]byte, error) HandleCodeRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, codeRequest CodeRequest) ([]byte, error) }
RequestHandler interface handles incoming requests from peers Must have methods in format of handleType(context.Context, ids.ShortID, uint32, request Type) error so that the Request object of relevant Type can invoke its respective handle method on this struct. Also see GossipHandler for implementation style.
type ResponseHandler ¶
type ResponseHandler interface { // OnResponse is invoked when the peer responded to a request OnResponse(response []byte) error // OnFailure is invoked when there was a failure in processing a request OnFailure() error }
ResponseHandler handles response for a sent request Only one of OnResponse or OnFailure is called for a given requestID, not both
type SyncSummary ¶
type SyncSummary struct { BlockNumber uint64 `serialize:"true"` BlockHash common.Hash `serialize:"true"` BlockRoot common.Hash `serialize:"true"` AtomicRoot common.Hash `serialize:"true"` // contains filtered or unexported fields }
SyncSummary provides the information necessary to sync a node starting at the given block.
func NewSyncSummary ¶
func NewSyncSummaryFromBytes ¶
func NewSyncSummaryFromBytes(summaryBytes []byte, acceptImpl func(SyncSummary) (block.StateSyncMode, error)) (SyncSummary, error)
func (SyncSummary) Accept ¶
func (s SyncSummary) Accept(context.Context) (block.StateSyncMode, error)
func (SyncSummary) Bytes ¶
func (s SyncSummary) Bytes() []byte
func (SyncSummary) Height ¶
func (s SyncSummary) Height() uint64
func (SyncSummary) ID ¶
func (s SyncSummary) ID() ids.ID
func (SyncSummary) String ¶
func (s SyncSummary) String() string