api

Documentation

Index

• type ActivationAPI
• type ConservativeState
• type GenesisTimeAPI
• type LoggingAPI
• type MeshAPI
• type NetworkIdentity
• type PeerCounter
• type PostSetupAPI
• type Publisher
• type SmeshingAPI
• type Syncer

Types

type ActivationAPI

type ActivationAPI interface {
	UpdatePoETServer(context.Context, string) error
}

ActivationAPI is an API for activation module.

type ConservativeState

type ConservativeState interface {
	GetStateRoot() types.Hash32
	GetLayerStateRoot(types.LayerID) (types.Hash32, error)
	GetLayerApplied(types.TransactionID) *types.LayerID
	GetAllAccounts() (*types.MultipleAccountsState, error)
	GetBalance(types.Address) uint64
	GetNonce(types.Address) uint64
	GetProjection(types.Address) (uint64, uint64, error)
	GetMeshTransaction(types.TransactionID) (*types.MeshTransaction, error)
	GetTransactions([]types.TransactionID) ([]*types.Transaction, map[types.TransactionID]struct{})
	GetTransactionsByAddress(types.LayerID, types.LayerID, types.Address) ([]*types.MeshTransaction, error)
}

ConservativeState is an API for reading state and transaction/mempool data.

type GenesisTimeAPI

type GenesisTimeAPI interface {
	GetGenesisTime() time.Time
	GetCurrentLayer() types.LayerID
}

GenesisTimeAPI is an API to get genesis time and current layer of the system.

type LoggingAPI

type LoggingAPI interface {
	SetLogLevel(loggerName, severity string) error
}

LoggingAPI is an API to system loggers.

type MeshAPI

type MeshAPI interface {
	GetATXs(context.Context, []types.ATXID) (map[types.ATXID]*types.ActivationTx, []types.ATXID)
	GetLayer(types.LayerID) (*types.Layer, error)
	GetRewards(types.Address) ([]types.Reward, error)
	LatestLayer() types.LayerID
	LatestLayerInState() types.LayerID
	ProcessedLayer() types.LayerID
	GetRewardsBySmesherID(types.NodeID) ([]types.Reward, error)
}

MeshAPI is an api for getting mesh status about layers/blocks/rewards.

type NetworkIdentity

type NetworkIdentity interface {
	ID() p2p.Peer
}

NetworkIdentity interface.

type PeerCounter

type PeerCounter interface {
	PeerCount() uint64
}

PeerCounter is an api to get amount of connected peers.

type PostSetupAPI

type PostSetupAPI = activation.PostSetupProvider

PostSetupAPI is an alias to PostSetupProvider.

type Publisher

type Publisher = pubsub.Publisher

Publisher interface for publishing messages.

type SmeshingAPI

type SmeshingAPI = activation.SmeshingProvider

SmeshingAPI is an alias to SmeshingProvider.

type Syncer

type Syncer interface {
	IsSynced(context.Context) bool
	Start(context.Context)
}

Syncer is the API to get sync status and to start sync.