RepositoryCurrent collected state Current
Observed since 20 Oct, 22:21 UTC
No superseded metadata states collected. Unchanged observations do not create new revisions.
Back to packageRELEASE DETAILS
6.14.0
npm@0x/asset-swapper
Convenience package for discovering and buying assets on-chain and off-chain.
Published12 May 2021
Direct dependencies62
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';
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
Downloads & popularity
Awaiting observationsNo metric observations yet
Download counts and popularity will appear here as the collector receives them.
Declared dependencies 63
Native requirements62 direct targetsNot calculated transitive count
| Package / target | Requirement | Relationship |
|---|---|---|
axiosEnvironment{
"local_name": "axios",
"alias": false,
"peer_metadata": null
} | ^0.21.1 | runtime |
lodashEnvironment{
"local_name": "lodash",
"alias": false,
"peer_metadata": null
} | ^4.17.11 | runtime |
graphqlEnvironment{
"local_name": "graphql",
"alias": false,
"peer_metadata": null
} | ^15.4.0 | runtime |
fast-abiEnvironment{
"local_name": "fast-abi",
"alias": false,
"peer_metadata": null
} | ^0.0.2 | runtime |
@0x/typesEnvironment{
"local_name": "@0x/types",
"alias": false,
"peer_metadata": null
} | ^3.3.3 | runtime |
@0x/utilsEnvironment{
"local_name": "@0x/utils",
"alias": false,
"peer_metadata": null
} | ^6.4.3 | runtime |
cream-sorEnvironment{
"local_name": "cream-sor",
"alias": false,
"peer_metadata": null
} | ^0.3.3 | runtime |
@0x/assertEnvironment{
"local_name": "@0x/assert",
"alias": false,
"peer_metadata": null
} | ^3.0.27 | runtime |
decimal.jsEnvironment{
"local_name": "decimal.js",
"alias": false,
"peer_metadata": null
} | ^10.2.0 | runtime |
heartbeatsEnvironment{
"local_name": "heartbeats",
"alias": false,
"peer_metadata": null
} | ^5.0.1 | runtime |
@bancor/sdkEnvironment{
"local_name": "@bancor/sdk",
"alias": false,
"peer_metadata": null
} | 0.2.9 | runtime |
@0x/dev-utilsEnvironment{
"local_name": "@0x/dev-utils",
"alias": false,
"peer_metadata": null
} | ^4.2.7 | runtime |
ethereum-typesEnvironment{
"local_name": "ethereum-types",
"alias": false,
"peer_metadata": null
} | ^3.5.0 | runtime |
ethereumjs-utilEnvironment{
"local_name": "ethereumjs-util",
"alias": false,
"peer_metadata": null
} | ^7.0.10 | runtime |
graphql-requestEnvironment{
"local_name": "graphql-request",
"alias": false,
"peer_metadata": null
} | ^3.4.0 | runtime |
@0x/json-schemasEnvironment{
"local_name": "@0x/json-schemas",
"alias": false,
"peer_metadata": null
} | ^6.1.3 | runtime |
@0x/quote-serverEnvironment{
"local_name": "@0x/quote-server",
"alias": false,
"peer_metadata": null
} | ^6.0.2 | runtime |
@0x/web3-wrapperEnvironment{
"local_name": "@0x/web3-wrapper",
"alias": false,
"peer_metadata": null
} | ^7.5.3 | runtime |
@0x/base-contractEnvironment{
"local_name": "@0x/base-contract",
"alias": false,
"peer_metadata": null
} | ^6.4.0 | runtime |
@0x/protocol-utilsEnvironment{
"local_name": "@0x/protocol-utils",
"alias": false,
"peer_metadata": null
} | ^1.6.0 | runtime |
@balancer-labs/sorEnvironment{
"local_name": "@balancer-labs/sor",
"alias": false,
"peer_metadata": null
} | 0.3.2 | runtime |
@ethersproject/abiEnvironment{
"local_name": "@ethersproject/abi",
"alias": false,
"peer_metadata": null
} | ^5.0.1 | runtime |
axios-mock-adapterEnvironment{
"local_name": "axios-mock-adapter",
"alias": false,
"peer_metadata": null
} | ^1.19.0 | runtime |
@0x/contracts-erc20Environment{
"local_name": "@0x/contracts-erc20",
"alias": false,
"peer_metadata": null
} | ^3.3.8 | runtime |
@0x/contract-wrappersEnvironment{
"local_name": "@0x/contract-wrappers",
"alias": false,
"peer_metadata": null
} | ^13.16.1 | runtime |
@0x/contracts-zero-exEnvironment{
"local_name": "@0x/contracts-zero-ex",
"alias": false,
"peer_metadata": null
} | ^0.23.0 | runtime |
@0x/contract-addressesEnvironment{
"local_name": "@0x/contract-addresses",
"alias": false,
"peer_metadata": null
} | ^6.1.0 | runtime |
@0x/typescript-typingsEnvironment{
"local_name": "@0x/typescript-typings",
"alias": false,
"peer_metadata": null
} | ^5.2.0 | runtime |
@ethersproject/addressEnvironment{
"local_name": "@ethersproject/address",
"alias": false,
"peer_metadata": null
} | ^5.0.1 | runtime |
@ethersproject/stringsEnvironment{
"local_name": "@ethersproject/strings",
"alias": false,
"peer_metadata": null
} | ^5.0.10 | runtime |
@ethersproject/contractsEnvironment{
"local_name": "@ethersproject/contracts",
"alias": false,
"peer_metadata": null
} | ^5.0.1 | runtime |
@ethersproject/providersEnvironment{
"local_name": "@ethersproject/providers",
"alias": false,
"peer_metadata": null
} | ^5.0.4 | runtime |
nycEnvironment{
"local_name": "nyc",
"alias": false,
"peer_metadata": null
} | ^11.0.1 | development |
shxEnvironment{
"local_name": "shx",
"alias": false,
"peer_metadata": null
} | ^0.2.2 | development |
chaiEnvironment{
"local_name": "chai",
"alias": false,
"peer_metadata": null
} | ^4.0.1 | development |
mochaEnvironment{
"local_name": "mocha",
"alias": false,
"peer_metadata": null
} | ^6.2.0 | development |
gitpkgEnvironment{
"local_name": "gitpkg",
"alias": false,
"peer_metadata": null
} | git+https://github.com/0xProject/gitpkg.git | development |
tslintEnvironment{
"local_name": "tslint",
"alias": false,
"peer_metadata": null
} | 5.11.0 | development |
typedocEnvironment{
"local_name": "typedoc",
"alias": false,
"peer_metadata": null
} | ~0.16.11 | development |
typemoqEnvironment{
"local_name": "typemoq",
"alias": false,
"peer_metadata": null
} | ^2.1.0 | development |
@0x/typesEnvironment{
"local_name": "@0x/types",
"alias": false,
"peer_metadata": null
} | ^3.3.3 | development |
dirty-chaiEnvironment{
"local_name": "dirty-chai",
"alias": false,
"peer_metadata": null
} | ^2.0.1 | development |
typescriptEnvironment{
"local_name": "typescript",
"alias": false,
"peer_metadata": null
} | 4.2.2 | development |
@0x/abi-genEnvironment{
"local_name": "@0x/abi-gen",
"alias": false,
"peer_metadata": null
} | ^5.6.0 | development |
@types/nodeEnvironment{
"local_name": "@types/node",
"alias": false,
"peer_metadata": null
} | 12.12.54 | development |
npm-run-allEnvironment{
"local_name": "npm-run-all",
"alias": false,
"peer_metadata": null
} | ^4.1.2 | development |
@types/mochaEnvironment{
"local_name": "@types/mocha",
"alias": false,
"peer_metadata": null
} | ^5.2.7 | development |
@types/lodashEnvironment{
"local_name": "@types/lodash",
"alias": false,
"peer_metadata": null
} | 4.14.104 | development |
@0x/migrationsEnvironment{
"local_name": "@0x/migrations",
"alias": false,
"peer_metadata": null
} | ^8.0.6 | development |
@0x/ts-doc-genEnvironment{
"local_name": "@0x/ts-doc-gen",
"alias": false,
"peer_metadata": null
} | ^0.0.28 | development |
chai-bignumberEnvironment{
"local_name": "chai-bignumber",
"alias": false,
"peer_metadata": null
} | ^3.0.0 | development |
@0x/sol-compilerEnvironment{
"local_name": "@0x/sol-compiler",
"alias": false,
"peer_metadata": null
} | ^4.7.3 | development |
@0x/subprovidersEnvironment{
"local_name": "@0x/subproviders",
"alias": false,
"peer_metadata": null
} | ^6.5.3 | development |
chai-as-promisedEnvironment{
"local_name": "chai-as-promised",
"alias": false,
"peer_metadata": null
} | ^7.1.0 | development |
@0x/contracts-genEnvironment{
"local_name": "@0x/contracts-gen",
"alias": false,
"peer_metadata": null
} | ^2.0.38 | development |
@0x/tslint-configEnvironment{
"local_name": "@0x/tslint-config",
"alias": false,
"peer_metadata": null
} | ^4.1.4 | development |
make-promises-safeEnvironment{
"local_name": "make-promises-safe",
"alias": false,
"peer_metadata": null
} | ^1.1.0 | development |
@0x/contracts-utilsEnvironment{
"local_name": "@0x/contracts-utils",
"alias": false,
"peer_metadata": null
} | ^4.7.8 | development |
@0x/mesh-rpc-clientEnvironment{
"local_name": "@0x/mesh-rpc-client",
"alias": false,
"peer_metadata": null
} | ^9.4.2 | development |
@0x/contracts-exchangeEnvironment{
"local_name": "@0x/contracts-exchange",
"alias": false,
"peer_metadata": null
} | ^3.2.30 | development |
@0x/contracts-test-utilsEnvironment{
"local_name": "@0x/contracts-test-utils",
"alias": false,
"peer_metadata": null
} | ^5.4.0 | development |
@0x/contracts-asset-proxyEnvironment{
"local_name": "@0x/contracts-asset-proxy",
"alias": false,
"peer_metadata": null
} | ^3.7.11 | development |
@0x/contracts-exchange-libsEnvironment{
"local_name": "@0x/contracts-exchange-libs",
"alias": false,
"peer_metadata": null
} | ^4.3.29 | development |
Distribution files
1 collectedDistribution 1
Source fileSource distribution
Checksums from source
{
"shasum": "8aa4aa33b5341cc799794f0c26092a5495de9ee7",
"tarball": "https://registry.npmjs.org/@0x/asset-swapper/-/asset-swapper-6.14.0.tgz",
"fileCount": 238,
"integrity": "sha512-q50qmBVGFZsXWWWxL+P+D207QMom5CYbpmVJK+HF1CQRvB6mKeBdBUUDV0BA0QbRkv0tCMcvnhSby/ZvIhr7TQ==",
"signatures": [
{
"sig": "MEQCIAyWA0Ljo+VFNjud1mqK85IuBgRuqzi0QvfUclXE8jEnAiBeFkmMly8SVogBVrGKP+voVN32okhEvvb7vyC+0zFAOw==",
"keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"
}
],
"unpackedSize": 2801296,
"npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgm5w/CRA9TVsSAnZWagAAR+4QAJX9LhnOuf7CCv/5FVkX\ns+N56oFFA3a+UXDLefULdaEddbs5i3OJNJda8Qq82rERE5xSxtchchlDLhwR\nW1XRqU1sCueB2jK7FDP+fAZCOPNBa32dwjXOckR6/f6yho0nPrxqgTqGe9oq\nvAPQ+11NWKNmofoqLsprCYvPGPZEbjirH/kiEiVD1Vqd9wBybz6HHvJJH8E5\nvfYHGEDkMg8tK7lwvym+nsisze3O+Lh2VcZUecjKWlCrmCi8BoS1n0gI6aL9\ntTnLPPG9Mxlzbge7gA3vZLFCz0odTadVmov0TkMANWwLMPvkcNwB5sl3mykZ\njVI7w9LvBbrUeMJ658J630BW8NBgczOAkTcH1piSOniPO/04SKZsv22zDRjr\nYWCY3lE9eOP40+NGNr0XRL2Ps0AzEqveEmPRXMWeMmHKesl31K8QR4HmOpbr\nF2ISLBHQRdkmpwcRv5kuqB33YKkxYkUy4HLS1Ie+LH3J/Z+avzyCUY6du1s+\nYaup9+6vuFBMDSNVsuT5j8XorK4lOQorfaD7YLESBD+YE4z+sArz1f6J47m1\n/vhfOGyyy0vYNWAjRuXviIjGMNG5jRvx8O4hg7jlsS9S0hlQtn46OIyziUev\nbyCzVQ2uD3kIkTshlK/ViZd38L0fbaUE1i0Lm2VKmRY8EiDSGkPLdgaXoh/Y\nOo1o\r\n=Hwno\r\n-----END PGP SIGNATURE-----\r\n"
}Repository
PENDINGRepository
PENDINGMetadata history
Meaningful changesRecord identity
package_version:491a88b65b38da5cd03cb5df5e65daaa7c0a67aecdae725d1b1fa36dbf34fc51