Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/rainlanguage/rain.solver

Node.js app that solves (clears) Rain Orderbook orders against onchain liquidity (DEXes, other Rain Orderbooks and orders)
https://github.com/rainlanguage/rain.solver

Last synced: 4 months ago
JSON representation

Node.js app that solves (clears) Rain Orderbook orders against onchain liquidity (DEXes, other Rain Orderbooks and orders)

Awesome Lists containing this project

README 

          
# Rain Solver

Rain Solver (also known as Rain Orderbook Arbitrage Bot) is a NodeJS app that solves (clears) Rain orderbook orders against major DeFi platforms liquidity, other Rain Orderbooks and opposite orders of the same Rain Orderbook, by finding arbitrage trades for token pairs of the active orders that are queried from a subgraph, once an opportunity is found a transaction is submitted to one of [Rain Arb Contracts](https://github.com/rainprotocol/rain.orderbook/tree/main/src/concrete) which handles the clearing process from there.



This app requires NodeJS v22 or higher to run and is docker ready.

This app can also be run in Github Actions with a cron job, please read below for more details.



## The Case for Profitability

Profitablity can be adjusted by using an integer ≥0 for `gasCoveragePercentage` config arg as the percentage of the gas cost of the transaction, denominated in receiving ERC20 token, the cost of the transaction is calculated in the receiving ERC20 token unit with current market price of that token against chain's native token.



for example:

- If set to 100, the receiving profit must be at least equal or greater than tx gas cost.

- If set above 100, the receiving profit must be more than the amount of gas cost, for example a transaction costs 0.01 USDT (calculated by current market price of ETH/USDT) and a value of 500 means the profit must be at least 5x the amount of gas used i.e. ≥0.05 USDT for the transaction to be successfull, so at least 0.04 USDT profit will be guaranteed.

- If set to 0, profitablity becomes irrevelant meaning any match will be submitted irrespective of whether or not the transaction will be profitable. 



## Tutorial

### Setup

Start by cloning the repo and then:

- with nix package manager (recommended way):



first you need to run `./prep-sushi.sh` which would need nix package manager installed on your system:

```bash

./prep-sushi.sh

```

next enter nix shell:

```bash

nix develop

```

and then:

```bash

npm install

npm run build

```

  or without entering the nix shell

```bash

nix develop -c npm install

nix develop -c npm run build

```



- without nix package manager:



you need to have pnpm `>= v8.15.3` and then run the following:

```bash

git submodule update --init --recursive

cd lib/sushiswap

pnpm install --frozen-lockfile

pnpm exec turbo run build --filter=./packages/sushi

cd ../..

```

and then install the dependencies, requires `>= nodejs v22`:

```bash

npm install

npm run build

```



### CLI

The app requires a config yaml file to operate and by default it looks in `./config.env.yaml`, however the path of the config file can be passed by using `-c` or `--config` flag on cli or set in `CONFIG` env variable, for more details about config file, please see `./config.example.yaml`.



For starting the app:

- with nix package manager (recommended way):



from nix shell:

if you are not already in nix shell, enter by following command:

```bash

nix develop

```

and then:

```bash

node rain-solver 

```



out of nix shell:



run the following if you don't want to enter nix shell

```bash

nix develop -c node rain-solver 

```





- without nix package manager (requires `>= nodejs v22`):



```bash

node rain-solver 

```







CLI options can be viewed by running:

```bash

node rain-solver -h

```



Alternatively all variables can be specified in env variables with below keys:

```bash

# path to config yaml file

CONFIG=



# Git branch to track for docker compose

DOCKER_CHANNEL=master



# api key for heyperDx platfomr to send spans to, if not set will send traces to localhost

HYPERDX_API_KEY=""



# trace/spans service name, defaults to "rain-solver" if not set

TRACER_SERVICE_NAME=""

```



## List of supported dexes as external liquidity (decentralized exchanges)

- `BalancerV3`

- `Stabull`

- `AerodromeSlipstreamV1`

- `AerodromeSlipstreamV2`

- `AlienBaseV2`

- `AlienBaseV3`

- `ApeSwap`

- `BakerySwap`

- `BaseSwapV2`

- `BaseSwapV3`

- `Biswap`

- `BladeSwap`

- `BlastDEX`

- `BlazeSwap`

- `BSCSwap`

- `COREx`

- `CroDefiSwap`

- `DackieSwapV2`

- `DackieSwapV3`

- `Dfyn`

- `DovishV3`

- `DyorV2`

- `EddyFinance`

- `Elk`

- `Enosys`

- `Fenix`

- `GlyphV4`

- `GravityFinance`

- `HoneySwap`

- `Horizon`

- `HyperBlast`

- `JetSwap`

- `KimV4`

- `KinetixV2`

- `KinetixV3`

- `KodiakV2`

- `KodiakV3`

- `Kwikswap`

- `LaserSwapV2`

- `LynexV1`

- `LynexV2`

- `MMFinance`

- `MonoswapV2`

- `MonoswapV3`

- `MSwap`

- `NetSwap`

- `NileV3`

- `NineInch`

- `PancakeSwapV2`

- `PancakeSwapV3`

- `Pangolin`

- `QuickSwapV2`

- `QuickSwapV3`

- `RingExchangeV2`

- `RingExchangeV3`

- `Scribe`

- `ShibaSwap`

- `Solarbeam`

- `SparkDexV2`

- `SparkDexV3`

- `SparkDexV3.1`

- `SpookySwapV2`

- `SpookySwapV3`

- `SquadSwapV2`

- `SushiSwapV2`

- `SushiSwapV3`

- `SwapBlast`

- `Swapsicle`

- `ThrusterV2.1`

- `ThrusterV2.3`

- `ThrusterV3`

- `TraderJoe`

- `UbeSwap`

- `UniswapV2`

- `UniswapV3`

- `VelodromeSlipstream`

- `VVSStandard`

- `VVSFlawless`

- `Wagmi`

- `Wigoswap`

- `ZebraV2`







## Developers Guide

First run the [setup](#setup) section and then you can use following commands:

To run the tests:

```bash

nix develop -c npm test

```

which runs both unit and e2e(on hardhat forked polygon network) tests.



To run unit tests:

```bash

nix develop -c npm run unit-test

```



To run e2e tests:

```bash

nix develop -c npm run e2e-test

```



To lint or lint and fix:

```bash

nix develop -c npm run lint

```

```bash

nix develop -c npm run lint-fix

```





### Diag Order

Read this [document](./DiagOrder.md) in order to diag what happenes when an order is being tried to find an opportunity to clear against onchain liquidity, you would find the onchain liquidity price at the time the order is being executed against it as well as the what the order evals to, ie its `maxouput` and `ratio`.



### Running On Docker



Use docker compose if possible as it handles several things for you:



- Restart policy

- Rebuild policy

- Volume management

- Log rotation/policy

- Potentially other stuff like networking



### .env



Docker compose natively supports .env so configure it as per example.env and above.



Notably `DOCKER_CHANNEL` MUST be set to the git branch that you're currently on,

and you should be at the HEAD of said branch when attempting to interact with it.



This ensures that you'll download a docker image compatible with the current code

in your repository.



### Up & volumes



Run `docker compose up -d` to bring the container up. If this is the first time

you are doing this for the current channel you will likely see a complaint about

a missing volume.



You can create the volume however you want using `docker volume` but if you want

to map a specific path on the host to the volume mounted in the guest you'll need

to tell Docker to do so. The default behaviour of Docker is that it manages

volumes opaquely within its own system files, which has pros and cons. Either way

the default behaviour won't give you a predictable path on the host to work with.



To create a bind mount to a specific absolute path on the host 



```

docker volume create --driver local --opt type=none --opt device= --opt o=bind 

```



### Running On Github Actions

In order to run this app periodically to clear orders in Github Actions, first you need to fork this repository, then you can modify the `./.github/workflows/take-orders.yaml` file with your desired configuration so the app run periodically. You can set the schedule for the app to run by modifying the cron syntax of the mentioned file and in the last line of the file, you can pass the required/optional arguments for the app to run. All the mentioned CLI arguments can be applied, for wallet private key and rpc url, you can set up Github Secrets.



Please be aware that schediled Github Actions can only be run at minimum once every 5 minutes and even that is not guarateed because it depends on Github resource availability at that time, so it is recommended to run the app on personal/reliable host if there is sensitivity with running on a schedule.