npm package: @onyxcoin/router-sdk
Description: Onyx Smart Order Router
Latest version: 0.0.1

# Onyx Smart Order Router

This repository contains routing logic for the Onyx 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 `yarn install` and `yarn build`.

```
yarn test
```

### Integration Tests

Make sure the `.env` file is configured to connect to mainnet and other chains. See the [CLI](#cli) section below for more details.

```
yarn 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 = '<JSON_RPC_PROVIDER>'
```

Then from the root directory you can execute the CLI.

## Examples

Some examples to use for manual CLI testing.

### Mainnet

```
./bin/cli quote --tokenIn 0xbb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c --tokenOut 0xF4C8E32EaDEC4BFe97E0F595AdD0f4450a863a11 --amount 1 --exactIn --recipient 0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B --protocols v1,v3,mixed

Best Route:
[V1] 100.00% = WETH -- [0x63Db6ba9E512186C2FAaDaCEF342FB4A40dc577c]XCN
	Raw Quote Exact In:
		2027.43
	Gas Adjusted Quote In:
		2027.40

Gas Used Quote Token: 0.027566
Gas Used USD: 0.010971
Calldata: 0xc04b8d59000...
Value: 0x00

  blockNumber: "57210619"
  estimatedGasUsed: "135000"
  gasPriceWei: "100000000"
Total ticks crossed: 1
```

### SEPOLIA

```
./bin/cli quote --tokenIn 0x4200000000000000000000000000000000000006 --tokenOut 0x9d94a7ff461e83f161c8c040e78557e31d8cba72 --amount 1 --exactIn --minSplits 1 --protocols v1 --router alpha --chainId 204
```

## 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/*`
- Add a log to `/CHANGELOG.md`
- Run `npm run integ-test` successfully

# How to publish the package to NPM

### Validate locally before publishing

Produce the exact tarball npm would publish

```
npm pack
```

Inspect contents

```
tar -tf onyx-router-sdk-[version].tgz
```

### Login & Publish

```
npm login
```

If scoped public package

```
npm publish --access public
```

# 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. See [here](https://github.com/Uniswap/smart-order-router/blob/98c58bdee9981fd9ffac9e7d7a97b18302d5f77a/src/routers/alpha-router/alpha-router.ts#L415-L416) for examples of how to set these values. Note some providers have different limits per chain.

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.