@moraswap/smart-order-router NPM

Moraswap Smart Order Router

This repository contains routing logic for the Moraswap V3 protocol.

It searches for the most efficient way to swap token A for token B, considering splitting swaps across multiple routes and gas costs.

Testing

Unit Tests

First make sure you have run npm install and npm run build.

npm run test

Integration Tests

Make sure the .env file is configured to connect to mainnet and other chains. See the CLI section below for more details.

npm run integ-test

Tenderly Simulations

Quotes can be simulated on Tenderly

Ensure you set the following environment variables:

process.env.TENDERLY_BASE_URL!,
process.env.TENDERLY_USER!,
process.env.TENDERLY_PROJECT!,
process.env.TENDERLY_ACCESS_KEY!,

CLI

The package can be run as a CLI for testing purposes.

First create a .env file in the root of the project and configure:

JSON_RPC_PROVIDER_NEON = '<JSON_RPC_PROVIDER>'
JSON_RPC_PROVIDER_NEON_DEVNET = '<JSON_RPC_PROVIDER>'

Then from the root directory you can execute the CLI.

Adding a new Chain

The main components to complete are:

Deploy contracts on chain, add the pools to subgraph
Populate v3 providers in src/providers/v3/subgraph-provider and src/providers/v3/static-subgraph-provider
Populate chainId and addresses in src/util/chains.ts and src/util/addresses.ts
Populate token providers in src/providers/caching-token-provider and src/providers/token-provider.ts
Populate gas constants in src/routers/alpha-router/gas-models/*
Populate bases in src/routers/legacy-router/bases.ts
Populate test/integ/routers/alpha-router/alpha-router.integration.test.ts and src/providers/v2/static-subgraph-provider.ts
Populate src/routers/alpha-router/*
Run npm run integ-test successfully

Troubleshooting

ProviderGasLimit errors

The package sends many large multicall requests to nodes. You must ensure that your node provider's eth_call gas limit is high enough to successfully process the RPC calls.

By default each eth_call will consume up to:

132,000,000 gas on Optimism
120,000,000 gas on Arbitrum
50,000,000 gas on Celo
150,000,000 gas on every other network (Mainnet, Goerli, etc.)

These parameters should work on Infura and Alchemy by default.

This total amount of gas each eth_call can consume is equal to the multicallChunk config value multiplied by the gasLimitPerCall config value. If you are using a node provider with a lower gas limit per eth_call you will need to override the default V3QuoteProvider with an instance that lowers the multicallChunk and gasLimitPerCall parameters such that the multiplication is below your node providers limit. Lowering these values will cause each multicall to consume less gas.

If you are running your own node, we recommend you configure start your node with a higher gas limit per call. For example, on Geth you can use the command line argument --rpc.gascap 150000000 to raise the limit to 150m, which is enough to run the default configuration of this package.

If you are using Hardhat mainnet forking, you should add blockGasLimit: 150_000_000 to your Hardhat config to use the default package configuration.