Skip to content

Improve README to clarify Zallet's dependencies and Z3 stack architecture #340

Description

@bhaumikmaan

Problem

The current README for Zallet does not adequately explain that Zallet is part of the Z3 stack and requires both Zebra and Zaino to function. This creates confusion as a user if you're not fully up-to-date, especially since:

  • Zallet-Zaino-Zebra dependence for blockchain data access
  • Cross-organization dependencies - The required components are maintained by different organizations:
    • Zallet: zcash/wallet
    • Zaino: zingolabs/zaino
    • Zebra: ZcashFoundation/zebra
  • Zcashd deprecation context - The README and repository about mentions this is a "zcashd wallet replacement" but doesn't explain/highlight the broader architectural shift to the Z3 stack

Proposed Improvements

  • Architecture Overview Section: Add a section explaining Zallet's role in the Z3 stack
  • Add clear links to the required components
  • Temporary addition of context on Zcashd Deprecation

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions