{"id":13499172,"url":"https://github.com/nayutaco/ptarmigan","last_synced_at":"2026-01-14T16:39:42.545Z","repository":{"id":133342946,"uuid":"97938608","full_name":"nayutaco/ptarmigan","owner":"nayutaco","description":"Lightning Network (BOLT)","archived":true,"fork":false,"pushed_at":"2021-10-19T02:52:28.000Z","size":55188,"stargazers_count":134,"open_issues_count":120,"forks_count":20,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-05-19T10:17:06.033Z","etag":null,"topics":["bitcoin","lightning-network"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nayutaco.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}},"created_at":"2017-07-21T10:59:52.000Z","updated_at":"2025-02-20T16:24:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"a9f3c9c6-ed2e-490e-877a-6ccbc1d0d7bd","html_url":"https://github.com/nayutaco/ptarmigan","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/nayutaco/ptarmigan","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nayutaco%2Fptarmigan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nayutaco%2Fptarmigan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nayutaco%2Fptarmigan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nayutaco%2Fptarmigan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nayutaco","download_url":"https://codeload.github.com/nayutaco/ptarmigan/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nayutaco%2Fptarmigan/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28426119,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T16:32:27.303Z","status":"ssl_error","status_checked_at":"2026-01-14T16:28:36.419Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["bitcoin","lightning-network"],"created_at":"2024-07-31T22:00:30.429Z","updated_at":"2026-01-14T16:39:42.531Z","avatar_url":"https://github.com/nayutaco.png","language":"C","funding_links":[],"categories":["Lightning Network Protocol","Awesome Embedded Bitcoin [![Awesome](https://awesome.re/badge-flat.svg)](https://awesome.re)"],"sub_categories":["Implementations","Embedded Projects"],"readme":"# Ptarmigan\n\n[![Build Status](https://travis-ci.org/nayutaco/ptarmigan.svg?branch=development)](https://travis-ci.org/nayutaco/ptarmigan)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)\n![Issue Welcome](https://img.shields.io/badge/issue-welcome-brightgreen.svg)\n\u003c!-- [![Coverity Scan Build Status](https://scan.coverity.com/projects/15128/badge.svg)](https://scan.coverity.com/projects/nayutaco-ptarmigan) --\u003e\n\n![Ptarmigan](docs/images/ptarmigan_text.png)\n\n## About\n\n* [Lightning Network BOLT](https://github.com/lightningnetwork/lightning-rfc) implementation\n* In Japanese, `ptarmigan` is called \"雷 (thunder) 鳥 (bird)\".\n\n## Setup\n\n* Ubuntu 18.04\n* bitcoind\n  * above v0.17 (`getnetworkinfo` version \u003e= 170000)\n  * bitcoin mainnet / testnet / regtest\n  * NOTE\n    * not support bitcoin.conf section format\n\n## Install\n\n```bash\nsudo apt install -y git autoconf pkg-config build-essential libtool python3 wget jq bc\n\ngit clone https://github.com/nayutaco/ptarmigan.git\ncd ptarmigan\nmake full\n\n# takes a lot of time...\n```\n\n[NOTE and details](docs/INSTALL.md)\n\n## Starting `bitcoind`\n\nAt first, start `bitcoind`.\n`ptarmd` use bitcoind JSON-RPC, so need `rpcuser` and `rpcpassword`.\n\n* bitcoin.conf sample\n\n```text\nrpcuser=bitcoinuser\nrpcpassword=bitcoinpassword\nserver=1\ntxindex=1\ntestnet=1\n```\n\n```bash\nbitcoind -daemon\n\n# check started chain\nbitcoin-cli getblockchaininfo | jq -e '.chain'\n```\n\n## Starting `ptarmd`\n\nFor starting `ptarmd`, you should make new node as follows.\n\n```bash\ncd ptarmigan/install\n./new_nodedir.sh [NODENAME]\ncd [NODENAME]\n\n# start ptarmigan daemon\n#   CHAIN=mainnet, testnet or regtest\n../ptarmd --network=testnet\n```\n\n## How to use\n\n* [How to use](docs/howtouse.md)\n* [How to use REST API](docs/howtouse_rest_api.md)\n\nNote: `ptarmigan` has interfaces of CLI, JSON-RPC and REST API.\nBut CLI and JSON-RPC will change in the near future.\nTry the newer REST API interface.\n\n## Dependency\n\n### libraries\n\n* git submodule\n  * [ARMmbed/MbedTLS](https://github.com/ARMmbed/mbedtls)\n  * [LMDB/lmdb](https://github.com/LMDB/lmdb)\n  * [akheron/jansson](https://github.com/akheron/jansson)\n  * [benhoyt/inih](https://github.com/benhoyt/inih)\n  * [curl/curl](https://github.com/curl/curl)\n  * [enki/libev](https://github.com/enki/libev)\n  * [luke-jr/libbase58](https://github.com/luke-jr/libbase58)\n  * [madler/zlib](https://github.com/madler/zlib)\n  * [nayutaco/jsonrpc-c](https://github.com/nayutaco/jsonrpc-c) - forked from [hmng/jsonrpc-c](https://github.com/hmng/jsonrpc-c)\n\n* download\n  * [boost](http://www.boost.org/) (for dijkstra shortest paths)\n  * [OpenSSL](https://www.openssl.org/) (only `USE_OPENSSL`)\n\n* reference code\n  * [sipa/bech32](https://github.com/sipa/bech32)\n\n### application\n\n* [bitcoind](https://github.com/bitcoin/bitcoin)\n  * JSON-RPC\n    * `getrawtransaction`\n    * `signrawtransactionwithwallet`\n    * `sendrawtransaction`\n    * `gettxout`\n    * `getblock`\n    * `getblockhash`\n    * `getblockcount`\n    * `getnewaddress`\n    * `estimatesmartfee`\n    * `getnetworkinfo`\n    * `listunspent`\n    * `lockunspent`\n\n## Security\n\nIf you find any issues regarding security,\nplease disclose the information by sending an (possibly encrypted) email to security at nayuta dot co.\n[Our PGP key `3C95B178758342844787766AAF91183E1DCC4222`](https://pgp.mit.edu/pks/lookup?op=vindex\u0026search=0xAF91183E1DCC4222).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnayutaco%2Fptarmigan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnayutaco%2Fptarmigan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnayutaco%2Fptarmigan/lists"}