This software is a database-backed web server that serves as a back end for Ripple Gateway applications. Server, Javascript Client, and CLI are provided as interfaces to a deployed gateway.
The Ripple Gateway's features include:
- user registration
- hosted wallets
- deposits
- widthdrawals
- off-ledger accounting
- payment monitoring
- issuing currency
- sending and receiving
- gateway administration
- federation protocol
See the Application Programming Interface Docs to the Ripple Gateway for usage.
- Node.js
- The express web module is used to serve HTTP/JSON endpoints
- A Basic Auth strategy is used for authentication of users, admin.
- Important NPM modules include: passport, db-migrate, sequelize, ripple-lib, pg, nconf, commander, bignumber.js, validator, and mocha
- Postgres
- The easiest way to get started with Postgres is by launching a free database hosted by Heroku
- For local development on Mac the simplest installation is via the Postgres App by Heroku.
- On Ubuntu, install and configure Postgres using the aptitude package manager and the psql tool.
- The Ripple REST API provides a simplified HTTP/JSON interface to all the Ripple protocol network operations, such as payments and other transactions.
The gateway server software requires git, g++, make, nodejs, postgres, and several npm modules.
- Detailed installation instructions for Ubuntu 13.10
A node.js http client library is provided that maps functions one-to-one to HTTP API commands
A CLI tool is provided for interacting with the API and configuring the gateway as an admin