\n\n[OsmosJS](https://github.com/osmosis-labs/osmojs) makes it easy to compose and broadcast Osmosis and Cosmos messages, with all of the proto and amino encoding handled for you.\n\n---\n\n## install\n\n```sh\nnpm install @osmonauts/math\n```\n\n## Table of Contents\n\n- [@osmonauts/math](#osmonautsmath)\n - [install](#install)\n - [Table of Contents](#table-of-contents)\n - [Calculations](#calculations)\n - [Pool Calculations](#pool-calculations)\n - [`calcPoolLiquidity`](#calcpoolliquidity)\n - [`calcCoinsNeededForValue`](#calccoinsneededforvalue)\n - [`calcMaxCoinsForPool`](#calcmaxcoinsforpool)\n - [`calcShareOutAmount`](#calcshareoutamount)\n - [`calcPoolAprs`](#calcpoolaprs)\n - [Swap Calculations](#swap-calculations)\n - [`getRoutesForTrade`](#getroutesfortrade)\n - [`calcAmountWithSlippage`](#calcamountwithslippage)\n - [`calcPriceImpactGivenIn`](#calcpriceimpactgivenin)\n - [`calcPriceImpactGivenOut`](#calcpriceimpactgivenout)\n - [Publishing](#publishing)\n - [Credits](#credits)\n - [Disclaimer](#disclaimer)\n\n## Calculations\n\n### Pool Calculations\n\n#### `calcPoolLiquidity`\n\nCalculate a pool's liquidity.\n\n```js\nimport { calcPoolLiquidity } from \"@osmonauts/math\";\n\nconst liquidity = calcPoolLiquidity(pool, prices);\n```\n\nPool liquidity is calculated using the formula below:\n$$liquidity=\\dfrac{tokenA}{10^{exponentA}}\\times priceA + \\dfrac{tokenB}{10^{exponentB}}\\times priceB$$\nFor pools with multiple tokens, just add more tokens to the end.\n\n#### `calcCoinsNeededForValue`\n\nCalculate the coins needed in a pool for the given dollar value.\n\n```js\nimport { calcCoinsNeededForValue } from \"@osmonauts/math\";\n\nconst coinsNeeded = calcCoinsNeededForValue(prices, poolInfo, value);\n```\n\nThe amount of either of the tokens needed in a pool is calculated using the formula below:\n\n$$amountNeeded=\\dfrac{tokenWeight}{totalWeight}\\times value \\div price\\times 10^{exponent}$$\n\n#### `calcMaxCoinsForPool`\n\nCalculate the maximum coins affordable in the balance for a given pool.\n\n```js\nimport { calcMaxCoinsForPool } from \"@osmonauts/math\";\n\nconst maxCoins = calcMaxCoinsForPool(prices, poolInfo, balances);\n```\n\n#### `calcShareOutAmount`\n\nOnce you have the coins needed from either `calcCoinsNeededForValue` or `calcMaxCoinsForPool`, you can use `calcShareOutAmount` to get the shareOutAmount for the pool:\n\n```js\nimport { calcShareOutAmount } from \"@osmonauts/math\";\n\nconst shareOutAmount = calcShareOutAmount(poolInfo, coinsNeeded);\n```\n\n#### `calcPoolAprs`\n\nCalculate a pool's APR which consists of three parts: superfluid APR, gauge APR and fees APR.\n\n```js\nimport { calcPoolAprs } from \"@osmonauts/math\";\n\nconst poolApr = calcPoolAprs({\n activeGauges, // all the active gauges of a pool\n pool, // pool info\n prices, // priceHash\n superfluidPools, // all the superfluid pools\n aprSuperfluid, // apr of superfluid staking\n lockupDurations, // all the lockup durations\n volume7d, // 7 day trading volume of the pool\n swapFee, // percentage value, e.g. 0.002\n lockup = \"14\", // optional, specify the lockup duration\n includeNonPerpetual = true, // optional, whether to include non-perpetual gauges\n})\n```\n\nFor superfluid APR, you can get all the pools' APRs from this [endpoint](https://api-osmosis.imperator.co/apr/v2/all).\n\nThe formula for calculating the gauge APR:\n\n$$gaugeAPR=\\dfrac{totalCoins-distributedCoins}{10^{exponent}}\\times price\\div liquidity\\times 36500$$\n\nFees APR works in a similar way:\n\n$$feesAPR=\\dfrac{tradingVolume7d}{7}\\times swapFee\\div liquidity\\times 36500$$\n\n### Swap Calculations\n\n#### `getRoutesForTrade`\n\nFind the available routes for trade given sell token and buy token, as well as pool pairs.\n\n```js\nimport { getRoutesForTrade, makePoolPairs } from \"@osmonauts/math\";\n\nconst pairs = makePoolPairs(pools, prices);\n\nconst routes = getRoutesForTrade({\n trade: {\n sell, // token to sell\n buy, // token to buy\n },\n pairs,\n});\n```\n\n#### `calcAmountWithSlippage`\n\nCalculates the tokenOut amount after slippage, slippage is the number without the \"%\" part, e.g. if slippage is \"1%\", then pass in `1` as slippage, rather than `0.01`.\n\n```js\nimport { calcAmountWithSlippage } from \"@osmonauts/math\";\n\nconst tokenOutMinAmount = calcAmountWithSlippage(tokenOutAmount, slippage);\n```\n\n#### `calcPriceImpactGivenIn`\n\nCalculates price impact given the tokenIn info and the tokenOutDenom.\n\n```js\nimport { calcPriceImpactGivenIn } from \"@osmonauts/math\";\n\nconst priceImpact = calcPriceImpactGivenIn(\n tokenIn, // tokenIn info\n tokenOutDenom,\n pool // the pool that contains both tokenIn and tokenOut as poolAssets\n);\n```\n\n#### `calcPriceImpactGivenOut`\n\nCalculates price impact given the tokenOut info and the tokenInDenom.\n\n```js\nimport { calcPriceImpactGivenOut } from \"@osmonauts/math\";\n\nconst priceImpact = calcPriceImpactGivenOut(\n tokenOut, // tokenOut info\n tokenInDenom,\n pool // the pool that contains both tokenIn and tokenOut as poolAssets\n);\n```\n\n## Publishing\n\nBuild the types and then publish:\n\n```\nyarn build:ts\nyarn publish\n```\n\n## Related\n\nCheckout these related projects:\n\n* [@cosmology/telescope](https://github.com/cosmology-tech/telescope) Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules.\n* [@cosmwasm/ts-codegen](https://github.com/CosmWasm/ts-codegen) Convert your CosmWasm smart contracts into dev-friendly TypeScript classes.\n* [chain-registry](https://github.com/cosmology-tech/chain-registry) Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.\n* [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit) Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.\n* [create-cosmos-app](https://github.com/cosmology-tech/create-cosmos-app) Set up a modern Cosmos app by running one command.\n* [interchain-ui](https://github.com/cosmology-tech/interchain-ui) The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit.\n* [starship](https://github.com/cosmology-tech/starship) Unified Testing and Development for the Interchain.\n\n## Credits\n\n🛠 Built by Cosmology — if you like our tools, please consider delegating to [our validator ⚛️](https://cosmology.zone/validator)\n\n\n## Disclaimer\n\nAS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.\n\nNo developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.\n","readmeFilename":"README.md"}
![](\"https://user-images.githubusercontent.com/545047/195456198-c35bf731-255e-42b6-833b-e76df553eec8.svg\")
\n \n![](\"https://github.com/osmosis-labs/osmojs/actions/workflows/run-tests.yaml/badge.svg\"){kind=icon}
\n \n ![](\"https://img.shields.io/badge/license-MIT-blue.svg\"){kind=icon}
\n ![](\"https://img.shields.io/github/package-json/v/osmosis-labs/osmojs?filename=packages%2Fosmojs%2Fpackage.json\")