michielbdejong/ilp-kit repository overview

⁠
ILP Kit

⁠ ILP wallet with hosted ledger and connector instances

⁠Setup⁠

• The easy way: with docker-compose⁠
• On Google Cloud Engine: https://github.com/sappenin/ilpkit-google-cloud/tree/master/ilpkit-gce-single⁠
• On Heroku: https://heroku.com/deploy?template=https://github.com/interledgerjs/ilp-kit/tree/release⁠

⁠Development⁠

See https://github.com/interledgerjs/ilp-kit/blob/master/docs/DEV.md⁠

⁠Table of contents

• Environment variables⁠
• Advanced Mode⁠
• Architecture⁠
  • Backend (REST API)⁠
    • API docs⁠
    • SPSP⁠
      • Webfinger⁠
  • Client⁠
    • Using Redux DevTools⁠
    • Theme Customization⁠

⁠Environment variables

Note: Most of the variables can either be set as environment variable or in a config file. The default config file is env.list. Environment variables take precedence over variables set in the config file.

⁠Required

⁠Optional

⁠Default five-bells-ledger environment variables

(used if the API_LEDGER_URI is not specified). You can read more about these variables in the five-bells-ledger readme⁠.

⁠Advanced Mode

ILP kit UI comes with an "advanced mode" for developers and advanced users. You can activate it with a hot-key: option+d on Mac or alt+d on Windows.

⁠Architecture

ILP kit consists of:

• a Five Bells ledger (the 'ledger' process)
• a Node.js⁠ (developed on v7.7.1) 'api' process, containing a connector and SPSP receivers
• html+js+css statics, built using React⁠
• a 'server' process which serves the statics on example.com, the ledger on example.com/ledger, the api on example.com/api
• an nginx instance in front the server process, which handles https termination

⁠Backend (REST API)

The backend is responsible for communicating with the ILP ledger, creating accounts, sending payments and keeping the payment history.

⁠API docs

• stable (release branch) - https://interledgerjs.github.io/ilp-kit/apidoc⁠
• latest (master branch) - https://interledgerjs.github.io/ilp-kit/apidoc/master⁠

⁠How it works

The wallet implements SPSP⁠ for initiating and receiving payments.

This means it announces an SPSP address of the form user@host, and links this to two things:

• an ILP address (roughly of the form g.us.usd.host.user, but this is not enforced, and your ILP address is not a unique string)
• a cryptographic key pair, used indirectly to generate and fulfill crypto conditions.

The connector component can peer with other connectors on the Interledger, and basically acts as a router.

The ledger can handle payments that are conditional on a cryptographic condition, and that's where the power of ILP lies. When you send money to an account on another ledger, your connector conditionally pays the next connector, all the way to the receiving connector. The receiving connector adds a conditional payment to the receiving ledger, and the receiver (which lives in the API component) fulfills the crypto condition, using (a key which from) the receiver's public key.

Only the receiver of an Interledger payment can fulfill the crypto condition, and that's why you can be sure that the intermediate hops will all roll back if the money cannot be safely delivered.

⁠Webfinger

Webfinger is used to lookup account/user identifiers.

Example request

curl -X GET
https://wallet.example/.well-known/webfinger?resource=acct:[email protected]

Example response

HTTP/1.1 200 OK
{
  "subject": "acct:[email protected]",
  "links": [
    {
      "rel": "https://interledger.org/rel/ledgerUri",
      "href": "https://red.ilpdemo.org/ledger"
    },
    {
      "rel": "https://interledger.org/rel/socketIOUri",
      "href": "https://red.ilpdemo.org/api/socket.io"
    },
    {
      "rel": "https://interledger.org/rel/ledgerAccount",
      "href": "https://red.ilpdemo.org/ledger/accounts/alice"
    },
    {
      "rel": "https://interledger.org/rel/sender/payment",
      "href": "https://red.ilpdemo.org/api/payments"
    },
    {
      "rel": "https://interledger.org/rel/sender/pathfind",
      "href": "https://red.ilpdemo.org/api/payments/findPath"
    },
    {
      "rel": "https://interledger.org/rel/spsp/v2",
      "href": "https://red.ilpdemo.org/api/spsp/alice"
    }
  ]
}

⁠Client

The client is a web app built on React⁠ that implements user signup/signin, sending payments and payment history.

Client state management is handled by Redux⁠.

⁠Theme Customization

npm install generates a src/theme/variables.scss which contains the theme colors. You can manually edit it.

Database has two tables: Users and Payments.