{"_id":"@auroblocks/chimp-sor","_rev":"9-9846adc46bdf4ff6097f2bb8f372264b","name":"@auroblocks/chimp-sor","dist-tags":{"latest":"0.0.10"},"versions":{"0.0.1":{"name":"@auroblocks/chimp-sor","version":"0.0.1","license":"GPL-3.0-only","main":"dist/index.js","module":"dist/index.esm.js","types":"dist/index.d.ts","scripts":{"build":"rollup -c","prepack":"yarn build","test:swap":"npx ts-node -P tsconfig.testing.json -r ./test/testScripts/swapExample.ts","test":"TS_NODE_PROJECT='tsconfig.testing.json' nyc mocha -r ts-node/register test/*.spec.ts --timeout 20000","test:only":"TS_NODE_PROJECT='tsconfig.testing.json' npx mocha -r ts-node/register --timeout 20000","coverage":"nyc report --reporter=text-lcov | coveralls","lint":"eslint ./src ./test --ext .ts --max-warnings 0","node":"npx hardhat node --tsconfig tsconfig.testing.json --fork $(. ./.env && echo $ALCHEMY_URL)","node:polygon":"npx hardhat --tsconfig tsconfig.testing.json --config hardhat.config.polygon.ts node --fork $(. ./.env && echo $ALCHEMY_URL_POLYGON) --port 8137"},"husky":{"hooks":{"pre-commit":"pretty-quick --staged && yarn run lint"}},"publishConfig":{"registry":"https://registry.npmjs.org/","access":"public"},"devDependencies":{"@balancer-labs/typechain":"^1.0.0","@ethersproject/abi":"^5.4.1","@ethersproject/address":"^5.4.0","@ethersproject/bignumber":"^5.4.2","@ethersproject/constants":"^5.4.0","@ethersproject/contracts":"^5.4.1","@ethersproject/providers":"^5.4.4","@ethersproject/wallet":"^5.4.0","@georgeroman/balancer-v2-pools":"0.0.7","@nomiclabs/hardhat-ethers":"^2.0.6","@rollup/plugin-commonjs":"^20.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^13.0.4","@rollup/plugin-typescript":"^8.2.5","@types/chai":"^4.2.10","@types/lodash.clonedeep":"^4.5.6","@types/mocha":"^7.0.2","@types/node":"^14.0.20","@typescript-eslint/eslint-plugin":"^4.29.2","@typescript-eslint/parser":"^4.29.2","bignumber.js":"^9.0.1","chai":"^4.2.0","dotenv":"^8.2.0","eslint":"^7.32.0","eslint-plugin-mocha-no-only":"^1.1.1","eslint-plugin-prettier":"^3.4.1","hardhat":"^2.9.9","husky":"^4.2.1","lodash.clonedeep":"^4.5.0","lodash.set":"^4.3.2","mocha":"8.2.1","nyc":"^15.0.0","perf_hooks":"^0.0.1","prettier":"^2.3.2","pretty-quick":"^2.0.1","rollup":"^2.56.3","rollup-plugin-dts":"^4.0.0","ts-node":"^10.0.0","typescript":"^4.3.5"},"dependencies":{"isomorphic-fetch":"^2.2.1"},"peerDependencies":{"@ethersproject/abi":"^5.4.1","@ethersproject/address":"^5.4.0","@ethersproject/bignumber":"^5.4.2","@ethersproject/constants":"^5.4.0","@ethersproject/contracts":"^5.4.1","@ethersproject/providers":"^5.4.4"},"gitHead":"5806b57158683291060928857f556f6b99088556","description":"

\n \n \n \n \n \n \n

\n\n

Smart Order Router (SOR)

\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\n## Note on Licensing\n\nExcept where indicated otherwise, the code in this repository is licensed GPLv3.\n\nSuperluminal Labs Ltd. is the owner of the directories `balancer-sor/src/pools/gyro2Pool/`, `balancer-sor/src/pools/gyro3Pool/` and `balancer-sor/src/pools/gyroEPool/` and any accompanying files contained herein (collectively, these “Software”). Use of these Software is exclusively subject to the [Gyroscope Pool License](./src/pools/gyroEPool/LICENSE), which is available at the provided link (the “Gyroscope Pool License”). These Software are not covered by the General Public License and do not confer any rights to the user other than the limited rights specified in the Gyroscope Pool License. A special hybrid license between Superluminal Labs Ltd and Balancer Labs OÜ governs Superluminal Labs Ltd's use of the Balancer Labs OÜ code [Special License](./src/pools/gyroEPool/GyroscopeBalancerLicense.pdf), which is available at the provided link. By using these Software, you agree to be bound by the terms and conditions of the Gyroscope Pool License. If you do not agree to all terms and conditions of the Gyroscope Pool License, do not use any of these Software.\n","readmeFilename":"README.md"}