activation

package
v1.3.1 Latest Latest
Warning

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

 Go to latest Published: Jan 10, 2024 License: MIT Imports: 63 Imported by: 0

Documentation

Overview

Package activation is responsible for creating activation transactions and running the mining flow, coordinating Post building, sending proofs to PoET and building NIPost structs.

Code generated by MockGen. DO NOT EDIT. Source: ./interface.go

Generated by this command: 

mockgen -typed -package=activation -destination=./mocks.go -source=./interface.go

Package activation is a generated GoMock package.

Index

Constants

View Source 
const DefaultPostServiceName = "service"

Variables

View Source 
var (
	// ErrATXChallengeExpired is returned when atx missed its publication window and needs to be regenerated.
	ErrATXChallengeExpired = errors.New("builder: atx expired")
	// ErrPoetServiceUnstable is returned when poet quality of service is low.
	ErrPoetServiceUnstable = &PoetSvcUnstableError{}
	// ErrPoetProofNotReceived is returned when no poet proof was received.
	ErrPoetProofNotReceived = errors.New("builder: didn't receive any poet proof")
)
View Source 
var (
	ErrNotFound       = errors.New("not found")
	ErrUnavailable    = errors.New("unavailable")
	ErrInvalidRequest = errors.New("invalid request")
)
View Source 
var ErrObjectExists = sql.ErrObjectExists

Functions

func SignAndFinalizeAtx added in v1.0.0 

func SignAndFinalizeAtx(signer *signing.EdSigner, atx *types.ActivationTx) error

SignAndFinalizeAtx signs the atx with specified signer and calculates the ID of the ATX.

Types

type AtxReceiver added in v1.0.0 

type AtxReceiver interface {
	OnAtx(*types.ActivationTxHeader)
}

type AtxReceiverOnAtxCall added in v1.1.5 

type AtxReceiverOnAtxCall struct {
	*gomock.Call
}

AtxReceiverOnAtxCall wrap *gomock.Call

func (*AtxReceiverOnAtxCall) Do added in v1.1.5 

func (c *AtxReceiverOnAtxCall) Do(f func(*types.ActivationTxHeader)) *AtxReceiverOnAtxCall

Do rewrite *gomock.Call.Do

func (*AtxReceiverOnAtxCall) DoAndReturn added in v1.1.5 

func (c *AtxReceiverOnAtxCall) DoAndReturn(f func(*types.ActivationTxHeader)) *AtxReceiverOnAtxCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*AtxReceiverOnAtxCall) Return added in v1.1.5 

func (c *AtxReceiverOnAtxCall) Return() *AtxReceiverOnAtxCall

Return rewrite *gomock.Call.Return

type Builder 

type Builder struct {
	// contains filtered or unexported fields
}

Builder struct is the struct that orchestrates the creation of activation transactions it is responsible for initializing post, receiving poet proof and orchestrating nipst. after which it will calculate total weight and providing relevant view as proof.

func NewBuilder 

func NewBuilder(
	conf Config,
	signer *signing.EdSigner,
	cdb *datastore.CachedDB,
	localDB *localsql.Database,
	publisher pubsub.Publisher,
	postService postService,
	nipostBuilder nipostBuilder,
	layerClock layerClock,
	syncer syncer,
	log *zap.Logger,
	opts ...BuilderOption,
) *Builder

NewBuilder returns an atx builder that will start a routine that will attempt to create an atx upon each new layer.

func (*Builder) Coinbase added in v1.0.0 

func (b *Builder) Coinbase() types.Address

Coinbase returns the current coinbase address.

func (*Builder) GetPositioningAtx 

func (b *Builder) GetPositioningAtx() (types.ATXID, error)

GetPositioningAtx returns atx id with the highest tick height.

func (*Builder) PublishActivationTx 

func (b *Builder) PublishActivationTx(ctx context.Context) error

PublishActivationTx attempts to publish an atx, it returns an error if an atx cannot be created.

func (*Builder) Regossip added in v1.1.10 

func (b *Builder) Regossip(ctx context.Context) error

func (*Builder) SetCoinbase added in v1.0.0 

func (b *Builder) SetCoinbase(rewardAddress types.Address)

SetCoinbase sets the address rewardAddress to be the coinbase account written into the activation transaction the rewards for blocks made by this miner will go to this address.

func (*Builder) SmesherID added in v1.0.0 

func (b *Builder) SmesherID() types.NodeID

SmesherID returns the ID of the smesher that created this activation.

func (*Builder) Smeshing added in v1.0.0 

func (b *Builder) Smeshing() bool

Smeshing returns true iff atx builder is smeshing.

func (*Builder) StartSmeshing added in v1.0.0 

func (b *Builder) StartSmeshing(coinbase types.Address) error

StartSmeshing is the main entry point of the atx builder. It runs the main loop of the builder in a new go-routine and shouldn't be called more than once without calling StopSmeshing in between. If the post data is incomplete or missing, data creation session will be preceded. Changing of the post options (e.g., number of labels), after initial setup, is supported. If data creation fails for any reason then the go-routine will panic.

func (*Builder) StopSmeshing added in v1.0.0 

func (b *Builder) StopSmeshing(deleteFiles bool) error

StopSmeshing stops the atx builder. It doesn't wait for the smeshing to stop.

type BuilderOption added in v1.0.0 

type BuilderOption func(*Builder)

BuilderOption ...

func WithContext added in v1.0.0 

func WithContext(ctx context.Context) BuilderOption

WithContext modifies parent context for background job.

func WithPoetConfig added in v1.0.0 

func WithPoetConfig(c PoetConfig) BuilderOption

WithPoetConfig sets the poet config.

func WithPoetRetryInterval added in v1.0.0 

func WithPoetRetryInterval(interval time.Duration) BuilderOption

WithPoetRetryInterval modifies time that builder will have to wait before retrying ATX build process if it failed due to issues with PoET server.

func WithValidator added in v1.0.3 

func WithValidator(v nipostValidator) BuilderOption

type Config added in v0.1.28 

type Config struct {
	GoldenATXID      types.ATXID
	LayersPerEpoch   uint32
	RegossipInterval time.Duration
}

Config defines configuration for Builder.

type ErrAtxNotFound 

type ErrAtxNotFound struct {
	Id types.ATXID
	// contains filtered or unexported fields
}

func (*ErrAtxNotFound) Error added in v1.0.0 

func (e *ErrAtxNotFound) Error() string

func (*ErrAtxNotFound) Is added in v1.0.0 

func (e *ErrAtxNotFound) Is(target error) bool

func (*ErrAtxNotFound) Unwrap added in v1.0.0 

func (e *ErrAtxNotFound) Unwrap() error

type HTTPPoetClient 

type HTTPPoetClient struct {
	// contains filtered or unexported fields
}

HTTPPoetClient implements PoetProvingServiceClient interface.

func NewHTTPPoetClient 

func NewHTTPPoetClient(baseUrl string, cfg PoetConfig, opts ...PoetClientOpts) (*HTTPPoetClient, error)

NewHTTPPoetClient returns new instance of HTTPPoetClient connecting to the specified url.

func (*HTTPPoetClient) Address added in v1.0.8 

func (c *HTTPPoetClient) Address() string

func (*HTTPPoetClient) PoetServiceID added in v0.1.11 

func (c *HTTPPoetClient) PoetServiceID(ctx context.Context) (types.PoetServiceID, error)

PoetServiceID returns the public key of the PoET proving service.

func (*HTTPPoetClient) PowParams added in v1.0.0 

func (c *HTTPPoetClient) PowParams(ctx context.Context) (*PoetPowParams, error)

func (*HTTPPoetClient) Proof added in v1.0.0 

func (c *HTTPPoetClient) Proof(ctx context.Context, roundID string) (*types.PoetProofMessage, []types.Member, error)

Proof implements PoetProvingServiceClient.

func (*HTTPPoetClient) Submit 

func (c *HTTPPoetClient) Submit(
	ctx context.Context,
	deadline time.Time,
	prefix, challenge []byte,
	signature types.EdSignature,
	nodeID types.NodeID,
	pow PoetPoW,
) (*types.PoetRound, error)

Submit registers a challenge in the proving service current open round.

type Handler added in v1.0.0 

type Handler struct {
	// contains filtered or unexported fields
}

Handler processes the atxs received from all nodes and their validity status.

func NewHandler added in v1.0.0 

func NewHandler(
	local p2p.Peer,
	cdb *datastore.CachedDB,
	atxsdata *atxsdata.Data,
	edVerifier *signing.EdVerifier,
	c layerClock,
	pub pubsub.Publisher,
	fetcher system.Fetcher,
	tickSize uint64,
	goldenATXID types.ATXID,
	nipostValidator nipostValidator,
	beacon AtxReceiver,
	tortoise system.Tortoise,
	log log.Log,
	poetCfg PoetConfig,
) *Handler

NewHandler returns a data handler for ATX.

func (*Handler) ContextuallyValidateAtx added in v1.0.0 

func (h *Handler) ContextuallyValidateAtx(atx *types.VerifiedActivationTx) error

ContextuallyValidateAtx ensures that the previous ATX referenced is the last known ATX for the referenced miner ID. If a previous ATX is not referenced, it validates that indeed there's no previous known ATX for that miner ID.

func (*Handler) FetchReferences added in v1.1.5 

func (h *Handler) FetchReferences(ctx context.Context, atx *types.ActivationTx) error

FetchReferences fetches referenced ATXs from peers if they are not found in db.

func (*Handler) GetEpochAtxs added in v1.0.0 

func (h *Handler) GetEpochAtxs(epochID types.EpochID) (ids []types.ATXID, err error)

GetEpochAtxs returns all valid ATXs received in the epoch epochID.

func (*Handler) HandleGossipAtx added in v1.0.0 

func (h *Handler) HandleGossipAtx(ctx context.Context, peer p2p.Peer, msg []byte) error

HandleGossipAtx handles the atx gossip data channel.

func (*Handler) HandleSyncedAtx added in v1.1.0 

func (h *Handler) HandleSyncedAtx(ctx context.Context, expHash types.Hash32, peer p2p.Peer, data []byte) error

HandleSyncedAtx handles atxs received by sync.

func (*Handler) ProcessAtx added in v1.0.0 

func (h *Handler) ProcessAtx(ctx context.Context, atx *types.VerifiedActivationTx) error

ProcessAtx validates the active set size declared in the atx, and contextually validates the atx according to atx validation rules it then stores the atx with flag set to validity of the atx.

ATXs received as input must be already syntactically valid. Only contextual validation is performed.

func (*Handler) SyntacticallyValidate added in v1.1.5 

func (h *Handler) SyntacticallyValidate(ctx context.Context, atx *types.ActivationTx) error

func (*Handler) SyntacticallyValidateDeps added in v1.1.5 

func (h *Handler) SyntacticallyValidateDeps(
	ctx context.Context,
	atx *types.ActivationTx,
) (*types.VerifiedActivationTx, error)

type MockAtxReceiver added in v1.0.0 

type MockAtxReceiver struct {
	// contains filtered or unexported fields
}

MockAtxReceiver is a mock of AtxReceiver interface.

func NewMockAtxReceiver added in v1.0.0 

func NewMockAtxReceiver(ctrl *gomock.Controller) *MockAtxReceiver

NewMockAtxReceiver creates a new mock instance.

func (*MockAtxReceiver) EXPECT added in v1.0.0 

func (m *MockAtxReceiver) EXPECT() *MockAtxReceiverMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockAtxReceiver) OnAtx added in v1.0.0 

func (m *MockAtxReceiver) OnAtx(arg0 *types.ActivationTxHeader)

OnAtx mocks base method.

type MockAtxReceiverMockRecorder added in v1.0.0 

type MockAtxReceiverMockRecorder struct {
	// contains filtered or unexported fields
}

MockAtxReceiverMockRecorder is the mock recorder for MockAtxReceiver.

func (*MockAtxReceiverMockRecorder) OnAtx added in v1.0.0 

func (mr *MockAtxReceiverMockRecorder) OnAtx(arg0 any) *AtxReceiverOnAtxCall

OnAtx indicates an expected call of OnAtx.

type MockPostClient added in v1.3.0 

type MockPostClient struct {
	// contains filtered or unexported fields
}

MockPostClient is a mock of PostClient interface.

func NewMockPostClient added in v1.3.0 

func NewMockPostClient(ctrl *gomock.Controller) *MockPostClient

NewMockPostClient creates a new mock instance.

func (*MockPostClient) EXPECT added in v1.3.0 

func (m *MockPostClient) EXPECT() *MockPostClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockPostClient) Info added in v1.3.0 

func (m *MockPostClient) Info(ctx context.Context) (*types.PostInfo, error)

Info mocks base method.

func (*MockPostClient) Proof added in v1.3.0 

func (m *MockPostClient) Proof(ctx context.Context, challenge []byte) (*types.Post, *types.PostInfo, error)

Proof mocks base method.

type MockPostClientMockRecorder added in v1.3.0 

type MockPostClientMockRecorder struct {
	// contains filtered or unexported fields
}

MockPostClientMockRecorder is the mock recorder for MockPostClient.

func (*MockPostClientMockRecorder) Info added in v1.3.0 

func (mr *MockPostClientMockRecorder) Info(ctx any) *PostClientInfoCall

Info indicates an expected call of Info.

func (*MockPostClientMockRecorder) Proof added in v1.3.0 

func (mr *MockPostClientMockRecorder) Proof(ctx, challenge any) *PostClientProofCall

Proof indicates an expected call of Proof.

type MockPostVerifier added in v1.0.0 

type MockPostVerifier struct {
	// contains filtered or unexported fields
}

MockPostVerifier is a mock of PostVerifier interface.

func NewMockPostVerifier added in v1.0.0 

func NewMockPostVerifier(ctrl *gomock.Controller) *MockPostVerifier

NewMockPostVerifier creates a new mock instance.

func (*MockPostVerifier) Close added in v1.0.0 

func (m *MockPostVerifier) Close() error

Close mocks base method.

func (*MockPostVerifier) EXPECT added in v1.0.0 

func (m *MockPostVerifier) EXPECT() *MockPostVerifierMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockPostVerifier) Verify added in v1.0.0 

func (m_2 *MockPostVerifier) Verify(ctx context.Context, p *shared.Proof, m *shared.ProofMetadata, opts ...verifying.OptionFunc) error

Verify mocks base method.

type MockPostVerifierMockRecorder added in v1.0.0 

type MockPostVerifierMockRecorder struct {
	// contains filtered or unexported fields
}

MockPostVerifierMockRecorder is the mock recorder for MockPostVerifier.

func (*MockPostVerifierMockRecorder) Close added in v1.0.0 

func (mr *MockPostVerifierMockRecorder) Close() *PostVerifierCloseCall

Close indicates an expected call of Close.

func (*MockPostVerifierMockRecorder) Verify added in v1.0.0 

func (mr *MockPostVerifierMockRecorder) Verify(ctx, p, m any, opts ...any) *PostVerifierVerifyCall

Verify indicates an expected call of Verify.

type MockSmeshingProvider added in v1.0.0 

type MockSmeshingProvider struct {
	// contains filtered or unexported fields
}

MockSmeshingProvider is a mock of SmeshingProvider interface.

func NewMockSmeshingProvider added in v1.0.0 

func NewMockSmeshingProvider(ctrl *gomock.Controller) *MockSmeshingProvider

NewMockSmeshingProvider creates a new mock instance.

func (*MockSmeshingProvider) Coinbase added in v1.0.0 

func (m *MockSmeshingProvider) Coinbase() types.Address

Coinbase mocks base method.

func (*MockSmeshingProvider) EXPECT added in v1.0.0 

func (m *MockSmeshingProvider) EXPECT() *MockSmeshingProviderMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockSmeshingProvider) SetCoinbase added in v1.0.0 

func (m *MockSmeshingProvider) SetCoinbase(coinbase types.Address)

SetCoinbase mocks base method.

func (*MockSmeshingProvider) SmesherID added in v1.0.0 

func (m *MockSmeshingProvider) SmesherID() types.NodeID

SmesherID mocks base method.

func (*MockSmeshingProvider) Smeshing added in v1.0.0 

func (m *MockSmeshingProvider) Smeshing() bool

Smeshing mocks base method.

func (*MockSmeshingProvider) StartSmeshing added in v1.0.0 

func (m *MockSmeshingProvider) StartSmeshing(arg0 types.Address) error

StartSmeshing mocks base method.

func (*MockSmeshingProvider) StopSmeshing added in v1.0.0 

func (m *MockSmeshingProvider) StopSmeshing(arg0 bool) error

StopSmeshing mocks base method.

type MockSmeshingProviderMockRecorder added in v1.0.0 

type MockSmeshingProviderMockRecorder struct {
	// contains filtered or unexported fields
}

MockSmeshingProviderMockRecorder is the mock recorder for MockSmeshingProvider.

func (*MockSmeshingProviderMockRecorder) Coinbase added in v1.0.0 

func (mr *MockSmeshingProviderMockRecorder) Coinbase() *SmeshingProviderCoinbaseCall

Coinbase indicates an expected call of Coinbase.

func (*MockSmeshingProviderMockRecorder) SetCoinbase added in v1.0.0 

func (mr *MockSmeshingProviderMockRecorder) SetCoinbase(coinbase any) *SmeshingProviderSetCoinbaseCall

SetCoinbase indicates an expected call of SetCoinbase.

func (*MockSmeshingProviderMockRecorder) SmesherID added in v1.0.0 

func (mr *MockSmeshingProviderMockRecorder) SmesherID() *SmeshingProviderSmesherIDCall

SmesherID indicates an expected call of SmesherID.

func (*MockSmeshingProviderMockRecorder) Smeshing added in v1.0.0 

func (mr *MockSmeshingProviderMockRecorder) Smeshing() *SmeshingProviderSmeshingCall

Smeshing indicates an expected call of Smeshing.

func (*MockSmeshingProviderMockRecorder) StartSmeshing added in v1.0.0 

func (mr *MockSmeshingProviderMockRecorder) StartSmeshing(arg0 any) *SmeshingProviderStartSmeshingCall

StartSmeshing indicates an expected call of StartSmeshing.

func (*MockSmeshingProviderMockRecorder) StopSmeshing added in v1.0.0 

func (mr *MockSmeshingProviderMockRecorder) StopSmeshing(arg0 any) *SmeshingProviderStopSmeshingCall

StopSmeshing indicates an expected call of StopSmeshing.

type MockatxProvider added in v1.0.0 

type MockatxProvider struct {
	// contains filtered or unexported fields
}

MockatxProvider is a mock of atxProvider interface.

func NewMockatxProvider added in v1.0.0 

func NewMockatxProvider(ctrl *gomock.Controller) *MockatxProvider

NewMockatxProvider creates a new mock instance.

func (*MockatxProvider) EXPECT added in v1.0.0 

func (m *MockatxProvider) EXPECT() *MockatxProviderMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockatxProvider) GetAtxHeader added in v1.0.0 

func (m *MockatxProvider) GetAtxHeader(id types.ATXID) (*types.ActivationTxHeader, error)

GetAtxHeader mocks base method.

type MockatxProviderMockRecorder added in v1.0.0 

type MockatxProviderMockRecorder struct {
	// contains filtered or unexported fields
}

MockatxProviderMockRecorder is the mock recorder for MockatxProvider.

func (*MockatxProviderMockRecorder) GetAtxHeader added in v1.0.0 

func (mr *MockatxProviderMockRecorder) GetAtxHeader(id any) *atxProviderGetAtxHeaderCall

GetAtxHeader indicates an expected call of GetAtxHeader.

type MocklayerClock added in v1.0.0 

type MocklayerClock struct {
	// contains filtered or unexported fields
}

MocklayerClock is a mock of layerClock interface.

func NewMocklayerClock added in v1.0.0 

func NewMocklayerClock(ctrl *gomock.Controller) *MocklayerClock

NewMocklayerClock creates a new mock instance.

func (*MocklayerClock) AwaitLayer added in v1.0.0 

func (m *MocklayerClock) AwaitLayer(layerID types.LayerID) <-chan struct{}

AwaitLayer mocks base method.

func (*MocklayerClock) CurrentLayer added in v1.0.0 

func (m *MocklayerClock) CurrentLayer() types.LayerID

CurrentLayer mocks base method.

func (*MocklayerClock) EXPECT added in v1.0.0 

func (m *MocklayerClock) EXPECT() *MocklayerClockMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MocklayerClock) LayerToTime added in v1.0.0 

func (m *MocklayerClock) LayerToTime(arg0 types.LayerID) time.Time

LayerToTime mocks base method.

type MocklayerClockMockRecorder added in v1.0.0 

type MocklayerClockMockRecorder struct {
	// contains filtered or unexported fields
}

MocklayerClockMockRecorder is the mock recorder for MocklayerClock.

func (*MocklayerClockMockRecorder) AwaitLayer added in v1.0.0 

func (mr *MocklayerClockMockRecorder) AwaitLayer(layerID any) *layerClockAwaitLayerCall

AwaitLayer indicates an expected call of AwaitLayer.

func (*MocklayerClockMockRecorder) CurrentLayer added in v1.0.0 

func (mr *MocklayerClockMockRecorder) CurrentLayer() *layerClockCurrentLayerCall

CurrentLayer indicates an expected call of CurrentLayer.

func (*MocklayerClockMockRecorder) LayerToTime added in v1.0.0 

func (mr *MocklayerClockMockRecorder) LayerToTime(arg0 any) *layerClockLayerToTimeCall

LayerToTime indicates an expected call of LayerToTime.

type MocknipostBuilder added in v1.0.0 

type MocknipostBuilder struct {
	// contains filtered or unexported fields
}

MocknipostBuilder is a mock of nipostBuilder interface.

func NewMocknipostBuilder added in v1.0.0 

func NewMocknipostBuilder(ctrl *gomock.Controller) *MocknipostBuilder

NewMocknipostBuilder creates a new mock instance.

func (*MocknipostBuilder) BuildNIPost added in v1.0.0 

func (m *MocknipostBuilder) BuildNIPost(ctx context.Context, challenge *types.NIPostChallenge) (*types.NIPost, error)

BuildNIPost mocks base method.

func (*MocknipostBuilder) DataDir added in v1.0.0 

func (m *MocknipostBuilder) DataDir() string

DataDir mocks base method.

func (*MocknipostBuilder) EXPECT added in v1.0.0 

func (m *MocknipostBuilder) EXPECT() *MocknipostBuilderMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

type MocknipostBuilderMockRecorder added in v1.0.0 

type MocknipostBuilderMockRecorder struct {
	// contains filtered or unexported fields
}

MocknipostBuilderMockRecorder is the mock recorder for MocknipostBuilder.

func (*MocknipostBuilderMockRecorder) BuildNIPost added in v1.0.0 

func (mr *MocknipostBuilderMockRecorder) BuildNIPost(ctx, challenge any) *nipostBuilderBuildNIPostCall

BuildNIPost indicates an expected call of BuildNIPost.

func (*MocknipostBuilderMockRecorder) DataDir added in v1.0.0 

func (mr *MocknipostBuilderMockRecorder) DataDir() *nipostBuilderDataDirCall

DataDir indicates an expected call of DataDir.

type MocknipostValidator added in v1.0.0 

type MocknipostValidator struct {
	// contains filtered or unexported fields
}

MocknipostValidator is a mock of nipostValidator interface.

func NewMocknipostValidator added in v1.0.0 

func NewMocknipostValidator(ctrl *gomock.Controller) *MocknipostValidator

NewMocknipostValidator creates a new mock instance.

func (*MocknipostValidator) EXPECT added in v1.0.0 

func (m *MocknipostValidator) EXPECT() *MocknipostValidatorMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MocknipostValidator) InitialNIPostChallenge added in v1.0.0 

func (m *MocknipostValidator) InitialNIPostChallenge(challenge *types.NIPostChallenge, atxs atxProvider, goldenATXID types.ATXID) error

InitialNIPostChallenge mocks base method.

func (*MocknipostValidator) NIPost added in v1.0.0 

func (m *MocknipostValidator) NIPost(ctx context.Context, nodeId types.NodeID, atxId types.ATXID, NIPost *types.NIPost, expectedChallenge types.Hash32, numUnits uint32) (uint64, error)

NIPost mocks base method.

func (*MocknipostValidator) NIPostChallenge added in v1.0.0 

func (m *MocknipostValidator) NIPostChallenge(challenge *types.NIPostChallenge, atxs atxProvider, nodeID types.NodeID) error

NIPostChallenge mocks base method.

func (*MocknipostValidator) NumUnits added in v1.0.0 

func (m *MocknipostValidator) NumUnits(cfg *PostConfig, numUnits uint32) error

NumUnits mocks base method.

func (*MocknipostValidator) PositioningAtx added in v1.0.0 

func (m *MocknipostValidator) PositioningAtx(id types.ATXID, atxs atxProvider, goldenATXID types.ATXID, pubepoch types.EpochID) error

PositioningAtx mocks base method.

func (*MocknipostValidator) Post added in v1.0.0 

func (m *MocknipostValidator) Post(ctx context.Context, nodeId types.NodeID, atxId types.ATXID, Post *types.Post, PostMetadata *types.PostMetadata, numUnits uint32) error

Post mocks base method.

func (*MocknipostValidator) PostMetadata added in v1.0.0 

func (m *MocknipostValidator) PostMetadata(cfg *PostConfig, metadata *types.PostMetadata) error

PostMetadata mocks base method.

func (*MocknipostValidator) VRFNonce added in v1.0.0 

func (m *MocknipostValidator) VRFNonce(nodeId types.NodeID, commitmentAtxId types.ATXID, vrfNonce *types.VRFPostIndex, PostMetadata *types.PostMetadata, numUnits uint32) error

VRFNonce mocks base method.

type MocknipostValidatorMockRecorder added in v1.0.0 

type MocknipostValidatorMockRecorder struct {
	// contains filtered or unexported fields
}

MocknipostValidatorMockRecorder is the mock recorder for MocknipostValidator.

func (*MocknipostValidatorMockRecorder) InitialNIPostChallenge added in v1.0.0 

func (mr *MocknipostValidatorMockRecorder) InitialNIPostChallenge(challenge, atxs, goldenATXID any) *nipostValidatorInitialNIPostChallengeCall

InitialNIPostChallenge indicates an expected call of InitialNIPostChallenge.

func (*MocknipostValidatorMockRecorder) NIPost added in v1.0.0 

func (mr *MocknipostValidatorMockRecorder) NIPost(ctx, nodeId, atxId, NIPost, expectedChallenge, numUnits any) *nipostValidatorNIPostCall

NIPost indicates an expected call of NIPost.

func (*MocknipostValidatorMockRecorder) NIPostChallenge added in v1.0.0 

func (mr *MocknipostValidatorMockRecorder) NIPostChallenge(challenge, atxs, nodeID any) *nipostValidatorNIPostChallengeCall

NIPostChallenge indicates an expected call of NIPostChallenge.

func (*MocknipostValidatorMockRecorder) NumUnits added in v1.0.0 

func (mr *MocknipostValidatorMockRecorder) NumUnits(cfg, numUnits any) *nipostValidatorNumUnitsCall

NumUnits indicates an expected call of NumUnits.

func (*MocknipostValidatorMockRecorder) PositioningAtx added in v1.0.0 

func (mr *MocknipostValidatorMockRecorder) PositioningAtx(id, atxs, goldenATXID, pubepoch any) *nipostValidatorPositioningAtxCall

PositioningAtx indicates an expected call of PositioningAtx.

func (*MocknipostValidatorMockRecorder) Post added in v1.0.0 

func (mr *MocknipostValidatorMockRecorder) Post(ctx, nodeId, atxId, Post, PostMetadata, numUnits any) *nipostValidatorPostCall

Post indicates an expected call of Post.

func (*MocknipostValidatorMockRecorder) PostMetadata added in v1.0.0 

func (mr *MocknipostValidatorMockRecorder) PostMetadata(cfg, metadata any) *nipostValidatorPostMetadataCall

PostMetadata indicates an expected call of PostMetadata.

func (*MocknipostValidatorMockRecorder) VRFNonce added in v1.0.0 

func (mr *MocknipostValidatorMockRecorder) VRFNonce(nodeId, commitmentAtxId, vrfNonce, PostMetadata, numUnits any) *nipostValidatorVRFNonceCall

VRFNonce indicates an expected call of VRFNonce.

type MockpoetClient added in v1.3.0 

type MockpoetClient struct {
	// contains filtered or unexported fields
}

MockpoetClient is a mock of poetClient interface.

func NewMockpoetClient added in v1.3.0 

func NewMockpoetClient(ctrl *gomock.Controller) *MockpoetClient

NewMockpoetClient creates a new mock instance.

func (*MockpoetClient) Address added in v1.3.0 

func (m *MockpoetClient) Address() string

Address mocks base method.

func (*MockpoetClient) EXPECT added in v1.3.0 

func (m *MockpoetClient) EXPECT() *MockpoetClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockpoetClient) PoetServiceID added in v1.3.0 

func (m *MockpoetClient) PoetServiceID(arg0 context.Context) (types.PoetServiceID, error)

PoetServiceID mocks base method.

func (*MockpoetClient) PowParams added in v1.3.0 

func (m *MockpoetClient) PowParams(ctx context.Context) (*PoetPowParams, error)

PowParams mocks base method.

func (*MockpoetClient) Proof added in v1.3.0 

func (m *MockpoetClient) Proof(ctx context.Context, roundID string) (*types.PoetProofMessage, []types.Member, error)

Proof mocks base method.

func (*MockpoetClient) Submit added in v1.3.0 

func (m *MockpoetClient) Submit(ctx context.Context, deadline time.Time, prefix, challenge []byte, signature types.EdSignature, nodeID types.NodeID, pow PoetPoW) (*types.PoetRound, error)

Submit mocks base method.

type MockpoetClientMockRecorder added in v1.3.0 

type MockpoetClientMockRecorder struct {
	// contains filtered or unexported fields
}

MockpoetClientMockRecorder is the mock recorder for MockpoetClient.

func (*MockpoetClientMockRecorder) Address added in v1.3.0 

func (mr *MockpoetClientMockRecorder) Address() *poetClientAddressCall

Address indicates an expected call of Address.

func (*MockpoetClientMockRecorder) PoetServiceID added in v1.3.0 

func (mr *MockpoetClientMockRecorder) PoetServiceID(arg0 any) *poetClientPoetServiceIDCall

PoetServiceID indicates an expected call of PoetServiceID.

func (*MockpoetClientMockRecorder) PowParams added in v1.3.0 

func (mr *MockpoetClientMockRecorder) PowParams(ctx any) *poetClientPowParamsCall

PowParams indicates an expected call of PowParams.

func (*MockpoetClientMockRecorder) Proof added in v1.3.0 

func (mr *MockpoetClientMockRecorder) Proof(ctx, roundID any) *poetClientProofCall

Proof indicates an expected call of Proof.

func (*MockpoetClientMockRecorder) Submit added in v1.3.0 

func (mr *MockpoetClientMockRecorder) Submit(ctx, deadline, prefix, challenge, signature, nodeID, pow any) *poetClientSubmitCall

Submit indicates an expected call of Submit.

type MockpoetDbAPI added in v1.0.0 

type MockpoetDbAPI struct {
	// contains filtered or unexported fields
}

MockpoetDbAPI is a mock of poetDbAPI interface.

func NewMockpoetDbAPI added in v1.0.0 

func NewMockpoetDbAPI(ctrl *gomock.Controller) *MockpoetDbAPI

NewMockpoetDbAPI creates a new mock instance.

func (*MockpoetDbAPI) EXPECT added in v1.0.0 

func (m *MockpoetDbAPI) EXPECT() *MockpoetDbAPIMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockpoetDbAPI) GetProof added in v1.0.0 

func (m *MockpoetDbAPI) GetProof(arg0 types.PoetProofRef) (*types.PoetProof, *types.Hash32, error)

GetProof mocks base method.

func (*MockpoetDbAPI) ValidateAndStore added in v1.0.0 

func (m *MockpoetDbAPI) ValidateAndStore(ctx context.Context, proofMessage *types.PoetProofMessage) error

ValidateAndStore mocks base method.

type MockpoetDbAPIMockRecorder added in v1.0.0 

type MockpoetDbAPIMockRecorder struct {
	// contains filtered or unexported fields
}

MockpoetDbAPIMockRecorder is the mock recorder for MockpoetDbAPI.

func (*MockpoetDbAPIMockRecorder) GetProof added in v1.0.0 

func (mr *MockpoetDbAPIMockRecorder) GetProof(arg0 any) *poetDbAPIGetProofCall

GetProof indicates an expected call of GetProof.

func (*MockpoetDbAPIMockRecorder) ValidateAndStore added in v1.0.0 

func (mr *MockpoetDbAPIMockRecorder) ValidateAndStore(ctx, proofMessage any) *poetDbAPIValidateAndStoreCall

ValidateAndStore indicates an expected call of ValidateAndStore.

type MockpostService added in v1.3.0 

type MockpostService struct {
	// contains filtered or unexported fields
}

MockpostService is a mock of postService interface.

func NewMockpostService added in v1.3.0 

func NewMockpostService(ctrl *gomock.Controller) *MockpostService

NewMockpostService creates a new mock instance.

func (*MockpostService) Client added in v1.3.0 

func (m *MockpostService) Client(nodeId types.NodeID) (PostClient, error)

Client mocks base method.

func (*MockpostService) EXPECT added in v1.3.0 

func (m *MockpostService) EXPECT() *MockpostServiceMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

type MockpostServiceMockRecorder added in v1.3.0 

type MockpostServiceMockRecorder struct {
	// contains filtered or unexported fields
}

MockpostServiceMockRecorder is the mock recorder for MockpostService.

func (*MockpostServiceMockRecorder) Client added in v1.3.0 

func (mr *MockpostServiceMockRecorder) Client(nodeId any) *postServiceClientCall

Client indicates an expected call of Client.

type MockpostSetupProvider added in v1.0.0 

type MockpostSetupProvider struct {
	// contains filtered or unexported fields
}

MockpostSetupProvider is a mock of postSetupProvider interface.

func NewMockpostSetupProvider added in v1.0.0 

func NewMockpostSetupProvider(ctrl *gomock.Controller) *MockpostSetupProvider

NewMockpostSetupProvider creates a new mock instance.

func (*MockpostSetupProvider) EXPECT added in v1.0.0 

func (m *MockpostSetupProvider) EXPECT() *MockpostSetupProviderMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockpostSetupProvider) PrepareInitializer added in v1.0.0 

func (m *MockpostSetupProvider) PrepareInitializer(opts PostSetupOpts) error

PrepareInitializer mocks base method.

func (*MockpostSetupProvider) Reset added in v1.0.0 

func (m *MockpostSetupProvider) Reset() error

Reset mocks base method.

func (*MockpostSetupProvider) StartSession added in v1.0.0 

func (m *MockpostSetupProvider) StartSession(context context.Context) error

StartSession mocks base method.

func (*MockpostSetupProvider) Status added in v1.0.0 

func (m *MockpostSetupProvider) Status() *PostSetupStatus

Status mocks base method.

type MockpostSetupProviderMockRecorder added in v1.0.0 

type MockpostSetupProviderMockRecorder struct {
	// contains filtered or unexported fields
}

MockpostSetupProviderMockRecorder is the mock recorder for MockpostSetupProvider.

func (*MockpostSetupProviderMockRecorder) PrepareInitializer added in v1.0.0 

func (mr *MockpostSetupProviderMockRecorder) PrepareInitializer(opts any) *postSetupProviderPrepareInitializerCall

PrepareInitializer indicates an expected call of PrepareInitializer.

func (*MockpostSetupProviderMockRecorder) Reset added in v1.0.0 

func (mr *MockpostSetupProviderMockRecorder) Reset() *postSetupProviderResetCall

Reset indicates an expected call of Reset.

func (*MockpostSetupProviderMockRecorder) StartSession added in v1.0.0 

func (mr *MockpostSetupProviderMockRecorder) StartSession(context any) *postSetupProviderStartSessionCall

StartSession indicates an expected call of StartSession.

func (*MockpostSetupProviderMockRecorder) Status added in v1.0.0 

func (mr *MockpostSetupProviderMockRecorder) Status() *postSetupProviderStatusCall

Status indicates an expected call of Status.

type Mockscaler added in v1.2.12 

type Mockscaler struct {
	// contains filtered or unexported fields
}

Mockscaler is a mock of scaler interface.

func NewMockscaler added in v1.2.12 

func NewMockscaler(ctrl *gomock.Controller) *Mockscaler

NewMockscaler creates a new mock instance.

func (*Mockscaler) EXPECT added in v1.2.12 

func (m *Mockscaler) EXPECT() *MockscalerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

type MockscalerMockRecorder added in v1.2.12 

type MockscalerMockRecorder struct {
	// contains filtered or unexported fields
}

MockscalerMockRecorder is the mock recorder for Mockscaler.

type Mocksyncer added in v1.0.0 

type Mocksyncer struct {
	// contains filtered or unexported fields
}

Mocksyncer is a mock of syncer interface.

func NewMocksyncer added in v1.0.0 

func NewMocksyncer(ctrl *gomock.Controller) *Mocksyncer

NewMocksyncer creates a new mock instance.

func (*Mocksyncer) EXPECT added in v1.0.0 

func (m *Mocksyncer) EXPECT() *MocksyncerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*Mocksyncer) RegisterForATXSynced added in v1.0.0 

func (m *Mocksyncer) RegisterForATXSynced() <-chan struct{}

RegisterForATXSynced mocks base method.

type MocksyncerMockRecorder added in v1.0.0 

type MocksyncerMockRecorder struct {
	// contains filtered or unexported fields
}

MocksyncerMockRecorder is the mock recorder for Mocksyncer.

func (*MocksyncerMockRecorder) RegisterForATXSynced added in v1.0.0 

func (mr *MocksyncerMockRecorder) RegisterForATXSynced() *syncerRegisterForATXSyncedCall

RegisterForATXSynced indicates an expected call of RegisterForATXSynced.

type NIPostBuilder added in v1.0.0 

type NIPostBuilder struct {
	// contains filtered or unexported fields
}

NIPostBuilder holds the required state and dependencies to create Non-Interactive Proofs of Space-Time (NIPost).

func NewNIPostBuilder added in v1.0.0 

func NewNIPostBuilder(
	poetDB poetDbAPI,
	postService postService,
	poetServers []string,
	dataDir string,
	lg *zap.Logger,
	signer *signing.EdSigner,
	poetCfg PoetConfig,
	layerClock layerClock,
	opts ...NIPostBuilderOption,
) (*NIPostBuilder, error)

NewNIPostBuilder returns a NIPostBuilder.

func (*NIPostBuilder) BuildNIPost added in v1.0.0 

func (nb *NIPostBuilder) BuildNIPost(ctx context.Context, challenge *types.NIPostChallenge) (*types.NIPost, error)

BuildNIPost uses the given challenge to build a NIPost. The process can take considerable time, because it includes waiting for the poet service to publish a proof - a process that takes about an epoch.

func (*NIPostBuilder) DataDir added in v1.0.0 

func (nb *NIPostBuilder) DataDir() string

func (*NIPostBuilder) UpdatePoETProvers added in v1.0.0 

func (nb *NIPostBuilder) UpdatePoETProvers(poetProvers []poetClient)

UpdatePoETProvers updates poetProver reference. It should not be executed concurrently with BuildNIPoST.

type NIPostBuilderOption added in v1.0.3 

type NIPostBuilderOption func(*NIPostBuilder)

type OffloadingPostVerifier added in v1.0.0 

type OffloadingPostVerifier struct {
	// contains filtered or unexported fields
}

func NewOffloadingPostVerifier added in v1.0.0 

func NewOffloadingPostVerifier(verifier PostVerifier, numWorkers int, logger *zap.Logger) *OffloadingPostVerifier

NewOffloadingPostVerifier creates a new post proof verifier with the given number of workers. The verifier will distribute incoming proofs between the workers. It will block if all workers are busy.

SAFETY: The `verifier` must be safe to use concurrently.

The verifier must be closed after use with Close().

func (*OffloadingPostVerifier) Autoscale added in v1.2.12 

func (v *OffloadingPostVerifier) Autoscale(min, target int)

Turn on automatic scaling of the number of workers. The number of workers will be scaled between `min` and `target` (inclusive).

func (*OffloadingPostVerifier) Close added in v1.0.0 

func (v *OffloadingPostVerifier) Close() error

func (*OffloadingPostVerifier) Verify added in v1.0.0 

func (v *OffloadingPostVerifier) Verify(
	ctx context.Context,
	p *shared.Proof,
	m *shared.ProofMetadata,
	opts ...verifying.OptionFunc,
) error

type PoetClientOpts added in v1.0.0 

type PoetClientOpts func(*HTTPPoetClient)

func WithLogger added in v1.1.5 

func WithLogger(logger *zap.Logger) PoetClientOpts

type PoetConfig added in v1.0.0 

type PoetConfig struct {
	PhaseShift        time.Duration `mapstructure:"phase-shift"`
	CycleGap          time.Duration `mapstructure:"cycle-gap"`
	GracePeriod       time.Duration `mapstructure:"grace-period"`
	RequestTimeout    time.Duration `mapstructure:"poet-request-timeout"`
	RequestRetryDelay time.Duration `mapstructure:"retry-delay"`
	MaxRequestRetries int           `mapstructure:"retry-max"`
}

PoetConfig is the configuration to interact with the poet server.

func DefaultPoetConfig added in v1.0.0 

func DefaultPoetConfig() PoetConfig

type PoetDb 

type PoetDb struct {
	// contains filtered or unexported fields
}

PoetDb is a database for PoET proofs.

func NewPoetDb 

func NewPoetDb(db *sql.Database, log log.Log) *PoetDb

NewPoetDb returns a new PoET handler.

func (*PoetDb) GetProof added in v1.0.0 

func (db *PoetDb) GetProof(proofRef types.PoetProofRef) (*types.PoetProof, *types.Hash32, error)

GetProof returns full proof.

func (*PoetDb) GetProofMessage 

func (db *PoetDb) GetProofMessage(proofRef types.PoetProofRef) ([]byte, error)

GetProofMessage returns the originally received PoET proof message.

func (*PoetDb) GetProofRef added in v1.0.0 

func (db *PoetDb) GetProofRef(poetID []byte, roundID string) (types.PoetProofRef, error)

func (*PoetDb) HasProof 

func (db *PoetDb) HasProof(proofRef types.PoetProofRef) bool

HasProof returns true if the database contains a proof with the given reference, or false otherwise.

func (*PoetDb) StoreProof added in v1.0.0 

func (db *PoetDb) StoreProof(ctx context.Context, ref types.PoetProofRef, proofMessage *types.PoetProofMessage) error

StoreProof saves the poet proof in local db.

func (*PoetDb) Validate 

func (db *PoetDb) Validate(
	root []byte,
	proof types.PoetProof,
	poetID []byte,
	roundID string,
	signature types.EdSignature,
) error

Validate validates a new PoET proof.

func (*PoetDb) ValidateAndStore 

func (db *PoetDb) ValidateAndStore(ctx context.Context, proofMessage *types.PoetProofMessage) error

ValidateAndStore validates and stores a new PoET proof.

func (*PoetDb) ValidateAndStoreMsg added in v0.1.16 

func (db *PoetDb) ValidateAndStoreMsg(ctx context.Context, expHash types.Hash32, _ p2p.Peer, data []byte) error

ValidateAndStoreMsg validates and stores a new PoET proof.

type PoetPoW added in v1.0.0 

type PoetPoW struct {
	Nonce  uint64
	Params PoetPowParams
}

type PoetPowParams added in v1.0.0 

type PoetPowParams struct {
	Challenge  []byte
	Difficulty uint
}

type PoetSvcUnstableError added in v1.0.0 

type PoetSvcUnstableError struct {
	// contains filtered or unexported fields
}

PoetSvcUnstableError means there was a problem communicating with a Poet service. It wraps the source error.

func (*PoetSvcUnstableError) Error added in v1.0.0 

func (e *PoetSvcUnstableError) Error() string

func (*PoetSvcUnstableError) Is added in v1.0.0 

func (e *PoetSvcUnstableError) Is(target error) bool

func (*PoetSvcUnstableError) Unwrap added in v1.0.0 

func (e *PoetSvcUnstableError) Unwrap() error

type PostClient 

type PostClient interface {
	Info(ctx context.Context) (*types.PostInfo, error)
	Proof(ctx context.Context, challenge []byte) (*types.Post, *types.PostInfo, error)
}

type PostClientInfoCall added in v1.3.0 

type PostClientInfoCall struct {
	*gomock.Call
}

PostClientInfoCall wrap *gomock.Call

func (*PostClientInfoCall) Do added in v1.3.0 

func (c *PostClientInfoCall) Do(f func(context.Context) (*types.PostInfo, error)) *PostClientInfoCall

Do rewrite *gomock.Call.Do

func (*PostClientInfoCall) DoAndReturn added in v1.3.0 

func (c *PostClientInfoCall) DoAndReturn(f func(context.Context) (*types.PostInfo, error)) *PostClientInfoCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*PostClientInfoCall) Return added in v1.3.0 

func (c *PostClientInfoCall) Return(arg0 *types.PostInfo, arg1 error) *PostClientInfoCall

Return rewrite *gomock.Call.Return

type PostClientProofCall added in v1.3.0 

type PostClientProofCall struct {
	*gomock.Call
}

PostClientProofCall wrap *gomock.Call

func (*PostClientProofCall) Do added in v1.3.0 

func (c *PostClientProofCall) Do(f func(context.Context, []byte) (*types.Post, *types.PostInfo, error)) *PostClientProofCall

Do rewrite *gomock.Call.Do

func (*PostClientProofCall) DoAndReturn added in v1.3.0 

func (c *PostClientProofCall) DoAndReturn(f func(context.Context, []byte) (*types.Post, *types.PostInfo, error)) *PostClientProofCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*PostClientProofCall) Return added in v1.3.0 

func (c *PostClientProofCall) Return(arg0 *types.Post, arg1 *types.PostInfo, arg2 error) *PostClientProofCall

Return rewrite *gomock.Call.Return

type PostConfig added in v1.0.0 

type PostConfig struct {
	MinNumUnits   uint32        `mapstructure:"post-min-numunits"`
	MaxNumUnits   uint32        `mapstructure:"post-max-numunits"`
	LabelsPerUnit uint64        `mapstructure:"post-labels-per-unit"`
	K1            uint32        `mapstructure:"post-k1"`
	K2            uint32        `mapstructure:"post-k2"`
	K3            uint32        `mapstructure:"post-k3"`
	PowDifficulty PowDifficulty `mapstructure:"post-pow-difficulty"`
}

PostConfig is the configuration of the Post protocol, used for data creation, proofs generation and validation.

func DefaultPostConfig added in v1.0.0 

func DefaultPostConfig() PostConfig

DefaultPostConfig defines the default configuration for Post.

func (PostConfig) ToConfig added in v1.0.0 

func (c PostConfig) ToConfig() config.Config

type PostPowFlags added in v1.3.0 

type PostPowFlags config.PowFlags

func (*PostPowFlags) Set added in v1.3.0 

func (f *PostPowFlags) Set(value string) error

Set implements pflag.Value.Set.

func (PostPowFlags) String added in v1.3.0 

func (f PostPowFlags) String() string

String implements pflag.Value.String.

func (PostPowFlags) Type added in v1.3.0 

func (PostPowFlags) Type() string

Type implements pflag.Value.Type.

func (*PostPowFlags) Value added in v1.3.0 

func (f *PostPowFlags) Value() config.PowFlags

type PostProofVerifyingOpts added in v1.0.0 

type PostProofVerifyingOpts struct {
	// Number of workers spawned to verify proofs.
	Workers int `mapstructure:"smeshing-opts-verifying-workers"`
	// The minimum number of verifying workers to keep
	// while POST is being generated in parallel.
	MinWorkers int `mapstructure:"smeshing-opts-verifying-min-workers"`
	// Flags used for the PoW verification.
	Flags PostPowFlags `mapstructure:"smeshing-opts-verifying-powflags"`
}

PostProvingOpts are the options controlling POST proving process.

func DefaultPostVerifyingOpts added in v1.0.0 

func DefaultPostVerifyingOpts() PostProofVerifyingOpts

type PostProviderID added in v1.1.0 

type PostProviderID struct {
	// contains filtered or unexported fields
}

func (*PostProviderID) Set added in v1.1.0 

func (id *PostProviderID) Set(value string) error

Set implements pflag.Value.Set.

func (*PostProviderID) SetUint32 added in v1.3.0 

func (id *PostProviderID) SetUint32(value uint32)

SetInt64 sets the value of the PostProviderID to the given int64.

func (PostProviderID) String added in v1.1.0 

func (id PostProviderID) String() string

String implements pflag.Value.String.

func (PostProviderID) Type added in v1.1.0 

func (PostProviderID) Type() string

Type implements pflag.Value.Type.

func (*PostProviderID) Value added in v1.1.0 

func (id *PostProviderID) Value() *uint32

Value returns the value of the PostProviderID as a pointer to uint32.

type PostProvingOpts added in v1.0.0 

type PostProvingOpts struct {
	// Number of threads used in POST proving process.
	Threads uint `mapstructure:"smeshing-opts-proving-threads"`

	// Number of nonces tried in parallel in POST proving process.
	Nonces uint `mapstructure:"smeshing-opts-proving-nonces"`

	// RandomXMode is the mode used for RandomX computations.
	RandomXMode PostRandomXMode `mapstructure:"smeshing-opts-proving-randomx-mode"`
}

PostProvingOpts are the options controlling POST proving process.

func DefaultPostProvingOpts added in v1.0.0 

func DefaultPostProvingOpts() PostProvingOpts

type PostRandomXMode added in v1.3.0 

type PostRandomXMode string
const (
	PostRandomXModeFast  PostRandomXMode = "fast"
	PostRandomXModeLight PostRandomXMode = "light"
)

func (*PostRandomXMode) Set added in v1.3.0 

func (m *PostRandomXMode) Set(value string) error

Set implements pflag.Value.Set.

func (PostRandomXMode) String added in v1.3.0 

func (m PostRandomXMode) String() string

String implements pflag.Value.String.

func (PostRandomXMode) Type added in v1.3.0 

func (PostRandomXMode) Type() string

Type implements pflag.Value.Type.

type PostSetupManager added in v1.0.0 

type PostSetupManager struct {
	// contains filtered or unexported fields
}

PostSetupManager implements the PostProvider interface.

func NewPostSetupManager added in v1.0.0 

func NewPostSetupManager(
	id types.NodeID,
	cfg PostConfig,
	logger *zap.Logger,
	db *datastore.CachedDB,
	goldenATXID types.ATXID,
) (*PostSetupManager, error)

NewPostSetupManager creates a new instance of PostSetupManager.

func (*PostSetupManager) PrepareInitializer added in v1.0.0 

func (mgr *PostSetupManager) PrepareInitializer(opts PostSetupOpts) error

PrepareInitializer prepares the initializer to begin the initialization process, it needs to be called before each call to StartSession. Having this function be separate from StartSession provides a means to understand if the post configuration is valid before kicking off a very long running task (StartSession can take days to complete). After the first call to this method subsequent calls to this method will return an error until StartSession has completed execution.

func (*PostSetupManager) Reset added in v1.0.0 

func (mgr *PostSetupManager) Reset() error

Reset deletes the data file(s).

func (*PostSetupManager) StartSession added in v1.0.0 

func (mgr *PostSetupManager) StartSession(ctx context.Context) error

StartSession starts (or continues) a PoST session. It supports resuming a previously started session, and will return an error if a session is already in progress. It must be ensured that PrepareInitializer is called once before each call to StartSession and that the node is ATX synced.

func (*PostSetupManager) Status added in v1.0.0 

func (mgr *PostSetupManager) Status() *PostSetupStatus

Status returns the setup current status.

type PostSetupOpts added in v1.0.0 

type PostSetupOpts struct {
	DataDir          string              `mapstructure:"smeshing-opts-datadir"`
	NumUnits         uint32              `mapstructure:"smeshing-opts-numunits"`
	MaxFileSize      uint64              `mapstructure:"smeshing-opts-maxfilesize"`
	ProviderID       PostProviderID      `mapstructure:"smeshing-opts-provider"`
	Throttle         bool                `mapstructure:"smeshing-opts-throttle"`
	Scrypt           config.ScryptParams `mapstructure:"smeshing-opts-scrypt"`
	ComputeBatchSize uint64              `mapstructure:"smeshing-opts-compute-batch-size"`
}

PostSetupOpts are the options used to initiate a Post setup data creation session, either via the public smesher API, or on node launch (via cmd args).

func DefaultPostSetupOpts added in v1.0.0 

func DefaultPostSetupOpts() PostSetupOpts

DefaultPostSetupOpts defines the default options for Post setup.

func (PostSetupOpts) ToInitOpts added in v1.0.3 

func (o PostSetupOpts) ToInitOpts() config.InitOpts

type PostSetupProvider added in v1.0.0 

type PostSetupProvider initialization.Provider

PostSetupProvider represent a compute provider for Post setup data creation.

type PostSetupState added in v1.0.0 

type PostSetupState int32
const (
	PostSetupStateNotStarted PostSetupState = 1 + iota
	PostSetupStatePrepared
	PostSetupStateInProgress
	PostSetupStateStopped
	PostSetupStateComplete
	PostSetupStateError
)

type PostSetupStatus added in v1.0.0 

type PostSetupStatus struct {
	State            PostSetupState
	NumLabelsWritten uint64
	LastOpts         *PostSetupOpts
}

PostSetupStatus represents a status snapshot of the Post setup.

type PostSupervisor added in v1.3.0 

type PostSupervisor struct {
	// contains filtered or unexported fields
}

PostSupervisor manages a local post service.

func NewPostSupervisor added in v1.3.0 

func NewPostSupervisor(
	logger *zap.Logger,
	cmdCfg PostSupervisorConfig,
	postCfg PostConfig,
	provingOpts PostProvingOpts,
	postSetupProvider postSetupProvider,
	syncer syncer,
) (*PostSupervisor, error)

NewPostSupervisor returns a new post service.

func (*PostSupervisor) Benchmark added in v1.3.0 

func (*PostSupervisor) Benchmark(p PostSetupProvider) (int, error)

Benchmark runs a short benchmarking session for a given provider to evaluate its performance.

func (*PostSupervisor) Config added in v1.3.0 

func (ps *PostSupervisor) Config() PostConfig

func (*PostSupervisor) Providers added in v1.3.0 

func (*PostSupervisor) Providers() ([]PostSetupProvider, error)

Providers returns a list of available compute providers for Post setup.

func (*PostSupervisor) Start added in v1.3.0 

func (ps *PostSupervisor) Start(opts PostSetupOpts) error

func (*PostSupervisor) Status added in v1.3.0 

func (ps *PostSupervisor) Status() *PostSetupStatus

func (*PostSupervisor) Stop added in v1.3.0 

func (ps *PostSupervisor) Stop(deleteFiles bool) error

Stop stops the post service.

type PostSupervisorConfig added in v1.3.0 

type PostSupervisorConfig struct {
	PostServiceCmd string
	NodeAddress    string
	MaxRetries     int

	CACert string
	Cert   string
	Key    string
}

func DefaultPostServiceConfig added in v1.3.0 

func DefaultPostServiceConfig() PostSupervisorConfig

DefaultPostServiceConfig returns the default config for post service.

func DefaultTestPostServiceConfig added in v1.3.0 

func DefaultTestPostServiceConfig() PostSupervisorConfig

DefaultTestPostServiceConfig returns the default config for post service in tests.

type PostVerifier added in v1.0.0 

type PostVerifier interface {
	io.Closer
	Verify(ctx context.Context, p *shared.Proof, m *shared.ProofMetadata, opts ...verifying.OptionFunc) error
}

func NewPostVerifier added in v1.0.0 

func NewPostVerifier(cfg PostConfig, logger *zap.Logger, opts ...verifying.OptionFunc) (PostVerifier, error)

NewPostVerifier creates a new post verifier.

type PostVerifierCloseCall added in v1.1.5 

type PostVerifierCloseCall struct {
	*gomock.Call
}

PostVerifierCloseCall wrap *gomock.Call

func (*PostVerifierCloseCall) Do added in v1.1.5 

func (c *PostVerifierCloseCall) Do(f func() error) *PostVerifierCloseCall

Do rewrite *gomock.Call.Do

func (*PostVerifierCloseCall) DoAndReturn added in v1.1.5 

func (c *PostVerifierCloseCall) DoAndReturn(f func() error) *PostVerifierCloseCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*PostVerifierCloseCall) Return added in v1.1.5 

func (c *PostVerifierCloseCall) Return(arg0 error) *PostVerifierCloseCall

Return rewrite *gomock.Call.Return

type PostVerifierVerifyCall added in v1.1.5 

type PostVerifierVerifyCall struct {
	*gomock.Call
}

PostVerifierVerifyCall wrap *gomock.Call

func (*PostVerifierVerifyCall) Do added in v1.1.5 

func (c *PostVerifierVerifyCall) Do(f func(context.Context, *shared.Proof, *shared.ProofMetadata, ...verifying.OptionFunc) error) *PostVerifierVerifyCall

Do rewrite *gomock.Call.Do

func (*PostVerifierVerifyCall) DoAndReturn added in v1.1.5 

func (c *PostVerifierVerifyCall) DoAndReturn(f func(context.Context, *shared.Proof, *shared.ProofMetadata, ...verifying.OptionFunc) error) *PostVerifierVerifyCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*PostVerifierVerifyCall) Return added in v1.1.5 

func (c *PostVerifierVerifyCall) Return(arg0 error) *PostVerifierVerifyCall

Return rewrite *gomock.Call.Return

type PowDifficulty added in v1.0.0 

type PowDifficulty [32]byte

func (*PowDifficulty) Set added in v1.0.0 

func (f *PowDifficulty) Set(value string) error

Set implements pflag.Value.Set.

func (PowDifficulty) String added in v1.0.0 

func (d PowDifficulty) String() string

func (PowDifficulty) Type added in v1.0.0 

func (PowDifficulty) Type() string

Type implements pflag.Value.Type.

func (*PowDifficulty) UnmarshalText added in v1.0.0 

func (d *PowDifficulty) UnmarshalText(text []byte) error

type SmeshingProvider added in v1.0.0 

type SmeshingProvider interface {
	Smeshing() bool
	StartSmeshing(types.Address) error
	StopSmeshing(bool) error
	SmesherID() types.NodeID
	Coinbase() types.Address
	SetCoinbase(coinbase types.Address)
}

SmeshingProvider defines the functionality required for the node's Smesher API.

type SmeshingProviderCoinbaseCall added in v1.1.5 

type SmeshingProviderCoinbaseCall struct {
	*gomock.Call
}

SmeshingProviderCoinbaseCall wrap *gomock.Call

func (*SmeshingProviderCoinbaseCall) Do added in v1.1.5 

func (c *SmeshingProviderCoinbaseCall) Do(f func() types.Address) *SmeshingProviderCoinbaseCall

Do rewrite *gomock.Call.Do

func (*SmeshingProviderCoinbaseCall) DoAndReturn added in v1.1.5 

func (c *SmeshingProviderCoinbaseCall) DoAndReturn(f func() types.Address) *SmeshingProviderCoinbaseCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*SmeshingProviderCoinbaseCall) Return added in v1.1.5 

func (c *SmeshingProviderCoinbaseCall) Return(arg0 types.Address) *SmeshingProviderCoinbaseCall

Return rewrite *gomock.Call.Return

type SmeshingProviderSetCoinbaseCall added in v1.1.5 

type SmeshingProviderSetCoinbaseCall struct {
	*gomock.Call
}

SmeshingProviderSetCoinbaseCall wrap *gomock.Call

func (*SmeshingProviderSetCoinbaseCall) Do added in v1.1.5 

func (c *SmeshingProviderSetCoinbaseCall) Do(f func(types.Address)) *SmeshingProviderSetCoinbaseCall

Do rewrite *gomock.Call.Do

func (*SmeshingProviderSetCoinbaseCall) DoAndReturn added in v1.1.5 

func (c *SmeshingProviderSetCoinbaseCall) DoAndReturn(f func(types.Address)) *SmeshingProviderSetCoinbaseCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*SmeshingProviderSetCoinbaseCall) Return added in v1.1.5 

func (c *SmeshingProviderSetCoinbaseCall) Return() *SmeshingProviderSetCoinbaseCall

Return rewrite *gomock.Call.Return

type SmeshingProviderSmesherIDCall added in v1.1.5 

type SmeshingProviderSmesherIDCall struct {
	*gomock.Call
}

SmeshingProviderSmesherIDCall wrap *gomock.Call

func (*SmeshingProviderSmesherIDCall) Do added in v1.1.5 

func (c *SmeshingProviderSmesherIDCall) Do(f func() types.NodeID) *SmeshingProviderSmesherIDCall

Do rewrite *gomock.Call.Do

func (*SmeshingProviderSmesherIDCall) DoAndReturn added in v1.1.5 

func (c *SmeshingProviderSmesherIDCall) DoAndReturn(f func() types.NodeID) *SmeshingProviderSmesherIDCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*SmeshingProviderSmesherIDCall) Return added in v1.1.5 

func (c *SmeshingProviderSmesherIDCall) Return(arg0 types.NodeID) *SmeshingProviderSmesherIDCall

Return rewrite *gomock.Call.Return

type SmeshingProviderSmeshingCall added in v1.1.5 

type SmeshingProviderSmeshingCall struct {
	*gomock.Call
}

SmeshingProviderSmeshingCall wrap *gomock.Call

func (*SmeshingProviderSmeshingCall) Do added in v1.1.5 

func (c *SmeshingProviderSmeshingCall) Do(f func() bool) *SmeshingProviderSmeshingCall

Do rewrite *gomock.Call.Do

func (*SmeshingProviderSmeshingCall) DoAndReturn added in v1.1.5 

func (c *SmeshingProviderSmeshingCall) DoAndReturn(f func() bool) *SmeshingProviderSmeshingCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*SmeshingProviderSmeshingCall) Return added in v1.1.5 

func (c *SmeshingProviderSmeshingCall) Return(arg0 bool) *SmeshingProviderSmeshingCall

Return rewrite *gomock.Call.Return

type SmeshingProviderStartSmeshingCall added in v1.1.5 

type SmeshingProviderStartSmeshingCall struct {
	*gomock.Call
}

SmeshingProviderStartSmeshingCall wrap *gomock.Call

func (*SmeshingProviderStartSmeshingCall) Do added in v1.1.5 

func (c *SmeshingProviderStartSmeshingCall) Do(f func(types.Address) error) *SmeshingProviderStartSmeshingCall

Do rewrite *gomock.Call.Do

func (*SmeshingProviderStartSmeshingCall) DoAndReturn added in v1.1.5 

func (c *SmeshingProviderStartSmeshingCall) DoAndReturn(f func(types.Address) error) *SmeshingProviderStartSmeshingCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*SmeshingProviderStartSmeshingCall) Return added in v1.1.5 

func (c *SmeshingProviderStartSmeshingCall) Return(arg0 error) *SmeshingProviderStartSmeshingCall

Return rewrite *gomock.Call.Return

type SmeshingProviderStopSmeshingCall added in v1.1.5 

type SmeshingProviderStopSmeshingCall struct {
	*gomock.Call
}

SmeshingProviderStopSmeshingCall wrap *gomock.Call

func (*SmeshingProviderStopSmeshingCall) Do added in v1.1.5 

func (c *SmeshingProviderStopSmeshingCall) Do(f func(bool) error) *SmeshingProviderStopSmeshingCall

Do rewrite *gomock.Call.Do

func (*SmeshingProviderStopSmeshingCall) DoAndReturn added in v1.1.5 

func (c *SmeshingProviderStopSmeshingCall) DoAndReturn(f func(bool) error) *SmeshingProviderStopSmeshingCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*SmeshingProviderStopSmeshingCall) Return added in v1.1.5 

func (c *SmeshingProviderStopSmeshingCall) Return(arg0 error) *SmeshingProviderStopSmeshingCall

Return rewrite *gomock.Call.Return

type Validator 

type Validator struct {
	// contains filtered or unexported fields
}

Validator contains the dependencies required to validate NIPosts.

func NewValidator 

func NewValidator(poetDb poetDbAPI, cfg PostConfig, scrypt config.ScryptParams, postVerifier PostVerifier) *Validator

NewValidator returns a new NIPost validator.

func (*Validator) InitialNIPostChallenge added in v1.0.0 

func (v *Validator) InitialNIPostChallenge(
	challenge *types.NIPostChallenge,
	atxs atxProvider,
	goldenATXID types.ATXID,
) error

func (*Validator) NIPost added in v1.0.0 

func (v *Validator) NIPost(
	ctx context.Context,
	nodeId types.NodeID,
	commitmentAtxId types.ATXID,
	nipost *types.NIPost,
	expectedChallenge types.Hash32,
	numUnits uint32,
) (uint64, error)

NIPost validates a NIPost, given a node id and expected challenge. It returns an error if the NIPost is invalid.

Some of the Post metadata fields validation values is ought to eventually be derived from consensus instead of local configuration. If so, their validation should be removed to contextual validation, while still syntactically-validate them here according to locally configured min/max values.

func (*Validator) NIPostChallenge added in v1.0.0 

func (*Validator) NIPostChallenge(challenge *types.NIPostChallenge, atxs atxProvider, nodeID types.NodeID) error

func (*Validator) NumUnits added in v1.0.0 

func (*Validator) NumUnits(cfg *PostConfig, numUnits uint32) error

func (*Validator) PositioningAtx added in v1.0.0 

func (v *Validator) PositioningAtx(
	id types.ATXID,
	atxs atxProvider,
	goldenATXID types.ATXID,
	pubepoch types.EpochID,
) error

func (*Validator) Post added in v1.0.0 

func (v *Validator) Post(
	ctx context.Context,
	nodeId types.NodeID,
	commitmentAtxId types.ATXID,
	PoST *types.Post,
	PostMetadata *types.PostMetadata,
	numUnits uint32,
) error

Post validates a Proof of Space-Time (PoST). It returns nil if validation passed or an error indicating why validation failed.

func (*Validator) PostMetadata added in v1.0.0 

func (*Validator) PostMetadata(cfg *PostConfig, metadata *types.PostMetadata) error

func (*Validator) VRFNonce added in v1.0.0 

func (v *Validator) VRFNonce(
	nodeId types.NodeID,
	commitmentAtxId types.ATXID,
	vrfNonce *types.VRFPostIndex,
	PostMetadata *types.PostMetadata,
	numUnits uint32,
) error

Source Files

View all Source files

Directories

Path Synopsis

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.