Documentation
¶
Overview ¶
Package netmap contains implementation of the Netmap contract for NeoFS systems.
Netmap contract stores and manages NeoFS network map, storage node candidates and epoch number counter. Currently it maintains two lists simultaneously, both in old BLOB-based format and new structured one. Nodes and IR are encouraged to use both during transition period, old format will eventually be discontinued.
Contract notifications ¶
AddNode notification. This notification is emitted when a storage node joins the candidate list via AddNode method (using new format).
AddNode
- name: publicKey
type: PublicKey
- name: addresses
type: Array
- name: attributes
type: Map
AddPeer notification. This notification is produced when a Storage node sends a bootstrap request by invoking AddPeer method.
AddPeer
- name: nodeInfo
type: ByteArray
UpdateStateSuccess notification. This notification is produced when a storage node or Alphabet changes node state by invoking UpdateState or DeleteNode methods. Supported states: online/offline/maintenance.
UpdateStateSuccess
- name: publicKey
type: PublicKey
- name: state
type: Integer
NewEpoch notification. This notification is produced when a new epoch is applied in the network by invoking NewEpoch method.
NewEpoch
- name: epoch
type: Integer
NewEpochSubscription notification. This notification is produced when a new contract was subscribed to new epoch event.
NewEpochSubscription - name: contract type: Hash160
Index ¶
- Constants
- func AddNode(n Node2)
- func CleanupThreshold() int
- func Config(key []byte) any
- func DeleteNode(pkey interop.PublicKey)
- func Epoch() int
- func GetEpochBlock(epoch int) int
- func GetEpochBlockByTime(ts int) int
- func GetEpochTime(epoch int) int
- func InnerRingList() []common.IRNodedeprecated
- func IsStorageNode(key interop.PublicKey) bool
- func IsStorageNodeInEpoch(key interop.PublicKey, epoch int) bool
- func IsStorageNodeStatus(key interop.PublicKey, epoch int, status nodestate.Type) bool
- func LastEpochBlock() int
- func LastEpochTime() int
- func ListCandidates() iterator.Iterator
- func ListNodes() iterator.Iterator
- func ListNodesEpoch(epoch int) iterator.Iterator
- func NewEpoch(epochNum int)
- func SetCleanupThreshold(val int)
- func SetConfig(id, key, val []byte)
- func SubscribeForNewEpoch(contract interop.Hash160)
- func UnsubscribeFromNewEpoch(contract interop.Hash160)
- func Update(nefFile, manifest []byte, data any)
- func UpdateSnapshotCount(count int)
- func UpdateState(state nodestate.Type, publicKey interop.PublicKey)
- func Version() int
- type Candidate
- type ConfigRecord
- type Node2
Constants ¶
const ( // DefaultSnapshotCount contains the number of previous snapshots stored by this contract. // Must be less than 255. DefaultSnapshotCount = 10 )
Variables ¶
This section is empty.
Functions ¶
func AddNode ¶
func AddNode(n Node2)
AddNode adds a new node into the candidate list for the next epoch. Node must have nodestate.Online state to be considered and the request must be signed by both the node and Alphabet. AddNode event is emitted upon success.
func CleanupThreshold ¶
func CleanupThreshold() int
CleanupThreshold returns the cleanup threshold configuration. Nodes that do not update their state for this number of epochs get kicked out of the network map. Zero means cleanups are disabled.
func Config ¶
Config returns configuration value of NeoFS configuration. If key does not exist, returns nil.
func DeleteNode ¶
DeleteNode removes a node with the given public key from candidate list. It must be signed by Alphabet nodes and doesn't require node witness. See UpdateState as well, this method emits UpdateStateSuccess upon success with state nodestate.Offline.
func GetEpochBlock ¶ added in v0.22.0
GetEpochBlock returns block index when given epoch came. Returns 0 if the epoch is missing. Do not confuse with GetEpochTime.
Use LastEpochBlock if you are interested in the current epoch.
func GetEpochBlockByTime ¶ added in v0.26.0
GetEpochBlockByTime returns the block index when the latest epoch that started not later than the provided block time came. Returns 0 if the time precedes any known epoch.
func GetEpochTime ¶ added in v0.22.0
GetEpochTime returns block time when given epoch came. Returns 0 if the epoch is missing. Do not confuse with GetEpochBlock.
Use LastEpochTime if you are interested in the current epoch.
func InnerRingList
deprecated
InnerRingList method returns a slice of structures that contains the public key of an Inner Ring node. It should be used in notary disabled environment only.
If notary is enabled, look to NeoFSAlphabet role in native RoleManagement contract of FS chain.
Deprecated: since non-notary settings are no longer supported, refer only to the RoleManagement contract only. The method will be removed in one of the future releases.
func IsStorageNode ¶
IsStorageNode allows to check for the given key presence in the current network map.
func IsStorageNodeInEpoch ¶
IsStorageNodeInEpoch is the same as IsStorageNode, but allows to do the check for previous epochs if they're still stored in the contract. If this epoch is no longer stored (or too new) it will return false.
func IsStorageNodeStatus ¶ added in v0.26.0
IsStorageNodeStatus checks if the given status matches for the given node in the specified epoch.
func LastEpochBlock ¶
func LastEpochBlock() int
LastEpochBlock method returns the block number when the current epoch was applied. Do not confuse with LastEpochTime.
Use GetEpochBlock for specific epoch.
func LastEpochTime ¶ added in v0.22.0
func LastEpochTime() int
LastEpochTime method returns the block time when the current epoch was applied. Do not confuse with LastEpochBlock.
Use GetEpochTime for specific epoch.
func ListCandidates ¶
ListCandidates returns an iterator for a set of current candidate nodes. Iterator values are Candidate structures.
func ListNodes ¶
ListNodes provides an iterator to walk over current (as in corresponding to the current epoch network map) node set. Iterator values are Node2 structures.
func ListNodesEpoch ¶
ListNodesEpoch provides an iterator to walk over node set at the given epoch. It's the same as ListNodes (and exposed as listNodes from the contract via overload), but allows to query a particular epoch data if it's still stored. If this epoch is already expired (or not happened yet) returns an empty iterator.
func NewEpoch ¶
func NewEpoch(epochNum int)
NewEpoch method changes the epoch number up to the provided epochNum argument. It can be invoked only by Alphabet nodes. If provided epoch number is less than the current epoch number or equals it, the method throws panic.
When epoch number is updated, the contract sets storage node candidates as the current network map. The contract also invokes NewEpoch method on Balance and Container contracts.
It produces NewEpoch notification.
func SetCleanupThreshold ¶
func SetCleanupThreshold(val int)
SetCleanupThreshold sets cleanup threshold configuration. Negative values are not allowed. Zero disables stale node cleanups on epoch change.
func SetConfig ¶
func SetConfig(id, key, val []byte)
SetConfig key-value pair as a NeoFS runtime configuration value. It can be invoked only by Alphabet nodes.
func SubscribeForNewEpoch ¶
SubscribeForNewEpoch registers passed contract as a NewEpoch event subscriber. Such a contract must have a `NewEpoch` method with a single numeric parameter. Transactions that call SubscribeForNewEpoch must be witnessed by the Alphabet. Produces `NewEpochSubscription` notification event with a just registered recipient in a success case.
func UnsubscribeFromNewEpoch ¶ added in v0.24.0
UnsubscribeFromNewEpoch removes new epoch subscription made by SubscribeForNewEpoch beforehand. Does nothing if subscription has not been made. Transactions that call UnsubscribeFromNewEpoch must be witnessed by the Alphabet. Produces `NewEpochUnsubscription` notification event if any unsubscription was made.
func Update ¶
Update method updates contract source code and manifest. It can be invoked only by committee.
func UpdateSnapshotCount ¶
func UpdateSnapshotCount(count int)
UpdateSnapshotCount updates the number of the stored snapshots. If a new number is less than the old one, old snapshots are removed. Otherwise, history is extended with empty snapshots, so `Snapshot` method can return invalid results for `diff = new-old` epochs until `diff` epochs have passed.
Count MUST NOT be negative.
func UpdateState ¶
UpdateState proposes a new state of candidate for the next-epoch network map. The candidate is identified by the given public key. Call transaction MUST be signed by the provided public key, i.e. by node itself. If the signature is correct, the Notary service will submit a request for signature by the NeoFS Alphabet. After collecting a sufficient number of signatures, the candidate's state will be switched to the given one ('UpdateStateSuccess' notification is thrown after that).
UpdateState panics if requested candidate is missing in the current candidate set. UpdateState drops candidate from the candidate set if it is switched to nodestate.Offline.
State MUST be from the nodestate.Type enum. Public key MUST be interop.PublicKeyCompressedLen bytes.
Types ¶
type Candidate ¶
type Candidate struct {
// Addresses are to be used to connect to the node.
Addresses []string
// Attributes are KV pairs with node metadata.
Attributes map[string]string
// Key is a node public key.
Key interop.PublicKey
// State is a current node state.
State nodestate.Type
// LastActiveEpoch is the last epoch this node was active in.
LastActiveEpoch int
}
Candidate is an extended version of Node2 that also knows about the last active epoch for the node.
func UnusedCandidate ¶
func UnusedCandidate() Candidate
UnusedCandidate does nothing except marking Candidate structure as used one thereby making RPC binding generator produce code for it. It is a temporary solution until we have proper iterator types. Never use it.
type ConfigRecord ¶
ConfigRecord represent a config Key/Value pair.
func ListConfig ¶
func ListConfig() []ConfigRecord
ListConfig returns an array of structures that contain key and value of all NeoFS configuration records. Key and value are both byte arrays.
type Node2 ¶
type Node2 struct {
// Addresses are to be used to connect to the node.
Addresses []string
// Attributes are KV pairs with node metadata.
Attributes map[string]string
// Key is a node public key.
Key interop.PublicKey
// State is a current node state.
State nodestate.Type
}
Node2 stores data related to a single NeoFS storage node. It follows the model defined in NeoFS API specification.
Source Files
Directories