mirror of
https://github.com/Chia-Network/chia-blockchain.git
synced 2024-09-21 16:41:14 +03:00
f2fe1dca62
* CLI support for performing an incremental keyring migration. This handles the case where new keys were created by an older client or the light wallet, and those keys then need to be moved to keyring.yaml. * Opportunistically perform a silent incremental keyring migration when the GUI unlocks the keyring. Track when keyring migration occurs so that we don't needlessly attempt on each GUI launch. ~/.chia_keys/.last_legacy_migration will contain the app version that last attempted migration. * Formatting & linter fixes * Tests for `chia keys migrate`. Missing a test for incremental migration. * Additional keyring migration tests * Formatting updates from black in files unrelated to this branch. * Revert "Formatting updates from black in files unrelated to this branch." This reverts commit a85030e8e0ea7406683efd8ae41e224c861e08ff. * Exit loop if remaining_keys <= 0 * Linter fix? Manually making this change as black doesn't identify any issues locally. * Linter fix again...
352 lines
11 KiB
Python
352 lines
11 KiB
Python
import click
|
|
|
|
from typing import Optional, Tuple
|
|
|
|
|
|
@click.group("keys", short_help="Manage your keys")
|
|
@click.pass_context
|
|
def keys_cmd(ctx: click.Context):
|
|
"""Create, delete, view and use your key pairs"""
|
|
from pathlib import Path
|
|
|
|
root_path: Path = ctx.obj["root_path"]
|
|
if not root_path.is_dir():
|
|
raise RuntimeError("Please initialize (or migrate) your config directory with chia init")
|
|
|
|
|
|
@keys_cmd.command("generate", short_help="Generates and adds a key to keychain")
|
|
@click.pass_context
|
|
def generate_cmd(ctx: click.Context):
|
|
from .init_funcs import check_keys
|
|
from .keys_funcs import generate_and_add
|
|
|
|
generate_and_add()
|
|
check_keys(ctx.obj["root_path"])
|
|
|
|
|
|
@keys_cmd.command("show", short_help="Displays all the keys in keychain")
|
|
@click.option(
|
|
"--show-mnemonic-seed", help="Show the mnemonic seed of the keys", default=False, show_default=True, is_flag=True
|
|
)
|
|
def show_cmd(show_mnemonic_seed):
|
|
from .keys_funcs import show_all_keys
|
|
|
|
show_all_keys(show_mnemonic_seed)
|
|
|
|
|
|
@keys_cmd.command("add", short_help="Add a private key by mnemonic")
|
|
@click.option(
|
|
"--filename",
|
|
"-f",
|
|
default=None,
|
|
help="The filename containing the secret key mnemonic to add",
|
|
type=str,
|
|
required=False,
|
|
)
|
|
@click.pass_context
|
|
def add_cmd(ctx: click.Context, filename: str):
|
|
from .init_funcs import check_keys
|
|
|
|
if filename:
|
|
from pathlib import Path
|
|
from .keys_funcs import add_private_key_seed
|
|
|
|
mnemonic = Path(filename).read_text().rstrip()
|
|
add_private_key_seed(mnemonic)
|
|
else:
|
|
from .keys_funcs import query_and_add_private_key_seed
|
|
|
|
query_and_add_private_key_seed()
|
|
check_keys(ctx.obj["root_path"])
|
|
|
|
|
|
@keys_cmd.command("delete", short_help="Delete a key by its pk fingerprint in hex form")
|
|
@click.option(
|
|
"--fingerprint",
|
|
"-f",
|
|
default=None,
|
|
help="Enter the fingerprint of the key you want to use",
|
|
type=int,
|
|
required=True,
|
|
)
|
|
@click.pass_context
|
|
def delete_cmd(ctx: click.Context, fingerprint: int):
|
|
from .init_funcs import check_keys
|
|
from .keys_funcs import delete
|
|
|
|
delete(fingerprint)
|
|
check_keys(ctx.obj["root_path"])
|
|
|
|
|
|
@keys_cmd.command("delete_all", short_help="Delete all private keys in keychain")
|
|
def delete_all_cmd():
|
|
from chia.util.keychain import Keychain
|
|
|
|
Keychain().delete_all_keys()
|
|
|
|
|
|
@keys_cmd.command("generate_and_print", short_help="Generates but does NOT add to keychain")
|
|
def generate_and_print_cmd():
|
|
from .keys_funcs import generate_and_print
|
|
|
|
generate_and_print()
|
|
|
|
|
|
@keys_cmd.command("sign", short_help="Sign a message with a private key")
|
|
@click.option("--message", "-d", default=None, help="Enter the message to sign in UTF-8", type=str, required=True)
|
|
@click.option(
|
|
"--fingerprint",
|
|
"-f",
|
|
default=None,
|
|
help="Enter the fingerprint of the key you want to use",
|
|
type=int,
|
|
required=False,
|
|
)
|
|
@click.option(
|
|
"--mnemonic-seed-filename",
|
|
"filename", # Rename the target argument
|
|
default=None,
|
|
help="The filename containing the mnemonic seed of the master key used for signing.",
|
|
type=str,
|
|
required=False,
|
|
)
|
|
@click.option("--hd_path", "-t", help="Enter the HD path in the form 'm/12381/8444/n/n'", type=str, required=True)
|
|
@click.option(
|
|
"--as-bytes",
|
|
"-b",
|
|
help="Sign the message as sequence of bytes rather than UTF-8 string",
|
|
default=False,
|
|
show_default=True,
|
|
is_flag=True,
|
|
)
|
|
def sign_cmd(message: str, fingerprint: Optional[int], filename: Optional[str], hd_path: str, as_bytes: bool):
|
|
from .keys_funcs import resolve_derivation_master_key, sign
|
|
|
|
private_key = resolve_derivation_master_key(filename if filename is not None else fingerprint)
|
|
sign(message, private_key, hd_path, as_bytes)
|
|
|
|
|
|
@keys_cmd.command("verify", short_help="Verify a signature with a pk")
|
|
@click.option("--message", "-d", default=None, help="Enter the message to sign in UTF-8", type=str, required=True)
|
|
@click.option("--public_key", "-p", default=None, help="Enter the pk in hex", type=str, required=True)
|
|
@click.option("--signature", "-s", default=None, help="Enter the signature in hex", type=str, required=True)
|
|
def verify_cmd(message: str, public_key: str, signature: str):
|
|
from .keys_funcs import verify
|
|
|
|
verify(message, public_key, signature)
|
|
|
|
|
|
@keys_cmd.command("migrate", short_help="Attempt to migrate keys to the Chia keyring")
|
|
@click.pass_context
|
|
def migrate_cmd(ctx: click.Context):
|
|
from .keys_funcs import migrate_keys
|
|
|
|
migrate_keys()
|
|
|
|
|
|
@keys_cmd.group("derive", short_help="Derive child keys or wallet addresses")
|
|
@click.option(
|
|
"--fingerprint",
|
|
"-f",
|
|
default=None,
|
|
help="Enter the fingerprint of the key you want to use.",
|
|
type=int,
|
|
required=False,
|
|
)
|
|
@click.option(
|
|
"--mnemonic-seed-filename",
|
|
"filename", # Rename the target argument
|
|
default=None,
|
|
help="The filename containing the mnemonic seed of the master key to derive from.",
|
|
type=str,
|
|
required=False,
|
|
)
|
|
@click.pass_context
|
|
def derive_cmd(ctx: click.Context, fingerprint: Optional[int], filename: Optional[str]):
|
|
ctx.obj["fingerprint"] = fingerprint
|
|
ctx.obj["filename"] = filename
|
|
|
|
|
|
@derive_cmd.command("search", short_help="Search the keyring for one or more matching derived keys or wallet addresses")
|
|
@click.argument("search-terms", type=str, nargs=-1)
|
|
@click.option(
|
|
"--limit", "-l", default=100, show_default=True, help="Limit the number of derivations to search against", type=int
|
|
)
|
|
@click.option(
|
|
"--non-observer-derivation",
|
|
"-d",
|
|
help="Search will be performed against keys derived using non-observer derivation.",
|
|
default=False,
|
|
show_default=True,
|
|
is_flag=True,
|
|
)
|
|
@click.option(
|
|
"--show-progress",
|
|
"-P",
|
|
help="Show search progress",
|
|
default=False,
|
|
show_default=True,
|
|
is_flag=True,
|
|
)
|
|
@click.option(
|
|
"--search-type",
|
|
"-t",
|
|
help="Limit the search to include just the specified types",
|
|
default=["address", "public_key"],
|
|
show_default=True,
|
|
multiple=True,
|
|
type=click.Choice(["public_key", "private_key", "address", "all"], case_sensitive=True),
|
|
)
|
|
@click.option(
|
|
"--derive-from-hd-path",
|
|
"-p",
|
|
help="Search for items derived from a specific HD path. Indices ending in an 'n' indicate that "
|
|
"non-observer derivation should used at that index. Example HD path: m/12381n/8444n/2/",
|
|
type=str,
|
|
)
|
|
@click.pass_context
|
|
def search_cmd(
|
|
ctx: click.Context,
|
|
search_terms: Tuple[str, ...],
|
|
limit: int,
|
|
non_observer_derivation: bool,
|
|
show_progress: bool,
|
|
search_type: Tuple[str, ...],
|
|
derive_from_hd_path: Optional[str],
|
|
):
|
|
import sys
|
|
from .keys_funcs import search_derive, resolve_derivation_master_key
|
|
from blspy import PrivateKey
|
|
|
|
private_key: Optional[PrivateKey] = None
|
|
fingerprint: Optional[int] = ctx.obj.get("fingerprint", None)
|
|
filename: Optional[str] = ctx.obj.get("filename", None)
|
|
|
|
# Specifying the master key is optional for the search command. If not specified, we'll search all keys.
|
|
if fingerprint is not None or filename is not None:
|
|
private_key = resolve_derivation_master_key(filename if filename is not None else fingerprint)
|
|
|
|
found: bool = search_derive(
|
|
private_key,
|
|
search_terms,
|
|
limit,
|
|
non_observer_derivation,
|
|
show_progress,
|
|
("all",) if "all" in search_type else search_type,
|
|
derive_from_hd_path,
|
|
)
|
|
|
|
sys.exit(0 if found else 1)
|
|
|
|
|
|
@derive_cmd.command("wallet-address", short_help="Derive wallet receive addresses")
|
|
@click.option(
|
|
"--index", "-i", help="Index of the first wallet address to derive. Index 0 is the first wallet address.", default=0
|
|
)
|
|
@click.option("--count", "-n", help="Number of wallet addresses to derive, starting at index.", default=1)
|
|
@click.option("--prefix", "-x", help="Address prefix (xch for mainnet, txch for testnet)", default=None, type=str)
|
|
@click.option(
|
|
"--non-observer-derivation",
|
|
"-d",
|
|
help="Derive wallet addresses using non-observer derivation.",
|
|
default=False,
|
|
show_default=True,
|
|
is_flag=True,
|
|
)
|
|
@click.option(
|
|
"--show-hd-path",
|
|
help="Show the HD path of the derived wallet addresses. If non-observer-derivation is specified, "
|
|
"path indices will have an 'n' suffix.",
|
|
default=False,
|
|
show_default=True,
|
|
is_flag=True,
|
|
)
|
|
@click.pass_context
|
|
def wallet_address_cmd(
|
|
ctx: click.Context, index: int, count: int, prefix: Optional[str], non_observer_derivation: bool, show_hd_path: bool
|
|
):
|
|
from .keys_funcs import derive_wallet_address, resolve_derivation_master_key
|
|
|
|
fingerprint: Optional[int] = ctx.obj.get("fingerprint", None)
|
|
filename: Optional[str] = ctx.obj.get("filename", None)
|
|
private_key = resolve_derivation_master_key(filename if filename is not None else fingerprint)
|
|
|
|
derive_wallet_address(
|
|
ctx.obj["root_path"], private_key, index, count, prefix, non_observer_derivation, show_hd_path
|
|
)
|
|
|
|
|
|
@derive_cmd.command("child-key", short_help="Derive child keys")
|
|
@click.option(
|
|
"--type",
|
|
"-t",
|
|
"key_type", # Rename the target argument
|
|
help="Type of child key to derive",
|
|
required=False,
|
|
type=click.Choice(["farmer", "pool", "wallet", "local", "backup", "singleton", "pool_auth"]),
|
|
)
|
|
@click.option(
|
|
"--derive-from-hd-path",
|
|
"-p",
|
|
help="Derive child keys rooted from a specific HD path. Indices ending in an 'n' indicate that "
|
|
"non-observer derivation should used at that index. Example HD path: m/12381n/8444n/2/",
|
|
type=str,
|
|
)
|
|
@click.option(
|
|
"--index", "-i", help="Index of the first child key to derive. Index 0 is the first child key.", default=0
|
|
)
|
|
@click.option("--count", "-n", help="Number of child keys to derive, starting at index.", default=1)
|
|
@click.option(
|
|
"--non-observer-derivation",
|
|
"-d",
|
|
help="Derive keys using non-observer derivation.",
|
|
default=False,
|
|
show_default=True,
|
|
is_flag=True,
|
|
)
|
|
@click.option(
|
|
"--show-private-keys",
|
|
"-s",
|
|
help="Display derived private keys",
|
|
default=False,
|
|
show_default=True,
|
|
is_flag=True,
|
|
)
|
|
@click.option(
|
|
"--show-hd-path",
|
|
help="Show the HD path of the derived wallet addresses",
|
|
default=False,
|
|
show_default=True,
|
|
is_flag=True,
|
|
)
|
|
@click.pass_context
|
|
def child_key_cmd(
|
|
ctx: click.Context,
|
|
key_type: Optional[str],
|
|
derive_from_hd_path: Optional[str],
|
|
index: int,
|
|
count: int,
|
|
non_observer_derivation: bool,
|
|
show_private_keys: bool,
|
|
show_hd_path: bool,
|
|
):
|
|
from .keys_funcs import derive_child_key, resolve_derivation_master_key
|
|
|
|
if key_type is None and derive_from_hd_path is None:
|
|
ctx.fail("--type or --derive-from-hd-path is required")
|
|
|
|
fingerprint: Optional[int] = ctx.obj.get("fingerprint", None)
|
|
filename: Optional[str] = ctx.obj.get("filename", None)
|
|
private_key = resolve_derivation_master_key(filename if filename is not None else fingerprint)
|
|
|
|
derive_child_key(
|
|
private_key,
|
|
key_type,
|
|
derive_from_hd_path.lower() if derive_from_hd_path is not None else None,
|
|
index,
|
|
count,
|
|
non_observer_derivation,
|
|
show_private_keys,
|
|
show_hd_path,
|
|
)
|