wrapper

Documentation

Index

• Variables
• type Client
• type Epoch
• type Wrapper
  • func New(c *Client) (*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) 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) GetNetMap(diff uint64) (*netmap.Netmap, error)
  • func (w Wrapper) GetNetMapByEpoch(epoch uint64) (*netmap.Netmap, error)
  • func (w *Wrapper) InnerRingCandidateFee() (uint64, error)
  • func (w *Wrapper) MaxObjectSize() (uint64, error)
  • func (w *Wrapper) NewEpoch(e Epoch) error
  • func (w *Wrapper) UpdatePeerState(key []byte, state netmap.NodeState) error
  • func (w *Wrapper) WithdrawFee() (uint64, error)

Variables

var ErrNilWrapper = errors.New("netmap contract client wrapper is nil")

ErrNilWrapper is returned by functions that expect a non-nil Wrapper pointer, but received nil.

Types

type Client

type Client = netmap.Client

Client represents the Netmap contract client.

It is a type alias of github.com/nspcc-dev/neofs-node/pkg/morph/client/netmap.Client.

type Epoch

type Epoch struct{}

Epoch represents the NeoFS epoch. FIXME: correct the definition.

type Wrapper

type Wrapper struct {
	// 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 New

func New(c *Client) (*Wrapper, error)

New creates, initializes and returns the Wrapper instance.

If Client is nil, netmap.ErrNilClient is returned.

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

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

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

func (*Wrapper) NewEpoch

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

NewEpoch updates NeoFS epoch number through Netmap contract call.

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.