From 9e6833eb403e77c52cf4533a13c603275291294e Mon Sep 17 00:00:00 2001
From: Kirill Fedoseev <k.fedoseev@innopolis.university>
Date: Fri, 10 Jul 2020 15:28:03 +0700
Subject: [PATCH] Update bw plugin README and version (#389)

---
 .../tokenbridge-bw-exchange/README.md         | 52 ++++++++++++++++---
 .../tokenbridge-bw-exchange/package.json      |  2 +-
 2 files changed, 47 insertions(+), 7 deletions(-)

diff --git a/burner-wallet-plugin/tokenbridge-bw-exchange/README.md b/burner-wallet-plugin/tokenbridge-bw-exchange/README.md
index a5317599..f90ec8f1 100644
--- a/burner-wallet-plugin/tokenbridge-bw-exchange/README.md
+++ b/burner-wallet-plugin/tokenbridge-bw-exchange/README.md
@@ -4,12 +4,16 @@ This plugin defines a Bridge trading pair to be used in the Exchange Plugin.
 
 Bridge trading pairs and assets supported:
 * ETC - WETC Bridge
+* MOON - xMOON Bridge
+* DAI - qDAI Bridge (For qDAI Bridge, it's necessary to use a custom DAI token from this repo instead of the DAI asset provided by burner-wallet)
 
 It also provides some generic resources that can be used and extended:
-* **ERC677Asset** - A representation of an Erc677 token
+* **ERC677Asset** - A representation of an Erc677 token.
+* **BridgeableERC20Asset** - A representation of Erc20 token with a possibility of bridging it via a call to `relayTokens`.
 * **NativeMediatorAsset** - Represents a native token that interacts with a Mediator extension.
 * **Mediator Pair** - Represents an Exchange Pair that interacts with mediators extensions.
-* **TokenBridgeGateway** - A gateway to operate with ETC, POA Sokol and POA Core networks. 
+* **MediatorErcToNative Pair** - Represents a modified Mediator Pair that interacts with a tokenbridge erc-to-native mediators contracts.
+* **TokenBridgeGateway** - A gateway to operate with ETC, POA Sokol, POA Core and qDAI networks.
 
 ### Install package
 ```
@@ -18,13 +22,22 @@ yarn add @poanet/tokenbridge-bw-exchange
  
 ### Usage
 
+#### WETCBridge example
+In this example, we use `TokenBridgeGateway` for connecting to the Ethereum Classic and `InfuraGateway` for connecting to the Ethereum Mainnet.
+
+`WETCBridge` operates with two assets: `WETC` (Ethereum Mainnet) and `ETC` (Ethereum Classic), they should be added in the assets list.
+
 ```javascript
-import { Etc, Wetc, EtcGateway, WETCBridge } from '@poanet/tokenbridge-bw-exchange'
+import BurnerCore from '@burner-wallet/core'
+import Exchange from '@burner-wallet/exchange'
+import { LocalSigner } from '@burner-wallet/core/signers'
+import { Etc, Wetc, TokenBridgeGateway, WETCBridge } from '@poanet/tokenbridge-bw-exchange'
+import { InfuraGateway } from '@burner-wallet/core/gateways'
 
 const core = new BurnerCore({
-  ...
-  gateways: [new EtcGateway(), new InfuraGateway(process.env.REACT_APP_INFURA_KEY)],
-  assets: [Etc, Wetc]
+  signers: [new LocalSigner()],
+  gateways: [new TokenBridgeGateway(), new InfuraGateway(process.env.REACT_APP_INFURA_KEY)],
+  assets: [Wetc, Etc]
 })
 
 const exchange = new Exchange({
@@ -32,6 +45,33 @@ const exchange = new Exchange({
 })
 ```
 
+### Using several exchanges simultaneously
+In this example, we use `TokenBridgeGateway` for connecting to the qDAI chain, `XDaiGatewai` for connecting to the xDAI chain and `InfuraGateway` for connecting to the Ethereum Mainnet and Rinkeby Network.
+
+`QDAIBridge` operates with two assets: `qDAI` (qDAI chain) and `DAI` (Ethereum Mainnet). Note that we use a custom DAI token from the `@poanet/tokenbridge-bw-exchange`, this is necessary for allowing bridge operations on this token.
+
+`MOONBridge` operates with two assets: `MOON` (Rinkeby network) and `xMOON` (xDAI chain).
+
+All four assets should be added to the assets list.
+
+```javascript
+import BurnerCore from '@burner-wallet/core'
+import Exchange from '@burner-wallet/exchange'
+import { LocalSigner } from '@burner-wallet/core/signers'
+import { InfuraGateway, XDaiGateway } from '@burner-wallet/core/gateways'
+import { Dai, qDai, MOON, xMOON, TokenBridgeGateway, QDAIBridge, MOONBridge } from '@poanet/tokenbridge-bw-exchange'
+
+const core = new BurnerCore({
+  signers: [new LocalSigner()],
+  gateways: [new TokenBridgeGateway(), new XDaiGateway(), new InfuraGateway(process.env.REACT_APP_INFURA_KEY)],
+  assets: [Dai, qDai, MOON, xMOON]
+})
+
+const exchange = new Exchange({
+  pairs: [new QDAIBridge(), new MOONBridge()]
+})
+```
+
 This is how the exchange plugin will look like:
 
 ![exchange-wetc](https://user-images.githubusercontent.com/4614574/80991095-e40d0900-8e0d-11ea-9915-1b4e4a052694.png) 
diff --git a/burner-wallet-plugin/tokenbridge-bw-exchange/package.json b/burner-wallet-plugin/tokenbridge-bw-exchange/package.json
index 0f0bbc48..63dfa012 100644
--- a/burner-wallet-plugin/tokenbridge-bw-exchange/package.json
+++ b/burner-wallet-plugin/tokenbridge-bw-exchange/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@poanet/tokenbridge-bw-exchange",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "license": "GPL-3.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",