This is an example project that mocks 5 PFI servers using the tbdex protocol.
Currently mocks five PFI servers and can be extended.
This example will:
- A server which does an "OFAC" check on the customer and issues a verifiable credential only if they are not on the OFAC list.
- Five tbdex protocol implementation that mocks 5 participating financial institutions.
See main.ts for the liquidity node code (server).
NOTE: this is not using market rates, or anything sensible, and is not intended to showcase all regulatory requirements that must be fulfilled. This is for illustrative purposes only, not production use. For a more general exemplar for a PFI liquidity node, please take a look at: https://github.com/TBD54566975/tbdex-pfi-exemplar/ (which also includes a database, this one does not).
This project is a fork of https://github.com/TBD54566975/example-pfi-aud-usd-tbdex
This project is using node v20.3.1 and npm >=v7.0.0. You can verify your node and npm installation via the terminal:
$ node --version
v20.3.1
$ npm --version
9.6.7
If you don't have node installed, feel free to choose whichever installation approach you feel the most comfortable with. If you don't have a preferred installation method, we recommend using nvm (aka node version manager). nvm allows you to install and use different versions of node. It can be installed by running brew install nvm (assuming that you have homebrew)
Once you have installed nvm, install the desired node version with nvm install vX.Y.Z.
(this is a step you only need to do once).
đź’ˇ Make sure you have all the prerequisites Install dependencies
npm install
Run the server (or restart it) in another terminal window:
npm run server
The business logic for the PFI is mainly in main.ts and the offerings as specified in offerings.ts. Each server port is also set up in config.ts. Poke around!
Each interaction happens in the context of an "Exchange" which is a record of the interaction between the customer and the PFI.
Configuration can be set using environment variables. Defaults are set in src/config.ts
| Resource | Description |
|---|---|
| CODEOWNERS | Outlines the project lead(s) |
| CODE_OF_CONDUCT.md | Expected behavior for project contributors, promoting a welcoming environment |
| CONTRIBUTING.md | Developer guide to build, test, run, access CI, chat, discuss, file issues |
| GOVERNANCE.md | Project governance |
| LICENSE | Apache License, Version 2.0 |