\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.finance/protocol/sor)\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 can be executed directly on-chain or with something like the [ExchangeProxy](https://github.com/balancer-labs/balancer-registry/blob/master/contracts/ExchangeProxy.sol).\n\nExample Output:\n\n```js\n// Following is output for 1USDC->WETH swapExactIn\n[\n swaps,\n amountOut,\n] = await SOR.getSwaps(....\n\n console.log(\n `USDC>WETH, SwapExactIn, 1USDC, Total WETH Return: ${amountOut.toString()}`\n );\n // USDC>WETH, SwapExactIn, 1USDC, Total WETH Return: 3090385829490120 - This is the total amount of WETH received for 1USDC\n console.log(`Swaps: `);\n console.log(swaps);\n\n /*\n This demonstrates a multihop swap going:\n USDC -> BTC++ via pool 0x75286...\n Then BTC++ -> WETH via pool 0xd4dbf...\n */\n [\n // Multihop swap\n [\n // First sequence in swap\n {\n pool: '0x75286e183d923a5f52f52be205e358c5c9101b09',\n tokenIn: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',\n tokenOut: '0x0327112423f3a68efdf1fcf402f6c5cb9f7c33fd',\n swapAmount: '1000000',\n limitReturnAmount: '0',\n maxPrice: '115792089237316195423570985008687907853269984665640564039457584007913129639935'\n },\n // Second sequence in swap\n {\n pool: '0xd4dbf96db2fdf8ed40296d8d104b371adf7dee12',\n tokenIn: '0x0327112423f3a68efdf1fcf402f6c5cb9f7c33fd',\n tokenOut: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',\n swapAmount: '89403274570637',\n limitReturnAmount: '0',\n maxPrice:'115792089237316195423570985008687907853269984665640564039457584007913129639935'\n }\n ]\n ]\n```\n\nThe file: [example-swapExactIn.ts](test/testScripts/example-swapExactIn.ts), shows full examples with comments for various swaps.\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/example-swapExactIn.ts`\n","readmeFilename":"README.md"}
![](\"https://circleci.com/gh/balancer-labs/balancer-sor.svg?style=svg&circle-token=33636208d3161f79ff283b29c8dba9841bda8931\")
\n \n \n ![](\"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