client

ThreeFold Grid Node Registrar Client

A Go client for interacting with the ThreeFold Grid Node Registrar service. Facilitates node registration and management on the ThreeFold Grid.

Overview

The Node Registrar Client enables communication with the ThreeFold Grid's node registration service. It provides methods to:

• Register nodes
• Manage node metadata
• Retrieve node information
• Delete node registrations

Features

Version

• Get Zos Version: Loads zos version for the current network
• Set Zos Version: Set zos version to specific version (can only be done by the network admin)

Accounts

• Create Account: Create new account on the registrar with uniqe key.
• Update Account: Update the account configuration (relays & rmbEncKey).
• Ensure Account: Ensures that an account is created with specific seed/mnemonic.
• Get Account: Get an account using either its twin_id or its public_key.

Farms

• Create Farm: Create new farm on the registrar with uniqe name.
• update Farm: Update farm configuration (farm_id, dedicated).
• Get Farm: Get a farm using its farm_id.

Node

• Register Node: Register physical/virtual nodes with on TFGrid.
• Update Node: Update node configuration (farm_id, interfaces, resources, location, secure_boot, virtualized).
• Get Node: Fetch registered node details using (node_id, twin_id, farm_id).
• Update Node Uptime: Update node Uptime.

API Methods

Version Operations

Account Management

Farm Operations

Node Operations

Installation

go get github.com/threefoldtech/tfgrid4-sdk-go/node-registrar/client

Usage

Initialize Client

import (
  "github.com/threefoldtech/tfgrid4-sdk-go/node-registrar/client"
)

func main() {
  registrarURL := "https://registrar.dev4.grid.tf/v1"

 // Generate 128-bit entropy (12-word mnemonic)
 entropy, err := bip39.NewEntropy(128)
 if err != nil {
   panic(err)
 }

 // Generate mnemonic from entropy
 mnemonic, err = bip39.NewMnemonic(entropy)
 if err != nil {
   panic(err)
 }
  fmt.Println("New Mnemonic:", mnemonic)
  
  cli, err := client.NewRegistrarClient(registrarURL, mnemonic)
  if err != nil {
    panic(err)
  }
}

Get Zos Version

 version, err := c.GetZosVersion()
 if err != nil {
   log.Fatal().Err(err).Msg("failed to set registrar version")
 }

 log.Info().Msgf("%s version is: %+v", network, version)

Set Zos Version (ONLY for network admin)

 err := c.SetZosVersion("v0.1.8", true)
 if err != nil {
   log.Fatal().Err(err).Msg("failed to set registrar version")
 }

 log.Info().Msg("version is updated successfully")

Create Account

 account, err := c.CreateAccount(relays, rmbEncKey)
 if err != nil {
   log.Fatal().Err(err).Msg("failed to create new account on registrar")
 }

log.Info().Uint64("twinID", account.TwinID).Msg("account created successfully")

Get Account

Get Account By Public Key

 account, err := c.GetAccountByPK(pk)
 if err != nil {
   log.Fatal().Err(err).Msg("failed to get account from registrar")
 }
 log.Info().Any("account", account).Send()

Get Account By Twin ID

 account, err := c.GetAccount(id)
 if err != nil {
   log.Fatal().Err(err).Msg("failed to get account from registrar")
 }
 log.Info().Any("account", account).Send()

Update Account

 err := c.UpdateAccount(client.UpdateAccountWithRelays(relays), client.UpdateAccountWithRMBEncKey(rmbEncKey))
 if err != nil {
   log.Fatal().Err(err).Msg("failed to get account from registrar")
 }
 log.Info().Msg("account updated successfully")

Ensure Account

 account, err := c.EnsureAccount(relays, rmbEncKey)
 if err != nil {
  log.Fatal().Err(err).Msg("failed to ensure account account from registrar")
 }
 log.Info().Any("account", account).Send()

Create Farm

 id, err := c.CreateFarm(farmName, twinID, false)
 if err != nil {
  log.Fatal().Err(err).Msg("failed to create new farm on registrar")
 }

 log.Info().Uint64("farmID", id).Msg("farm created successfully")

Get Farm

 farm, err := c.GetFarm(id)
 if err != nil {
  log.Fatal().Err(err).Msg("failed to get farm from registrar")
 }
 log.Info().Any("farm", farm).Send()

List Farms

 farms, err := c.ListFarms(ListFarmWithName(name))
 if err != nil {
  log.Fatal().Err(err).Msg("failed to list farms from registrar")
 }
 log.Info().Any("farm", farms[0]).Send()

Update Farm

 err := c.UpdateFarm(farmID, client.UpdateFarmWithName(name))
 if err != nil {
  log.Fatal().Err(err).Msg("failed to get farm from registrar")
 }
 log.Info().Msg("farm updated successfully")

Register a Node

 id, err := c.RegisterNode(farmID, twinID, interfaces, location, resources, serialNumber, secureBoot, virtualized)
 if err != nil {
   log.Fatal().Err(err).Msg("failed to register a new node on registrar")
 }
 log.Info().Uint64("nodeID", id).Msg("node registered successfully")

Get Node

Get Node With Node ID

 node, err := c.GetNode(id)
 if err != nil {
  log.Fatal().Err(err).Msg("failed to get node from registrar")
 }
 log.Info().Any("node", node).Send()

Get Node With Twin ID

 node, err := c.GetNodeByTwinID(id)
 if err != nil {
  log.Fatal().Err(err).Msg("failed to get node from registrar")
 }
 log.Info().Any("node", node).Send()

List Nodes

 nodes, err := c.ListNodes(client.ListNodesWithFarmID(id))
 if err != nil {
  log.Fatal().Err(err).Msg("failed to list nodes from registrar")
 }
 log.Info().Any("node", node[0]).Send()

Update Node

 err := c.UpdateNode(client.UpdateNodesWithLocation(location))
 if err != nil {
  log.Fatal().Err(err).Msg("failed to update node location on the registrar")
 }
 log.Info().Msg("node updated successfully")

Update Node Uptime

 err := c.ReportUptime(report)
 if err != nil {
  log.Fatal().Err(err).Msg("failed to update node uptime in the registrar")
 }
 log.Info().Msg("node uptime is updated successfully")