registry

Documentation

Overview

Package registry provides a business specific API to the local database.

Index

• Constants
• Variables
• func GetFeeDestination(chainID *iscp.ChainID) ledgerstate.Address
• func InitFlags()
• func MakeChainRecordDbKey(chainID *iscp.ChainID) []byte
• type BlobCache
• 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 DKShareRegistryProvider
• type Impl
  • func NewRegistry(log *logger.Logger, store kvstore.KVStore) *Impl
  • func (r *Impl) ActivateChainRecord(chainID *iscp.ChainID) (*ChainRecord, error)
  • func (r *Impl) DeactivateChainRecord(chainID *iscp.ChainID) (*ChainRecord, error)
  • func (r *Impl) DistrustPeer(pubKey ed25519.PublicKey) (*peering.TrustedPeer, error)
  • func (r *Impl) GetBlob(h hashing.HashValue) ([]byte, bool, error)
  • func (r *Impl) GetChainRecordByChainID(chainID *iscp.ChainID) (*ChainRecord, error)
  • func (r *Impl) GetChainRecords() ([]*ChainRecord, error)
  • func (r *Impl) GetNodeIdentity() (*ed25519.KeyPair, error)
  • func (r *Impl) GetNodePublicKey() (*ed25519.PublicKey, error)
  • func (r *Impl) HasBlob(h hashing.HashValue) (bool, error)
  • func (r *Impl) IsTrustedPeer(pubKey ed25519.PublicKey) error
  • func (r *Impl) LoadDKShare(sharedAddress ledgerstate.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) SaveDKShare(dkShare *tcrypto.DKShare) error
  • func (r *Impl) TrustPeer(pubKey ed25519.PublicKey, netID string) (*peering.TrustedPeer, error)
  • func (r *Impl) TrustedPeers() ([]*peering.TrustedPeer, error)
  • func (r *Impl) UpdateChainRecord(chainID *iscp.ChainID, f func(*ChainRecord) bool) (*ChainRecord, error)
• type NodeIdentityProvider
• type Provider

Constants

const BlobCacheDefaultTTL = 1 * time.Hour

const (
	// CfgBindAddress defines the config flag of the web API binding address.
	CfgRewardAddress = "reward.address"
)

Variables

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

Functions

func GetFeeDestination

func GetFeeDestination(chainID *iscp.ChainID) ledgerstate.Address

func InitFlags

func InitFlags()

func MakeChainRecordDbKey

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

Types

type BlobCache

type BlobCache interface {
	GetBlob(h hashing.HashValue) ([]byte, bool, error)
	HasBlob(h hashing.HashValue) (bool, error)
	// PutBlob ttl s TimeToLive, expiration time in Unix nanoseconds
	PutBlob(data []byte, ttl ...time.Duration) (hashing.HashValue, error)
}

BlobCache is an access to the cache of big binary objects

type ChainRecord

type ChainRecord struct {
	ChainID *iscp.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 *iscp.ChainID) (*ChainRecord, error)
	GetChainRecords() ([]*ChainRecord, error)
	UpdateChainRecord(chainID *iscp.ChainID, f func(*ChainRecord) bool) (*ChainRecord, error)
	ActivateChainRecord(chainID *iscp.ChainID) (*ChainRecord, error)
	DeactivateChainRecord(chainID *iscp.ChainID) (*ChainRecord, error)
}

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

type DKShareRegistryProvider

type DKShareRegistryProvider interface {
	SaveDKShare(dkShare *tcrypto.DKShare) error
	LoadDKShare(sharedAddress ledgerstate.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 *iscp.ChainID) (*ChainRecord, error)

func (*Impl) DeactivateChainRecord

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

func (*Impl) DistrustPeer

func (r *Impl) DistrustPeer(pubKey ed25519.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 *iscp.ChainID) (*ChainRecord, error)

func (*Impl) GetChainRecords

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

func (*Impl) GetNodeIdentity

func (r *Impl) GetNodeIdentity() (*ed25519.KeyPair, error)

GetNodeIdentity implements NodeIdentityProvider.

func (*Impl) GetNodePublicKey

func (r *Impl) GetNodePublicKey() (*ed25519.PublicKey, error)

GetNodePublicKey implements NodeIdentityProvider.

func (*Impl) HasBlob

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

func (*Impl) IsTrustedPeer

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

IsTrustedPeer implements TrustedNetworkManager interface.

func (*Impl) LoadDKShare

func (r *Impl) LoadDKShare(sharedAddress ledgerstate.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) SaveDKShare

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

SaveDKShare implements dkg.DKShareRegistryProvider.

func (*Impl) TrustPeer

func (r *Impl) TrustPeer(pubKey ed25519.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 *iscp.ChainID, f func(*ChainRecord) bool) (*ChainRecord, error)

type NodeIdentityProvider

type NodeIdentityProvider interface {
	GetNodeIdentity() (*ed25519.KeyPair, error)
	GetNodePublicKey() (*ed25519.PublicKey, error)
}

type Provider

type Provider func() *Impl