Merge pull request #3 from ava-labs/cleanup

Cleanup

Author: patrick-ogrady

.gitignore

@@ -47,3 +47,5 @@ db*
 bin/
 build/
 vendor
+
+.quark-cli-pk

README.md

@@ -18,7 +18,7 @@ Build quarkvm:
 cd ${HOME}/go/src/github.com/ava-labs/quarkvm
 ./scripts/build.sh
 ```
-
+## TODO: MIGRATE TO USING AVA-SIM
 *Step 1.* To interact with Avalanche network RPC chain APIs, download and run a [AvalancheGo](https://github.com/ava-labs/avalanchego#installation) node locally, as follows:
 
 ```bash
@@ -135,18 +135,15 @@ curl --location --request POST '127.0.0.1:9650/ext/P' \
 #
 ```
 
-Connect to quarkvm:
+*Step 7.* Interact with quarkVM using quark-cli:
 
 ```bash
-curl --location --request POST '127.0.0.1:9650/ext/vm/tGas3T58KzdjLHhBDMnH2TvrddhqTji5iZAMZ3RXs2NLpSnhH' \
---header 'Content-Type: application/json' \
---data-raw '{
-    "jsonrpc":"2.0",
-    "id"     :1,
-    "method" :"quarkvm.put",
-    "params" :{
-        "key":"foo",
-        "value":"bar"
-    }
-}'
+# TODO: add config file/env for key location and/or RPC
+quark-cli create
+quark-cli claim jim.avax
+quark-cli set jim.avax/twitter @jimbo
+quark-cli lifeline jim.avax
+quark-cli get jim.avax/twitter
+quark-cli info jim.avax (remaining life, num keys, claimed/unclaimed/expired)
+quark-cli keys jim.avax (get all keys values)
 ```

agent/agent.go

@@ -0,0 +1,55 @@
+package claim
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/ava-labs/quarkvm/cmd/quarkcli/create"
+
+	"github.com/fatih/color"
+	"github.com/spf13/cobra"
+)
+
+func init() {
+	cobra.EnablePrefixMatching = true
+}
+
+// NewCommand implements "quark-cli" command.
+func NewCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "claim [options] <prefix>",
+		Short: "Claims the given prefix",
+		Long: `
+Claims the given prefix.
+
+# "jim" is the prefix
+$ quark-cli claim jim
+
+`,
+		RunE: claimFunc,
+	}
+	return cmd
+}
+
+func claimFunc(cmd *cobra.Command, args []string) error {
+	pk, err := create.LoadPK()
+	if err != nil {
+		return err
+	}
+	color.Green("loaded address %s", pk.PublicKey().Address())
+	p := getClaimOp(args)
+	fmt.Println("NOT IMPLEMENTED YET:", p)
+	// get difficulty/blockhash to target
+	// mine
+	// submit -> wait -> re-mine
+	return nil
+}
+
+func getClaimOp(args []string) (prefix string) {
+	if len(args) != 1 {
+		fmt.Fprintf(os.Stderr, "expected one argument, got %d\n", len(args))
+		os.Exit(128)
+	}
+
+	return args[0]
+}

cmd/quarkcli/claim/claim.go

@@ -0,0 +1,84 @@
+package create
+
+import (
+	"errors"
+	"fmt"
+	"os"
+	"path"
+
+	"github.com/ava-labs/quarkvm/crypto/ed25519"
+
+	"github.com/fatih/color"
+	"github.com/spf13/cobra"
+)
+
+const (
+	privateKeyFile = ".quark-cli-pk"
+)
+
+func init() {
+	cobra.EnablePrefixMatching = true
+}
+
+// NewCommand implements "quark-cli" command.
+func NewCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "create [options]",
+		Short: "Creates a new key in the default location",
+		Long: `
+Creates a new key in the default location.
+
+$ quark-cli create
+
+`,
+		RunE: createFunc,
+	}
+	return cmd
+}
+
+func getPKLocation() (string, error) {
+	p, err := os.Getwd()
+	if err != nil {
+		return "", err
+	}
+	return path.Join(p, privateKeyFile), nil
+}
+
+// TODO: run before all functions (erroring if can't load)
+func LoadPK() (ed25519.PrivateKey, error) {
+	pkLocation, err := getPKLocation()
+	if err != nil {
+		return nil, err
+	}
+
+	pk, err := os.ReadFile(pkLocation)
+	if err != nil {
+		return nil, err
+	}
+	return ed25519.LoadPrivateKey(pk)
+}
+
+func createFunc(cmd *cobra.Command, args []string) error {
+	// Error if key already exists
+	pkLocation, err := getPKLocation()
+	if err != nil {
+		return err
+	}
+	if _, err := os.Stat(pkLocation); err == nil {
+		return fmt.Errorf("file already exists at %s", pkLocation)
+	} else if !errors.Is(err, os.ErrNotExist) {
+		return err
+	}
+
+	// Generate new key and save to disk
+	// TODO: encrypt key
+	pk, err := ed25519.NewPrivateKey()
+	if err != nil {
+		return err
+	}
+	if err := os.WriteFile(pkLocation, pk.Bytes(), 0644); err != nil {
+		return err
+	}
+	color.Green("created address %s and saved to %s", pk.PublicKey().Address(), pkLocation)
+	return nil
+}

cmd/quarkcli/create/create.go

@@ -1,22 +1,23 @@
 // Copyright (C) 2019-2021, Ava Labs, Inc. All rights reserved.
 // See the file LICENSE for licensing terms.
 
-// quarkvmctl is a set of quarkvm client commands
-// to interact with KVVM servers.
 package main
 
 import (
 	"fmt"
 	"os"
 
-	"github.com/ava-labs/quarkvm/cmd/quarkvmctl/put"
+	"github.com/ava-labs/quarkvm/cmd/quarkcli/claim"
+	"github.com/ava-labs/quarkvm/cmd/quarkcli/create"
+	"github.com/ava-labs/quarkvm/cmd/quarkcli/put"
+
 	"github.com/spf13/cobra"
 )
 
 var rootCmd = &cobra.Command{
-	Use:        "quarkvmctl",
-	Short:      "Quark KVVM client CLI",
-	SuggestFor: []string{"quarkvm-ctl"},
+	Use:        "quark-cli",
+	Short:      "QuarkVM client CLI",
+	SuggestFor: []string{"quark-cli"},
 }
 
 func init() {
@@ -25,13 +26,15 @@ func init() {
 
 func init() {
 	rootCmd.AddCommand(
+		create.NewCommand(),
+		claim.NewCommand(),
 		put.NewCommand(),
 	)
 }
 
 func main() {
 	if err := rootCmd.Execute(); err != nil {
-		fmt.Fprintf(os.Stderr, "quarkvmctl failed %v\n", err)
+		fmt.Fprintf(os.Stderr, "quark-cli failed %v\n", err)
 		os.Exit(1)
 	}
 	os.Exit(0)