registry

Documentation

Overview

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

Index

• Constants
• func GetFeeDestination(scaddr *address.Address) address.Address
• func InitFlags()
• func InitLogger()
• func SaveChainRecord(bd *ChainRecord) error
• type ChainRecord
  • func ActivateChainRecord(chainID *coretypes.ChainID) (*ChainRecord, error)
  • func DeactivateChainRecord(chainID *coretypes.ChainID) (*ChainRecord, error)
  • func GetChainRecord(chainID *coretypes.ChainID) (*ChainRecord, error)
  • func GetChainRecords() ([]*ChainRecord, error)
  • func UpdateChainRecord(chainID *coretypes.ChainID, f func(*ChainRecord) bool) (*ChainRecord, error)
  • func (bd *ChainRecord) Read(r io.Reader) error
  • func (bd *ChainRecord) String() string
  • func (bd *ChainRecord) Write(w io.Writer) error
• type Impl
  • func NewRegistry(suite tcrypto.Suite, log *logger.Logger, dbp ...*dbprovider.DBProvider) *Impl
  • func (r *Impl) GetBlob(h hashing.HashValue) ([]byte, bool, error)
  • func (r *Impl) GetNodeIdentity() (*key.Pair, error)
  • func (r *Impl) GetNodePublicKey() (kyber.Point, error)
  • func (r *Impl) HasBlob(h hashing.HashValue) (bool, error)
  • func (r *Impl) LoadDKShare(sharedAddress *address.Address) (*tcrypto.DKShare, error)
  • func (r *Impl) PutBlob(data []byte, ttl ...time.Duration) (hashing.HashValue, error)
  • func (r *Impl) SaveDKShare(dkShare *tcrypto.DKShare) error
• type NodeIdentityProvider

Constants

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

Functions

func GetFeeDestination

func GetFeeDestination(scaddr *address.Address) address.Address

func InitFlags

func InitFlags()

func InitLogger

func InitLogger()

func SaveChainRecord

func SaveChainRecord(bd *ChainRecord) error

Types

type ChainRecord

type ChainRecord struct {
	ChainID        coretypes.ChainID
	Color          balance.Color // origin tx hash
	CommitteeNodes []string      // "host_addr:port"
	Active         bool
}

ChainRecord is a minimum data needed to load a committee for the chain it is up to the node (not smart contract) to check authorizations to create/update this record

func ActivateChainRecord

func ActivateChainRecord(chainID *coretypes.ChainID) (*ChainRecord, error)

func DeactivateChainRecord

func DeactivateChainRecord(chainID *coretypes.ChainID) (*ChainRecord, error)

func GetChainRecord

func GetChainRecord(chainID *coretypes.ChainID) (*ChainRecord, error)

func GetChainRecords

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

func UpdateChainRecord

func UpdateChainRecord(chainID *coretypes.ChainID, f func(*ChainRecord) bool) (*ChainRecord, error)

func (*ChainRecord) Read

func (bd *ChainRecord) Read(r io.Reader) error

func (*ChainRecord) String

func (bd *ChainRecord) String() string

func (*ChainRecord) Write

func (bd *ChainRecord) Write(w io.Writer) error

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(suite tcrypto.Suite, log *logger.Logger, dbp ...*dbprovider.DBProvider) *Impl

New creates new instance of the registry implementation.

func (*Impl) GetBlob

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

Reads data from registry by hash. Returns existence flag

func (*Impl) GetNodeIdentity

func (r *Impl) GetNodeIdentity() (*key.Pair, error)

GetNodeIdentity implements NodeIdentityProvider.

func (*Impl) GetNodePublicKey

func (r *Impl) GetNodePublicKey() (kyber.Point, error)

GetNodePublicKey implements NodeIdentityProvider.

func (*Impl) HasBlob

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

func (*Impl) LoadDKShare

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

LoadDKShare implements dkg.RegistryProvider.

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) SaveDKShare

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

SaveDKShare implements dkg.RegistryProvider.

type NodeIdentityProvider

type NodeIdentityProvider interface {
	GetNodeIdentity() (*key.Pair, error)
	GetNodePublicKey() (kyber.Point, error)
}

NodeIdentityProvider is a subset of the registry interface providing access to the persistent node identity information.