Paid HTTP client using Interledger and node-fetch
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
src
.eslintrc
.gitignore
README.md
index.js
npmrc-env
package-lock.json
package.json
test.js

README.md

ILP Fetch

Simple paid HTTP request library for Interledger. Based on node-fetch.

Usage

The ILP Fetch API supports all the options that are present in the node-fetch API.

Two additional fields are added:

  • plugin: The ILP plugin used to make payments.
  • maxPrice: The maximum, in the plugin's base units, which ILP fetch will send.

Example

The below example will upload a file containing hello world to Unhash (content-addressed storage on top of ILP).

const plugin = require('ilp-plugin')()
const fetch = require('.')

fetch('https://alpha.unhash.io', {
  plugin,
  maxPrice: 100,
  method: 'POST',
  body: 'hello world'
})
  .then(r => r.json())
  .then(json => {
    console.log('json response:', json)
    process.exit(0)
  })
  .catch(e => {
    console.error(e)
    process.exit(1)
  })

Test

First run Moneyd on your machine. Then:

git clone https://github.com/interledgerjs/ilp-fetch.git
cd ilp-fetch
npm install
DEBUG=* node test.js

In the Browser

Because ILP fetch is based around Fetch, it is possible for it to run in the browser. Because of the restricted use of headers and cross-origin requests (and because it is not possible to access moneyd from within a webpage), it may not be useful in an ordinary webpage.

However, in the evironment of an extension it can be useful to make payment-enabled requests. Additionally, an extension should have no problems making cross-origin requests or accessing moneyd.

Just add the following block to your webpack config:

  externals: {
    'node-fetch': 'fetch'
  }