sync

Oct 14, 2024

Changes in this version

+ var ErrNoChangeProofClientProvided = errors.New("change proof client is a required field of the sync config")

+ var ErrNoRangeProofClientProvided = errors.New("range proof client is a required field of the sync config")

+ type GetChangeProofHandler struct

+ func NewGetChangeProofHandler(log logging.Logger, db DB) *GetChangeProofHandler

+ func (*GetChangeProofHandler) AppGossip(context.Context, ids.NodeID, []byte)

+ func (g *GetChangeProofHandler) AppRequest(ctx context.Context, _ ids.NodeID, _ time.Time, requestBytes []byte) ([]byte, *common.AppError)

+ type GetRangeProofHandler struct

+ func NewGetRangeProofHandler(log logging.Logger, db DB) *GetRangeProofHandler

+ func (*GetRangeProofHandler) AppGossip(context.Context, ids.NodeID, []byte)

+ func (g *GetRangeProofHandler) AppRequest(ctx context.Context, _ ids.NodeID, _ time.Time, requestBytes []byte) ([]byte, *common.AppError)

type ManagerConfig

+ ChangeProofClient *p2p.Client

+ Hasher merkledb.Hasher

+ RangeProofClient *p2p.Client

+ StateSyncNodes []ids.NodeID

Apr 30, 2024

Changes in this version

type ClientConfig

+ Hasher merkledb.Hasher

Oct 11, 2023

Changes in this version

type ClientConfig

+ BranchFactor merkledb.BranchFactor

type ManagerConfig

+ BranchFactor merkledb.BranchFactor

Aug 11, 2023

Changes in this version

+ type MockNetworkClient struct

+ func NewMockNetworkClient(ctrl *gomock.Controller) *MockNetworkClient

+ func (m *MockNetworkClient) AppRequestFailed(arg0 context.Context, arg1 ids.NodeID, arg2 uint32) error

+ func (m *MockNetworkClient) AppResponse(arg0 context.Context, arg1 ids.NodeID, arg2 uint32, arg3 []byte) error

+ func (m *MockNetworkClient) Connected(arg0 context.Context, arg1 ids.NodeID, arg2 *version.Application) error

+ func (m *MockNetworkClient) Disconnected(arg0 context.Context, arg1 ids.NodeID) error

+ func (m *MockNetworkClient) EXPECT() *MockNetworkClientMockRecorder

+ func (m *MockNetworkClient) Request(ctx context.Context, nodeID ids.NodeID, request []byte) ([]byte, error)

+ func (m *MockNetworkClient) RequestAny(ctx context.Context, minVersion *version.Application, request []byte) (ids.NodeID, []byte, error)

+ func (m *MockNetworkClient) TrackBandwidth(nodeID ids.NodeID, bandwidth float64)

+ type MockNetworkClientMockRecorder struct

+ func (mr *MockNetworkClientMockRecorder) AppRequestFailed(arg0, arg1, arg2 interface{}) *gomock.Call

+ func (mr *MockNetworkClientMockRecorder) AppResponse(arg0, arg1, arg2, arg3 interface{}) *gomock.Call

+ func (mr *MockNetworkClientMockRecorder) Connected(arg0, arg1, arg2 interface{}) *gomock.Call

+ func (mr *MockNetworkClientMockRecorder) Disconnected(arg0, arg1 interface{}) *gomock.Call

+ func (mr *MockNetworkClientMockRecorder) Request(ctx, nodeID, request interface{}) *gomock.Call

+ func (mr *MockNetworkClientMockRecorder) RequestAny(ctx, minVersion, request interface{}) *gomock.Call

+ func (mr *MockNetworkClientMockRecorder) TrackBandwidth(nodeID, bandwidth interface{}) *gomock.Call

Jul 10, 2023

Changes in this version

+ type DB interface

+ type Manager struct

+ func NewManager(config ManagerConfig) (*Manager, error)

+ func (m *Manager) Close()

+ func (m *Manager) Error() error

+ func (m *Manager) Start(ctx context.Context) error

+ func (m *Manager) UpdateSyncTarget(syncTargetRoot ids.ID) error

+ func (m *Manager) Wait(ctx context.Context) error

+ type ManagerConfig struct

+ Client Client

+ DB DB

+ Log logging.Logger

+ SimultaneousWorkLimit int

+ TargetRoot ids.ID

Jun 14, 2023

Changes in this version

+ type SyncableDB interface

Apr 29, 2023

Changes in this version

+ var ErrMinProofSizeIsTooLarge = errors.New("cannot generate any proof within the requested limit")

type ChangeProofRequest

+ BytesLimit uint32

+ KeyLimit uint16

type RangeProofRequest

+ BytesLimit uint32

+ KeyLimit uint16

Feb 21, 2023

Changes in this version

type ClientConfig

+ StateSyncMinVersion *version.Application

Feb 1, 2023

Changes in this version

+ const Version

+ var ErrAcquiringSemaphore = errors.New("error acquiring semaphore")

+ var ErrAlreadyClosed = errors.New("StateSyncManager is closed")

+ var ErrAlreadyStarted = errors.New("cannot start a StateSyncManager that has already been started")

+ var ErrFinishedWithUnexpectedRoot = errors.New("finished syncing with an unexpected root")

+ var ErrNoClientProvided = errors.New("client is a required field of the sync config")

+ var ErrNoDatabaseProvided = errors.New("sync database is a required field of the sync config")

+ var ErrNoLogProvided = errors.New("log is a required field of the sync config")

+ var ErrNotEnoughBytes = errors.New("less bytes read than the specified length")

+ var ErrRequestFailed = errors.New("request failed")

+ var ErrZeroWorkLimit = errors.New("simultaneous work limit must be greater than 0")

+ var StateSyncVersion = &version.Application

+ type ChangeProofRequest struct

+ End []byte

+ EndingRoot ids.ID

+ Limit uint16

+ Start []byte

+ StartingRoot ids.ID

+ func (r *ChangeProofRequest) Handle(ctx context.Context, nodeID ids.NodeID, requestID uint32, h Handler) error

+ func (r ChangeProofRequest) String() string

+ type Client interface

+ GetChangeProof func(ctx context.Context, request *ChangeProofRequest, ...) (*merkledb.ChangeProof, error)

+ GetRangeProof func(ctx context.Context, request *RangeProofRequest) (*merkledb.RangeProof, error)

+ func NewClient(config *ClientConfig) Client

+ type ClientConfig struct

+ Log logging.Logger

+ Metrics SyncMetrics

+ NetworkClient NetworkClient

+ StateSyncNodeIDs []ids.NodeID

+ type Handler interface

+ type MockClient struct

+ func NewMockClient(ctrl *gomock.Controller) *MockClient

+ func (m *MockClient) EXPECT() *MockClientMockRecorder

+ func (m *MockClient) GetChangeProof(arg0 context.Context, arg1 *ChangeProofRequest, arg2 *merkledb.Database) (*merkledb.ChangeProof, error)

+ func (m *MockClient) GetRangeProof(arg0 context.Context, arg1 *RangeProofRequest) (*merkledb.RangeProof, error)

+ type MockClientMockRecorder struct

+ func (mr *MockClientMockRecorder) GetChangeProof(arg0, arg1, arg2 interface{}) *gomock.Call

+ func (mr *MockClientMockRecorder) GetRangeProof(arg0, arg1 interface{}) *gomock.Call

+ type NetworkClient interface

+ AppRequestFailed func(context.Context, ids.NodeID, uint32) error

+ AppResponse func(context.Context, ids.NodeID, uint32, []byte) error

+ Connected func(context.Context, ids.NodeID, *version.Application) error

+ Disconnected func(context.Context, ids.NodeID) error

+ Request func(ctx context.Context, nodeID ids.NodeID, request []byte) ([]byte, error)

+ RequestAny func(ctx context.Context, minVersion *version.Application, request []byte) ([]byte, ids.NodeID, error)

+ TrackBandwidth func(nodeID ids.NodeID, bandwidth float64)

+ func NewNetworkClient(appSender common.AppSender, myNodeID ids.NodeID, maxActiveRequests int64, ...) NetworkClient

+ type NetworkServer struct

+ func NewNetworkServer(appSender common.AppSender, db *merkledb.Database, log logging.Logger) *NetworkServer

+ func (s *NetworkServer) AppRequest(_ context.Context, nodeID ids.NodeID, requestID uint32, deadline time.Time, ...) error

+ func (s *NetworkServer) HandleChangeProofRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, ...) error

+ func (s *NetworkServer) HandleRangeProofRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, ...) error

+ type RangeProofRequest struct

+ End []byte

+ Limit uint16

+ Root ids.ID

+ Start []byte

+ func (r *RangeProofRequest) Handle(ctx context.Context, nodeID ids.NodeID, requestID uint32, h Handler) error

+ func (r RangeProofRequest) String() string

+ type Request interface

+ Handle func(ctx context.Context, nodeID ids.NodeID, requestID uint32, h Handler) error

+ type ResponseHandler interface

+ OnFailure func()

+ OnResponse func(response []byte)

+ type StateSyncConfig struct

+ Client Client

+ Log logging.Logger

+ SimultaneousWorkLimit int

+ SyncDB *merkledb.Database

+ TargetRoot ids.ID

+ type StateSyncManager struct

+ func NewStateSyncManager(config StateSyncConfig) (*StateSyncManager, error)

+ func (m *StateSyncManager) Close()

+ func (m *StateSyncManager) Error() error

+ func (m *StateSyncManager) StartSyncing(ctx context.Context) error

+ func (m *StateSyncManager) UpdateSyncTarget(syncTargetRoot ids.ID) error

+ func (m *StateSyncManager) Wait(ctx context.Context) error

+ type SyncMetrics interface

+ RequestFailed func()

+ RequestMade func()

+ RequestSucceeded func()

+ func NewMetrics(namespace string, reg prometheus.Registerer) (SyncMetrics, error)