feat: implementation of ZecKit reusable GitHub Action and CI optimizations (Milestone 3)#6
Open
intelliDean wants to merge 72 commits intozecdev:mainfrom
Open
feat: implementation of ZecKit reusable GitHub Action and CI optimizations (Milestone 3)#6intelliDean wants to merge 72 commits intozecdev:mainfrom
intelliDean wants to merge 72 commits intozecdev:mainfrom
Conversation
Implements Milestone 3 deliverables on top of the existing M1/M2 foundation: ## GitHub Actions CI - e2e-test.yml: Full devnet startup, smoke tests, artifact upload on failure - smoke-test.yml: Lightweight health checks on every push - Job timeout set to 120 minutes to accommodate Docker build time ## Two-Node Zebra Regtest Cluster - zebra-miner: internal miner, mines blocks continuously - zebra-sync: second node for cluster readiness verification - Fixed zebra-sync.toml config fields for Zebra 4.1.0 compatibility (initial_testnet_peers, crawl_new_peer_interval) - All indexer/faucet services point to zebra-miner for reliable data ## CLI Enhancements (zeckit up / test) - health.rs: detailed RPC error messages surfaced during wait loops - up.rs: periodic error reporting during Zebra startup - test.rs: 7-test smoke suite; cluster sync is warn-only (Regtest P2P peering is best-effort in isolated CI environments) ## Docker / Entrypoint - entrypoint.sh: verbose startup logging, config validation, zebrad --version - Sync node waits for miner to be reachable before starting zebrad - Removed container_name fields to prevent naming conflicts in CI - Relaxed port bindings to 0.0.0.0 for CI compatibility ## E2E Golden Flow (verified in CI) fund (650 ZEC coinbase) -> shield (transparent->Orchard) -> shielded send (0.05 ZEC) TXID confirmed on-chain, faucet live with 650+ ZEC Orchard balance ## README - CI badges (E2E Tests, Smoke Test, License) - M3 complete status with deliverable list - Updated test suite table (7 tests with WARN explanation) - M4 roadmap entry
…e instead of skipping
…insufficient funds
…o.lock optimization
…dalone CI Adds three new flags to `zeckit up` so external projects can use ZecKit as a standalone devnet-as-a-service action: - --miner-address: override the Zebra mining reward address (instead of the embedded default). Mining goes directly to your wallet from block 1. - --fund-address: automatically transfer ZEC to this address after the devnet is healthy and initial blocks are mined. - --fund-amount: amount in ZEC to transfer to --fund-address (default 10.0). Updates action.yml to expose these as action inputs alongside a new `only_setup` input that skips ZecKit's own smoke tests, allowing the action to be used purely for environment setup. Addresses reviewer feedback from hhanh00/wallet-ci-test demo.
…Regtest" This reverts commit 06bf53a.
feat: upgrade to NU6/NU6.1 and zingolib v3.0.0
docs: update README and startup guide for NU6 support milestone
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR fulfils the requirements for Milestone 3 by converting ZecKit into a fully reusable GitHub Action. It enables any external repository to effortlessly spin up a Zcash devnet and execute the E2E Golden Flow (Fund → Shield → Send → Verify) against both zaino and lightwalletd backends.
(Note: The smoke-test.yml workflow will remain in a "pending/failed" state on my fork because I have reverted it to runs-on: self-hosted to match your infrastructure requirements. It will pass normally once executed on a repository with the correctly tagged self-hosted runner connected. If not revert it to
runs-on: ubuntu-latest)Standalone Action — Flexible Funding (addresses reviewer feedback)
Inspired by the hhanh00/wallet-ci-test demo, the action now supports being used as a pure devnet-as-a-service step, where external projects supply their own addresses and run their own tests:
New CLI flags on
zeckit up:--miner-address— override Zebra's mining reward address (instead of embedded default)--fund-address— auto-fund a destination address once the devnet is healthy--fund-amount— amount in ZEC to send (default10.0)A full working example is in the sample project.
Key Changes
GitHub Action Integration (action.yml)
--profileflags duringdocker pull, drastically reducing workflow execution time from 20+ minutes down to seconds.run-summary.jsonandfaucet-stats.json) to allow external repositories to make assertions on transaction data.miner_address,fund_address,fund_amount, andonly_setupinputs for standalone usage.CLI Workflow Generator (zeckit init)
Automatic CI Setup: Introduced the zeckit init command, which automatically generates a production-ready GitHub Actions workflow file (
.github/workflows/zeckit.yml).Configurable Backends: Supports generating workflows for both
zainoand lightwalletd backends via the--backendflag.Developer Experience: Simplifies the integration of ZecKit into external repositories by providing a one-command solution for CI bootstrapping.
CLI & Automation Enhancements (test.rs)
zeckit testcommand sequence.Documentation & Workflows