netmap

package
v0.41.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 27, 2024 License: GPL-3.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	MaxObjectSizeConfig           = "MaxObjectSize"
	BasicIncomeRateConfig         = "BasicIncomeRate"
	AuditFeeConfig                = "AuditFee"
	EpochDurationConfig           = "EpochDuration"
	ContainerFeeConfig            = "ContainerFee"
	ContainerAliasFeeConfig       = "ContainerAliasFee"
	EigenTrustIterationsConfig    = "EigenTrustIterations"
	EigenTrustAlphaConfig         = "EigenTrustAlpha"
	InnerRingCandidateFeeConfig   = "InnerRingCandidateFee"
	WithdrawFeeConfig             = "WithdrawFee"
	HomomorphicHashingDisabledKey = "HomomorphicHashingDisabled"
	MaintenanceModeAllowedConfig  = "MaintenanceModeAllowed"
)

Variables

View Source 
var ErrConfigNotFound = errors.New("config value not found")

ErrConfigNotFound is returned when the requested key was not found in the network config (returned value is `Null`).

Functions

func BoolAssert added in v0.30.0 

func BoolAssert(item stackitem.Item) (any, error)

BoolAssert converts stack item to bool.

func DecodeNetMap added in v0.38.0 

func DecodeNetMap(resStack []stackitem.Item) (*netmap.NetMap, error)

func IntegerAssert added in v0.12.0 

func IntegerAssert(item stackitem.Item) (any, error)

IntegerAssert converts stack item to int64.

func StringAssert added in v0.19.0 

func StringAssert(item stackitem.Item) (any, error)

StringAssert converts stack item to string.

Types

type AddPeerPrm added in v0.28.0 

type AddPeerPrm struct {
	client.InvokePrmOptional
	// contains filtered or unexported fields
}

AddPeerPrm groups parameters of AddPeer operation.

func (*AddPeerPrm) SetNodeInfo added in v0.28.0 

func (a *AddPeerPrm) SetNodeInfo(nodeInfo netmap.NodeInfo)

SetNodeInfo sets new peer NodeInfo.

type Client 

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

Client is a wrapper over StaticClient which makes calls with the names and arguments of the NeoFS Netmap contract.

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

func NewFromMorph added in v0.28.0 

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

NewFromMorph returns the wrapper instance from the raw morph client.

func (*Client) AddPeer 

func (c *Client) AddPeer(p AddPeerPrm) error

AddPeer registers peer in NeoFS network through Netmap contract call.

func (*Client) AuditFee added in v0.28.0 

func (c *Client) AuditFee() (uint64, error)

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

func (*Client) BasicIncomeRate added in v0.28.0 

func (c *Client) BasicIncomeRate() (uint64, error)

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

func (*Client) ContainerAliasFee added in v0.28.0 

func (c *Client) ContainerAliasFee() (uint64, error)

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

func (*Client) ContainerFee added in v0.28.0 

func (c *Client) ContainerFee() (uint64, error)

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

func (Client) ContractAddress added in v0.28.0 

func (c Client) ContractAddress() util.Uint160

ContractAddress returns the address of the associated contract.

func (*Client) EigenTrustAlpha added in v0.28.0 

func (c *Client) 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 (*Client) EigenTrustIterations added in v0.28.0 

func (c *Client) EigenTrustIterations() (uint64, error)

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

func (*Client) Epoch added in v0.12.0 

func (c *Client) Epoch() (uint64, error)

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

func (*Client) EpochDuration added in v0.28.0 

func (c *Client) EpochDuration() (uint64, error)

EpochDuration returns number of sidechain blocks per one NeoFS epoch.

func (*Client) GetCandidates added in v0.28.0 

func (c *Client) GetCandidates() ([]netmap.NodeInfo, error)

GetCandidates calls "netmapCandidates" method and decodes []netmap.NodeInfo from the response.

func (*Client) GetInnerRingList added in v0.28.0 

func (c *Client) GetInnerRingList() (keys.PublicKeys, error)

GetInnerRingList return current IR list.

func (*Client) GetNetMap added in v0.28.0 

func (c *Client) GetNetMap(diff uint64) (*netmap.NetMap, error)

GetNetMap calls "snapshot" method and decodes netmap.NetMap from the response.

func (*Client) GetNetMapByEpoch added in v0.28.0 

func (c *Client) GetNetMapByEpoch(epoch uint64) (*netmap.NetMap, error)

GetNetMapByEpoch calls "snapshotByEpoch" method with the given epoch and decodes netmap.NetMap from the response.

func (*Client) HomomorphicHashDisabled added in v0.30.0 

func (c *Client) HomomorphicHashDisabled() (bool, error)

HomomorphicHashDisabled returns global configuration value of homomorphic hashing settings.

Returns (false, nil) if config key is not found in the contract.

func (*Client) InnerRingCandidateFee added in v0.28.0 

func (c *Client) InnerRingCandidateFee() (uint64, error)

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

func (*Client) LastEpochBlock added in v0.23.0 

func (c *Client) LastEpochBlock() (uint32, error)

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

func (*Client) MaintenanceModeAllowed added in v0.33.0 

func (c *Client) MaintenanceModeAllowed() (bool, error)

MaintenanceModeAllowed reads admission of "maintenance" state from the NeoFS network configuration stored in the Sidechain. The admission means that storage nodes are allowed to switch their state to "maintenance".

By default, maintenance state is disallowed.

func (*Client) MaxObjectSize added in v0.28.0 

func (c *Client) MaxObjectSize() (uint64, error)

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

func (Client) Morph added in v0.25.0 

func (c Client) Morph() *client.Client

Morph returns raw morph client.

func (*Client) NetMap 

func (c *Client) NetMap() (*netmap.NetMap, error)

NetMap calls "netmap" method and decode netmap.NetMap from the response.

func (*Client) NewEpoch 

func (c *Client) NewEpoch(epoch uint64) error

NewEpoch updates NeoFS epoch number through Netmap contract call.

func (*Client) ReadNetworkConfiguration added in v0.29.0 

func (c *Client) ReadNetworkConfiguration() (NetworkConfiguration, error)

ReadNetworkConfiguration reads NetworkConfiguration from the NeoFS Sidechain.

func (*Client) SetConfig added in v0.22.0 

func (c *Client) SetConfig(p SetConfigPrm) error

SetConfig sets config field.

func (*Client) UpdateInnerRing added in v0.23.0 

func (c *Client) UpdateInnerRing(p UpdateIRPrm) error

UpdateInnerRing updates inner ring keys.

func (*Client) UpdatePeerState added in v0.28.0 

func (c *Client) UpdatePeerState(p UpdatePeerPrm) error

UpdatePeerState changes peer status through Netmap contract call.

func (*Client) WithdrawFee added in v0.28.0 

func (c *Client) WithdrawFee() (uint64, error)

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

type NetworkConfiguration added in v0.29.0 

type NetworkConfiguration struct {
	MaxObjectSize uint64

	StoragePrice uint64

	AuditFee uint64

	EpochDuration uint64

	ContainerFee uint64

	ContainerAliasFee uint64

	EigenTrustIterations uint64

	EigenTrustAlpha float64

	IRCandidateFee uint64

	WithdrawalFee uint64

	HomomorphicHashingDisabled bool

	MaintenanceModeAllowed bool

	Raw []RawNetworkParameter
}

NetworkConfiguration represents NeoFS network configuration stored in the NeoFS Sidechain.

type NodeInfo added in v0.12.0 

type NodeInfo = netmap.NodeInfo

type Option 

type Option func(*opts)

Option allows to set an optional parameter of Wrapper.

func AsAlphabet added in v0.28.0 

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.

type RawNetworkParameter added in v0.29.0 

type RawNetworkParameter struct {
	// Name of the parameter.
	Name string

	// Raw parameter value.
	Value []byte
}

RawNetworkParameter is a NeoFS network parameter which is transmitted but not interpreted by the NeoFS API protocol.

type SetConfigPrm added in v0.27.0 

type SetConfigPrm struct {
	client.InvokePrmOptional
	// contains filtered or unexported fields
}

SetConfigPrm groups parameters of SetConfig operation.

func (*SetConfigPrm) SetID added in v0.27.0 

func (s *SetConfigPrm) SetID(id []byte)

SetID sets ID of the config value.

func (*SetConfigPrm) SetKey added in v0.27.0 

func (s *SetConfigPrm) SetKey(key []byte)

SetKey sets key of the config value.

func (*SetConfigPrm) SetValue added in v0.27.0 

func (s *SetConfigPrm) SetValue(value any)

SetValue sets value of the config value.

type UpdateIRPrm added in v0.27.0 

type UpdateIRPrm struct {
	client.InvokePrmOptional
	// contains filtered or unexported fields
}

UpdateIRPrm groups parameters of UpdateInnerRing invocation.

func (*UpdateIRPrm) SetKeys added in v0.27.0 

func (u *UpdateIRPrm) SetKeys(keys keys.PublicKeys)

SetKeys sets new inner ring keys.

type UpdatePeerPrm added in v0.28.0 

type UpdatePeerPrm struct {
	client.InvokePrmOptional
	// contains filtered or unexported fields
}

UpdatePeerPrm groups parameters of UpdatePeerState operation.

func (*UpdatePeerPrm) SetKey added in v0.28.0 

func (u *UpdatePeerPrm) SetKey(key []byte)

SetKey sets public key.

func (*UpdatePeerPrm) SetMaintenance added in v0.33.0 

func (u *UpdatePeerPrm) SetMaintenance()

SetMaintenance marks node to be switched into "maintenance" state.

Zero UpdatePeerPrm marks node as "offline".

func (*UpdatePeerPrm) SetOnline added in v0.29.0 

func (u *UpdatePeerPrm) SetOnline()

SetOnline marks node to be switched into "online" state.

Zero UpdatePeerPrm marks node as "offline".

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.