Skip to main content

Crate stratum_apps

Crate stratum_apps 

Source
Expand description

§Stratum Apps - SV2 Application Utilities

This crate consolidates the essential utilities needed for building Stratum V2 applications. It combines the functionality from the original separate utility crates into a single, well-organized library with feature-based compilation.

§Features

§Core Features

  • network - High-level networking utilities (enabled by default)
  • fallback-coordinator - Runtime fallback coordination helpers (enabled by default)
  • config - Configuration management helpers (enabled by default)
  • payout - Shared payout-mode parsing and coinbase-output distribution helpers
  • monitoring - HTTP and Prometheus monitoring helpers (optional)
  • std - Standard-library support for key and random utilities (enabled by default)
  • core - Re-export and enable stratum-core

§Role-Specific Feature Bundles

  • pool - Everything needed for pool applications
  • jd_client - Everything needed for JD client applications
  • jd_server - Configuration helpers for JD server applications
  • translator - Everything needed for translator applications (includes SV1 and payout helpers)
  • mining_device - Configuration helpers for mining device applications

§Modules

  • network_helpers - High-level networking utilities for SV2 connections
  • config_helpers - Configuration management and parsing utilities
  • payout - Payout-mode parsing and coinbase-output construction/verification helpers

Re-exports§

pub use stratum_core;

Modules§

channel_utils
Shared async channel cleanup helpers.
coinbase_output_constraints
Creates a CoinbaseOutputConstraints message from a list of coinbase outputs
config_helpers
Configuration management helpers
custom_mutex
Custom Mutex
fallback_coordinator
Fallback coordinator
key_utils
Key utilities for cryptographic operations
monitoring
Channel monitoring - expose channel data via HTTP JSON APIs Monitoring system for SV2 applications.
network_helpers
High-level networking utilities for SV2 connections
payout
Shared payout-mode parsing and coinbase-output distribution helpers. Shared payout-mode parsing and coinbase-output distribution helpers.
sync
Share synchronous primitives
task_manager
tp_type
Template provider type
utils
Utility methods used in apps.