These code snippets are intended for use with Rafiki Money. While everyone is welcome to use these code snippets as a reference, please note that they may need to be adapted to suit your particular application.
- Node 20 or higher
- A preferred package manager (
npm,pnpm,yarn) - TSX
- TypeScript Open Payments SDK
Before working with the code snippets, create a test wallet account on the Interledger test network. More information about setting up and funding your test wallet account, as well as obtaining a public-private key pair and ID can be found in the Open Payments documentation. You'll need the private key to complete your setup.
Install dependencies:
# Using NPM
npm install
# Using PNPM
pnpm install
# Using Yarn
yarnWhen you get your public-private key pair, the private key is automatically downloaded to your machine.
Move the private.key file to the root directory of this repository.
Ensure you are at the repository root and execute the following command in your terminal:
cp .env.example .envOpen the newly created .env file and fill in the following variables:
WALLET_ADDRESSKEY_ID
Now that you have all the necessary components to initialize the authenticated Open Payments client, you're ready to begin utilizing the code snippets.
From the repository's root you can execute the following scripts using your preferred package manager:
| Script | Description |
|---|---|
| grant | Request a grant |
| grant:continuation | Continuation request for a grant (interactive) |
| grant:ip | Request a grant for an incoming payment |
| grant:op | Request a grant for an outgoing payment |
| grant:quote | Request a grant for a quote |
| ip:create | Create an incoming payment |
| ip:complete | Complete an incoming payment |
| ip:get | Retrieve an incoming payment |
| ip:list | List incoming payments |
| op:create | Create an outgoing payment |
| op:get | Retrieve an outgoing payment |
| op:list | List outgoing payments |
| quote:create | Create a quote |
| quote:get | Retrieve a quote |
| wa:get | Retrieve wallet address' information |
| wa:get-keys | Retrieve wallet address' JWKs |
| token:revoke | Revoke a token |
| token:revoke:ip | Revoke incoming payment token |
| token:revoke:op | Revoke outgoing payment token |
| token:revoke:quote | Revoke quote token |
| token:rotate | Rotate a token |
| token:rotate:ip | Rotate incoming payment token |
| token:rotate:op | Rotate outgoing payment token |
| token:rotate:quote | Rotate quote token |
Example:
# Using NPM
npm run grant
# Using PNPM
pnpm grant
# Using Yarn
yarn grant