aboutsummaryrefslogtreecommitdiffstats
path: root/contracts/exchange-forwarder
diff options
context:
space:
mode:
authorAmir Bandeali <abandeali1@gmail.com>2019-01-23 05:37:14 +0800
committerAmir Bandeali <abandeali1@gmail.com>2019-01-23 05:37:14 +0800
commitfe1ef930ad0febcf2b35f26da7d19123c881f741 (patch)
tree24721707fafda1243586968a7867be7f75611e03 /contracts/exchange-forwarder
parentab4d4a69ec105f1716cd705350441bb2d9ec4b87 (diff)
downloaddexon-0x-contracts-fe1ef930ad0febcf2b35f26da7d19123c881f741.tar
dexon-0x-contracts-fe1ef930ad0febcf2b35f26da7d19123c881f741.tar.gz
dexon-0x-contracts-fe1ef930ad0febcf2b35f26da7d19123c881f741.tar.bz2
dexon-0x-contracts-fe1ef930ad0febcf2b35f26da7d19123c881f741.tar.lz
dexon-0x-contracts-fe1ef930ad0febcf2b35f26da7d19123c881f741.tar.xz
dexon-0x-contracts-fe1ef930ad0febcf2b35f26da7d19123c881f741.tar.zst
dexon-0x-contracts-fe1ef930ad0febcf2b35f26da7d19123c881f741.zip
Update DEPLOYS and READMEs within each package
Diffstat (limited to 'contracts/exchange-forwarder')
-rw-r--r--contracts/exchange-forwarder/DEPLOYS.json1
-rw-r--r--contracts/exchange-forwarder/README.md16
2 files changed, 11 insertions, 6 deletions
diff --git a/contracts/exchange-forwarder/DEPLOYS.json b/contracts/exchange-forwarder/DEPLOYS.json
index 1a093bf77..86bd264c4 100644
--- a/contracts/exchange-forwarder/DEPLOYS.json
+++ b/contracts/exchange-forwarder/DEPLOYS.json
@@ -9,6 +9,7 @@
"networks": {
"1": "0x5468a1dc173652ee28d249c271fa9933144746b1",
"3": "0x2240dab907db71e64d3e0dba4800c83b5c502d4e",
+ "4": "0xd2dbf3250a764eaaa94fa0c84ed87c0edc8ed04e",
"42": "0x17992e4ffb22730138e4b62aaa6367fa9d3699a6"
}
}
diff --git a/contracts/exchange-forwarder/README.md b/contracts/exchange-forwarder/README.md
index 820f6e78a..3fc8c006b 100644
--- a/contracts/exchange-forwarder/README.md
+++ b/contracts/exchange-forwarder/README.md
@@ -1,10 +1,14 @@
-## Contract extensions
+## Exchange Forwarder
-Smart contracts that implement extensions for the 0x protocol.
+This package contains the implementation of the [`Forwarder`](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/forwarder-specification.md) contract. This contract is intended to improve the UX of interacting with the 0x [`Exchange`](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md#exchange) contract by abstracting user approvals, converting ETH to WETH, and paying fees. 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.
-## Usage
+## Installation
-Contract extensions of the protocol can be found in the [contracts](./contracts) directory. This directory contains contracts that interact with the 2.0.0 contracts and will be used in production, such as the [Forwarder](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/forwarder-specification.md) contract.
+**Install**
+
+```bash
+npm install @0x/contracts-exchange-forwarder --save
+```
## Bug bounty
@@ -37,13 +41,13 @@ yarn install
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-extensions yarn build
+PKG=@0x/contracts-exchange-forwarder yarn build
```
Or continuously rebuild on change:
```bash
-PKG=@0x/contracts-extensions yarn watch
+PKG=@0x/contracts-exchange-forwarder yarn watch
```
### Clean