{"id":21561762,"url":"https://github.com/synonymdev/nigiri-chopsticks","last_synced_at":"2025-07-16T16:31:06.129Z","repository":{"id":104962056,"uuid":"385914513","full_name":"synonymdev/nigiri-chopsticks","owner":"synonymdev","description":null,"archived":true,"fork":false,"pushed_at":"2021-07-14T11:31:06.000Z","size":4562,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-18T13:02:02.682Z","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-14T11:22:46.000Z","updated_at":"2024-07-24T19:48:18.000Z","dependencies_parsed_at":"2023-07-07T08:17:00.162Z","dependency_job_id":null,"html_url":"https://github.com/synonymdev/nigiri-chopsticks","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/synonymdev/nigiri-chopsticks","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fnigiri-chopsticks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fnigiri-chopsticks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fnigiri-chopsticks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fnigiri-chopsticks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/synonymdev","download_url":"https://codeload.github.com/synonymdev/nigiri-chopsticks/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fnigiri-chopsticks/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.113Z","updated_at":"2025-07-16T16:31:06.121Z","avatar_url":"https://github.com/synonymdev.png","language":null,"readme":"# Nigiri chopsticks\n\nThis is an API passthrough that simply proxies requests to the underlying services.\nIt expects an electrum REST server and an optional RPC server for faucet and custom broadcasting services.\n\n## Usage\n\nClone the repo:\n\n```bash\n$ git clone git@github.com:vulpmeventures/nigiri-chopsticks.git\n```\n\nRun tests:\n\n```\n$ bash scripts/test local\n```\n\nTo run tests locally you must have a running Nigiri instance.\n\nBuild for Linux x64:\n\n```bash\nnigiri-chopsticks $ bash scripts/build linux amd64\n```\n\nBuild for Mac:\n\n```bash\nnigiri-chopsticks $ bash scripts/build darwin amd64\n```\n\nRun:\n\n```bash\nnigiri-chopsticks $ ./build/nigiri-chopsticks-darwin-amd64\n```\n\n## Routes and Customization\n\nThe web server starts at default address `localhost:3000` with the following routes:\n\n- `/faucet` if faucet is enabled, to send funds to an address\n  - example for Bitcoin:\n  ```bash\n  $ curl -X POST --data '{\"address\": \"2MsnWskyHaHvcZUHA4gnR3G95EnUmZQjzM8\", \"amount\": 0.02}' http://localhost:3000/faucet\n  ```\n  - example for Liquid\n  ```bash\n  $ curl -X POST --data '{\"address\": \"2MsnWskyHaHvcZUHA4gnR3G95EnUmZQjzM8\", \"asset\": \"2dcf5a8834645654911964ec3602426fd3b9b4017554d3f9c19403e7fc1411d3\", \"amount\": 0.02}' http://localhost:3000/faucet\n  ```\n- `/mint` (only for Liquid chain) if faucet is enabled, to issue an asset and sent all issuance amount to an address\n  - example:\n  ```bash\n  $ curl -X POST --data '{\"address\": \"ert1q90dz89u8eudeswzynl3p2jke564ejc2cnfcwuq\", \"quantity\": 1000, \"name\": \"TokenName\", \"ticker\":\"TKN\"}' http://localhost:3000/mint\n  ```\n- `/registry` (only for Liquid chain) if faucet is enabled, to get extra info about one or more assets like `name` and `ticker`\n  ```bash\n  $ curl -X POST --data '{\"assets\": [\"2dcf5a8834645654911964ec3602426fd3b9b4017554d3f9c19403e7fc1411d3\"]}' http://localhost:3000/registry\n  # [{\"asset\":\"2dcf5a8834645654911964ec3602426fd3b9b4017554d3f9c19403e7fc1411d3\",\"contract\":{\"name\":\"test\",\"ticker\":\"TST\"},\"issuance_txin\":{\"txid\":\"a0891447adb288e5a49fa10ede7016788a1b3a175cfb423eb133e45f6cefca84\",\"vin\":0},\"name\":\"test\",\"ticker\":\"TST\"\n  ```\n- all [esplora](https://github.com/blockstream/esplora/blob/master/API.md) HTTP API endpoints\n\n**Note:**  \nIf mining is enabled, the esplora broadcast endpoint is wrapped so that a block is mined just after the transaction is published to get it confirmed; this is useful when running in regtest network.  \nAll requests to chopsticks are (optionally) logged using a logger inspired by [negroni](https://github.com/urfave/negroni) package.\n\nTo customize server urls and ports use flags when running the binary:\n\n- `--chain` one between `bitcoin` and `liquid`\n- `--addr` server listening address (default `localhost:3000`)\n- `--rpc-addr` btc RPC server listening address (default `localhost:19001`)\n- `--btc-cookie` btc RPC server user and password (default `admin1:123`)\n- `--liquid-addr` liquid RPC server listening address (default `localhost:18884`)\n- `--electrs-addr` electrs HTTP server listening address (default `localhost:3002`)\n- `--use-tls` specify using either `http` or `https` (default `true`)\n- `--use-faucet` to have a /faucet endpoint available for sending funds\n- `--use-mining` to have the esplora /broadcast endpoint wrapped so that a block is mined after the transaction\n  is published\n- `--use-logger` to log every request/response\n- `--registry-path` to set the path for the asset registry db (default to current directory - Liquid only)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsynonymdev%2Fnigiri-chopsticks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsynonymdev%2Fnigiri-chopsticks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsynonymdev%2Fnigiri-chopsticks/lists"}