Rafiki is open source software that provides an efficient solution for an account servicing entity to enable Interledger functionality on its users' accounts.
This includes
- sending and receiving payments (via SPSP and Open Payments)
- allowing third-party access to initiate payments and view transaction data (via Open Payments)
❗ Rafiki is intended to be run by account servicing entities only and should not be used in production by non-regulated entities.
Rafiki is made up of several components, including an Interledger connector, a high-throughput accounting database called TigerBeetle, and several APIs:
- the Admin APIs to create peering relationships, add supported assets, and issue wallet addresses
- the Open Payments API to allow third parties (with the account holder's consent) to initiate payments and to view the transaction history
- the SPSP API for simple Interledger Payments
Additionally, this package also includes a reference implementation of a GNAP authorization server, which handles the access control for the Open Payment API. For more information on the architecture, check out the Architecture documentation.
Never heard of Interledger before? Or would you like to learn more? Here are some excellent places to start:
Please read the contribution guidelines before submitting contributions. All contributions must adhere to our code of conduct.
Our Rafiki community calls are open to our community members. We have them every Tuesday at 15:30 GMT, via Google Meet.
Google Meet joining info
Video call link: https://meet.google.com/sms-fwny-ezc
Or dial: (GB) +44 20 3956 0467 PIN: 140 111 239#
More phone numbers: https://tel.meet/sms-fwny-ezc?pin=5321780226087
- Git for version control
- Docker to run containerized services
- Node Version Manager (NVM) to manage Node.js versions
After you have Git, Docker, and NVM installed, run the following commands to continue setting up your local development environment.
Clone the Rafiki repository
git clone https://github.com/interledger/rafiki.git
cd rafikiInstall Node.js
nvm install
nvm useInstall pnpm -- a quick and efficient Node.js package manager
corepack enableIf you were previously using Yarn as a package manager, run this:
pnpm cleanInstall dependencies
pnpm iThe Rafiki local environment is the best way to explore Rafiki locally. The localenv directory contains instructions for setting up a local playground. Please refer to the README for each individual package for more details.
| Description | Command |
|---|---|
| Build all of the packages in the repo | pnpm -r build |
| Build a specific package (e.g. backend, frontend, etc.) | pnpm --filter backend build |
| Generate types from specific package GraphQL schema | pnpm --filter backend generate |
| Run individual tests (e.g. backend) | pnpm --filter backend test |
| Run all tests | pnpm -r --workspace-concurrency=1 test |
| Format and lint code | pnpm format |
| Check lint and formatting | pnpm checks |
| Verify code formatting | pnpm check:prettier |
| Verify lint | pnpm check:lint |