f55eaa867b
* Add BiSwap (as UniV2 clone) on BSC * changelog PR number * add BSW * remove BiSwap from transformer_utils * Do not initialize BalancerV2SwapInfoCache on unsupported chains [TKR-365] (#472) * Do not initialize BalancerV2SwapInfoCache on unsupported chains * Update CHANGELOG.json * Updated CHANGELOGS & MD docs * Publish - @0x/asset-swapper@16.57.3 * chore: Decomission SnowSwap [TKR-356] (#468) * Decomission SnowSwap * SnowSwap doesn't have much liquidity anymore (the largest pool has ~$50k) * Update CHANGELOG.json * Update CHANGELOG.json * chore: Offboard Swerve Finance and LinkSwap [TKR-356] (#469) * Offboard swerve * Update CHANGELOG.json * Offboard LinkSwap * Remove unused import * Fix CHANGELOG.json * chore: Offboard Eth2Dai [TKR-356] (#470) * Offboard Eth2Dai * Update CHANGELOG.json * feat: add IRfqClient (#467) * add message to changelog for #467 (#474) * Update saddle mainnet pools (#450) * Add saddle v2 pools * remove outdated pools * add two saddle meta pools * forgot changelog * remove saddle metapools * changelog update * Fix a lint issue (#475) * Updated CHANGELOGS & MD docs * Publish - @0x/asset-swapper@16.59.0 * Add BiSwap (as UniV2 clone) on BSC * rebase new changes for balv2, up changelog, quotes working * remove Biswap from transformer_utils once again Co-authored-by: Kyu <kyuhyun217@gmail.com> Co-authored-by: Github Actions <github-actions@github.com> Co-authored-by: phil-ociraptor <phil@0x.org> Co-authored-by: Cece Z <me@cecez.xyz> Co-authored-by: Noah Khamliche <noah@0xproject.com>
@0x/asset-swapper
Convenience package for swapping assets represented on the Ethereum blockchain using 0x. The package helps to perform all the off-chain computations to execute a marketBuy or marketSell function execution with 0x exchange contracts, or 0x extension contracts. Given some liquidity (0x signed orders), it helps estimate the cost of buying or selling a certain asset (giving a range) and then provide varying consumable outputs to execute the buy or sell.
Asset-swapper integrates with the Standard Relayer API(in the future Mesh as well) and takes care of sourcing liquidity, order-pruning, and order-validation. The final result is a library that tells you what assets are available, provides a quote based on specified assets, and provide varying consumable metadata that can be used both on-chain in smart contracts or off-chain through web3 to swap a desired amount of ERC20 for another ERC20 asset.
Installation
yarn add @0x/asset-swapper
Import
import { SwapQuoter } from '@0x/asset-swapper';
or
var SwapQuoter = require('@0x/asset-swapper').SwapQuoter;
var SwapQuoteConsumer = require('@0x/asset-swapper').SwapQuoteConsumer;
If your project is in TypeScript, add the following to your tsconfig.json:
"compilerOptions": {
"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
Contributing
We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.
Please read our contribution guidelines before getting started.
Install dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
yarn config set workspaces-experimental true
Then install dependencies
yarn install
Build
To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
PKG=@0x/asset-swapper yarn build
Or continuously rebuild on change:
PKG=@0x/asset-swapper yarn watch
Clean
yarn clean
Lint
yarn lint
Run Tests
yarn test