registry

README

Registry Client in Go

Based on the Rust Registry Client

Documentation

Index

• Variables
• func NewHashTree(tree *v1.MixedHashTree) (*hashtree.HashTree, error)
• type Client
  • func New(a *agent.Agent) *Client
  • func (c *Client) GetLatestVersion() (uint64, error)
  • func (c *Client) GetNNSSubnetID() (*principal.Principal, error)
  • func (c *Client) GetNodeListSince(version uint64) (NodeMap, error)
  • func (c *Client) GetSubnetDetails(subnetID principal.Principal) (*v1.SubnetRecord, error)
  • func (c *Client) GetSubnetIDs() ([]principal.Principal, error)
  • func (c *Client) GetSubnetPublicKey(subnetID principal.Principal) ([]byte, error)
• type DataCenterMap
• type DataProvider
  • func NewDataProvider(a *agent.Agent) *DataProvider
  • func (d DataProvider) GetCertifiedChangesSince(version uint64, publicKey []byte) ([]VersionedRecord, uint64, error)
  • func (d DataProvider) GetChangesSince(version uint64) ([]*v1.RegistryDelta, uint64, error)
  • func (d DataProvider) GetLatestVersion() (uint64, error)
  • func (d DataProvider) GetSubnetForCanister(canID principal.Principal) (principal.Principal, error)
  • func (d DataProvider) GetValue(key []byte, version *uint64) ([]byte, uint64, error)
  • func (d DataProvider) GetValueUpdate(key []byte, version *uint64) ([]byte, uint64, error)
• type IPv4Interface
• type NodeDetails
• type NodeMap
  • func (n NodeMap) ByDataCenter() DataCenterMap
  • func (n NodeMap) ByNodeOperator() NodeOperatorMap
  • func (n NodeMap) ByNodeProvider() NodeProviderMap
• type NodeOperatorMap
• type NodeProviderMap
• type VersionedRecord

Variables

var REGISTRY_PRINCIPAL = principal.MustDecode("rwlgt-iiaaa-aaaaa-aaaaa-cai")

Functions

func NewHashTree

func NewHashTree(tree *v1.MixedHashTree) (*hashtree.HashTree, error)

Types

type Client

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

func New

func New(a *agent.Agent) *Client

New

func (*Client) GetLatestVersion

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

func (*Client) GetNNSSubnetID

func (c *Client) GetNNSSubnetID() (*principal.Principal, error)

func (*Client) GetNodeListSince

func (c *Client) GetNodeListSince(version uint64) (NodeMap, error)

func (*Client) GetSubnetDetails

func (c *Client) GetSubnetDetails(subnetID principal.Principal) (*v1.SubnetRecord, error)

func (*Client) GetSubnetIDs

func (c *Client) GetSubnetIDs() ([]principal.Principal, error)

func (*Client) GetSubnetPublicKey

func (c *Client) GetSubnetPublicKey(subnetID principal.Principal) ([]byte, error)

type DataCenterMap

type DataCenterMap map[string][]NodeDetails

type DataProvider

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

func NewDataProvider

func NewDataProvider(a *agent.Agent) *DataProvider

func (DataProvider) GetCertifiedChangesSince

func (d DataProvider) GetCertifiedChangesSince(version uint64, publicKey []byte) ([]VersionedRecord, uint64, error)

func (DataProvider) GetChangesSince

func (d DataProvider) GetChangesSince(version uint64) ([]*v1.RegistryDelta, uint64, error)

GetChangesSince returns the changes since the given version.

func (DataProvider) GetLatestVersion

func (d DataProvider) GetLatestVersion() (uint64, error)

func (DataProvider) GetSubnetForCanister

func (d DataProvider) GetSubnetForCanister(canID principal.Principal) (principal.Principal, error)

func (DataProvider) GetValue

func (d DataProvider) GetValue(key []byte, version *uint64) ([]byte, uint64, error)

GetValue returns the value of the given key and its version. If version is nil, the latest version is returned.

func (DataProvider) GetValueUpdate

func (d DataProvider) GetValueUpdate(key []byte, version *uint64) ([]byte, uint64, error)

GetValueUpdate returns the value of the given key and its version.

type IPv4Interface

type IPv4Interface struct {
	Address      string
	Gateways     []string
	PrefixLength uint32
}

type NodeDetails

type NodeDetails struct {
	IPv6            string
	IPv4            *IPv4Interface
	NodeOperatorID  principal.Principal
	NodeProviderID  principal.Principal
	DCID            string
	HostOSVersionID *string
	Domain          *string
}

type NodeMap

type NodeMap map[string]NodeDetails

func (NodeMap) ByDataCenter

func (n NodeMap) ByDataCenter() DataCenterMap

func (NodeMap) ByNodeOperator

func (n NodeMap) ByNodeOperator() NodeOperatorMap

func (NodeMap) ByNodeProvider

func (n NodeMap) ByNodeProvider() NodeProviderMap

type NodeOperatorMap

type NodeOperatorMap map[string][]NodeDetails

type NodeProviderMap

type NodeProviderMap map[string][]NodeDetails

type VersionedRecord

type VersionedRecord struct {
	Key     string
	Version uint64
	Value   []byte
}