nathan-at-least / zingolib

An API and test-app that exposes zcash functionality for app consumption

Zingolib

This repo provides both a library for zingoproxyclient and zingo-mobile, as well as an included cli application to interact with zcashd via lightwalletd.

WARNING! Experimental

• This is experimental software.
• It should not be used in production!
• It should not be relied upon for custody, transfer, or receipt of ZEC!
• Please use only if you know specifically what you are doing!!

Zingo CLI

zingo-cli is a command line lightwalletd-proxy client. To use it, see "compiling from source" below. Releases are currently only provisional, we will update the README as releases come out.

Privacy

• While all the keys and transaction detection happens on the client, the server can learn what blocks contain your shielded transactions.
• The server also learns other metadata about you like your ip address etc...
• Also remember that t-addresses are publically visible on the blockchain.
• Price information is retrieved from Gemini exchange.

Note Management

Zingo-CLI does automatic note and utxo management, which means it doesn't allow you to manually select which address to send outgoing transactions from. It follows these principles:

• Defaults to sending shielded transactions, even if you're sending to a transparent address
• Sapling funds need at least 5 confirmations before they can be spent
• Can select funds from multiple shielded addresses in the same transaction
• Will automatically shield your transparent funds at the first opportunity
  • When sending an outgoing transaction to a shielded address, Zingo-CLI can decide to use the transaction to additionally shield your transparent funds (i.e., send your transparent funds to your own shielded address in the same transaction)

Compiling from source

Pre-requisites

• Rust v1.37 or higher.
  • Run rustup update to get the latest version of Rust if you already have it installed
• Rustfmt
  • Run rustup component add rustfmt to add rustfmt
• Build tools
  • Please install the build tools for your platform. On Ubuntu sudo apt install build-essential gcc
• Protobuf Compiler
  • Please install the protobuf compiler for your platform. On Ubuntu sudo apt install protobuf-compiler

git clone https://github.com/zingolabs/zingolib.git
cd zingolib
cargo build --release
./target/release/zingo-cli

This will launch the interactive prompt. Type help to get a list of commands.

Library:

We currently depend on unreleased patches of orchard and librustzcash, via cargo's patching mechanism. Because patching only applies at the top level of a project, in order to use this library as a dependancy, copy the [patch.crates-io] section of Cargo.toml into your own workspace Cargo.toml

Notes:

• If you want to run your own server, please see zingo lightwalletd, and then run ./zingo-cli --server http://127.0.0.1:9067
• The default log file is in ~/.zcash/zingo-wallet.debug.log. A default wallet is stored in ~/.zcash/zingo-wallet.dat
• Currently, the default, hard-coded lightwalletd server is https://mainnet.lightwalletd.com:9067/. To change this, you can modify the DEFAULT_SERVER const in config/src/lib.rs

Running in non-interactive mode:

You can also run zingo-cli in non-interactive mode by passing the command you want to run as an argument. For example, zingo-cli addresses will list all wallet addresses and exit. Run zingo-cli help to see a list of all commands.

Options

Here are some CLI arguments you can pass to zingo-cli. Please run zingo-cli --help for the full list.

• --server: Connect to a custom zcash lightwalletd server.
  • Example: ./zingo-cli --server 127.0.0.1:9067
• --seed: Restore a wallet from a seed phrase. Note that this will fail if there is an existing wallet. Delete (or move) any existing wallet to restore from the 24-word seed phrase
  • Example: ./zingo-cli --seed "twenty four words seed phrase"
• --recover: Attempt to recover the seed phrase from a corrupted wallet
• --data-dir: uses the specified path as data directory.
  • Example: ./zingo-cli --server 127.0.0.1:9067 --data-dir /Users/ZingoRocks/my-test-wallet will use the provided directory to store zingo-wallet.dat and logs. If the provided directory does not exist, it will create it.

Regtest

There is an experimental feature flag available with zingo-cli, in which the cli works in regtest mode, by also locally running zcashd and lightwalletd.

Please see zingolib/regtest/README.md for a detailed explanation.