{"id":18284616,"url":"https://github.com/libsv/regtest-stack","last_synced_at":"2025-08-02T05:10:26.205Z","repository":{"id":39620281,"uuid":"400565600","full_name":"libsv/regtest-stack","owner":"libsv","description":"A development environment for bitocoin sv development. This sets up a local regtest environment with a bitcoin node, mapi and minerid services. it also adds dashboards for viewing transactions and maintaining the node.","archived":false,"fork":false,"pushed_at":"2022-09-14T14:16:37.000Z","size":115,"stargazers_count":8,"open_issues_count":1,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-07-30T09:48:33.347Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/libsv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-08-27T16:06:34.000Z","updated_at":"2024-02-29T16:26:34.000Z","dependencies_parsed_at":"2022-08-09T22:40:16.356Z","dependency_job_id":null,"html_url":"https://github.com/libsv/regtest-stack","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/libsv/regtest-stack","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libsv%2Fregtest-stack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libsv%2Fregtest-stack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libsv%2Fregtest-stack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libsv%2Fregtest-stack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/libsv","download_url":"https://codeload.github.com/libsv/regtest-stack/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libsv%2Fregtest-stack/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268338289,"owners_count":24234540,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T13:14:10.067Z","updated_at":"2025-08-02T05:10:26.174Z","avatar_url":"https://github.com/libsv.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Regtest Stack\n\nThis repository contains `dockerfile`s and a `docker-compose` configuration to run the following:\n\n* Bitcoin SV in `regtest` mode\n* What's On Chain\n* A custom web dashboard for controlling the mining operations of the Bitcoin SV node\n* mAPI\n* MinerId\n\n## Getting Started\n\n1. Clone this repository\n2. Check and modify `docker-compose.yaml` to set the desired SV Node version (`services/sv/args/VERSION` element). Also check the `sv/build` script if you manually build just that image\n3. `docker-compose up`\n\nYou can also run the system in daemon mode using `docker-compose up -d` and then use the [regtest script file](regtest.sh) to easily execute bitcoin RPC commands, for example:\n\n```\n❯ ./regtest.sh getinfo\n{\n  \"version\": 101000800,\n  \"protocolversion\": 70015,\n  \"walletversion\": 160300,\n  \"balance\": 14937.48993463,\n  \"blocks\": 11720,\n  \"timeoffset\": 0,\n  \"connections\": 0,\n  \"proxy\": \"\",\n  \"difficulty\": 4.656542373906925e-10,\n  \"testnet\": false,\n  \"stn\": false,\n  \"keypoololdest\": 1642815292,\n  \"keypoolsize\": 1999,\n  \"paytxfee\": 0.00000000,\n  \"relayfee\": 0.00000250,\n  \"errors\": \"\",\n  \"maxblocksize\": 2000000000,\n  \"maxminedblocksize\": 512000000,\n  \"maxstackmemoryusagepolicy\": 100000000,\n  \"maxstackmemoryusageconsensus\": 200000000\n}\n```\n\n## Services\n\nThe following services are available:\n\n### SV Node RPC\n\nHost: `localhost`  \nPort: `8332`  \nUser: `rpc`  \nPass: `rpc`  \n\n### SV Node P2P\n\nHost: `localhost`  \nPort: `8333`  \n\n### SV Node ZeroMQ\n\nHost: `localhost`  \nPort: `28332`  \n\n### MinerId\n\nHost: `localhost`  \nPort: `9012`  \n\n[Miner ID reference](https://github.com/bitcoin-sv/minerid-reference) contains commands.\n\nTo create a MinerId, run:\n\n```\nnpm run cli -- generateminerid --name testMiner\n```\n\n### mAPI\n\nHost: `localhost`  \nPort: `9014`  \n\nThe [API reference](https://github.com/bitcoin-sv/merchantapi-reference) has more information as well as the [swagger documentation](https://bitcoin-sv.github.io/merchantapi-reference).\n\n### What's On Chain\n\nURL: `http://localhost:8080`\n\n### Mining Dashboard\n\nURL: `http://localhost:3010`\n\n## Updating SV Node Configuration\n\nThe file `sv/bitcoin.conf` is volume-mounted into the SV Node container during `docker-compose up`. Modify it as required, then restart the node with `docker-compose down` and `docker-compose up`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibsv%2Fregtest-stack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flibsv%2Fregtest-stack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibsv%2Fregtest-stack/lists"}