{"id":21561761,"url":"https://github.com/synonymdev/nigiri","last_synced_at":"2025-07-16T16:31:05.814Z","repository":{"id":104962061,"uuid":"387741472","full_name":"synonymdev/nigiri","owner":"synonymdev","description":null,"archived":true,"fork":false,"pushed_at":"2021-08-19T12:05:40.000Z","size":8047,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-18T13:02:02.648Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/synonymdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-20T09:33:04.000Z","updated_at":"2024-05-06T15:29:23.000Z","dependencies_parsed_at":null,"dependency_job_id":"72878b67-6fab-4f8e-a07f-b46321360e9a","html_url":"https://github.com/synonymdev/nigiri","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/synonymdev/nigiri","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fnigiri","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fnigiri/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fnigiri/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fnigiri/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/synonymdev","download_url":"https://codeload.github.com/synonymdev/nigiri/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fnigiri/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265524626,"owners_count":23782014,"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","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-24T09:27:54.104Z","updated_at":"2025-07-16T16:31:05.804Z","avatar_url":"https://github.com/synonymdev.png","language":null,"readme":"# 🍣 Nigiri Bitcoin \n\nNigiri provides a command line interface that manages a selection of `docker-compose` batteries included to have ready-to-use bitcoin `regtest` development environment, with a **bitcoin** node, **electrum** explorer both backend and frontend user interface. \n\nIt offers a [JSON HTTP proxy passtrough](https://github.com/vulpemventures/nigiri-chopsticks) that adds to the explorer handy endpoints like `/faucet` and automatic block generation when calling the `/tx` pushing a transaction.\n\nYou can have Elements too with the `--liquid` flag.\n\n\n# No time to make a Nigiri yourself?\n## Pre-built binary\n\n\n* Download and install `nigiri` command line interface\n\n```\n$ curl https://getnigiri.vulpem.com | bash\n```\n\nThis will create a directory `~/.nigiri` copying there `{bitcoin|elements}.conf` you can modify.\n\n\n* Lauch Docker daemon (Mac OSX)\n\n```\n$ open -a Docker\n``` \nYou may want to [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)\n\n* Close and reopen your terminal, then start Bitcoin and Liquid\n\n```\n$ nigiri start --liquid\n```\n**That's it.**\nGo to http://localhost:5000 for quickly inspect the Bitcoin blockchain or http://localhost:5001 for Liquid.\n\n* Use the Bitcoin CLI inside the box\n\n```\n$ nigiri rpc getnewaddress \"\" \"bech32\"\nbcrt1qsl4j5je4gu3ecjle8lckl3u8yywh8rff6xxk2r\n```\n\n* Use the Elements CLI inside the box\n\n```\n$ nigiri rpc --liquid getnewaddress \"\" \"bech32\"\nel1qqwwx9gyrcrjrhgnrnjq9dq9t4hykmr6ela46ej63dnkdkcg8veadrvg5p0xg0zd6j3aug74cv9m4cf4jslwdqnha2w2nsg9x3\n```\n\n# Make from scratch\n## Utensils\n\n* [Docker (compose)](https://docs.docker.com/compose/)\n* Go\n\n## Ingredients\n\n* [Bitcoin daemon](https://bitcoin.org/en/bitcoin-core/)\n* [Liquid daemon](https://blockstream.com/liquid/)\n* [Electrum server](https://github.com/Blockstream/electrs)\n* [Esplora](https://github.com/Blockstream/esplora)\n* [Nigiri Chopsticks](https://github.com/vulpemventures/nigiri-chopsticks)\n\n## Directions\n\n| Preparation Time: 5 min  | Cooking Difficulty: Easy |\n| --- | --- |\n\n* Clone the repo:\n\n```bash\n$ git clone https://github.com/vulpemventures/nigiri.git\n```\n\n* Enter project directory and install dependencies:\n\n```bash\n$ make install\n```\n\n\n* Build binary \n\n```\n$ make build\n```\n\nDone! You should be able to find the binary in the local `./build` folder. Give it permission to execute and move/rename into your PATH.\n\n\n* Clean\n\nRemeber to always `clean` Nigiri before running `install` to upgrade to a new version.\n\n```\n$ make clean\n```\n\n\n\n## Tasting\n\nAt the moment bitcoind, elements and electrs are started on *regtest* network.\n\n\n*  Start nigiri:\n\n```bash\n$ nigiri start\n```\nUse the `--liquid` flag to let you do experiments with the Liquid sidechain. A liquid daemon and a block explorer are also started when passing this flag.\n\n* Stop nigiri:\n\n```bash\n$ nigiri stop\n```\nUse the `--delete` flag to not just stop Docker containers but also to remove them and delete the config file and any new data written in volumes.\n\n* Generate and send bitcoin to given address\n\n```bash\n# Bitcoin\n$ nigiri faucet bcrt1qsl4j5je4gu3ecjle8lckl3u8yywh8rff6xxk2r\n\n# Elements\n$ nigiri faucet --liquid el1qqwwx9gyrcrjrhgnrnjq9dq9t4hykmr6ela46ej63dnkdkcg8veadrvg5p0xg0zd6j3aug74cv9m4cf4jslwdqnha2w2nsg9x3\n```\n\n* Liquid only Issue and send a given quantity of an asset\n\n```bash\n$ nigiri mint el1qqwwx9gyrcrjrhgnrnjq9dq9t4hykmr6ela46ej63dnkdkcg8veadrvg5p0xg0zd6j3aug74cv9m4cf4jslwdqnha2w2nsg9x3 1000 VulpemToken VLP\n```\n\n* Broadcast a raw transaction and automatically generate a block\n\n```bash\n# Bitcoin\n$ nigiri push \u003chex\u003e\n\n# Elements\n$ nigiri push --liquid \u003chex\u003e\n```\n\n* Check the logs of Bitcoin services\n\n```bash\n# Bitcoind\n$ nigiri logs node\n# Electrs\n$ nigiri logs electrs\n# Chopsticks\n$ nigiri logs chopsticks\n```\n\n* Check the logs of Liquid services\n\n```bash\n# Elementsd\n$ nigiri logs node --liquid\n# Electrs Liquid\n$ nigiri logs electrs --liquid\n# Chopsticks Liquid\n$ nigiri logs chopsticks --liquid\n```\n\n* Use the Bitcoin CLI inside the box\n\n```\n$ nigiri rpc getnewaddress \"\" \"bech32\"\nbcrt1qsl4j5je4gu3ecjle8lckl3u8yywh8rff6xxk2r\n```\n\n* Use the Elements CLI inside the box\n\n```\n$ nigiri rpc --liquid getnewaddress \"\" \"bech32\"\nel1qqwwx9gyrcrjrhgnrnjq9dq9t4hykmr6ela46ej63dnkdkcg8veadrvg5p0xg0zd6j3aug74cv9m4cf4jslwdqnha2w2nsg9x3\n```\n\n* Run in headless mode (without Esplora)\nIf you are looking to spin-up Nigiri in Travis or Github Action you can use the `--ci` flag.\n\n```\n$ nigiri start --ci [--liquid]\n```\n\n\n* Update the docker images\n\n```\n$ nigiri update\n```\n\n\n\n\nNigiri uses the default directory `~/.nigiri` to store configuration files and docker-compose files.\nTo set a custom directory use the `--datadir` flag.\n\nRun the `help` command to see the full list of available flags.\n\n## Nutrition Facts\n\n`Chopsticks` service exposes on port `3000` (and on `3001` if started with `--liquid` flag) all [Esplora's available endpoints](https://github.com/blockstream/esplora/blob/master/API.md) and extends them with the following:\n\n\n### Bitcoin \u0026 Liquid\n\n- `POST /faucet` which expects a body `{ \"address\": \u003creceiving_address\u003e }` \n- `POST /tx` has been extended to automatically mine a block when is called.\n\n### Liquid only\n\n- `POST /mint` which expects a body `{\"address\": \"ert1q90dz89u8eudeswzynl3p2jke564ejc2cnfcwuq\", \"quantity\": 1000, \"name\":\"VULPEM\", \"ticker\":\"VLP\"}` \n- `POST /registry` to get extra info about one or more assets like `name` and `ticker` which expects a body with an array of assets `{\"assets\": [\"2dcf5a8834645654911964ec3602426fd3b9b4017554d3f9c19403e7fc1411d3\"]}`\n\n\n## Footnotes\n\nIf you really do love Sathoshi's favourite dish like us at Vulpem Ventures, check the real [recipe](https://www.allrecipes.com/recipe/228952/nigiri-sushi/) out and enjoy your own, delicious, hand made nigiri sushi.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsynonymdev%2Fnigiri","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsynonymdev%2Fnigiri","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsynonymdev%2Fnigiri/lists"}