registry

Documentation

Index

• Constants
• Variables
• func MakeChainRecordDbKey(chainID *isc.ChainID) []byte
• type AuxChainRecord
• type ChainRecord
  • func ChainRecordFromBytes(data []byte) (*ChainRecord, error)
  • func FromMarshalUtil(mu *marshalutil.MarshalUtil) (*ChainRecord, error)
  • func (rec *ChainRecord) Bytes() []byte
  • func (rec *ChainRecord) String() string
• type ChainRecordRegistryProvider
• type Config
  • func DefaultConfig() *Config
• type DKShareRegistryProvider
• type Impl
  • func NewRegistry(log *logger.Logger, store kvstore.KVStore) *Impl
  • func (r *Impl) ActivateChainRecord(chainID *isc.ChainID) (*ChainRecord, error)
  • func (r *Impl) DeactivateChainRecord(chainID *isc.ChainID) (*ChainRecord, error)
  • func (r *Impl) DistrustPeer(pubKey *cryptolib.PublicKey) (*peering.TrustedPeer, error)
  • func (r *Impl) GetBlob(h hashing.HashValue) ([]byte, bool, error)
  • func (r *Impl) GetChainRecordByChainID(chainID *isc.ChainID) (*ChainRecord, error)
  • func (r *Impl) GetChainRecords() ([]*ChainRecord, error)
  • func (r *Impl) GetNodeIdentity() *cryptolib.KeyPair
  • func (r *Impl) GetNodePublicKey() *cryptolib.PublicKey
  • func (r *Impl) HasBlob(h hashing.HashValue) (bool, error)
  • func (r *Impl) IsTrustedPeer(pubKey *cryptolib.PublicKey) error
  • func (r *Impl) LoadConsensusJournal(id journal.ID) (journal.LogIndex, journal.LocalView, error)
  • func (r *Impl) LoadDKShare(sharedAddress iotago.Address) (tcrypto.DKShare, error)
  • func (r *Impl) PutBlob(data []byte, ttl ...time.Duration) (hashing.HashValue, error)
  • func (r *Impl) SaveChainRecord(rec *ChainRecord) error
  • func (r *Impl) SaveConsensusJournalLocalView(id journal.ID, localView journal.LocalView) error
  • func (r *Impl) SaveConsensusJournalLogIndex(id journal.ID, logIndex journal.LogIndex) error
  • func (r *Impl) SaveDKShare(dkShare tcrypto.DKShare) error
  • func (r *Impl) TrustPeer(pubKey *cryptolib.PublicKey, netID string) (*peering.TrustedPeer, error)
  • func (r *Impl) TrustedPeers() ([]*peering.TrustedPeer, error)
  • func (r *Impl) UpdateChainRecord(chainID *isc.ChainID, f func(*ChainRecord) bool) (*ChainRecord, error)
• type NodeIdentityProvider
• type Provider
• type Registry
  • func NewTextRegistry(log *logger.Logger, filename string) Registry

Constants

const BlobCacheDefaultTTL = 1 * time.Hour

Variables

var ErrDKShareNotFound = errors.New("dkShare not found")

Functions

func MakeChainRecordDbKey

func MakeChainRecordDbKey(chainID *isc.ChainID) []byte

Types

type AuxChainRecord

type AuxChainRecord struct {
	Active  bool
	ChainID string
}

type ChainRecord

type ChainRecord struct {
	ChainID isc.ChainID
	Active  bool
}

ChainRecord represents chain the node is participating in TODO optimize, no need for a persistent structure, simple activity tag is enough

func ChainRecordFromBytes

func ChainRecordFromBytes(data []byte) (*ChainRecord, error)

CommitteeRecordFromBytes

func FromMarshalUtil

func FromMarshalUtil(mu *marshalutil.MarshalUtil) (*ChainRecord, error)

func (*ChainRecord) Bytes

func (rec *ChainRecord) Bytes() []byte

func (*ChainRecord) String

func (rec *ChainRecord) String() string

type ChainRecordRegistryProvider

type ChainRecordRegistryProvider interface {
	GetChainRecordByChainID(chainID *isc.ChainID) (*ChainRecord, error)
	GetChainRecords() ([]*ChainRecord, error)
	UpdateChainRecord(chainID *isc.ChainID, f func(*ChainRecord) bool) (*ChainRecord, error)
	ActivateChainRecord(chainID *isc.ChainID) (*ChainRecord, error)
	DeactivateChainRecord(chainID *isc.ChainID) (*ChainRecord, error)
	SaveChainRecord(rec *ChainRecord) error
}

ChainRecordRegistryProvider stands for a partial registry interface, needed for this package.

type Config

type Config struct {
	UseText  bool
	Filename string
}

func DefaultConfig

func DefaultConfig() *Config

type DKShareRegistryProvider

type DKShareRegistryProvider interface {
	SaveDKShare(dkShare tcrypto.DKShare) error
	LoadDKShare(sharedAddress iotago.Address) (tcrypto.DKShare, error)
}

DKShareRegistryProvider stands for a partial registry interface, needed for this package. It should be implemented by registry.impl

type Impl

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

Impl is just a placeholder to implement all interfaces needed by different components. Each of the interfaces are implemented in the corresponding file in this package.

func NewRegistry

func NewRegistry(log *logger.Logger, store kvstore.KVStore) *Impl

New creates new instance of the registry implementation.

func (*Impl) ActivateChainRecord

func (r *Impl) ActivateChainRecord(chainID *isc.ChainID) (*ChainRecord, error)

func (*Impl) DeactivateChainRecord

func (r *Impl) DeactivateChainRecord(chainID *isc.ChainID) (*ChainRecord, error)

func (*Impl) DistrustPeer

func (r *Impl) DistrustPeer(pubKey *cryptolib.PublicKey) (*peering.TrustedPeer, error)

DistrustPeer implements TrustedNetworkManager interface. Get is kind of optional, so we ignore errors related to it.

func (*Impl) GetBlob

func (r *Impl) GetBlob(h hashing.HashValue) ([]byte, bool, error)

Reads data from registry by hash. Returns existence flag

func (*Impl) GetChainRecordByChainID

func (r *Impl) GetChainRecordByChainID(chainID *isc.ChainID) (*ChainRecord, error)

func (*Impl) GetChainRecords

func (r *Impl) GetChainRecords() ([]*ChainRecord, error)

func (*Impl) GetNodeIdentity

func (r *Impl) GetNodeIdentity() *cryptolib.KeyPair

GetNodeIdentity implements NodeIdentityProvider.

func (*Impl) GetNodePublicKey

func (r *Impl) GetNodePublicKey() *cryptolib.PublicKey

GetNodePublicKey implements NodeIdentityProvider.

func (*Impl) HasBlob

func (r *Impl) HasBlob(h hashing.HashValue) (bool, error)

func (*Impl) IsTrustedPeer

func (r *Impl) IsTrustedPeer(pubKey *cryptolib.PublicKey) error

IsTrustedPeer implements TrustedNetworkManager interface.

func (*Impl) LoadConsensusJournal

func (r *Impl) LoadConsensusJournal(id journal.ID) (journal.LogIndex, journal.LocalView, error)

func (*Impl) LoadDKShare

func (r *Impl) LoadDKShare(sharedAddress iotago.Address) (tcrypto.DKShare, error)

LoadDKShare implements dkg.DKShareRegistryProvider.

func (*Impl) PutBlob

func (r *Impl) PutBlob(data []byte, ttl ...time.Duration) (hashing.HashValue, error)

PutBlob Writes data into the registry with the key of its hash Also stores TTL if provided

func (*Impl) SaveChainRecord

func (r *Impl) SaveChainRecord(rec *ChainRecord) error

func (*Impl) SaveConsensusJournalLocalView

func (r *Impl) SaveConsensusJournalLocalView(id journal.ID, localView journal.LocalView) error

func (*Impl) SaveConsensusJournalLogIndex

func (r *Impl) SaveConsensusJournalLogIndex(id journal.ID, logIndex journal.LogIndex) error

func (*Impl) SaveDKShare

func (r *Impl) SaveDKShare(dkShare tcrypto.DKShare) error

SaveDKShare implements dkg.DKShareRegistryProvider.

func (*Impl) TrustPeer

func (r *Impl) TrustPeer(pubKey *cryptolib.PublicKey, netID string) (*peering.TrustedPeer, error)

TrustPeer implements TrustedNetworkManager interface.

func (*Impl) TrustedPeers

func (r *Impl) TrustedPeers() ([]*peering.TrustedPeer, error)

TrustedPeers implements TrustedNetworkManager interface.

func (*Impl) UpdateChainRecord

func (r *Impl) UpdateChainRecord(chainID *isc.ChainID, f func(*ChainRecord) bool) (*ChainRecord, error)

type NodeIdentityProvider

type NodeIdentityProvider interface {
	GetNodeIdentity() *cryptolib.KeyPair
	GetNodePublicKey() *cryptolib.PublicKey
}

type Provider

type Provider func() Registry

type Registry

type Registry interface {
	NodeIdentityProvider
	DKShareRegistryProvider
	ChainRecordRegistryProvider
	journal.Registry
	peering.TrustedNetworkManager
}

func NewTextRegistry

func NewTextRegistry(log *logger.Logger, filename string) Registry