Skip to main content

Key Management

Abstract​

The greenfield-cosmos-sdk comes with a built-in keyring module that helps manage private and public keypairs for secure interactions with a node. In this tutorial, we'll explore how to use the gnfd command to manage keys in the greenfield-cosmos-sdk.

Quick Start​

Create a New Key​

You can use add to create a new key with the name you want to use.

gnfd keys add ${name}

You can replace ${name} with any name you choose. The command will prompt you to enter a passphrase to encrypt the key.

Show a Key​

To show information about the key you just created, you can run:

gnfd keys show ${name}

List All Keys​

To list all existing keys, you can run:

gnfd keys list

Delete a Key​

To delete a key, you can use the following command:

gnfd keys delete ${name}

Detailed CLI​

The following section explains the different commands that can be used with the gnfd command to manage keys.

add​

The add command allows users to add a new key with specified name, encrypt it, and save to ${name} file.

gnfd keys add ${name} [flags]

Example:

gnfd keys add temp

Example Output:

- address: 0x48D54D...48b6d2
  name: temp
  pubkey: '{"@type":"/ethermint.crypto.v1.ethsecp256k1.PubKey","key":"AqAzVo.../rZgIu"}'
  pubkey_hex: 02a03356...eb66022e
  type: local

**Important** write this mnemonic phrase in a safe place.
It is the only way to recover your account if you ever forget your password.

position number holiday ... cause bounce mercy

delete​

The delete command allows users to delete given keys.

gnfd keys delete ${name}... [flags]

Example:

gnfd keys delete temp

Example Output:

Key reference will be deleted. Continue? [y/N]: y
Key deleted forever (uh oh!)

export​

The export command allows users to export private keys.

gnfd keys export ${name} [flags]

Example:

gnfd keys export temp

Example Output:

Enter passphrase to encrypt the exported key:

-----BEGIN TENDERMINT PRIVATE KEY-----
type: eth_secp256k1
kdf: bcrypt
salt: D4AEA1...36B597

3tvq8w39N...pTwLRdgVGI=
=Wfrn
-----END TENDERMINT PRIVATE KEY-----

import​

The import command allows users to import private keys.

gnfd keys import ${name} <keyfile> [flags]

Example:

gnfd keys import temp temp.info

list​

The list command allows users to list all existed keys.

gnfd keys list [flags]

Example:

gnfd keys list

Example Output:

- address: 0xA627c3...B61dF7
  name: temp
  pubkey: '{"@type":"/ethermint.crypto.v1.ethsecp256k1.PubKey","key":"AhJl...0t8hJC"}'
  pubkey_hex: 021265c6...2df21242
  type: local

migrate​

The migrate command can migrate keys from amino to proto serialization format.

gnfd keys migrate [flags]

Example:

gnfd keys migrate

mnemonic​

The mnemonic command can compute the bip39 mnemonic for some input entropy.

gnfd keys mnemonic [flags]

Example:

gnfd keys mnemonic

Example Output:

bridge bleak zebra ... gym quick antique

rename​

The rename command allows users to rename an existed key.

gnfd keys rename <old_name> <new_name> [flags]

Example:

gnfd keys rename temp new_name

Example Output:

Key reference will be renamed from temp to new_name. Continue? [y/N]: y
Key was successfully renamed from temp to new_name

show​

The show command allows users to retrieve key information by name or address.

gnfd keys show [name_or_address [name_or_address...]] [flags]

Example:

gnfd keys show temp

Example Output:

- address: 0xA627c3...B61dF7
  name: temp
  pubkey: '{"@type":"/ethermint.crypto.v1.ethsecp256k1.PubKey","key":"AhJl...0t8hJC"}'
  pubkey_hex: 021265c6...2df21242
  type: local