wrapper

Documentation

Index

• func WriteConfig(dst ConfigWriter, iterator func(func(key, val []byte) error) error) error
• type ConfigWriter
• type Option
  • func AsAlphabet() Option
  • func TryNotary() Option
• type Wrapper
  • func NewFromMorph(cli *client.Client, contract util.Uint160, fee fixedn.Fixed8, opts ...Option) (*Wrapper, error)
  • func (w *Wrapper) AddPeer(nodeInfo *netmap.NodeInfo) error
  • func (w *Wrapper) AuditFee() (uint64, error)
  • func (w *Wrapper) BasicIncomeRate() (uint64, error)
  • func (w *Wrapper) ContainerAliasFee() (uint64, error)
  • func (w *Wrapper) ContainerFee() (uint64, error)
  • func (w *Wrapper) EigenTrustAlpha() (float64, error)
  • func (w *Wrapper) EigenTrustIterations() (uint64, error)
  • func (w *Wrapper) Epoch() (uint64, error)
  • func (w *Wrapper) EpochDuration() (uint64, error)
  • func (w Wrapper) GetCandidates() (*netmap.Netmap, error)
  • func (w *Wrapper) GetInnerRingList() (keys.PublicKeys, error)
  • func (w Wrapper) GetNetMap(diff uint64) (*netmap.Netmap, error)
  • func (w Wrapper) GetNetMapByEpoch(epoch uint64) (*netmap.Netmap, error)
  • func (w *Wrapper) InnerRingCandidateFee() (uint64, error)
  • func (w *Wrapper) IterateConfigParameters(f func(key, value []byte) error) error
  • func (w *Wrapper) LastEpochBlock() (uint32, error)
  • func (w *Wrapper) MaxObjectSize() (uint64, error)
  • func (w Wrapper) Morph() *client.Client
  • func (w *Wrapper) NewEpoch(e uint64) error
  • func (w *Wrapper) SetConfig(id, key []byte, value interface{}) error
  • func (w *Wrapper) Snapshot() (*netmap.Netmap, error)
  • func (w *Wrapper) UpdateInnerRing(keys keys.PublicKeys) error
  • func (w *Wrapper) UpdatePeerState(key []byte, state netmap.NodeState) error
  • func (w *Wrapper) WithdrawFee() (uint64, error)

Functions

func WriteConfig

func WriteConfig(dst ConfigWriter, iterator func(func(key, val []byte) error) error) error

WriteConfig writes NeoFS network configuration received via iterator.

Returns iterator's errors directly.

Types

type ConfigWriter

type ConfigWriter interface {
	UnknownParameter(string, []byte)
	MaxObjectSize(uint64)
	BasicIncomeRate(uint64)
	AuditFee(uint64)
	EpochDuration(uint64)
	ContainerFee(uint64)
	ContainerAliasFee(uint64)
	EigenTrustIterations(uint64)
	EigenTrustAlpha(float64)
	InnerRingCandidateFee(uint64)
	WithdrawFee(uint64)
}

ConfigWriter is an interface of NeoFS network config writer.

type Option

type Option func(*opts)

Option allows to set an optional parameter of Wrapper.

func AsAlphabet

func AsAlphabet() Option

AsAlphabet returns option to sign main TX of notary requests with client's private key.

Considered to be used by IR nodes only.

func TryNotary

func TryNotary() Option

TryNotary returns option to enable notary invocation tries.

type Wrapper

type Wrapper struct {
	internal.StaticClient
	// contains filtered or unexported fields
}

Wrapper is a wrapper over netmap contract client which implements:

• network map storage;
• tool for peer state updating.

Working wrapper must be created via constructor New. Using the Wrapper that has been created with new(Wrapper) expression (or just declaring a Wrapper variable) is unsafe and can lead to panic.

func NewFromMorph

func NewFromMorph(cli *client.Client, contract util.Uint160, fee fixedn.Fixed8, opts ...Option) (*Wrapper, error)

NewFromMorph returns the wrapper instance from the raw morph client.

func (*Wrapper) AddPeer

func (w *Wrapper) AddPeer(nodeInfo *netmap.NodeInfo) error

AddPeer registers peer in NeoFS network through Netmap contract call.

func (*Wrapper) AuditFee

func (w *Wrapper) AuditFee() (uint64, error)

AuditFee returns audit fee configuration value from network config in netmap contract.

func (*Wrapper) BasicIncomeRate

func (w *Wrapper) BasicIncomeRate() (uint64, error)

BasicIncomeRate returns basic income rate configuration value from network config in netmap contract.

func (*Wrapper) ContainerAliasFee

func (w *Wrapper) ContainerAliasFee() (uint64, error)

ContainerAliasFee returns additional fee paid by container owner to each alphabet node for container nice name registration.

func (*Wrapper) ContainerFee

func (w *Wrapper) ContainerFee() (uint64, error)

ContainerFee returns fee paid by container owner to each alphabet node for container registration.

func (*Wrapper) EigenTrustAlpha

func (w *Wrapper) EigenTrustAlpha() (float64, error)

EigenTrustAlpha returns global configuration value of alpha parameter. It receives the alpha as a string and tries to convert it to float.

func (*Wrapper) EigenTrustIterations

func (w *Wrapper) EigenTrustIterations() (uint64, error)

EigenTrustIterations returns global configuration value of iteration cycles for EigenTrust algorithm per epoch.

func (*Wrapper) Epoch

func (w *Wrapper) Epoch() (uint64, error)

Epoch receives number of current NeoFS epoch through the Netmap contract call.

func (*Wrapper) EpochDuration

func (w *Wrapper) EpochDuration() (uint64, error)

EpochDuration returns number of sidechain blocks per one NeoFS epoch.

func (Wrapper) GetCandidates

func (w Wrapper) GetCandidates() (*netmap.Netmap, error)

GetCandidates receives information list about candidates for the next epoch network map through the Netmap contract call, composes network map from them and returns it.

func (*Wrapper) GetInnerRingList

func (w *Wrapper) GetInnerRingList() (keys.PublicKeys, error)

GetInnerRingList return current IR list.

func (Wrapper) GetNetMap

func (w Wrapper) GetNetMap(diff uint64) (*netmap.Netmap, error)

GetNetMap receives information list about storage nodes through the Netmap contract call, composes network map from them and returns it. With diff == 0 returns current network map, else return snapshot of previous network map.

func (Wrapper) GetNetMapByEpoch

func (w Wrapper) GetNetMapByEpoch(epoch uint64) (*netmap.Netmap, error)

GetNetMapByEpoch receives information list about storage nodes through the Netmap contract call, composes network map from them and returns it. Returns snapshot of the specified epoch number.

func (*Wrapper) InnerRingCandidateFee

func (w *Wrapper) InnerRingCandidateFee() (uint64, error)

InnerRingCandidateFee returns global configuration value of fee paid by node to be in inner ring candidates list.

func (*Wrapper) IterateConfigParameters

func (w *Wrapper) IterateConfigParameters(f func(key, value []byte) error) error

IterateConfigParameters iterates over configuration parameters stored in Netmap contract and passes them to f.

Returns f's errors directly.

func (*Wrapper) LastEpochBlock

func (w *Wrapper) LastEpochBlock() (uint32, error)

LastEpochBlock receives block number of current NeoFS epoch through the Netmap contract call.

func (*Wrapper) MaxObjectSize

func (w *Wrapper) MaxObjectSize() (uint64, error)

MaxObjectSize receives max object size configuration value through the Netmap contract call.

func (Wrapper) Morph

func (w Wrapper) Morph() *client.Client

Morph returns raw morph client.

func (*Wrapper) NewEpoch

func (w *Wrapper) NewEpoch(e uint64) error

NewEpoch updates NeoFS epoch number through Netmap contract call.

func (*Wrapper) SetConfig

func (w *Wrapper) SetConfig(id, key []byte, value interface{}) error

SetConfig sets config field.

func (*Wrapper) Snapshot

func (w *Wrapper) Snapshot() (*netmap.Netmap, error)

Snapshot returns current netmap node infos. Consider using pkg/morph/client/netmap for this.

func (*Wrapper) UpdateInnerRing

func (w *Wrapper) UpdateInnerRing(keys keys.PublicKeys) error

UpdateInnerRing updates inner ring keys.

func (*Wrapper) UpdatePeerState

func (w *Wrapper) UpdatePeerState(key []byte, state netmap.NodeState) error

UpdatePeerState changes peer status through Netmap contract call.

func (*Wrapper) WithdrawFee

func (w *Wrapper) WithdrawFee() (uint64, error)

WithdrawFee returns global configuration value of fee paid by user to withdraw assets from NeoFS contract.