Module sn_interface::network_knowledge

Re-exports

• pub use self::node_state::MembershipState;
• pub use self::node_state::NodeState;
• pub use self::section_authority_provider::SapCandidate;
• pub use self::section_authority_provider::SectionAuthUtils;
• pub use self::section_authority_provider::SectionAuthorityProvider;
• pub use self::section_keys::SectionKeyShare;
• pub use self::section_keys::SectionKeysProvider;

Modules

• node_state
• section_authority_provider
• section_keys

Structs

• MyNodeInfo
  Information and state of our node
• NetworkKnowledge
  Container for storing information about the network, including our own section.
• RelocationDst
  We are relocating to the section that matches the contained XorName.
• RelocationInfo
  The relocation info contains the dst (in NodeState), the old name, the new name and the source section signature over the fact that the section considered the node to be relocated.
• RelocationProof
  A relocation proof proves that a section started a relocation of one of its nodes, and that the new name provided was created by that node.
• RelocationTrigger
  The relocation trigger is sent by the elder nodes to the relocating nodes. This is then used by the relocating nodes to request the Section to propose a relocation membership change.
• SectionTree
  Container for storing information about other sections in the network.
• SectionTreeUpdate
  The update to our NetworkKnowledge containing the section’s SectionAuthorityProvider signed by the section and the proof chain to validate the it.
• SectionsDAG
  A Merkle DAG of BLS keys where every key is signed by its parent key, except the genesis one.

Enums

• Error
  Internal error.
• RelocationState
  The current state of a relocating node

Constants

• DEFAULT_ELDER_COUNT
  Number of elders per section.
• GENESIS_DBC_SK
  The secret key for the genesis DBC.
• MIN_ADULT_AGE
  The minimum age a node becomes an adult node.

Functions

• elder_count
  Get the expected elder count for our network. Defaults to DEFAULT_ELDER_COUNT, but can be overridden by the env var SN_ELDER_COUNT.
• partition_by_prefix
• recommended_section_size
  Recommended section size. The section will keep adding nodes when requested by the upper layers, until it can split. A split happens if both post-split sections would have at least this number of nodes.
• section_has_room_for_node
• supermajority
  SuperMajority of a given group (i.e. > 2/3)
• threshold
  Threshold of a given group

Type Definitions

• Result
  The type returned by the sn_routing message handling methods.