This project is a demo application designed to illustrate how to integrate and use the Cybrid Bank API Typescript client. The application executes a Bitcoin trade flow on the Cybrid Sandbox environment by creating a customer, account, quote, and trade. Developers wishing to integrate with the Cybrid Bank API may follow similar patterns demonstrated within this project.
Start by cloning this project to your local machine. Within your local repository, you can install all of the demo application's dependencies, including the Cybrid Bank API client, by executing:
$ npm install
$ npm run compile
The demo application requires API access to the Cybrid Sandbox. To get started in the Sandbox, register for an account at https://www.cybrid.xyz/access. Once logged in, you will be prompted to name your Organization, create a Bank, and generate an API key pair.
This demo application has been tested with Node v18.7.0.
The project comes with an example environment file that outlines the environment variables used by the application. Some environment variables are secret and are required to be provided by the user. Other variables have default values.
Copy the example file example.env as .env:
$ cp example.env .env
Inside .env, configure the environment variables to point to your Bank and API application:
- Set the value of
BANK_GUIDto the GUID of your Sandbox Bank. - Set the value of
APPLICATION_CLIENT_IDandAPPLICATION_CLIENT_SECRETto your generated API Client ID and Client Secret, respectively.
Once your environment is configured, you can run the demo application by executing the run command:
$ npm run start
This will run the application, executing the buy flow. If the flow is successful, and the resulting BTC account reports the expected balance, the application will exit with a return code of 0.
If an invalid state is reported, such as an unexpected balance, or an error is raised during execution, the application will exit with a non-zero return code.