PkgFoundry
Catalog npm
Back to packageRELEASE DETAILS

13.6.6

npm

@0x-klaytn/contract-wrappers

Wrappers for 0x smart contract wrappers generated using @0x/abi-gen

0xprojectethereumexchangetokens
Published28 Feb 2020
Direct dependencies14
Transitive dependenciesNot calculated

README

Current package documentation

@0x-klaytn/contract-wrappers

Wrappers for 0x smart contracts, generated using @0x/abi-gen.

Installation

Install

npm install @0x-klaytn/contract-wrappers --save

Import

import { ContractWrappers } from '@0x-klaytn/contract-wrappers';

If your project is in TypeScript, add the following to your tsconfig.json:

"compilerOptions": {
    "typeRoots": ["node_modules/@0x-klaytn/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-klaytn/contract-wrappers yarn build

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test

Documentation

Documentation for this package is generated by TypeDoc, using the Solidity source code for 0x contracts. Each contract corresponds to one global-level module, which contains relevant enums and interfaces for its events and structs. Most significantly, each module exports a class, <ContractName>Contract, e.g. ExchangeContract, which implements helper methods for all the functions defined in the corresponding contract.

A convention to note is that these contract-specific helper methods are defined as object literals, which are separated from methods in the generated documentation. Each contract method has a number of sub-methods, e.g. sendTransactionAsync, or estimateGasAsync, which are documented separately. This is an example of an expected method call signature: exchangeContractInstance.fillOrder.sendTransactionAsync(...arguments).

Development

This package contains generated code. We use the abi-gen utility to generate wrappers from compiler artifacts in @0x/contract-artifacts. To re-generate wrappers, e.g. when @0x/contract-artifacts has been updated, run yarn wrappers:generate && yarn wrappers:prettier.

Downloads & popularity

Awaiting observations

No metric observations yet

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

Declared dependencies 14

Native requirements
14 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
@0x-klaytn/contract-addresses
Environment
{
  "local_name": "@0x-klaytn/contract-addresses",
  "alias": false,
  "peer_metadata": null
}
^4.6.3runtime
@0x-klaytn/utils
Environment
{
  "local_name": "@0x-klaytn/utils",
  "alias": false,
  "peer_metadata": null
}
^5.4.3runtime
@0x-klaytn/web3-wrapper
Environment
{
  "local_name": "@0x-klaytn/web3-wrapper",
  "alias": false,
  "peer_metadata": null
}
^7.0.9runtime
@0x/assert
Environment
{
  "local_name": "@0x/assert",
  "alias": false,
  "peer_metadata": null
}
^3.0.6runtime
@0x-klaytn/base-contract
Environment
{
  "local_name": "@0x-klaytn/base-contract",
  "alias": false,
  "peer_metadata": null
}
^6.2.1runtime
@0x/json-schemas
Environment
{
  "local_name": "@0x/json-schemas",
  "alias": false,
  "peer_metadata": null
}
^5.0.6runtime
@0x/types
Environment
{
  "local_name": "@0x/types",
  "alias": false,
  "peer_metadata": null
}
^3.1.2runtime
ethereum-types
Environment
{
  "local_name": "ethereum-types",
  "alias": false,
  "peer_metadata": null
}
^3.1.0runtime
ethers
Environment
{
  "local_name": "ethers",
  "alias": false,
  "peer_metadata": null
}
~4.0.4runtime
@0x/ts-doc-gen
Environment
{
  "local_name": "@0x/ts-doc-gen",
  "alias": false,
  "peer_metadata": null
}
^0.0.22development
@0x/tslint-config
Environment
{
  "local_name": "@0x/tslint-config",
  "alias": false,
  "peer_metadata": null
}
^4.0.0development
tslint
Environment
{
  "local_name": "tslint",
  "alias": false,
  "peer_metadata": null
}
5.11.0development
typedoc
Environment
{
  "local_name": "typedoc",
  "alias": false,
  "peer_metadata": null
}
^0.15.0development
typescript
Environment
{
  "local_name": "typescript",
  "alias": false,
  "peer_metadata": null
}
3.0.1development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "shasum": "826883153aa37386b56ecbd5da1b61732972e9cf",
  "integrity": "sha512-cJprfANXLZTLifkF3Ej54W2Uolbnu1jz7MsiYEyL7ODAxt9fHeaWrWDIK9JXIeECKQtyy694bXMjNHokEeSWEQ==",
  "tarball": "https://registry.npmjs.org/@0x-klaytn/contract-wrappers/-/contract-wrappers-13.6.6.tgz",
  "fileCount": 81,
  "unpackedSize": 1983048,
  "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeWXhkCRA9TVsSAnZWagAA+7kP/1t9dMcZ60DIAAn6ONWx\nXGZ22wtyKJ1WT7ipaIYcr+NS1A1TzWksVF2gsAU+VKQs4yEmjE1zuuVxONdq\nscJd29B8nz8opGfEnY5n4g/k/Jdglr6Yjc3qSpIlczreruaVdYGMNJjpmuVf\nlQ/u5qHoVw5jbfVK8Oxp3V0ZnHQUiq1GBdIyQHanHuf5qdHxIb+6kG8iACFW\n9iUBQR1mwfjks1ZQRnLmP0rRqGxRQqyvLF3/OQU2JMIRMdo5WkgijuS/QHWs\nXQZuqCMEYIl0viuaQ50yOkWitWLDpOFB0p67aksToVQ7zWqlY/ETGrsMwJ3o\ndGI0Jt+/zCKmp9xFJxnAplecFpi6zOMI8vc495enx07rUjNYnx1OBFnM7wXG\nNKPHRPJoEJoTBAYbaBXw+CUhKtkOl6NayZH6if6UXqD2v6y1p29OU+ux0Yse\nwLv8YiPqH1lAJO8BdcWnAxhuELcv2jt3oA8ULf2zN0ZZyybt0A0Vez2TKBcQ\n1yMruvRfqaWE87w+B0GTlBvMMnCeiHw0vRE4sLRnbhNbjwdiaR4rTmUGSOUa\nMa6C8XGFfmRTgcCu5akBzoKmMWayw0B4Jgs0hM4ivMX6RVNjFWhAXKD1DwvL\n8dasKOwS2m2CHieS5xXBxLUazR9EcK+HUjlJnqXi4aP13V9RYXXOplBEBg9m\n+AOf\r\n=hQiY\r\n-----END PGP SIGNATURE-----\r\n",
  "signatures": [
    {
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
      "sig": "MEQCIFbaxPaJoe0Hij5SH6hQun2oo5A1J1jDq+z+K16lyO6HAiAxLhsKpSo2CwodwxaTc/4iMaOMBTCAbc4QRc1vdg3kUw=="
    }
  ]
}

Repository

PENDING
0xproject/0x-monorepo

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 22:17 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:89b0ed630aed53551adb7a252afe96f604cb5a124fd8feffc462bcbec3625311

Other collected versions

13.7.28 Mar13.7.15 Mar13.7.05 Mar13.6.91 Mar13.6.81 Mar13.6.71 MarView all collected versions →