Skip to content

metapep/hc-pool

 
 

Repository files navigation

HCASH Pool (Stratum v1 + GBT)

NestJS + TypeScript stratum server configured for HCASH.

Protocol support:

  • Stratum v1 (mining protocol)
  • getblocktemplate (GBT) via JSON-RPC to hashcashd
  • Not Stratum v2

Canonical HCASH Docker Flow

This repository is intended to run against your existing hashcash-core devnet in ../hashcash-core.

  1. Start node stack:
cd ../hashcash-core
make regtest-up
  1. Start pool stack:
cd ../hc-pool
docker compose -f docker-compose.hcash-regtest.yml up -d --build
  1. Run deterministic validation:
./scripts/validate-hcash-regtest.sh
  1. Stop pool stack:
docker compose -f docker-compose.hcash-regtest.yml down --remove-orphans

HCASH Docker Profile

  • Compose file: docker-compose.hcash-regtest.yml
  • Env file: config/hcash-regtest.env
  • Cookie mount:
    • source: ../hashcash-core/data/node1/regtest/.cookie
    • target: /run/hashcash/.cookie
  • RPC endpoint from container: http://host.docker.internal:10309
  • Chain/profile defaults live in config/hcash-regtest.env:
    • address/network params (CHAIN_*)
    • PoW diff1 target (POW_DIFF1_TARGET)
    • vardiff tuning (STRATUM_*)

Ports:

  • Stratum: 3333/tcp
  • API: 3334/tcp (localhost bound)

Miner Connection

  • Stratum URL: stratum+tcp://<host>:3333
  • Authorization format: <HCASH_ADDRESS>.<worker>
  • Expected address support:
    • hcash1... bech32
    • HCASH legacy base58 prefixes

Pool Fee Config

  • DEV_FEE_ADDRESS: fee payout address.
  • DEV_FEE_PERCENT: fee percentage (0 < fee < 100, defaults to 1.5 if invalid).
  • If DEV_FEE_ADDRESS is set, the fee split is applied on every template.
  • If DEV_FEE_ADDRESS is empty, payout remains 100% to the miner address.

Additional Docs

Development

npm install
npm run build
npm run start

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 96.9%
  • Shell 2.0%
  • Other 1.1%