This is a low-level interface to ILP, largely intended for building ILP into other Application layer protocols.

• Generate Interledger Payment Requests on the receiving side, including handling Crypto Condition generation and fulfillment)
• Pay for payment requests on the sending side
• Quote and send payments through multiple ledger types (using ilp-core)

• Account discovery
• Amount negotiation
• Communication of requests from recipient to sender

For a higher-level interface that includes the above features, see the Wallet Client.

npm install --save ilp ilp-plugin-bells

Note that ledger plugins must be installed alongside this module

The client uses recipient-generated Interledger Payment Requests, which include the condition for the payment. This means that the recipient must first generate a payment request, which the sender then fulfills. This client library handles the generation of such requests, but not the communication of the request details from the recipient to the sender.

'use strict'

const ILP = require('ilp')
const FiveBellsLedgerPlugin = require('ilp-plugin-bells')
const receiver = ILP.createReceiver({
  _plugin: FiveBellsLedgerPlugin,
  prefix: 'ilpdemo.blue.',
  account: 'https://blue.ilpdemo.org/ledger/accounts/receiver',
  password: 'receiver'
})
receiver.listen()

const paymentRequest = receiver.createRequest({
  amount: 10
})

// XXX: user implements this
sendRequestToPayer(paymentRequest)

// This automatically checks the incoming transfer and fulfills the condition
receiver.on('incoming', (transfer, fulfillment) => {
  console.log('Got paid ' + paymentRequest.destinationAmount + ' for ' + paymentRequest.destinationMemo.thisIsFor)
})

'use strict'

const ILP = require('ilp')
const FiveBellsLedgerPlugin = require('ilp-plugin-bells')
const sender = ILP.createSender({
  _plugin: FiveBellsLedgerPlugin,
  prefix: 'ilpdemo.red.',
  account: 'https://red.ilpdemo.org/ledger/accounts/alice',
  password: 'alice'
})

// XXX: user implements this
const paymentRequest = { /* request from recipient */ }

sender.quoteRequest(paymentRequest)
  .then((paymentParams) => {
    return sender.payRequest(paymentParams)
  })

'use strict'

const co = require('co')
const ILP = require('ilp')
const FiveBellsLedgerPlugin = require('ilp-plugin-bells')

const sender = ILP.createSender({
  _plugin: FiveBellsLedgerPlugin,
  prefix: 'ilpdemo.red.',
  account: 'https://red.ilpdemo.org/ledger/accounts/alice',
  password: 'alice'
})

const receiver = ILP.createReceiver({
  _plugin: FiveBellsLedgerPlugin,
  prefix: 'ilpdemo.blue.',
  account: 'https://blue.ilpdemo.org/ledger/accounts/bob',
  password: 'bobbob'
})

co(function * () {
  yield receiver.listen()
  receiver.on('incoming', (transfer, fulfillment) => {
    console.log('received transfer:', transfer)
    console.log('fulfilled transfer hold with fulfillment:', fulfillment)
  })

  const request = receiver.createRequest({
    amount: '10',
  })
  console.log('request:', request)

  const paymentParams = yield sender.quoteRequest(request)
  console.log('paymentParams', paymentParams)

  const result = yield sender.payRequest(paymentParams)
  console.log('sender result:', result)
}).catch((err) => {
  console.log(err)
})

Returns an ILP Sender to quote and pay for payment requests.

Kind: inner method of Sender

• ~createSender(opts) ⇒ Sender
  • ~quoteSourceAmount(destinationAddress, sourceAmount) ⇒ Promise.<String>
  • ~quoteDestinationAmount(destinationAddress, destinationAmount) ⇒ Promise.<String>
  • ~quoteRequest(paymentRequest) ⇒ Promise.<PaymentParams>
  • ~payRequest(paymentParams) ⇒ Promise.<String>
  • ~stopListening() ⇒ Promise.<null>

Get a fixed source amount quote

Kind: inner method of createSender
Returns: Promise.<String> - destinationAmount

Get a fixed destination amount quote

Kind: inner method of createSender
Returns: Promise.<String> - sourceAmount

Quote a request from a receiver

Kind: inner method of createSender
Returns: Promise.<PaymentParams> - Resolves with the parameters that can be passed to payRequest

Pay for a payment request. Uses a determinstic transfer id so that paying is idempotent (as long as ledger plugins correctly reject multiple transfers with the same id)

Kind: inner method of createSender
Returns: Promise.<String> - Resolves with the condition fulfillment

Disconnect from the ledger and stop listening for events.

Kind: inner method of createSender
Returns: Promise.<null> - Resolves when the sender is disconnected.

Returns an ILP Receiver to create payment requests, listen for incoming transfers, and automatically fulfill conditions of transfers paying for the payment requests created by the Receiver.

Kind: inner method of Receiver

• ~createReceiver(opts) ⇒ Receiver
  • ~getAddress() ⇒ String
  • ~createRequest() ⇒ Object
  • ~listen() ⇒ Promise.<null>
  • ~stopListening() ⇒ Promise.<null>

Get ILP address

Kind: inner method of createReceiver

Create a payment request

Kind: inner method of createReceiver

Listen for incoming transfers and automatically fulfill conditions for transfers corresponding to requests this receiver created.

Kind: inner method of createReceiver
Returns: Promise.<null> - Resolves when the receiver is connected
Emits: incoming, incoming:requestid

Disconnect from the ledger and stop listening for events.

Kind: inner method of createReceiver
Returns: Promise.<null> - Resolves when the receiver is disconnected.

IncomingTransfer from the ledger plugin and the fulfillment string

Kind: event emitted by Receiver

IncomingTransfer from the ledger plugin and the fulfillment string for a specific request

Kind: event emitted by Receiver