message

package
v0.15.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 1, 2025 License: GPL-3.0, LGPL-3.0 Imports: 12 Imported by: 15

Documentation

Overview

Copyright (C) 2019-2025, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

Copyright (C) 2019-2025, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

Index

Constants

View Source 
const (
	StateTrieNode      = NodeType(1)
	StateTrieKeyLength = common.HashLength
)
View Source 
const MaxCodeHashesPerRequest = 5
View Source 
const (
	Version = uint16(0)
)

Variables

View Source 
var Codec codec.Manager

Functions

func RequestToBytes added in v0.8.5 

func RequestToBytes(codec codec.Manager, request Request) ([]byte, error)

RequestToBytes marshals the given request object into bytes

Types

type AcceptImplFn added in v0.15.2 

type AcceptImplFn func(Syncable) (block.StateSyncMode, error)

type BlockRequest added in v0.8.7 

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 added in v0.8.7 

func (b BlockRequest) Handle(ctx context.Context, nodeID ids.NodeID, requestID uint32, handler RequestHandler) ([]byte, error)

func (BlockRequest) String added in v0.8.7 

func (b BlockRequest) String() string

type BlockResponse added in v0.8.7 

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 BlockSyncSummary added in v0.15.2 

type BlockSyncSummary struct {
	BlockNumber uint64      `serialize:"true"`
	BlockHash   common.Hash `serialize:"true"`
	BlockRoot   common.Hash `serialize:"true"`
	// contains filtered or unexported fields
}

BlockSyncSummary provides the information necessary to sync a node starting at the given block.

func NewBlockSyncSummary added in v0.15.2 

func NewBlockSyncSummary(blockHash common.Hash, blockNumber uint64, blockRoot common.Hash) (*BlockSyncSummary, error)

func (*BlockSyncSummary) Accept added in v0.15.2 

func (s *BlockSyncSummary) Accept(context.Context) (block.StateSyncMode, error)

func (*BlockSyncSummary) Bytes added in v0.15.2 

func (s *BlockSyncSummary) Bytes() []byte

func (*BlockSyncSummary) GetBlockHash added in v0.15.2 

func (s *BlockSyncSummary) GetBlockHash() common.Hash

func (*BlockSyncSummary) GetBlockRoot added in v0.15.2 

func (s *BlockSyncSummary) GetBlockRoot() common.Hash

func (*BlockSyncSummary) Height added in v0.15.2 

func (s *BlockSyncSummary) Height() uint64

func (*BlockSyncSummary) ID added in v0.15.2 

func (s *BlockSyncSummary) ID() ids.ID

func (*BlockSyncSummary) String added in v0.15.2 

func (s *BlockSyncSummary) String() string

type BlockSyncSummaryParser added in v0.15.2 

type BlockSyncSummaryParser struct{}

func NewBlockSyncSummaryParser added in v0.15.2 

func NewBlockSyncSummaryParser() *BlockSyncSummaryParser

func (*BlockSyncSummaryParser) Parse added in v0.15.2 

func (b *BlockSyncSummaryParser) Parse(summaryBytes []byte, acceptImpl AcceptImplFn) (Syncable, error)

type BlockSyncSummaryProvider added in v0.15.2 

type BlockSyncSummaryProvider struct{}

func (*BlockSyncSummaryProvider) StateSummaryAtBlock added in v0.15.2 

func (a *BlockSyncSummaryProvider) StateSummaryAtBlock(blk *types.Block) (block.StateSummary, error)

StateSummaryAtBlock returns the block state summary at block if valid.

type CodeRequest added in v0.8.7 

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 added in v0.8.7 

func NewCodeRequest(hashes []common.Hash) CodeRequest

func (CodeRequest) Handle added in v0.8.7 

func (c CodeRequest) Handle(ctx context.Context, nodeID ids.NodeID, requestID uint32, handler RequestHandler) ([]byte, error)

func (CodeRequest) String added in v0.8.7 

func (c CodeRequest) String() string

type CodeResponse added in v0.8.7 

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 LeafsRequest added in v0.8.7 

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 added in v0.8.7 

func (l LeafsRequest) Handle(ctx context.Context, nodeID ids.NodeID, requestID uint32, handler RequestHandler) ([]byte, error)

func (LeafsRequest) String added in v0.8.7 

func (l LeafsRequest) String() string

type LeafsResponse added in v0.8.7 

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 added in v0.8.7 

type NodeType uint8

NodeType outlines the trie that a leaf node belongs to handlers.LeafsRequestHandler uses this information to determine which trie type to fetch the information from

type NoopRequestHandler added in v0.8.10 

type NoopRequestHandler struct{}

func (NoopRequestHandler) HandleBlockRequest added in v0.8.10 

func (NoopRequestHandler) HandleBlockRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, request BlockRequest) ([]byte, error)

func (NoopRequestHandler) HandleCodeRequest added in v0.8.10 

func (NoopRequestHandler) HandleCodeRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, codeRequest CodeRequest) ([]byte, error)

func (NoopRequestHandler) HandleLeafsRequest added in v0.15.2 

func (NoopRequestHandler) HandleLeafsRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, leafsRequest LeafsRequest) ([]byte, error)

type Request added in v0.8.5 

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 added in v0.8.5 

type RequestHandler interface {
	HandleLeafsRequest(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.NodeID, uint32, request Type) error so that the Request object of relevant Type can invoke its respective handle method on this struct.

type ResponseHandler added in v0.8.5 

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 Syncable added in v0.15.2 

type Syncable interface {
	block.StateSummary
	GetBlockHash() common.Hash
	GetBlockRoot() common.Hash
}

type SyncableParser added in v0.15.2 

type SyncableParser interface {
	Parse(summaryBytes []byte, acceptImpl AcceptImplFn) (Syncable, error)
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.