app

CLI tool for managing Bitcoin Mini private keys.

This tool provides the following functionalities:

  • Validation: Check if a given MiniKey is valid.
  • Generation: Generate new 30-character MiniKeys.
  • Conversion:
    • MiniKey → HEX private key.
    • HEX private key → Wallet Import Format (WIF).
  • Verification: Confirm that a WIF key matches its original MiniKey.
  • Full Workflow: Validate MiniKeys, convert to HEX, and generate WIF keys.
Description:

  • CLI tool for managing Bitcoin Mini private keys.

    This tool provides the following functionalities:

    • Validation: Check if a given MiniKey is valid.
    • Generation: Generate new 30-character MiniKeys.
    • Conversion:
      • MiniKey → HEX private key.
      • HEX private key → Wallet Import Format (WIF).
    • Verification: Confirm that a WIF key matches its original MiniKey.
    • Full Workflow: Validate MiniKeys, convert to HEX, and generate WIF keys.
Source:

Requires

  • module:commander
  • module:@core/logger
  • module:@classes/MiniKeyConverter
  • module:@core/output
  • module:config/config.json

Members

(inner, constant) Converter :MiniKeyConverter

Description:

  • Instance of the MiniKeyConverter class.

Source:

Instance of the MiniKeyConverter class.

Type:

(inner, constant) LOG_LEVEL :string

Description:

  • Set default log level from configuration file or fallback to 'info'.

Source:

Set default log level from configuration file or fallback to 'info'.

Type:
  • string

Methods

(inner) LoggingLevelOptions()

Description:

  • Adjust logging levels dynamically based on CLI options.

Source:

(inner) generate()

Description:

  • Command: Generate a new MiniKey and convert it to HEX and WIF formats.

Source:

(inner) process(minikey)

Description:

  • Command: Process a MiniKey through the full workflow.

Source:
Parameters:
Name Type Description
minikey string

The Mini private key to process.

(inner) to-hex(minikey)

Description:

  • Command: Convert a MiniKey to HEX.

Source:
Parameters:
Name Type Description
minikey string

The Mini private key to convert.

(inner) to-wif(hexkey, testnetopt, compressedopt)

Description:

  • Command: Convert HEX to WIF.

Source:
Parameters:
Name Type Attributes Default Description
hexkey string

The HEX private key to convert.
testnet boolean <optional>
 false

Generate a testnet WIF key.
compressed boolean <optional>
 false

Generate a compressed WIF key.

(inner) validate(minikey)

Description:

  • Command: Validate a MiniKey.

Source:
Parameters:
Name Type Description
minikey string

The Mini private key to validate.

(inner) verify(minikey, wifkey)

Description:

  • Command: Verify if a WIF matches a MiniKey.

Source:
Parameters:
Name Type Description
minikey string

The Mini private key.
wifkey string

The Wallet Import Format key.