Skip to content

Latest commit

 

History

History
176 lines (143 loc) · 3.88 KB

README.md

File metadata and controls

176 lines (143 loc) · 3.88 KB
Raw

Gotham Client

Gotham Client

Introduction

Gotham client is a bitcoin minimalist decentralized wallet CLI app.

Requirement

Gotham server is required to interact with the client, for instruction on how to run it see here.

Installation

git clone https://github.com/KZen-networks/gotham-city.git
cd gotham-city/gotham-client
cargo build --release

Using the CLI

./target/release/cli --help            
Command Line Interface for a minimalist decentralized crypto-currency wallet

USAGE:
    cli [FLAGS] [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information
    -v               Sets the level of verbosity

SUBCOMMANDS:
    create-wallet    Create an MPC wallet
    help             Prints this message or the help of the given subcommand(s)
    wallet           Operation on wallet

Wallet creation (required)

./target/release/cli create-wallet
  • Output:
(id: f1025e8f-36c3-4220-8749-ac29d5f17974) Generating master key...
(id: f1025e8f-36c3-4220-8749-ac29d5f17974) Master key gen completed
(id: f1025e8f-36c3-4220-8749-ac29d5f17974) Took: PT1.559251309S

Wallet operations

./target/release/cli wallet --help
Operation on wallet

USAGE:
    cli wallet [FLAGS] [SUBCOMMAND]

FLAGS:
    -o               Rotate secret shares
    -s               Create backup
    -c               Verify encrypted backup
    -r               Recover from backup
    -b               Total balance
    -h, --help       Prints help information
    -u               List unspent transactions (tx hash)
    -a               Generate a new address
    -e               Wallet private shares backup
    -V, --version    Prints version information

SUBCOMMANDS:
    help    Prints this message or the help of the given subcommand(s)
    send    Send a transaction

Get a derived/new address (HD)

./target/release/cli wallet -a
  • Output:
Network: [testnet], Address: [tb1quxl4c4cyl3586s7tuql7tqqsv233sumxz0588a]

Get total balance

./target/release/cli wallet -b
  • Output:
Network: [testnet], Balance: [balance: 1100000, pending: 0]

Get list unspent

./target/release/cli wallet -u
  • Output:
Network: [testnet], Unspent tx hashes: [
bc32ff53c1b9f71d7a6a5e3f5ec7bc8d20afe50214110a0718c9004be33d57d6
53bc8eca351446f0ec2c13a978243b726a132792305a6758bfc75c67209f9d6b
]

Send a transaction

./target/release/cli wallet send -t [ADDRESS] -a [BTC_AMOUNT]
  • Example:
./target/release/cli wallet send -t tb1quxl4c4cyl3586s7tuql7tqqsv233sumxz0588a -a 0.0001
  • Output:
Network: [testnet], Sent 0.0001 BTC to address tb1quxl4c4cyl3586s7tuql7tqqsv233sumxz0588a. Transaction ID: 44545bf81fc8aebcde855c2e33a5f83a17a93f76164330e1ee9e366e8e039444

Rotate secret shares

./target/release/cli wallet -o
  • Output:
Rotating secret shares
key rotation complete, (Took: PT1.087591809S)

Backup

Backup has 3 phases: (1) creating the backup, encrypted on a seperate file, (2) verifying the backup (3) recover

create backup

./target/release/cli wallet -s
  • Output:
Backup private share pending (it can take some time)...
Backup key saved in escrow (Took: PT20.828933102S)

verify backup

./target/release/cli wallet -c
  • Output:
verify encrypted backup (it can take some time)...
backup verified 🍻
 (Took: PT12.325232629S)

Recover from backup

./target/release/cli wallet -r
  • Output:
backup recovery in process 📲 (it can take some time)...
Recovery Completed Successfully ❤️
 Backup recovered 💾(Took: PT0.405034789S)