Back to packageRELEASE DETAILS

1.0.0

npm

@0x/asset-swapper

Convenience package for discovering and buying assets on-chain and off-chain.

Published31 Jul 2019

Direct dependencies33

Transitive dependenciesNot calculated

README

Current package documentation

@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';

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

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 33

Native requirements

33 direct targetsNot calculated transitive count

Package / target	Requirement	Relationship
lodash Environment { "local_name": "lodash", "alias": false, "peer_metadata": null }	`^4.17.11`	runtime
@0x/types Environment { "local_name": "@0x/types", "alias": false, "peer_metadata": null }	`^2.4.1`	runtime
@0x/utils Environment { "local_name": "@0x/utils", "alias": false, "peer_metadata": null }	`^4.4.2`	runtime
@0x/assert Environment { "local_name": "@0x/assert", "alias": false, "peer_metadata": null }	`^2.1.2`	runtime
@0x/connect Environment { "local_name": "@0x/connect", "alias": false, "peer_metadata": null }	`^5.0.15`	runtime
@0x/dev-utils Environment { "local_name": "@0x/dev-utils", "alias": false, "peer_metadata": null }	`^2.2.6`	runtime
@0x/migrations Environment { "local_name": "@0x/migrations", "alias": false, "peer_metadata": null }	`^4.1.11`	runtime
ethereum-types Environment { "local_name": "ethereum-types", "alias": false, "peer_metadata": null }	`^2.1.4`	runtime
@0x/order-utils Environment { "local_name": "@0x/order-utils", "alias": false, "peer_metadata": null }	`^8.2.4`	runtime
@0x/json-schemas Environment { "local_name": "@0x/json-schemas", "alias": false, "peer_metadata": null }	`^3.1.12`	runtime
@0x/subproviders Environment { "local_name": "@0x/subproviders", "alias": false, "peer_metadata": null }	`^5.0.0`	runtime
@0x/web3-wrapper Environment { "local_name": "@0x/web3-wrapper", "alias": false, "peer_metadata": null }	`^6.0.9`	runtime
@0x/fill-scenarios Environment { "local_name": "@0x/fill-scenarios", "alias": false, "peer_metadata": null }	`^3.0.15`	runtime
@0x/contract-wrappers Environment { "local_name": "@0x/contract-wrappers", "alias": false, "peer_metadata": null }	`^10.1.0`	runtime
@0x/contract-addresses Environment { "local_name": "@0x/contract-addresses", "alias": false, "peer_metadata": null }	`^3.0.2`	runtime
@0x/typescript-typings Environment { "local_name": "@0x/typescript-typings", "alias": false, "peer_metadata": null }	`^4.2.4`	runtime
nyc Environment { "local_name": "nyc", "alias": false, "peer_metadata": null }	`^11.0.1`	development
shx Environment { "local_name": "shx", "alias": false, "peer_metadata": null }	`^0.2.2`	development
chai Environment { "local_name": "chai", "alias": false, "peer_metadata": null }	`^4.0.1`	development
mocha Environment { "local_name": "mocha", "alias": false, "peer_metadata": null }	`^6.2.0`	development
tslint Environment { "local_name": "tslint", "alias": false, "peer_metadata": null }	`5.11.0`	development
typedoc Environment { "local_name": "typedoc", "alias": false, "peer_metadata": null }	`0.13.0`	development
typemoq Environment { "local_name": "typemoq", "alias": false, "peer_metadata": null }	`^2.1.0`	development
dirty-chai Environment { "local_name": "dirty-chai", "alias": false, "peer_metadata": null }	`^2.0.1`	development
typescript Environment { "local_name": "typescript", "alias": false, "peer_metadata": null }	`3.0.1`	development
@types/node Environment { "local_name": "@types/node", "alias": false, "peer_metadata": null }	`*`	development
npm-run-all Environment { "local_name": "npm-run-all", "alias": false, "peer_metadata": null }	`^4.1.2`	development
@types/mocha Environment { "local_name": "@types/mocha", "alias": false, "peer_metadata": null }	`^5.2.7`	development
@types/lodash Environment { "local_name": "@types/lodash", "alias": false, "peer_metadata": null }	`4.14.104`	development
chai-bignumber Environment { "local_name": "chai-bignumber", "alias": false, "peer_metadata": null }	`^3.0.0`	development
chai-as-promised Environment { "local_name": "chai-as-promised", "alias": false, "peer_metadata": null }	`^7.1.0`	development
@0x/tslint-config Environment { "local_name": "@0x/tslint-config", "alias": false, "peer_metadata": null }	`^3.0.1`	development
make-promises-safe Environment { "local_name": "make-promises-safe", "alias": false, "peer_metadata": null }	`^1.1.0`	development

Distribution files

1 collected

Distribution 1

Source distribution

Source file

Checksums from source

{
  "shasum": "99958f128ed4b63add173ed0e51d399e97b82830",
  "tarball": "https://registry.npmjs.org/@0x/asset-swapper/-/asset-swapper-1.0.0.tgz",
  "fileCount": 77,
  "integrity": "sha512-za/YumHK/HIS4/x+kO/jQrViXC3pA1lJmw/rkDJivGeNesG11V4lmgQ9zbudEi6bWDWZldnGry+Dgjn5JipHdw==",
  "signatures": [
    {
      "sig": "MEQCIFcgiASCiP5kEljZWu5vq60BsjRPxPF+G00MyEOSrcg8AiAWLeYMOdkCua9EVBMhpyhEIYrrB57tuTEMYwZWglk58w==",
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"
    }
  ],
  "unpackedSize": 255965,
  "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdQfv7CRA9TVsSAnZWagAAumEQAJGx8UCu5CisvW7KJumu\nHeiAv71RJTQg6IqImwW+b65bzSBdtW11JDmYwUiOrjcu6/ooVa2wmoRdyQSH\n8l8+Kmmdaw3YbPgtyOwFqQs6oQ4N/Lp0AOsvx/em2dQ7sOg7H+E6My+Prvf9\ng/qWjPPpKj4IsiblD1/GGcbSgPnjvG0Yuc1zy/OvxTFCERK5+IflksP+nV3c\n/HKqP8kerbl3jnIzRPdRJI4g82P5XZWyIGuUcrvA9RLSQoIEhbW5u2xwe55L\nsw6fsW1/mj66kkm+vq4jydsiR+7191wypoJahyxIDFpzIAWP4h2KepqhcXp5\nFrhrMYk2tm/oCSbXLHO4qvXwpV4RwmLdDpzUOOPuBxsfFkzQF34+GWN0GqOm\nSU6elCsRhqiW1hpfd/0E8AsS4Q1TysaU/1xSw0fulSb7c/SVDN/znw2UmC/l\nSQ0+12WYXSWC4BXWByJaOyKjTfwqGCVAz1tFz0JkFoNC/wKgiQbMmm4UdUrs\nDjQZvdKkhw24hAiPHYnxIgXPgQcmX4hz/to9t0ulWVrhc9qcwviALHwc+sDI\nviLcWwUHHZks3QLFIFMd0VUlNYyELqA4d46X16/C9Vw2Ssyyh8CCf1+/INrl\n8q2wAqilrhjHm3WKkUBrs9B0Av3c/KF4pWhkVe+Pmrd9EZ81catDfR8+iD5h\n0tKq\r\n=mdCD\r\n-----END PGP SIGNATURE-----\r\n"
}