diff options
author | Leonid Logvinov <logvinov.leon@gmail.com> | 2019-01-29 00:26:13 +0800 |
---|---|---|
committer | Leonid Logvinov <logvinov.leon@gmail.com> | 2019-01-29 00:26:13 +0800 |
commit | 141ac0ca0be15602a1bcf466e873134e084f30c1 (patch) | |
tree | f0e08db40c46e8c671a99231b645365747a8073f /contracts/asset-proxy/README.md | |
parent | 0c12128f64f7d9a8de6088e98c2e638533d6f5bf (diff) | |
parent | 25e42c0ad47e9ec06e474cd12a488ae837660302 (diff) | |
download | dexon-0x-contracts-141ac0ca0be15602a1bcf466e873134e084f30c1.tar.gz dexon-0x-contracts-141ac0ca0be15602a1bcf466e873134e084f30c1.tar.zst dexon-0x-contracts-141ac0ca0be15602a1bcf466e873134e084f30c1.zip |
Merge development
Diffstat (limited to 'contracts/asset-proxy/README.md')
-rw-r--r-- | contracts/asset-proxy/README.md | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/contracts/asset-proxy/README.md b/contracts/asset-proxy/README.md new file mode 100644 index 000000000..48a5b20a5 --- /dev/null +++ b/contracts/asset-proxy/README.md @@ -0,0 +1,73 @@ +## AssetProxy + +This package contains the implementations of all of the [`AssetProxy`](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md#assetproxy) contracts available within the 0x protocol. These contracts are responsible for decoding the `assetData` sent to them and performing the actual transfer of assets. Addresses of the deployed contracts can be found in the 0x [wiki](https://0xproject.com/wiki#Deployed-Addresses) or the [DEPLOYS](./DEPLOYS.json) file within this package. + +## Installation + +**Install** + +```bash +npm install @0x/contracts-asset-proxy --save +``` + +## Bug bounty + +A bug bounty for the 2.0.0 contracts is ongoing! Instructions can be found [here](https://0xproject.com/wiki#Bug-Bounty). + +## 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. + +For proposals regarding the 0x protocol's smart contract architecture, message format, or additional functionality, go to the [0x Improvement Proposals (ZEIPs)](https://github.com/0xProject/ZEIPs) repository and follow the contribution guidelines provided therein. + +Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. + +### Install Dependencies + +If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: + +```bash +yarn config set workspaces-experimental true +``` + +Then install dependencies + +```bash +yarn install +``` + +### Build + +To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: + +```bash +PKG=@0x/contracts-asset-proxy yarn build +``` + +Or continuously rebuild on change: + +```bash +PKG=@0x/contracts-asset-proxy yarn watch +``` + +### Clean + +```bash +yarn clean +``` + +### Lint + +```bash +yarn lint +``` + +### Run Tests + +```bash +yarn test +``` + +#### Testing options + +Contracts testing options like coverage, profiling, revert traces or backing node choosing - are described [here](../TESTING.md). |