Rc/0.2.0

.config/nextest.toml

@@ -1,2 +1,138 @@
 [profile.default]
+test-threads = 6
 fail-fast = false
+slow-timeout = { period = "60s", terminate-after = "10" }
+# retries = 1
+
+# All the following tests keep failing because of zebra with the following error message:
+# "Serialization/Deserialization Error: data did not match any variant of untagged enum Input at line 1 column <X>"
+# We will ignore these tests for now in CI, until zebra releases the fix
+
+[profile.ci]
+test-threads = 6
+slow-timeout = { period = "60s", terminate-after = "30" }
+default-filter = """
+    not test(testnet)
+    & not test(client_rpcs)
+"""
+
+[profile.ci.junit]  # this can be some other profile, too
+path = "junit.xml"
+
+[profile.quick]
+# Use this profile for a fast check verifying the absence of regressions. Our best assurance against
+# false negatives is to run the entire test suite.
+test-threads = "num-cpus"
+fail-fast = false # If a test fails against this profile, that's a surprise to be investigated
+slow-timeout = { period = "60s", terminate-after = "10" }
+# Excludes tests that fail in low-resource environments. Flakey test are listed at the beginning
+# of the expression, slow at the end.  If a slow and flakey test is discovered it should be included
+# in the flakey category.
+#  On a developer laptop:
+#  flakey 63 ==  tests fail at least once
+#  slow   32 ==  >60s runtime
+default-filter = """
+    not (
+        test(/^chain_query_interface::find_fork_point_zcashd$/) |
+        test(/^chain_query_interface::get_block_range_zcashd$/) |
+        test(/^chain_query_interface::get_raw_transaction_zcashd$/) |
+        test(/^chain_query_interface::get_transaction_status_zcashd$/) |
+        test(/^chain_query_interface::repro_flake_zcashd$/) |
+        test(/^chain_query_interface::repro_nfs_drain$/) |
+        test(/^chain_query_interface::sync_large_chain_zcashd$/) |
+        test(/^chain_query_interface::sync_large_chain_zebrad$/) |
+        test(/^zebrad::get::mempool_info$/) |
+        test(/^zebrad::get::mempool_stream$/) |
+        test(/^zebrad::get::mempool_tx$/) |
+        test(/^zebrad::get::raw_mempool$/) |
+        test(/^zebrad::get::raw_transaction$/) |
+        test(/^zebrad::get::taddress_balance$/) |
+        test(/^zebrad::get::taddress_txids$/) |
+        test(/^zebrad::get::taddress_utxos$/) |
+        test(/^zebrad::get::taddress_utxos_stream$/) |
+        test(/^zebrad::get::transaction_mempool$/) |
+        test(/^zebrad::get::transaction_mined$/) |
+        test(/^zebrad::get::z::subtrees_by_index$/) |
+        test(/^zebrad::get::z::treestate$/) |
+        test(/^zcashd::get::tree_state$/) |
+        test(/^zcashd::zcash_indexer::check_info_no_cookie$/) |
+        test(/^zebrad::get::get_mempool_info$/) |
+        test(/^zebrad::get::raw_mempool_regtest$/) |
+        test(/^zebrad::get::raw_transaction_regtest$/) |
+        test(/^zebrad::get::address_balance_regtest$/) |
+        test(/^zebrad::get::address_balance$/) |
+        test(/^zebrad::get::address_tx_ids$/) |
+        test(/^zebrad::get::address_utxos$/) |
+        test(/^zebrad::get::block$/) |
+        test(/^zebrad::lightwallet_indexer::get_taddress_balance$/) |
+        test(/^zebrad::lightwallet_indexer::get_transaction$/) |
+        test(/^zcashd::monitor_unverified_mempool$/) |
+        test(/^zcashd::sent_to::orchard$/) |
+        test(/^zcashd::sent_to::sapling$/) |
+        test(/^zebrad::fetch_service::monitor_unverified_mempool$/) |
+        test(/^zebrad::fetch_service::send_to::all$/) |
+        test(/^zebrad::fetch_service::send_to::orchard$/) |
+        test(/^zebrad::fetch_service::send_to::sapling$/) |
+        test(/^zebrad::fetch_service::send_to::transparent$/) |
+        test(/^zebrad::fetch_service::shield$/) |
+        test(/^zebrad::state_service::monitor_unverified_mempool$/) |
+        test(/^zebrad::state_service::send_to::all$/) |
+        test(/^zebrad::state_service::send_to::orchard$/) |
+        test(/^zebrad::state_service::send_to::sapling$/) |
+        test(/^zebrad::state_service::send_to::transparent$/) |
+        test(/^zebrad::state_service::shield$/) |
+        test(/^launch_testmanager::zcashd::zaino_clients_receive_mining_reward$/) |
+        test(/^launch_testmanager::zebrad::state_service::zaino_clients_receive_mining_reward_and_send$/) |
+        test(/^zebrad::get::block_raw$/) |
+        test(/^zebrad::lightwallet_indexer::get_subtree_roots$/) |
+        test(/^launch_testmanager::zcashd::zaino_clients$/) |
+        test(/^zcashd::zcash_indexer::get_block_subsidy$/) |
+        test(/^zebra::get::address_deltas$/) |
+        test(/^zebra::get::z::subtrees_by_index_regtest$/) |
+        test(/^zebrad::get::mining_info$/) |
+        test(/^zebra::get::address_balance_regtest$/) |
+        test(/^zebra::get::raw_transaction_regtest$/) |
+        test(/^zebra::get::get_mempool_info$/) |
+        test(/^zebra::get::raw_mempool_regtest$/) |
+        test(/^zcashd::zcash_indexer::get_mining_info$/) |
+        test(/^zebrad::process_200_blocks$/)
+    )
+    &
+    not (
+        test(/^zcashd::process_100_blocks$/) |
+        test(/^zcashd::process_200_blocks$/) |
+        test(/^launch_testmanager::zebrad::fetch_service::zaino_clients_receive_mining_reward_and_send$/) |
+        test(/^zcashd::sent_to::transparent$/) |
+        test(/^zcashd::shield$/) |
+        test(/^zcashd::sent_to::all$/) |
+        test(/^zcashd::get::best_blockhash$/) |
+        test(/^zcashd::get::block_count$/) |
+        test(/^zcashd::get::block_range$/) |
+        test(/^zcashd::get::block_range_nullifiers$/) |
+        test(/^zcashd::get::block_subsidy$/) |
+        test(/^zcashd::get::mempool_info$/) |
+        test(/^zcashd::get::mempool_stream$/) |
+        test(/^zcashd::get::mempool_tx$/) |
+        test(/^zcashd::get::raw_mempool$/) |
+        test(/^zcashd::get::raw_transaction$/) |
+        test(/^zcashd::get::taddress_balance$/) |
+        test(/^zcashd::get::taddress_txids$/) |
+        test(/^zcashd::get::taddress_utxos$/) |
+        test(/^zcashd::get::taddress_utxos_stream$/) |
+        test(/^zcashd::get::transaction_mempool$/) |
+        test(/^zcashd::get::transaction_mined$/) |
+        test(/^zcashd::get::z::get_treestate$/) |
+        test(/^zcashd::get::z::subtrees_by_index$/) |
+        test(/^zcashd::zcash_indexer::get_difficulty$/) |
+        test(/^zcashd::zcash_indexer::get_mempool_info$/) |
+        test(/^zcashd::zcash_indexer::get_raw_mempool$/) |
+        test(/^zcashd::zcash_indexer::get_raw_transaction$/) |
+        test(/^zcashd::zcash_indexer::z_get_subtrees_by_index$/) |
+        test(/^zcashd::zcash_indexer::z_get_treestate$/) |
+        test(/^launch_testmanager::zebrad::state_service::zaino_clients_receive_mining_reward$/) |
+        test(/^zebrad::get::peer_info$/)
+    )
+"""
+
+[profile.quick.junit]
+path = "junit.xml"

.dockerignore

@@ -0,0 +1,22 @@
+# Build artifacts
+target/
+**/target/
+**/*.rs.bk
+
+# VCS / CI
+.git/
+.gitignore
+.github/
+
+# IDE / OS
+.vscode/
+.idea/
+*.swp
+.DS_Store
+
+# Misc
+**/*.log
+
+docker_cargo/
+container-target/
+

.env.testing-artifacts

@@ -0,0 +1,8 @@
+# Rust toolchain version (for rust:<version>-bookworm base image)
+RUST_VERSION=1.92
+
+# zcashd Git tag (https://github.com/zcash/zcash/releases)
+ZCASH_VERSION=6.11.0
+
+# zebrad version tag for pulling zfnd/zebra:<version>
+ZEBRA_VERSION=4.1.0

.githooks/pre-push

@@ -0,0 +1 @@
+makers lint

.github/ISSUE_TEMPLATE/architecture.yaml

@@ -0,0 +1,63 @@
+name: "Architecture Issue"
+description: Document structural concerns, design decisions, or refactoring needs
+labels: ["architecture"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Use this template to document architectural concerns, design problems, or areas needing refactoring.
+
+        These issues help track technical debt and guide future development.
+
+  - type: textarea
+    id: observation
+    attributes:
+      label: Observation
+      description: What architectural concern have you identified?
+      placeholder: |
+        The X module is tightly coupled with Y...
+        The current design makes it difficult to...
+    validations:
+      required: true
+
+  - type: textarea
+    id: location
+    attributes:
+      label: Location in codebase
+      description: Which modules, files, or components are affected?
+      placeholder: |
+        - `zaino-state/src/...`
+        - `chain_index::finalized_state::...`
+    validations:
+      required: true
+
+  - type: dropdown
+    id: concern_type
+    attributes:
+      label: Type of concern
+      description: What category best describes this?
+      multiple: true
+      options:
+        - Coupling / Dependencies
+        - Abstraction boundaries
+        - Separation of concerns
+        - API design
+        - Module organization
+        - Type system / Safety
+        - Persistence layer
+        - Error handling
+        - Other
+    validations:
+      required: true
+
+  - type: textarea
+    id: impact
+    attributes:
+      label: Impact
+      description: How does this affect development, maintenance, or correctness?
+
+  - type: textarea
+    id: suggestion
+    attributes:
+      label: Suggested direction
+      description: Any ideas on how to address this? (optional)

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,88 @@
+name: "Bug Report"
+description: Report a bug or unexpected behavior
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to report a bug!
+
+        **Before submitting**, please check if a similar issue already exists.
+
+  - type: dropdown
+    id: usage
+    attributes:
+      label: Usage mode
+      description: How are you using Zaino?
+      options:
+        - zainod (running the daemon)
+        - Library integration (using zaino-* crates)
+        - Both / Not sure
+    validations:
+      required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: A clear description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to reproduce
+      description: List the steps to reproduce the issue.
+      placeholder: |
+        1. Start zainod with config...
+        2. Send request to...
+        3. Observe error...
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: What did you expect to happen?
+    validations:
+      required: true
+
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: |
+        Please include:
+        - Zaino version or commit hash
+        - Backend version (zebra/zcashd)
+        - OS and platform
+      placeholder: |
+        Zaino: v0.x.x or commit abc123
+        Backend: Zebra 27.0.0
+        OS: Linux x86_64 / macOS ARM64
+    validations:
+      required: true
+
+  - type: textarea
+    id: config
+    attributes:
+      label: Configuration
+      description: Paste your zainod config file (redact any sensitive values).
+      render: toml
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs
+      description: |
+        Relevant log output. Use debug logging if possible (`level = "debug"` in config).
+        Wrap long logs in `<details>` tags.
+      render: shell
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Any other relevant information (config snippets, block heights, tx ids, etc.)

.github/ISSUE_TEMPLATE/code_smell.yaml

@@ -0,0 +1,67 @@
+name: "Code Smell"
+description: Flag anti-patterns, naming issues, or code that needs attention
+labels: ["code-smell"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Use this to flag code that works but has problems worth addressing.
+
+        Code smells are indicators of deeper issues - they may or may not need immediate action.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: What's the smell?
+      description: Describe the problematic pattern or code.
+    validations:
+      required: true
+
+  - type: textarea
+    id: location
+    attributes:
+      label: Location
+      description: Where is this code? (file paths, module names, function names)
+      placeholder: |
+        `chain_index/src/finalized_state/entry.rs:42`
+    validations:
+      required: true
+
+  - type: dropdown
+    id: smell_type
+    attributes:
+      label: Category
+      description: What type of smell is this?
+      multiple: true
+      options:
+        - Naming confusion
+        - Duplication
+        - Long function / God object
+        - Primitive obsession
+        - Feature envy
+        - Inappropriate intimacy (tight coupling)
+        - Dead code
+        - Magic numbers / strings
+        - Missing abstraction
+        - Test smell
+        - Other
+    validations:
+      required: true
+
+  - type: dropdown
+    id: priority
+    attributes:
+      label: Severity
+      description: How urgently should this be addressed?
+      options:
+        - Low - Nice to fix eventually
+        - Medium - Should fix when touching this code
+        - High - Actively causing problems
+    validations:
+      required: true
+
+  - type: textarea
+    id: suggestion
+    attributes:
+      label: Suggested fix
+      description: How might this be improved? (optional)