Ptarmigan

About

Lightning Network BOLT implementation
In Japanese, ptarmigan is called "雷 (thunder) 鳥 (bird)".

Setup

Ubuntu 18.04
bitcoind
- above v0.17 (getnetworkinfo version >= 170000)
- bitcoin mainnet / testnet / regtest
- NOTE
  - not support bitcoin.conf section format

Install

sudo apt install -y git autoconf pkg-config build-essential libtool python3 wget jq bc

git clone https://github.com/nayutaco/ptarmigan.git
cd ptarmigan
make full

# takes a lot of time...

NOTE and details

Starting `bitcoind`

At first, start bitcoind. ptarmd use bitcoind JSON-RPC, so need rpcuser and rpcpassword.

bitcoin.conf sample

rpcuser=bitcoinuser
rpcpassword=bitcoinpassword
server=1
txindex=1
testnet=1

bitcoind -daemon

# check started chain
bitcoin-cli getblockchaininfo | jq -e '.chain'

Starting `ptarmd`

For starting ptarmd, you should make new node as follows.

cd ptarmigan/install
./new_nodedir.sh [NODENAME]
cd [NODENAME]

# start ptarmigan daemon
#   CHAIN=mainnet, testnet or regtest
../ptarmd --network=testnet

How to use

Note: ptarmigan has interfaces of CLI, JSON-RPC and REST API. But CLI and JSON-RPC will change in the near future. Try the newer REST API interface.

Dependency

libraries

git submodule
- ARMmbed/MbedTLS
- LMDB/lmdb
- akheron/jansson
- benhoyt/inih
- curl/curl
- enki/libev
- luke-jr/libbase58
- madler/zlib
- nayutaco/jsonrpc-c - forked from hmng/jsonrpc-c
download
- boost (for dijkstra shortest paths)
- OpenSSL (only USE_OPENSSL)
reference code
- sipa/bech32

application

bitcoind
- JSON-RPC
  - getrawtransaction
  - signrawtransactionwithwallet
  - sendrawtransaction
  - gettxout
  - getblock
  - getblockhash
  - getblockcount
  - getnewaddress
  - estimatesmartfee
  - getnetworkinfo
  - listunspent
  - lockunspent

Security

If you find any issues regarding security, please disclose the information by sending an (possibly encrypted) email to security at nayuta dot co. Our PGP key 3C95B178758342844787766AAF91183E1DCC4222.