network

package

Go to main page

Versions in this module

v0

v0.9.0

Mar 1, 2024

Changes in this version

+ var ErrNoPeersConnected = errors.New("no peers connected")

+ var ErrStreamReset = errors.New("stream reset")

+ type AddressAdder interface

+ AddAddrs func(p peer.ID, addrs []multiaddr.Multiaddr, ttl time.Duration)

+ type NotifeeTracker struct

+ func NewNotifeeTracker(addressAdder AddressAdder, peerAdder PeerAdder) *NotifeeTracker

+ func (n *NotifeeTracker) HandlePeerFound(p peer.AddrInfo)

+ type PeerAdder interface

+ AddPeer func(setID int, peerIDs ...peer.ID)

type Service

+ func (s *Service) BlockAnnounceHandshake(header *types.Header) error

v0.8.0

Dec 11, 2023

Changes in this version

+ const BootstrapRequestData

+ const MaxBlockResponseSize

+ const MaxBlocksInResponse

+ const SyncID

+ var ErrFailedToReadEntireMessage = errors.New("failed to read entire message")

+ var ErrGreaterThanMaxSize = errors.New("greater than maximum size")

+ var ErrInvalidLEB128EncodedData = errors.New("invalid LEB128 encoded data")

+ var ErrNilStream = errors.New("nil stream")

+ var ErrReceivedEmptyMessage = errors.New("received empty message")

type BlockRequestMessage

+ func NewAscendingBlockRequests(startNumber, targetNumber uint, requestedData byte) []*BlockRequestMessage

+ func NewBlockRequest(startingBlock variadic.Uint32OrHash, amount uint32, requestedData byte, ...) *BlockRequestMessage

type Config

+ ListenAddress string

+ NodeKey string

+ type Logger interface

+ Debugf func(format string, args ...interface{})

+ Errorf func(format string, args ...interface{})

+ Infof func(format string, args ...interface{})

+ Warn func(s string)

+ Warnf func(format string, args ...interface{})

+ type MDNS interface

+ Start func() error

+ Stop func() error

+ type MessageType byte

+ type RequestMaker interface

+ Do func(to peer.ID, req Message, res ResponseMessage) error

+ type RequestResponseProtocol struct

+ func (rrp *RequestResponseProtocol) Do(to peer.ID, req Message, res ResponseMessage) error

+ type ResponseMessage interface

+ Decode func(in []byte) (err error)

+ Encode func() ([]byte, error)

+ String func() string

type Service

+ func (s *Service) AllConnectedPeersIDs() []peer.ID

+ func (s *Service) GetRequestResponseProtocol(subprotocol string, requestTimeout time.Duration, maxResponseSize uint64) *RequestResponseProtocol

+ type Telemetry interface

+ SendMessage func(msg json.Marshaler)

v0.7.0

Nov 23, 2022

Changes in this version

+ const DefaultDiscoveryInterval

+ const MaxGrandpaNotificationSize

type BlockAnnounceHandshake

+ func (hs *BlockAnnounceHandshake) IsValid() bool

type BlockState

+ GetHighestFinalisedHeader func() (*types.Header, error)

type Config

+ DiscoveryInterval time.Duration

+ Metrics metrics.IntervalConfig

+ PublicDNS string

+ PublicIP string

+ SlotDuration time.Duration

+ Telemetry telemetry.Client

type Handshake

+ IsValid func() bool

+ type NotificationsMessageBatchHandler = func(peer peer.ID, msg NotificationsMessage)

type Pair

+ First []byte

+ Second []byte

+ type Peer interface

+ Messages func() chan peerset.Message

+ PeerReputation func(peer.ID) (peerset.Reputation, error)

+ SortedPeers func(idx int) chan peer.IDSlice

+ type PeerAdd interface

+ AddPeer func(int, ...peer.ID)

+ AddReservedPeer func(int, ...peer.ID)

+ Incoming func(int, ...peer.ID)

+ SetReservedPeer func(int, ...peer.ID)

+ type PeerRemove interface

+ DisconnectPeer func(int, ...peer.ID)

+ RemovePeer func(int, ...peer.ID)

+ RemoveReservedPeer func(int, ...peer.ID)

+ type PeerSetHandler interface

+ ReportPeer func(peerset.ReputationChange, ...peer.ID)

+ Start func(context.Context)

type Service

+ Metrics metrics.IntervalConfig

+ func (*Service) HighestBlock() int64

+ func (*Service) StartingBlock() int64

+ func (s *Service) AddReservedPeers(addrs ...string) error

+ func (s *Service) DoBlockRequest(to peer.ID, req *BlockRequestMessage) (*BlockResponseMessage, error)

+ func (s *Service) GossipMessage(msg NotificationsMessage)

+ func (s *Service) IsSynced() bool

+ func (s *Service) RemoveReservedPeers(addrs ...string) error

+ func (s *Service) ReportPeer(change peerset.ReputationChange, p peer.ID)

+ type SyncDirection byte

+ const Ascending

+ const Descending

+ func (sd SyncDirection) String() string

type Syncer

+ HandleBlockAnnounceHandshake func(from peer.ID, msg *BlockAnnounceHandshake) error

type TransactionHandler

+ TransactionsCount func() int

v0.6.0

Apr 8, 2021

v0.5.2

Apr 7, 2021

v0.5.1

Apr 7, 2021

v0.5.0

Apr 7, 2021

v0.4.1

Apr 14, 2021

Changes in this version

type Config

+ PersistentPeers []string

v0.4.0

Apr 6, 2021

Changes in this version

type BlockState

+ GetHashByNumber func(num *big.Int) (common.Hash, error)

type Syncer

+ SetSyncing func(bool)

v0.3.2

Mar 22, 2021

Changes in this version

type BlockAnnounceMessage

+ BestBlock bool

type BlockState

+ GetFinalizedHeader func(round, setID uint64) (*types.Header, error)

type Config

+ PublishMetrics bool

v0.3.1

Mar 8, 2021

v0.3.0

Feb 25, 2021

Changes in this version

+ const DefaultMaxPeerCount

+ const DefaultMinPeerCount

type BlockAnnounceHandshake

+ func (hs *BlockAnnounceHandshake) Hash() common.Hash

+ func (hs *BlockAnnounceHandshake) IsHandshake() bool

+ func (hs *BlockAnnounceHandshake) SubProtocol() string

type BlockAnnounceMessage

+ func (bm *BlockAnnounceMessage) Hash() common.Hash

+ func (bm *BlockAnnounceMessage) IsHandshake() bool

+ func (bm *BlockAnnounceMessage) SubProtocol() string

type BlockRequestMessage

+ func (bm *BlockRequestMessage) SubProtocol() string

type BlockResponseMessage

+ func (bm *BlockResponseMessage) SubProtocol() string

type BlockState

+ BestBlockNumber func() (*big.Int, error)

+ HasBlockBody func(common.Hash) (bool, error)

type Config

+ MaxPeers int

+ MinPeers int

+ TransactionHandler TransactionHandler

type ConnManager

+ func (cm *ConnManager) RegisterCloseHandler(protocolID protocol.ID, cb func(id peer.ID))

type ConsensusMessage

+ func (cm *ConsensusMessage) Hash() common.Hash

+ func (cm *ConsensusMessage) IsHandshake() bool

+ func (cm *ConsensusMessage) SubProtocol() string

+ type Handshake interface

+ type HandshakeDecoder = func([]byte) (Handshake, error)

+ type HandshakeGetter = func() (Handshake, error)

+ type HandshakeValidator = func(peer.ID, Handshake) error

+ type LightRequest struct

+ RmtCallRequest *RemoteCallRequest

+ RmtChangesRequest *RemoteChangesRequest

+ RmtHeaderRequest *RemoteHeaderRequest

+ RmtReadChildRequest *RemoteReadChildRequest

+ RmtReadRequest *RemoteReadRequest

+ func NewLightRequest() *LightRequest

+ func (l *LightRequest) Decode(in []byte) error

+ func (l *LightRequest) Encode() ([]byte, error)

+ func (l *LightRequest) SubProtocol() string

+ func (l LightRequest) String() string

+ type LightResponse struct

+ RmtCallResponse *RemoteCallResponse

+ RmtChangeResponse *RemoteChangesResponse

+ RmtHeaderResponse *RemoteHeaderResponse

+ RmtReadResponse *RemoteReadResponse

+ func NewLightResponse() *LightResponse

+ func (l *LightResponse) Decode(in []byte) error

+ func (l *LightResponse) Encode() ([]byte, error)

+ func (l *LightResponse) SubProtocol() string

+ func (l LightResponse) String() string

type Message

+ SubProtocol func() string

+ type MessageDecoder = func([]byte) (NotificationsMessage, error)

+ type NotificationsMessage interface

+ Hash func() common.Hash

+ IsHandshake func() bool

+ Type func() byte

+ type NotificationsMessageHandler = func(peer peer.ID, msg NotificationsMessage) error

+ type Pair struct

+ type RemoteCallRequest struct

+ Block []byte

+ Data []byte

+ Method string

+ func (rc *RemoteCallRequest) String() string

+ type RemoteCallResponse struct

+ Proof []byte

+ func (rc *RemoteCallResponse) String() string

+ type RemoteChangesRequest struct

+ FirstBlock *optional.Hash

+ LastBlock *optional.Hash

+ Max []byte

+ Min []byte

+ StorageKey *optional.Bytes

+ func NewRemoteChangesRequest() *RemoteChangesRequest

+ func (rc *RemoteChangesRequest) String() string

+ type RemoteChangesResponse struct

+ Max []byte

+ Proof [][]byte

+ Roots [][]Pair

+ RootsProof []byte

+ func (rc *RemoteChangesResponse) String() string

+ type RemoteHeaderRequest struct

+ Block []byte

+ func (rh *RemoteHeaderRequest) String() string

+ type RemoteHeaderResponse struct

+ Header []*optional.Header

+ func (rh *RemoteHeaderResponse) String() string

+ type RemoteReadChildRequest struct

+ Block []byte

+ Keys [][]byte

+ StorageKey []byte

+ func (rr *RemoteReadChildRequest) String() string

+ type RemoteReadRequest struct

+ Block []byte

+ Keys [][]byte

+ func (rr *RemoteReadRequest) String() string

+ type RemoteReadResponse struct

+ Proof []byte

+ func (rr *RemoteReadResponse) String() string

type Service

+ func (s *Service) RegisterNotificationsProtocol(sub protocol.ID, messageID byte, handshakeGetter HandshakeGetter, ...) error

+ func (s *Service) SetSyncer(syncer Syncer)

+ func (s *Service) SetTransactionHandler(handler TransactionHandler)

type Syncer

+ IsSynced func() bool

+ ProcessBlockData func(data []*types.BlockData) error

+ type TransactionHandler interface

+ HandleTransactionMessage func(*TransactionMessage) error

type TransactionMessage

+ func (tm *TransactionMessage) Hash() common.Hash

+ func (tm *TransactionMessage) IsHandshake() bool

+ func (tm *TransactionMessage) SubProtocol() string

v0.2.0

Nov 10, 2020

Changes in this version

+ const RequestedDataBody

+ const RequestedDataHeader

+ const RequestedDataJustification

+ const RequestedDataMessageQueue

+ const RequestedDataReceipt

+ type BlockAnnounceHandshake struct

+ BestBlockHash common.Hash

+ BestBlockNumber uint64

+ GenesisHash common.Hash

+ Roles byte

+ func (hs *BlockAnnounceHandshake) Decode(r io.Reader) error

+ func (hs *BlockAnnounceHandshake) Encode() ([]byte, error)

+ func (hs *BlockAnnounceHandshake) IDString() string

+ func (hs *BlockAnnounceHandshake) String() string

+ func (hs *BlockAnnounceHandshake) Type() int

type BlockAnnounceMessage

+ func (bm *BlockAnnounceMessage) Type() int

type BlockRequestMessage

+ func (bm *BlockRequestMessage) Type() int

type BlockResponseMessage

+ func (bm *BlockResponseMessage) Type() int

type Config

+ ErrChan chan<- error

+ LogLvl log.Lvl

+ MessageHandler MessageHandler

+ Syncer Syncer

type ConnManager

+ func (*ConnManager) IsProtected(id peer.ID, tag string) (protected bool)

type ConsensusMessage

+ func (cm *ConsensusMessage) Type() int

type Message

+ Type func() int

+ type MessageHandler interface

+ HandleMessage func(Message)

+ type MockNetworkState struct

+ Health common.Health

+ NetworkState common.NetworkState

+ Peers []common.PeerInfo

+ func (ns *MockNetworkState) SetHealth(health common.Health)

+ func (ns *MockNetworkState) SetNetworkState(networkState common.NetworkState)

+ func (ns *MockNetworkState) SetPeers(peers []common.PeerInfo)

type Service

+ func (s *Service) IsStopped() bool

+ func (s *Service) SendMessage(msg Message)

+ func (s *Service) SetMessageHandler(handler MessageHandler)

type StatusMessage

+ func (sm *StatusMessage) Type() int

+ type Syncer interface

+ CreateBlockResponse func(*BlockRequestMessage) (*BlockResponseMessage, error)

+ HandleBlockAnnounce func(*BlockAnnounceMessage) *BlockRequestMessage

+ HandleBlockResponse func(*BlockResponseMessage) *BlockRequestMessage

+ HandleSeenBlocks func(*big.Int) *BlockRequestMessage

type TransactionMessage

+ func (tm *TransactionMessage) Type() int

v0.1.0

May 27, 2020

Changes in this version

+ const BlockAnnounceMsgType

+ const BlockRequestMsgType

+ const BlockResponseMsgType

+ const ChainSpecificMsgType

+ const ConsensusMsgType

+ const DefaultBasePath

+ const DefaultKeyFile

+ const DefaultPort

+ const DefaultProtocolID

+ const DefaultProtocolVersion

+ const DefaultRandSeed

+ const DefaultRoles

+ const ExpireStatusInterval

+ const MDNSPeriod

+ const NetworkStateTimeout

+ const RemoteCallRequestType

+ const RemoteCallResponseType

+ const RemoteChangesRequestType

+ const RemoteChangesResponseType

+ const RemoteHeaderRequestType

+ const RemoteHeaderResponseType

+ const RemoteReadRequestType

+ const RemoteReadResponseType

+ const SendStatusInterval

+ const StatusMsgType

+ const TransactionMsgType

+ var DefaultBootnodes = []string(nil)

+ type BlockAnnounceMessage struct

+ Digest [][]byte

+ ExtrinsicsRoot common.Hash

+ Number *big.Int

+ ParentHash common.Hash

+ StateRoot common.Hash

+ func (bm *BlockAnnounceMessage) Decode(r io.Reader) error

+ func (bm *BlockAnnounceMessage) Encode() ([]byte, error)

+ func (bm *BlockAnnounceMessage) GetType() int

+ func (bm *BlockAnnounceMessage) IDString() string

+ func (bm *BlockAnnounceMessage) String() string

+ type BlockRequestMessage struct

+ Direction byte

+ EndBlockHash *optional.Hash

+ ID uint64

+ Max *optional.Uint32

+ RequestedData byte

+ StartingBlock *variadic.Uint64OrHash

+ func (bm *BlockRequestMessage) Decode(r io.Reader) error

+ func (bm *BlockRequestMessage) Encode() ([]byte, error)

+ func (bm *BlockRequestMessage) GetType() int

+ func (bm *BlockRequestMessage) IDString() string

+ func (bm *BlockRequestMessage) String() string

+ type BlockResponseMessage struct

+ BlockData []*types.BlockData

+ ID uint64

+ func (bm *BlockResponseMessage) Decode(r io.Reader) error

+ func (bm *BlockResponseMessage) Encode() ([]byte, error)

+ func (bm *BlockResponseMessage) GetType() int

+ func (bm *BlockResponseMessage) IDString() string

+ func (bm *BlockResponseMessage) String() string

+ type BlockState interface

+ BestBlockHeader func() (*types.Header, error)

+ GenesisHash func() common.Hash

+ type Config struct

+ BasePath string

+ BlockState BlockState

+ Bootnodes []string

+ MinSupportedVersion uint32

+ MsgRec <-chan Message

+ MsgSend chan<- Message

+ NetworkState NetworkState

+ NoBootstrap bool

+ NoMDNS bool

+ NoStatus bool

+ Port uint32

+ ProtocolID string

+ ProtocolVersion uint32

+ RandSeed int64

+ Roles byte

+ SyncChan chan<- *big.Int

+ type ConnManager struct

+ func (*ConnManager) Close() error

+ func (*ConnManager) GetTagInfo(peer.ID) *connmgr.TagInfo

+ func (*ConnManager) Protect(peer.ID, string)

+ func (*ConnManager) TagPeer(peer.ID, string, int)

+ func (*ConnManager) TrimOpenConns(ctx context.Context)

+ func (*ConnManager) Unprotect(peer.ID, string) bool

+ func (*ConnManager) UntagPeer(peer.ID, string)

+ func (*ConnManager) UpsertTag(peer.ID, string, func(int) int)

+ func (cm *ConnManager) ClosedStream(n network.Network, s network.Stream)

+ func (cm *ConnManager) Connected(n network.Network, c network.Conn)

+ func (cm *ConnManager) Disconnected(n network.Network, c network.Conn)

+ func (cm *ConnManager) Listen(n network.Network, addr ma.Multiaddr)

+ func (cm *ConnManager) ListenClose(n network.Network, addr ma.Multiaddr)

+ func (cm *ConnManager) Notifee() network.Notifiee

+ func (cm *ConnManager) OpenedStream(n network.Network, s network.Stream)

+ type ConsensusMessage struct

+ ConsensusEngineID types.ConsensusEngineID

+ Data []byte

+ func (cm *ConsensusMessage) Decode(r io.Reader) error

+ func (cm *ConsensusMessage) Encode() ([]byte, error)

+ func (cm *ConsensusMessage) GetType() int

+ func (cm *ConsensusMessage) IDString() string

+ func (cm *ConsensusMessage) String() string

+ type Message interface

+ Decode func(io.Reader) error

+ Encode func() ([]byte, error)

+ GetType func() int

+ IDString func() string

+ String func() string

+ type NetworkState interface

+ SetHealth func(common.Health)

+ SetNetworkState func(common.NetworkState)

+ SetPeers func([]common.PeerInfo)

+ type Notifee struct

+ func (n Notifee) HandlePeerFound(p peer.AddrInfo)

+ type Service struct

+ func NewService(cfg *Config) (*Service, error)

+ func (s *Service) Health() common.Health

+ func (s *Service) NetworkState() common.NetworkState

+ func (s *Service) NodeRoles() byte

+ func (s *Service) Peers() []common.PeerInfo

+ func (s *Service) Start() error

+ func (s *Service) Stop() error

+ type StatusMessage struct

+ BestBlockHash common.Hash

+ BestBlockNumber uint64

+ ChainStatus []byte

+ GenesisHash common.Hash

+ MinSupportedVersion uint32

+ ProtocolVersion uint32

+ Roles byte

+ func (sm *StatusMessage) Decode(r io.Reader) error

+ func (sm *StatusMessage) Encode() ([]byte, error)

+ func (sm *StatusMessage) GetType() int

+ func (sm *StatusMessage) IDString() string

+ func (sm *StatusMessage) String() string

+ type TransactionMessage struct

+ Extrinsics []types.Extrinsic

+ func (tm *TransactionMessage) Decode(r io.Reader) error

+ func (tm *TransactionMessage) Encode() ([]byte, error)

+ func (tm *TransactionMessage) GetType() int

+ func (tm *TransactionMessage) IDString() string

+ func (tm *TransactionMessage) String() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL