\n\nSmart Order Router, or SOR, is an off-chain linear optimization of routing orders across pools for best price execution.\n\nSOR exists in the Bronze release as a way to aggregate liquidity across all Balancer pools. Future releases of Balancer will accomplish this on-chain and allow aggregate contract fillable liquidity.\n\nLiquidity aggregators are free to use the SOR npm package or create their own order routing across pools.\n\n[Read More](https://docs.balancer.fi/developers/smart-order-router)\n\n## Overview Of Use And Example\n\nThere are two types of swap available:\n\n**swapExactIn** - i.e. You want to swap exactly 1 ETH as input and SOR will calculate X amount of BAL you receive in return. \nor \n**swapExactOut** - i.e. You want to receive exactly 1 BAL and SOR will calculate X amount of ETH you must input.\n\nThe SOR will return totalReturn/totalInput as well as a list swaps to achieve the total. Swaps can be through direct pools, i.e. A > POOL1 > B, or via a multihop pool, i.e. A > POOL1 > C > POOL2 > B. The swaps are returned in a format that can be directly to the Vault to execute the trade.\n\nThe example file `swapExample.ts` in: [./testScripts](test/testScripts/), demonstrates full examples with comments.\n\nTo Run:\n\nCreate a .env file in root dir with your infura provider key: `INFURA=your_key`\n\nInstall dependencies: `$ yarn install`\n\nRun example: `$ ts-node ./test/testScripts/swapExample.ts`\n\n## Environment Variables\n\nOptional config values can be set in the .env file:\n\nPRICE_ERROR_TOLERANCE - how close we expect prices after swap to be in SOR suggested paths. Defaults 0.00001.\n\nINFINITESIMAL - Infinitesimal is an amount that's used to initialize swap amounts so they are not zero or the path's limit. Defaults 0.000001.\n\nExample:\n\n```\nPRICE_ERROR_TOLERANCE=0.00001\nINFINITESIMAL=0.000001\n```\n","readmeFilename":"README.md"}
![](\"https://circleci.com/gh/balancer-labs/balancer-sor.svg?style=svg&circle-token=33636208d3161f79ff283b29c8dba9841bda8931\")
![](\"https://coveralls.io/repos/github/balancer-labs/balancer-sor/badge.svg?t=7avwwt\"){kind=icon}
\n \n \n ![](\"https://img.shields.io/badge/License-GPLv3-green.svg\"){kind=icon}
\n \n \n ![](\"https://img.shields.io/badge/npm-v0.2.4-blue.svg?style=flat-square\"){kind=icon}
\n \n