Zcash Rust crates

This repository contains a (work-in-progress) set of Rust crates for working with Zcash.

<!-- START mermaid-dependency-graph -->

graph TB
    subgraph librustzcash
        direction TB
        subgraph main
            zcash_address
            zcash_primitives
            zcash_transparent
            zcash_proofs
            zcash_extensions
            zcash_protocol
            pczt
            zcash_client_backend
            zcash_client_memory
            zcash_client_sqlite
            zcash_keys
            zip321
        end

        subgraph standalone_components
            equihash
            f4jumble
            zcash_encoding
        end
    end

    subgraph shielded_protocols
        sapling-crypto
        orchard
    end

    subgraph protocol_components
        zcash_note_encryption
        zip32
        zcash_spec
    end

    %% Direct edges that also have a transitive path are left in (so the linter checks
    %% they are deliberate edges) but commented out (to simplify the graph).

    zcash_client_sqlite --> zcash_client_backend
    zcash_client_memory --> zcash_client_backend

    zcash_client_backend --> pczt

    %% zcash_client_sqlite --> zcash_keys
    %% zcash_client_memory --> zcash_keys
    zcash_client_backend --> zcash_keys

    zcash_client_backend --> zcash_proofs

    zcash_extensions --> zcash_primitives
    zcash_proofs --> zcash_primitives
    pczt --> zcash_primitives
    %% zcash_client_backend --> zcash_primitives
    %% zcash_client_sqlite --> zcash_primitives
    %% zcash_client_memory --> zcash_primitives

    %% zcash_client_sqlite --> zcash_transparent
    %% zcash_client_memory --> zcash_transparent
    %% zcash_client_backend --> zcash_transparent
    %% pczt --> zcash_transparent
    zcash_keys --> zcash_transparent
    zcash_primitives --> zcash_transparent

    zcash_client_backend --> zip321

    zcash_transparent --> zcash_address
    %% zcash_keys --> zcash_address
    %% zcash_client_backend --> zcash_address
    %% zcash_client_sqlite --> zcash_address
    %% zcash_client_memory --> zcash_address
    zip321 --> zcash_address

    %% zcash_transparent --> zcash_protocol
    %% zcash_keys --> zcash_protocol
    %% zcash_client_sqlite --> zcash_protocol
    %% zcash_client_memory --> zcash_protocol
    %% zcash_primitives --> zcash_protocol
    %% zcash_client_backend --> zcash_protocol
    %% pczt --> zcash_protocol
    %% zcash_extensions --> zcash_protocol
    zcash_address --> zcash_protocol
    %% zip321 --> zcash_protocol

    %% zcash_client_sqlite --> zcash_encoding
    %% zcash_transparent --> zcash_encoding
    %% zcash_client_memory --> zcash_encoding
    %% zcash_client_backend --> zcash_encoding
    %% zcash_keys --> zcash_encoding
    %% zcash_primitives --> zcash_encoding
    %% zcash_address --> zcash_encoding
    zcash_protocol --> zcash_encoding

    zcash_primitives --> equihash
    zcash_address --> f4jumble

    %% zcash_client_backend --> orchard
    %% pczt --> orchard
    zcash_keys --> orchard
    zcash_primitives --> orchard
    %% zcash_client_sqlite --> orchard
    %% zcash_client_memory --> orchard

    %% zcash_client_sqlite --> sapling-crypto
    %% zcash_client_memory --> sapling-crypto
    %% zcash_client_backend --> sapling-crypto
    zcash_keys --> sapling-crypto
    %% zcash_proofs --> sapling-crypto
    zcash_primitives --> sapling-crypto
    %% pczt --> sapling-crypto

    orchard --> zcash_note_encryption
    sapling-crypto --> zcash_note_encryption
    %% zcash_primitives --> zcash_note_encryption
    %% pczt --> zcash_note_encryption
    %% zcash_client_backend --> zcash_note_encryption

    %% zcash_client_sqlite --> zip32
    %% zcash_client_memory --> zip32
    %% zcash_client_backend --> zip32
    %% zcash_keys --> zip32
    orchard --> zip32
    sapling-crypto --> zip32
    zcash_transparent --> zip32

    %% zcash_transparent --> zcash_spec
    %% orchard --> zcash_spec
    %% sapling-crypto --> zcash_spec
    zip32 --> zcash_spec

    main --> standalone_components

    librustzcash --> shielded_protocols
    shielded_protocols --> protocol_components

    click equihash "https://docs.rs/equihash/" _blank
    click f4jumble "https://docs.rs/f4jumble/" _blank
    click orchard "https://docs.rs/orchard/" _blank
    click pczt "https://docs.rs/pczt/" _blank
    click sapling-crypto "https://docs.rs/sapling-crypto/" _blank
    click zcash_address "https://docs.rs/zcash_address/" _blank
    click zcash_encoding "https://docs.rs/zcash_encoding/" _blank
    click zcash_client_backend "https://docs.rs/zcash_client_backend/" _blank
    click zcash_client_memory "https://docs.rs/zcash_client_memory/" _blank
    click zcash_client_sqlite "https://docs.rs/zcash_client_sqlite/" _blank
    click zcash_extensions "https://docs.rs/zcash_extensions/" _blank
    click zcash_keys "https://docs.rs/zcash_keys/" _blank
    click zcash_note_encryption "https://docs.rs/zcash_note_encryption/" _blank
    click zcash_primitives "https://docs.rs/zcash_primitives/" _blank
    click zcash_proofs "https://docs.rs/zcash_proofs/" _blank
    click zcash_protocol "https://docs.rs/zcash_protocol/" _blank
    click zcash_spec "https://docs.rs/zcash_spec/" _blank
    click zcash_transparent "https://docs.rs/zcash_transparent/" _blank
    click zip321 "https://docs.rs/zip321/" _blank
    click zip32 "https://docs.rs/zip32/" _blank

<!-- END mermaid-dependency-graph -->

Crates

librustzcash: a Rust Crates Walkthrough w/ nuttycom

Zcash Protocol

• zcash_protocol: Constants & common types
  • consensus parameters
  • bounded value types (Zatoshis, ZatBalance)
  • memo types
• zcash_transparent: Bitcoin-derived transparent transaction components
  • transparent addresses
  • transparent input, output, and bundle types
  • support for transparent parts of pczt construction
• zcash_primitives: Core utilities for working with Zcash transactions
  • the primary transaction data type
  • transaction builder(s)
  • proving, signing, & serialization
  • low-level fee types
• zcash_proofs: The Sprout circuit & proving system

Keys, Addresses & Wallet Support

• zcash_address: Parsing & serialization of Zcash addresses
  • unified address, fvk & ivk containers
  • no dependencies on protocol-specific types
  • serialization API definitions
• zip321: Parsing & serizalization for ZIP 321 payment requests
• zcash_keys: Spending Keys, Viewing Keys, & Addresses
  • protocol-specific & Unified address types
  • ZIP 32 key & address derivation implementations
  • Unified spending keys & viewing keys
  • Sapling spending & viewing key types
• pczt: Data types & interfaces for PCZT construction
  • partially constructed transaction types
  • transaction construction role interfaces & partial implementations
• zcash_client_backend: A wallet framework for Zcash
  • wallet data storage APIs
  • chain scanning
  • light client protocol support
  • fee calculation
  • transaction proposals & high-level transaction construction APIs
• zcash_client_sqlite: SQLite-based implementation of zcash_client_backend storage APIs

Utilities & Common Dependencies

• f4jumble: Encoding for Unified addresses
• zcash_encoding: Bitcoin-derived transaction encoding utilities for Zcash
• equihash: Proof-of-work protocol implementation

Security Warnings

These libraries are under development and have not been fully reviewed.

License

All code in this workspace is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.