Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/interledger-deprecated/ilp-plugin-bitcoin-paychan
ILP ledger plugin for simple unidirectional Bitcoin payment channels
https://github.com/interledger-deprecated/ilp-plugin-bitcoin-paychan
bitcoin blockchain cltv interledger ledger-plugin payment-channel
Last synced: 3 months ago
JSON representation
ILP ledger plugin for simple unidirectional Bitcoin payment channels
- Host: GitHub
- URL: https://github.com/interledger-deprecated/ilp-plugin-bitcoin-paychan
- Owner: interledger-deprecated
- Created: 2017-05-25T15:29:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-20T21:46:43.000Z (over 6 years ago)
- Last Synced: 2024-04-14T10:59:10.330Z (7 months ago)
- Topics: bitcoin, blockchain, cltv, interledger, ledger-plugin, payment-channel
- Language: JavaScript
- Size: 290 KB
- Stars: 22
- Watchers: 8
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ilp-plugin-bitcoin-paychan
> Interledger.js Ledger Plugin for Bitcoin using CLTV Payment ChannelsThis plugin enables [Interledger](https://interledger.org) payments through [Bitcoin](https://bitcoin.org) using simple payment channels.
`ilp-plugin-bitcoin-paychan` implements the [Interledger.js Ledger Plugin Interface](https://github.com/interledger/rfcs/blob/master/0024-ledger-plugin-interface-2/0024-ledger-plugin-interface-2.md), which allows Bitcoin to be used with [`ilp` client](https://github.com/interledgerjs/ilp) and the [`ilp-connector`](https://github.com/interledgerjs/ilp-connector).
## Installation
**Dependencies:**
- Node.js >=v7.10.0
- Bitcoin Cored Node**Setup:**
```sh
git clone https://github.com/interledgerjs/ilp-plugin-bitcoin-paychan.git
cd ilp-plugin-bitcoin-paychan
npm install
```## How It Works
`ilp-plugin-bitcoin-paychan` uses simple unidirectional Bitcoin payment channels implemented with [CHECKLOCKTIMEVERIFY (CLTV)](https://github.com/bitcoin/bips/blob/master/bip-0065.mediawiki). While the underlying channel is not conditional (i.e. does not use hashlocks), the plugin only sends updates to the channel when it receives the fulfillment from the other party. This means that payments that there is some risk for payments that are in flight. However, the Interledger Protocol isolates participants from risk from indirect peers.
By implementing all of the functions required by the [Ledger Plugin Interface](https://github.com/interledger/rfcs/blob/master/0004-ledger-plugin-interface/0004-ledger-plugin-interface.md), this allows Bitcoin to be used by standard Interledger.js components.
For more information about how Interledger works, see [IL-RFC 1: Interledger Architecture](https://github.com/interledger/rfcs/blob/master/0001-interledger-architecture/0001-interledger-architecture.md).