@0x/abi-gen-wrappers
    TypeScript icon, indicating that this package has built-in type declarations

    5.3.2 • Public • Published

    @0x/abi-gen-wrappers

    Low-level 0x smart contract wrappers generated using @0x/abi-gen. These low-level wrappers are imported by other packages in the 0x monorepo and application developers are not expected to import this package directly.

    You may also be interested in the @0x/contract-wrappers package which includes some higher-level features.

    Installation

    yarn add @0x/abi-gen-wrappers

    Import

    import * as wrappers from '@0x/abi-gen-wrappers';

    or

    var wrappers = require('@0x/abi-gen-wrappers');

    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/abi-gen-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).

    Keywords

    none

    Install

    npm i @0x/abi-gen-wrappers

    DownloadsWeekly Downloads

    390

    Version

    5.3.2

    License

    Apache-2.0

    Unpacked Size

    4.14 MB

    Total Files

    101

    Last publish

    Collaborators

    • tobernguyen
    • dex_tracker
    • shawnxin89
    • dekz
    • dorothy-zbornak
    • mzhu25
    • amirbandeali
    • phil-ociraptor