@0x/asset-swapper 中文文档教程
@0x/asset-swapper
使用 0x 交换以太坊区块链上表示的资产的便捷包。 该包有助于执行所有链下计算,以使用 0x 交换合约或 0x 扩展合约执行 marketBuy 或 marketSell 函数执行。 给定一些流动性(0x 签署的订单),它有助于估计购买或出售某种资产的成本(给出一个范围),然后提供不同的可消费输出来执行购买或出售。
Asset-swapper 集成了Standard Relayer API(在未来的 Mesh 中)并负责采购流动性,订单修剪和订单验证。 最终的结果是一个库,它告诉你有哪些资产可用,提供基于指定资产的报价,并提供各种可消费的元数据,这些元数据既可以在智能合约的链上使用,也可以通过 web3 在链下使用,以交换所需数量的另一个 ERC20 资产的 ERC20。
Installation
yarn add @0x/asset-swapper
导入
import { SwapQuoter } from '@0x/asset-swapper';
或者
var SwapQuoter = require('@0x/asset-swapper').SwapQuoter;
var SwapQuoteConsumer = require('@0x/asset-swapper').SwapQuoteConsumer;
如果您的项目是 TypeScript,请将以下内容添加到您的 tsconfig.json:
"compilerOptions": {
"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
Contributing
我们欢迎来自更广泛社区的改进和修复! 要报告此包中的错误,请在此存储库中创建一个问题。
请在开始之前阅读我们的贡献指南。
Install dependencies
如果您没有启用 yarn workspaces (Yarn < v1.0) - 启用它们:
yarn config set workspaces-experimental true
然后安装依赖
yarn install
Build
项 要构建此包和它所依赖的所有其他 monorepo 包,请从 monorepo 根目录运行以下命令:
PKG=@0x/asset-swapper yarn build
或持续重建关于改变:
PKG=@0x/asset-swapper yarn watch
Clean
yarn clean
Lint
yarn lint
Run Tests
yarn test
@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