refactor registrar cli

Author: Eslam-Nawara

go.work.sum

@@ -38,25 +38,22 @@ github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8
 github.com/swaggo/swag v1.16.4 h1:clWJtd9LStiG3VeijiCfOVODP6VpHtKdQy9ELFG3s1A=
 github.com/swaggo/swag v1.16.4/go.mod h1:VBsHJRsDvfYvqoiMKnsdwhNV9LEMHgEDZcyVYX0sxPg=
 github.com/urfave/cli/v2 v2.3.0/go.mod h1:LJmUH05zAU44vOAcrfzZQKsZbVcdbOG8rtL3/XcUArI=
+github.com/vedhavyas/go-subkey v1.0.3 h1:iKR33BB/akKmcR2PMlXPBeeODjWLM90EL98OrOGs8CA=
+github.com/vedhavyas/go-subkey v1.0.3/go.mod h1:CloUaFQSSTdWnINfBRFjVMkWXZANW+nd8+TI5jYcl6Y=
 golang.org/x/arch v0.0.0-20210923205945-b76863e36670/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8=
 golang.org/x/arch v0.8.0/go.mod h1:FEVrYAQjsQXMVJ1nsMoVVXPZg6p2JE2mx8psSWTDQys=
-golang.org/x/crypto v0.1.0/go.mod h1:RecgLatLF4+eUMCP1PoPZQb+cVrJcOPbHkTkbkB9sbw=
 golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8=
+golang.org/x/crypto v0.28.0 h1:GBDwsMXVQi34v5CCYUm2jkJvu4cbtru2U4TN2PSyQnw=
 golang.org/x/crypto v0.31.0 h1:ihbySMvVjLAeSH1IbfcRTkD/iNscyz8rGzjF/E5hV6U=
 golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk=
 golang.org/x/mod v0.9.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
 golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
-golang.org/x/mod v0.18.0 h1:5+9lSbEzPSdWkH32vYPBwEpX8KwDbM52Ud9xBUvNlb0=
 golang.org/x/mod v0.18.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
-golang.org/x/mod v0.21.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY=
 golang.org/x/net v0.0.0-20210421230115-4e50805a0758/go.mod h1:72T/g9IO56b78aLF+1Kcs5dz7/ng1VjMUvfKvpfy+jM=
 golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44=
 golang.org/x/net v0.23.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg=
-golang.org/x/net v0.25.0 h1:d/OCCoBEUq33pjydKrGQhw7IlUPI2Oylr+8qLx49kac=
 golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
 golang.org/x/net v0.26.0/go.mod h1:5YKkiSynbBIh3p6iOc/vibscux0x38BZDkn8sCUPxHE=
-golang.org/x/net v0.30.0 h1:AcW1SDZMkb8IpzCdQUaIq2sP4sZ4zw+55h6ynffypl4=
-golang.org/x/net v0.30.0/go.mod h1:2wGyMJ5iFasEhkwi13ChkO/t1ECNC4X4eBKkVFyYFlU=
 golang.org/x/net v0.31.0/go.mod h1:P4fl1q7dY2hnZFxEk4pPSkDHF+QqjitcnDjUQyMM+pM=
 golang.org/x/net v0.33.0 h1:74SYHlV8BIgHIFC/LrYkOGIwL19eTYXQ5wc6TBuO36I=
 golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4=

node-registrar/tools/farm/README.md

@@ -1,38 +1,49 @@
 # New Farm Tool
 
 ## Overview
+
 This tool allows users to create a farm account on a specified network.
 
 ## Installation
+
 1. Clone the repository:
+
    ```sh
    git clone https://github.com/threefoldtech/tfgrid4-sdk-go
    ```
+
 2. Navigate to the project directory:
+
    ```sh
    cd tfgrid4-sdk-go/node-registrar/tools/farm
    ```
+
 3. Build the application:
+
    ```sh
    go build -o new-farm main.go
    ```
 
 ## Usage
+
 ```sh
-./new-farm -seed <seed> -network <network> -farm_name <farm_name>
+./new-farm -seed <seed> -network <network> -farm-name <farm-name>
 ```
 
 ### Parameters
+
 - `-seed`  (required): A hexadecimal string used as a private key seed.
 - `-network` (required): Specifies the network (`dev`, `qa`, `test`, `main`).
-- `-farm_name` (required): The name of the farm to create.
+- `-farm-name` (required): The name of the farm to create.
 
 ### Example Usage
+
 ```sh
-./new-farm -seed aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899 -network dev -farm_name MyFarm
+./new-farm -seed aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899 -network dev -farm-name MyFarm
 ```
+
 The `FarmID` (e.g., `11`) is returned upon successful farm creation.
 
 ## Next Step
 
-Once this is done, you can create a V4 bootstrap image using the V4 Zero-OS Boot Generator: https://v4.bootstrap.grid.tf/.
+Once this is done, you can create a V4 bootstrap image using the V4 Zero-OS Boot Generator: <https://v4.bootstrap.grid.tf/>.

node-registrar/tools/farm/main.go

@@ -29,7 +29,7 @@ func main() {
 
 	flag.StringVar(&seed, "seed", "", "seed")
 	flag.StringVar(&network, "network", "", "network (dev, qa, test, main)")
-	flag.StringVar(&name, "farm_name", "", "farm name")
+	flag.StringVar(&name, "farm-name", "", "farm name")
 	flag.Parse()
 
 	u, ok := urls[network]

registrar-cli/README.md

@@ -61,7 +61,7 @@ Account command represents events on account on Threefold grid4
 ➜  ./registrar-cli account get --network dev --twin-id 33
 5:00PM INF account={"public_key":"w5TYTeB/rCskd1iNrOKaFlpGn+Cp28gFZobTNABUv50=","relays":[],"rmb_enc_key":"","twin_id":33}
 ➜
-➜  ./registrar-cli account get --network dev --public-key <public-key> 
+➜  ./registrar-cli account get --network dev --public-key <public-key>
 5:01PM INF account={"public_key":"w5TYTeB/rCskd1iNrOKaFlpGn+Cp28gFZobTNABUv50=","relays":[],"rmb_enc_key":"","twin_id":33}
 ```
 
@@ -92,7 +92,7 @@ Farm command represents events on farms on Threefold grid4
 
 **Flags**:
 
-- `--farm_name` (required): The name of the farm to create.
+- `--farm-name` (required): The name of the farm to create.
 - `--network` (required): Specifies the network (`dev`, `qa`, `test`, `main`).
 - `--mnemonic`  (required): Account mnemonic.
 - `--dedicated` (optional default: false): is the farm dedicated.
@@ -125,7 +125,7 @@ Farm command represents events on farms on Threefold grid4
 - `--network` (required): Specifies the network (`dev`, `qa`, `test`, `main`).
 - `--mnemonic`  (required): Account mnemonic.
 - `--farm-id` (optional): id of the farm needed to be loaded.
-- `--farm_name` (optional): The new name of the farm.
+- `--farm-name` (optional): The new name of the farm.
 - `--dedicated` (optional): update the farm to dedicated.
 
 **Example Usage**:

registrar-cli/cmd/account_create.go

@@ -2,6 +2,7 @@
 package cmd
 
 import (
+	"github.com/pkg/errors"
 	"github.com/rs/zerolog/log"
 	"github.com/spf13/cobra"
 	"github.com/threefoldtech/tfgrid4-sdk-go/registrar-cli/internal/cmd"
@@ -14,12 +15,12 @@ var accountCreateCmd = &cobra.Command{
 	RunE: func(cobraCmd *cobra.Command, args []string) error {
 		mnemonic, err := cobraCmd.Flags().GetString("mnemonic")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get mnemonic flag")
 		}
 
 		network, err := cobraCmd.Flags().GetString("network")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get network flag")
 		}
 
 		relays, err := cobraCmd.Flags().GetStringArray("relays")
@@ -34,12 +35,10 @@ var accountCreateCmd = &cobra.Command{
 
 		account, mnemonic, err := cmd.CreateAccount(network, relays, rmbEncKey, mnemonic)
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to create account")
 		}
 		log.Info().Str("mnemonic", mnemonic).Msg("new account is created with mnemonic")
-
 		log.Info().Uint64("twinID", account.TwinID).Msg("account is created successfully")
-
 		return nil
 	},
 }

registrar-cli/cmd/account_get.go

@@ -2,6 +2,7 @@
 package cmd
 
 import (
+	"github.com/pkg/errors"
 	"github.com/rs/zerolog/log"
 	"github.com/spf13/cobra"
 	"github.com/threefoldtech/tfgrid4-sdk-go/registrar-cli/internal/cmd"
@@ -14,26 +15,25 @@ var accountGetCmd = &cobra.Command{
 	RunE: func(cobraCmd *cobra.Command, args []string) error {
 		network, err := cobraCmd.Flags().GetString("network")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get network flag")
 		}
 
 		twinID, err := cobraCmd.Flags().GetUint64("twin-id")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get twin-id flag")
 		}
 
 		pk, err := cobraCmd.Flags().GetString("public-key")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get public-key flag")
 		}
 
 		account, err := cmd.GetAccount(network, twinID, pk)
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get account")
 		}
 
 		log.Info().Any("account", account).Send()
-
 		return nil
 	},
 }

registrar-cli/cmd/farm_create.go

@@ -2,6 +2,7 @@
 package cmd
 
 import (
+	"github.com/pkg/errors"
 	"github.com/rs/zerolog/log"
 	"github.com/spf13/cobra"
 	"github.com/threefoldtech/tfgrid4-sdk-go/registrar-cli/internal/cmd"
@@ -14,36 +15,48 @@ var farmCreateCmd = &cobra.Command{
 	RunE: func(cobraCmd *cobra.Command, args []string) error {
 		mnemonic, err := cobraCmd.Flags().GetString("mnemonic")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get mnemonic flag")
 		}
 
 		network, err := cobraCmd.Flags().GetString("network")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get network flag")
 		}
 
 		farmName, err := cobraCmd.Flags().GetString("farm-name")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get farm-name flag")
 		}
 
-		stellarAddrss, err := cobraCmd.Flags().GetString("stellar-address")
+		stellarAddress, err := cobraCmd.Flags().GetString("stellar-address")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get stellar-address flag")
 		}
 
 		dedicated, err := cobraCmd.Flags().GetBool("dedicated")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get dedicated flag")
 		}
 
-		farmID, err := cmd.CreateFarm(mnemonic, network, farmName, stellarAddrss, dedicated)
+		// Validate required inputs
+		if farmName == "" {
+			return errors.New("farm name is required (use --farm-name flag)")
+		}
+
+		if network == "" {
+			return errors.New("network is required (use --network flag)")
+		}
+
+		if mnemonic == "" {
+			return errors.New("mnemonic is required (use --mnemonic flag)")
+		}
+
+		farmID, err := cmd.CreateFarm(mnemonic, network, farmName, stellarAddress, dedicated)
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to create farm")
 		}
 
 		log.Info().Uint64("farmID", farmID).Msg("farm is created successfully")
-
 		return nil
 	},
 }

registrar-cli/cmd/farm_get.go

@@ -2,8 +2,7 @@
 package cmd
 
 import (
-	"fmt"
-
+	"github.com/pkg/errors"
 	"github.com/rs/zerolog/log"
 	"github.com/spf13/cobra"
 	"github.com/threefoldtech/tfgrid4-sdk-go/registrar-cli/internal/cmd"
@@ -16,21 +15,21 @@ var farmGetCmd = &cobra.Command{
 	RunE: func(cobraCmd *cobra.Command, args []string) error {
 		network, err := cobraCmd.Flags().GetString("network")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get network flag")
 		}
 
 		farmID, err := cobraCmd.Flags().GetUint64("farm-id")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get farm-id flag")
 		}
 
 		if farmID == 0 {
-			return fmt.Errorf("you need to provide farm id to load a farm")
+			return errors.New("farm id is required (use --farm-id flag with a non-zero value)")
 		}
 
 		farm, err := cmd.GetFarm(network, farmID)
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get farm")
 		}
 
 		log.Info().Any("farm", farm).Send()

registrar-cli/cmd/farm_update.go

@@ -2,6 +2,7 @@
 package cmd
 
 import (
+	"github.com/pkg/errors"
 	"github.com/rs/zerolog/log"
 	"github.com/spf13/cobra"
 	"github.com/threefoldtech/tfgrid4-sdk-go/registrar-cli/internal/cmd"
@@ -14,41 +15,40 @@ var farmUpdateCmd = &cobra.Command{
 	RunE: func(cobraCmd *cobra.Command, args []string) error {
 		mnemonic, err := cobraCmd.Flags().GetString("mnemonic")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get mnemonic flag")
 		}
 
 		network, err := cobraCmd.Flags().GetString("network")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get network flag")
 		}
 
 		farmID, err := cobraCmd.Flags().GetUint64("farm-id")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get farm-id flag")
 		}
 
 		farmName, err := cobraCmd.Flags().GetString("farm-name")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get farm-name flag")
 		}
 
-		stellarAddrss, err := cobraCmd.Flags().GetString("stellar-address")
+		stellarAddress, err := cobraCmd.Flags().GetString("stellar-address")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get stellar-address flag")
 		}
 
 		dedicated, err := cobraCmd.Flags().GetBool("dedicated")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get dedicated flag")
 		}
 
-		err = cmd.UpdateFarm(farmID, mnemonic, network, farmName, stellarAddrss, dedicated)
+		err = cmd.UpdateFarm(farmID, mnemonic, network, farmName, stellarAddress, dedicated)
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to update farm")
 		}
 
 		log.Info().Msg("farm is updated successfully")
-
 		return nil
 	},
 }

registrar-cli/cmd/node_get.go

@@ -2,6 +2,7 @@
 package cmd
 
 import (
+	"github.com/pkg/errors"
 	"github.com/rs/zerolog/log"
 	"github.com/spf13/cobra"
 	"github.com/threefoldtech/tfgrid4-sdk-go/registrar-cli/internal/cmd"
@@ -14,26 +15,25 @@ var nodeGetCmd = &cobra.Command{
 	RunE: func(cobraCmd *cobra.Command, args []string) error {
 		network, err := cobraCmd.Flags().GetString("network")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get network flag")
 		}
 
 		nodeID, err := cobraCmd.Flags().GetUint64("node-id")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get node-id flag")
 		}
 
 		twinID, err := cobraCmd.Flags().GetUint64("twin-id")
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get twin-id flag")
 		}
 
 		node, err := cmd.GetNode(network, nodeID, twinID)
 		if err != nil {
-			return err
+			return errors.Wrap(err, "failed to get node")
 		}
 
 		log.Info().Any("node", node).Send()
-
 		return nil
 	},
 }