[Tooling] SLIP-0010 HD Child Key Generation (#510)

## Description

This PR contains an implementation of
[SLIP-0010](https://github.com/satoshilabs/slips/blob/master/slip-0010.md)
which allows for deterministic child key generation from a master key.
This is done by using the seed of the master key and creating a `hmac`
hash using the `sha512` hashing function. The hash is split into 2
`[]byte` slices representing the `SecretKey` and the `ChainCode`.

This `hmac` key can then be used to deterministically generate keys
within the BIP-44 path `m/44'/635'/%d'`. `44` referring to the BIP-44
hardened key purpose of the path and `635'` is the coin type for Pocket
Network. `%d` can be any number between `0-2147483647` inclusive.
Allowing for a large number of child keys to be deterministically
generated and retrieved by index from a single master key's seed.

_NOTE_ All the child keys are ed25519 keys created from the `SecretKey`
of the SLIP HMAC keypair. They are then converted into an encrypted
`KeyPair` interface following the same pattern already found in the
keybase.

Some documentation on this process can be seen
[here](https://github.com/pokt-network/pocket/blob/slip-0010-keys/shared/crypto/README.md#slip-0010-hd-child-key-generation)

The complete test vectors from the SLIP-0010 spec are included in
`slip_test.go` as well as some pokt specific test cases.

The `DeriveChild` CLI endpoint has also been added to allow to end users
to use the SLIP integration.

## Issue

Fixes N/A

## Type of change

Please mark the relevant option(s):

- [x] New feature, functionality or library
- [ ] Bug fix
- [ ] Code health or cleanup
- [ ] Major breaking change
- [x] Documentation
- [ ] Other <!-- add details here if it a different type of change -->

## List of changes

- Implement SLIP-0010
- Integrate child key generation with the keybase
- Add unit tests for child generation and to cover the SLIP-0010 spec
test vectors
- Add CLI endpoint `DeriveChild`
- Update documentation

## Testing

- [x] `make develop_test`
- [x]
[LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md)
w/ all of the steps outlined in the `README`

## Required Checklist

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have tested my changes using the available tooling
- [x] I have updated the corresponding CHANGELOG

### If Applicable Checklist

- [x] I have updated the corresponding README(s); local and/or global
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] I have added, or updated,
[mermaid.js](https://mermaid-js.github.io) diagrams in the corresponding
README(s)
- [ ] I have added, or updated, documentation and
[mermaid.js](https://mermaid-js.github.io) diagrams in `shared/docs/*`
if I updated `shared/*`README(s)

app/client/cli/keys.go

@@ -10,6 +10,7 @@ import (
 	"github.com/pokt-network/pocket/shared/crypto"
 	utilTypes "github.com/pokt-network/pocket/utility/types"
 	"path/filepath"
+	"strconv"
 	"strings"
 
 	"github.com/pokt-network/pocket/app/client/keybase"
@@ -23,6 +24,9 @@ var (
 	importAs   string
 	hint       string
 	newPwd     string
+	storeChild bool
+	childPwd   string
+	childHint  string
 )
 
 func init() {
@@ -45,6 +49,7 @@ func NewKeysCommand() *cobra.Command {
 	importCmds := keysImportCommands()
 	signMsgCmds := keysSignMsgCommands()
 	signTxCmds := keysSignTxCommands()
+	slipCmds := keysSlipCommands()
 
 	// Add --pwd and --hint flags
 	applySubcommandOptions(createCmds, attachPwdFlagToSubcommands())
@@ -77,6 +82,12 @@ func NewKeysCommand() *cobra.Command {
 	applySubcommandOptions(signTxCmds, attachInputFlagToSubcommands())
 	applySubcommandOptions(signTxCmds, attachOutputFlagToSubcommands())
 
+	// Add --pwd, --store_child, --child_pwd, --child_hint flags
+	applySubcommandOptions(slipCmds, attachPwdFlagToSubcommands())
+	applySubcommandOptions(slipCmds, attachStoreChildFlagToSubcommands())
+	applySubcommandOptions(slipCmds, attachChildPwdFlagToSubcommands())
+	applySubcommandOptions(slipCmds, attachChildHintFlagToSubcommands())
+
 	cmd.AddCommand(createCmds...)
 	cmd.AddCommand(updateCmds...)
 	cmd.AddCommand(deleteCmds...)
@@ -85,6 +96,7 @@ func NewKeysCommand() *cobra.Command {
 	cmd.AddCommand(importCmds...)
 	cmd.AddCommand(signMsgCmds...)
 	cmd.AddCommand(signTxCmds...)
+	cmd.AddCommand(slipCmds...)
 
 	return cmd
 }
@@ -680,3 +692,53 @@ func keysSignTxCommands() []*cobra.Command {
 	}
 	return cmds
 }
+
+func keysSlipCommands() []*cobra.Command {
+	cmds := []*cobra.Command{
+		{
+			Use:     "DeriveChild <parentAddrHex> <index>",
+			Short:   "Derive the child key at the given index from a parent key",
+			Long:    "Derive the child key at <index> from the parent key provided optionally store it in the keybase with [--store_child]",
+			Aliases: []string{"derivechild"},
+			Args:    cobra.ExactArgs(2),
+			RunE: func(cmd *cobra.Command, args []string) error {
+				// Unpack CLI args
+				parentAddr := args[0]
+				idx64, err := strconv.ParseUint(args[1], 10, 32)
+				if err != nil {
+					return err
+				}
+				index := uint32(idx64)
+
+				// Open the debug keybase at the specified path
+				pocketDir := strings.TrimSuffix(dataDir, "/")
+				keybasePath, err := filepath.Abs(pocketDir + keybaseSuffix)
+				if err != nil {
+					return err
+				}
+				kb, err := keybase.NewKeybase(keybasePath)
+				if err != nil {
+					return err
+				}
+
+				if !nonInteractive {
+					pwd = readPassphrase(pwd)
+				}
+
+				kp, err := kb.DeriveChildFromKey(parentAddr, pwd, index, childPwd, childHint, storeChild)
+				if err != nil {
+					return err
+				}
+
+				if err := kb.Stop(); err != nil {
+					return err
+				}
+
+				logger.Global.Info().Str("address", kp.GetAddressString()).Str("parent", parentAddr).Uint32("index", index).Bool("stored", storeChild).Msg("Child key derived")
+
+				return nil
+			},
+		},
+	}
+	return cmds
+}

app/client/cli/utils.go

@@ -220,6 +220,24 @@ func attachHintFlagToSubcommands() []cmdOption {
 	}}
 }
 
+func attachStoreChildFlagToSubcommands() []cmdOption {
+	return []cmdOption{func(c *cobra.Command) {
+		c.Flags().BoolVar(&storeChild, "store_child", true, "store the derived child key in the keybase")
+	}}
+}
+
+func attachChildHintFlagToSubcommands() []cmdOption {
+	return []cmdOption{func(c *cobra.Command) {
+		c.Flags().StringVar(&childHint, "child_hint", "", "hint for the passphrase of the derived child's private key")
+	}}
+}
+
+func attachChildPwdFlagToSubcommands() []cmdOption {
+	return []cmdOption{func(c *cobra.Command) {
+		c.Flags().StringVar(&childPwd, "child_pwd", "", "passphrase for the derived child's private key")
+	}}
+}
+
 func unableToConnectToRpc(err error) error {
 	fmt.Printf("❌ Unable to connect to the RPC @ %s\n\nError: %s", boldText(remoteCLIURL), err)
 	return nil

app/client/doc/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.0.18] - 2023-02-28
+
+- Implement SLIP-0010 HD child key derivation with the keybase
+- Add CLI endpoints to derive child keys by index
+
 ## [0.0.0.17] - 2023-02-23
 
 - Add CLI endpoints to interact with the keybase

app/client/doc/commands/client.md

@@ -28,4 +28,4 @@ The CLI is meant to be an user but also a machine friendly way for interacting w
 * [client Validator](client_Validator.md)	 - Validator actor specific commands
 * [client debug](client_debug.md)	 - Debug utility for rapid development
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Account.md

@@ -21,4 +21,4 @@ Account specific commands
 * [client](client.md)	 - Pocket Network Command Line Interface (CLI)
 * [client Account Send](client_Account_Send.md)	 - Send <fromAddr> <to> <amount>
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Account_Send.md

@@ -29,4 +29,4 @@ client Account Send <fromAddr> <to> <amount> [flags]
 
 * [client Account](client_Account.md)	 - Account specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Application.md

@@ -24,4 +24,4 @@ Application actor specific commands
 * [client Application Unpause](client_Application_Unpause.md)	 - Unpause <fromAddr>
 * [client Application Unstake](client_Application_Unstake.md)	 - Unstake <fromAddr>
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Application_EditStake.md

@@ -29,4 +29,4 @@ client Application EditStake <fromAddr> <amount> <relayChainIDs> <serviceURI> [f
 
 * [client Application](client_Application.md)	 - Application actor specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Application_Stake.md

@@ -37,4 +37,4 @@ client Application Stake <fromAddr> <amount> <relayChainIDs> <serviceURI> [flags
 
 * [client Application](client_Application.md)	 - Application actor specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Application_Unpause.md

@@ -29,4 +29,4 @@ client Application Unpause <fromAddr> [flags]
 
 * [client Application](client_Application.md)	 - Application actor specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Application_Unstake.md

@@ -29,4 +29,4 @@ client Application Unstake <fromAddr> [flags]
 
 * [client Application](client_Application.md)	 - Application actor specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Consensus.md

@@ -24,4 +24,4 @@ Consensus specific commands
 * [client Consensus State](client_Consensus_State.md)	 - Returns "Height/Round/Step"
 * [client Consensus Step](client_Consensus_Step.md)	 - Returns the Step
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Consensus_Height.md

@@ -28,4 +28,4 @@ client Consensus Height [flags]
 
 * [client Consensus](client_Consensus.md)	 - Consensus specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Consensus_Round.md

@@ -28,4 +28,4 @@ client Consensus Round [flags]
 
 * [client Consensus](client_Consensus.md)	 - Consensus specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Consensus_State.md

@@ -28,4 +28,4 @@ client Consensus State [flags]
 
 * [client Consensus](client_Consensus.md)	 - Consensus specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Consensus_Step.md

@@ -28,4 +28,4 @@ client Consensus Step [flags]
 
 * [client Consensus](client_Consensus.md)	 - Consensus specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Fisherman.md

@@ -24,4 +24,4 @@ Fisherman actor specific commands
 * [client Fisherman Unpause](client_Fisherman_Unpause.md)	 - Unpause <fromAddr>
 * [client Fisherman Unstake](client_Fisherman_Unstake.md)	 - Unstake <fromAddr>
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Fisherman_EditStake.md

@@ -29,4 +29,4 @@ client Fisherman EditStake <fromAddr> <amount> <relayChainIDs> <serviceURI> [fla
 
 * [client Fisherman](client_Fisherman.md)	 - Fisherman actor specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Fisherman_Stake.md

@@ -37,4 +37,4 @@ client Fisherman Stake <fromAddr> <amount> <relayChainIDs> <serviceURI> [flags]
 
 * [client Fisherman](client_Fisherman.md)	 - Fisherman actor specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Fisherman_Unpause.md

@@ -29,4 +29,4 @@ client Fisherman Unpause <fromAddr> [flags]
 
 * [client Fisherman](client_Fisherman.md)	 - Fisherman actor specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Fisherman_Unstake.md

@@ -29,4 +29,4 @@ client Fisherman Unstake <fromAddr> [flags]
 
 * [client Fisherman](client_Fisherman.md)	 - Fisherman actor specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Governance.md

@@ -21,4 +21,4 @@ Governance specific commands
 * [client](client.md)	 - Pocket Network Command Line Interface (CLI)
 * [client Governance ChangeParameter](client_Governance_ChangeParameter.md)	 - ChangeParameter <owner> <key> <value>
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Governance_ChangeParameter.md

@@ -29,4 +29,4 @@ client Governance ChangeParameter <owner> <key> <value> [flags]
 
 * [client Governance](client_Governance.md)	 - Governance specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Keys.md

@@ -21,6 +21,7 @@ Key specific commands
 * [client](client.md)	 - Pocket Network Command Line Interface (CLI)
 * [client Keys Create](client_Keys_Create.md)	 - Create new key
 * [client Keys Delete](client_Keys_Delete.md)	 - Deletes the key from the keybase
+* [client Keys DeriveChild](client_Keys_DeriveChild.md)	 - Derive the child key at the given index from a parent key
 * [client Keys Export](client_Keys_Export.md)	 - Exports the private key as a raw string or JSON to either STDOUT or to a file
 * [client Keys Get](client_Keys_Get.md)	 - Get the address and public key from the keybase
 * [client Keys Import](client_Keys_Import.md)	 - Imports a key from a string or from a file
@@ -31,4 +32,4 @@ Key specific commands
 * [client Keys Verify](client_Keys_Verify.md)	 - Verifies the signature is valid from the signer
 * [client Keys VerifyTx](client_Keys_VerifyTx.md)	 - Verifies the transaction's signature is valid from the signer
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Keys_Create.md

@@ -30,4 +30,4 @@ client Keys Create [flags]
 
 * [client Keys](client_Keys.md)	 - Key specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Keys_Delete.md

@@ -29,4 +29,4 @@ client Keys Delete <addrHex> [flags]
 
 * [client Keys](client_Keys.md)	 - Key specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Keys_DeriveChild.md

@@ -0,0 +1,35 @@
+## client Keys DeriveChild
+
+Derive the child key at the given index from a parent key
+
+### Synopsis
+
+Derive the child key at <index> from the parent key provided optionally store it in the keybase with [--store_child]
+
+```
+client Keys DeriveChild <parentAddrHex> <index> [flags]
+```
+
+### Options
+
+```
+      --child_hint string   hint for the passphrase of the derived child's private key
+      --child_pwd string    passphrase for the derived child's private key
+  -h, --help                help for DeriveChild
+      --pwd string          passphrase used by the cmd, non empty usage bypass interactive prompt
+      --store_child         store the derived child key in the keybase (default true)
+```
+
+### Options inherited from parent commands
+
+```
+      --data_dir string         Path to store pocket related data (keybase etc.) (default "/home/harry/.pocket")
+      --non_interactive         if true skips the interactive prompts wherever possible (useful for scripting & automation)
+      --remote_cli_url string   takes a remote endpoint in the form of <protocol>://<host> (uses RPC Port) (default "http://localhost:50832")
+```
+
+### SEE ALSO
+
+* [client Keys](client_Keys.md)	 - Key specific commands
+
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Keys_Export.md

@@ -31,4 +31,4 @@ client Keys Export <addrHex> [--export_format] [--output_file] [flags]
 
 * [client Keys](client_Keys.md)	 - Key specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Keys_Get.md

@@ -28,4 +28,4 @@ client Keys Get <addrHex> [flags]
 
 * [client Keys](client_Keys.md)	 - Key specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Keys_Import.md

@@ -32,4 +32,4 @@ client Keys Import [privateKeyString] [--input_file] [--import_format] [flags]
 
 * [client Keys](client_Keys.md)	 - Key specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Keys_List.md

@@ -28,4 +28,4 @@ client Keys List [flags]
 
 * [client Keys](client_Keys.md)	 - Key specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Keys_Sign.md

@@ -29,4 +29,4 @@ client Keys Sign <addrHex> <messageHex> [flags]
 
 * [client Keys](client_Keys.md)	 - Key specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Keys_SignTx.md

@@ -31,4 +31,4 @@ client Keys SignTx <addrHex> [--input_file] [--output_file] [flags]
 
 * [client Keys](client_Keys.md)	 - Key specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Keys_Update.md

@@ -31,4 +31,4 @@ client Keys Update <addrHex> [--pwd] [--new_pwd] [--hint] [flags]
 
 * [client Keys](client_Keys.md)	 - Key specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Keys_Verify.md

@@ -29,4 +29,4 @@ client Keys Verify <addrHex> <messageHex> <signatureHex> [flags]
 
 * [client Keys](client_Keys.md)	 - Key specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Keys_VerifyTx.md

@@ -31,4 +31,4 @@ client Keys VerifyTx <addrHex> [--input_file] [flags]
 
 * [client Keys](client_Keys.md)	 - Key specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Servicer.md

@@ -24,4 +24,4 @@ Servicer actor specific commands
 * [client Servicer Unpause](client_Servicer_Unpause.md)	 - Unpause <fromAddr>
 * [client Servicer Unstake](client_Servicer_Unstake.md)	 - Unstake <fromAddr>
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Servicer_EditStake.md

@@ -29,4 +29,4 @@ client Servicer EditStake <fromAddr> <amount> <relayChainIDs> <serviceURI> [flag
 
 * [client Servicer](client_Servicer.md)	 - Servicer actor specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Servicer_Stake.md

@@ -37,4 +37,4 @@ client Servicer Stake <fromAddr> <amount> <relayChainIDs> <serviceURI> [flags]
 
 * [client Servicer](client_Servicer.md)	 - Servicer actor specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023

app/client/doc/commands/client_Servicer_Unpause.md

@@ -29,4 +29,4 @@ client Servicer Unpause <fromAddr> [flags]
 
 * [client Servicer](client_Servicer.md)	 - Servicer actor specific commands
 
-###### Auto generated by spf13/cobra on 23-Feb-2023
+###### Auto generated by spf13/cobra on 24-Feb-2023