15a63c4bc5
before this change, TypeScript compilation of the generated contract wrapper was giving me the following errors: $ abi-gen --abis 'build/contracts/*.json' --out build/types --template contract_templates/contract.handlebars --partials 'contract_templates/partials/*.handlebars' Found 7 partial templates Found 1 ABI files Processing: Migrations... Created: build/types/migrations.ts $ tsc build/types/migrations.ts(81,23): error TS1013: A rest parameter or binding pattern may not have a trailing comma. build/types/migrations.ts(108,23): error TS1013: A rest parameter or binding pattern may not have a trailing comma. build/types/migrations.ts(130,23): error TS1013: A rest parameter or binding pattern may not have a trailing comma. build/types/migrations.ts(146,25): error TS1013: A rest parameter or binding pattern may not have a trailing comma. build/types/migrations.ts(173,25): error TS1013: A rest parameter or binding pattern may not have a trailing comma. build/types/migrations.ts(195,25): error TS1013: A rest parameter or binding pattern may not have a trailing comma. info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command. Here is the generated code around the first error: 74: public setCompleted = { 75: async sendTransactionAsync( 76: completed: BigNumber, 77: txData: Partial<TxData> = {}, 78: ): Promise<string> { 79: const self = this as any as MigrationsContract; 80: const inputAbi = self._lookupAbi('setCompleted(uint256)').inputs; 81: [completed, 82: ] = BaseContract._formatABIDataItemList(inputAbi, [completed, 83: ], BaseContract._bigNumberToString.bind(self)); All of the other errors are the same, a destructuring assignment with a single element but with a trailing comma. This is legal JavaScript but it is not allowed by the TypeScript compiler, apparently per the bug described at https://github.com/Microsoft/TypeScript/issues/24628 . While awaiting the 3.0 version of TypeScript, it's a simple enough change to have the template not append a trailing comma.
0x is an open protocol that facilitates trustless, low friction exchange of Ethereum-based assets. A full description of the protocol may be found in our whitepaper.
This repository is a monorepo including the 0x protocol smart contracts and numerous developer tools. Each public sub-package is independently published to NPM.
Published Packages
| Package | Version | Description |
|---|---|---|
0x.js |
 |
A Javascript library for interacting with the 0x protocol |
@0xproject/abi-gen |
 |
Tool to generate TS wrappers from smart contract ABIs |
@0xproject/assert |
 |
Type and schema assertions used by our packages |
@0xproject/base-contract |
 |
BaseContract used by auto-generated abi-gen wrapper contracts |
@0xproject/connect |
 |
A Javascript library for interacting with the Standard Relayer API |
@0xproject/sol-compiler |
 |
A thin wrapper around Solc.js that outputs artifacts, resolves imports, only re-compiles when needed, and other niceties. |
@0xproject/dev-utils |
 |
Dev utils to be shared across 0x projects and packages |
@0xproject/json-schemas |
 |
0x-related json schemas |
@0xproject/monorepo-scripts |
 |
Monorepo scripts |
@0xproject/react-docs |
 |
React documentation component for rendering TypeDoc & Doxity generated JSON |
@0xproject/react-shared |
 |
0x shared react components |
@0xproject/sra-report |
 |
Generate reports for standard relayer API compliance |
@0xproject/sol-cov |
 |
Solidity test coverage tool |
@0xproject/subproviders |
 |
Useful web3 subproviders (e.g LedgerSubprovider) |
@0xproject/tslint-config |
 |
Custom 0x development TSLint rules |
@0xproject/types |
 |
Shared type declarations |
@0xproject/typescript-typings |
 |
Repository of types for external packages |
@0xproject/utils |
 |
Shared utilities |
@0xproject/web3-wrapper |
 |
Web3 wrapper |
Private Packages
| Package | Description |
|---|---|
@0xproject/contracts |
0x solidity smart contracts & tests |
@0xproject/react-docs-example |
Example documentation site created with @0xproject/react-docs |
@0xproject/testnet-faucets |
A faucet micro-service that dispenses test ERC20 tokens or Ether |
@0xproject/website |
0x website & Portal DApp |
Usage
Dedicated documentation pages:
- 0x.js Library
- 0x Connect
- Smart contracts
- Subproviders
- Sol Compiler
- Web3-wrapper
- JSON-schemas
- Sol-cov
- Standard Relayer API
Node version >= 6.12 is required.
Most of the packages require additional typings for external dependencies.
You can include those by prepending @0xproject/typescript-typings package to your typeRoots config.
"typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"],
Contributing
We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
Read our contribution guidelines.
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 all packages:
yarn build
To build a specific package:
PKG=@0xproject/web3-wrapper yarn build
Watch
To re-build all packages on change:
yarn watch
To watch a specific package and all it's dependent packages:
PKG=[NPM_PACKAGE_NAME] yarn watch
e.g
PKG=@0xproject/web3-wrapper yarn watch
Clean
Clean all packages:
yarn clean
Clean a specific package
PKG=0x.js yarn clean
Rebuild
To re-build (clean & build) all packages:
yarn rebuild
To re-build (clean & build) a specific package & it's deps:
PKG=0x.js yarn rebuild
Lint
Lint all packages:
yarn lint
Lint a specific package:
PKG=0x.js yarn lint
Run Tests
Run all tests:
yarn test
Run a specific package's test:
PKG=@0xproject/web3-wrapper yarn test