Soroswap Backend

Read more about the Soroswap.Finance Stack in in docs.soroswap.finance

1. Set up

First, create the .env file from the .env.example file and fill in the environment variables.

You can copy the .env.example by running the following command:

cp  .env.example  .env

Once created: fill the POSTGRES_URL variable with the connection string to your database, in the following format:

POSTGRES_URL=protocol://user:password@host:port/database_name

and fill in the remaining values.

[!NOTE] If you will run the development instance (with docker-compose) the "REDIS_HOST" value should be "redis"

If you are developing locally and using the PostgreSQL container of the Docker Compose, your setup should be:

POSTGRES_USER=postgres
POSTGRES_PASSWORD=password
POSTGRES_DATABASE=postgresdb
POSTGRES_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@pgdb:5432/${POSTGRES_DATABASE}?schema=public

2. Build and run the app using Docker

To run the app, execute the following command:

docker-compose  up

If any changes are made to the code, you can rebuild the app by running:

docker-compose  up  --build

3. Run the Prisma migrations, generate the Prisma client and run the app

This should be made inside the backend_backend_1 container, so in toder to do this. First, enter to the backend Docker container by running:

docker exec -it backend_backend_1 bash

Once inside the container, run the following commands:

yarn install # need to run this only once
yarn prisma migrate dev # need to run this only once
yarn prisma generate # need to run this only once
yarn start:dev # need to run this every time

Note: If you want to check what are the containers name, you can just run:

docker ps

Whith this, you can enter to any Docker container's terminal by running:

docker exec -it <CONTAINER_NAME> bash

4. Postgres Database:

Update / Populate: Every time the app starts will populate any missing data from mecury.

Inspect: By default, Prisma provides a "studio" to inspect the tables.

to open it inside the docker container you can run

yarn prisma studio

Reset: if for some reason you need to reset your database you can run the following

yarn prisma db push --force-reset

5. Available Requests examples

All requests can be accessed through the following URL: http://localhost:4000/docs

1. Subscribe to pairs:

curl -X POST \
  http://0.0.0.0:4000/pairs \
  -H 'apiKey: <your_api_key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contractId": [
      "CBV3WDVJ7NC3RKVPBKLWXD46I6HL6GBZHSRBMJ6SLUAUISGITAB3DQO7"
    ],
    "keyXdr": "AAAAFA==",
    "durability": "persistent"
  }'

2. Get mercury pairs count:

curl -X GET \
  http://0.0.0.0:4000/pairs/mercury-count \
  -H 'apiKey: <your_api_key>'

3. Get DB count:

curl -X GET \
  http://0.0.0.0:4000/pairs/count \
  -H 'apiKey: <your_api_key>'

4. Get all liquidity pools:

curl -X POST \
  http://0.0.0.0:4000/pairs/all?network=testnet \
  -H 'apiKey: <your_api_key>'

6. Subscribing to Contracts manually

Factory

You should subscribe to the factory contract before subscribing to any pair. The factory contract is the main contract that manages all the pairs in the network. This should be done manually when a new Factory contract is deployed.

To subscribe to the factory contract, you can use the following script:

yarn subscribe:factory

You may need to reexecute docker-compose up after running the script.

Phoenix

You should subscribe to the phoenix contract before subscribing to any pair. The phoenix contract is the main contract that manages all the pairs in the network for the phoenix protocol. This should be done manually when a new Phoenix contract is deployed.

yarn subscribe:phoenix <contractId> <keyXdr>