feat: merge eth-proxy-contract into eth-input-data (#139)

Author: vrolland

…/payment-network-eth-input-data-0.1.0.md …/payment-network-eth-input-data-0.2.0.mdpackages/advanced-logic/specs/payment-network-eth-input-data-0.1.0.md renamed to packages/advanced-logic/specs/payment-network-eth-input-data-0.2.0.md packages/advanced-logic/specs/payment-network-eth-input-data-0.1.0.md renamed to packages/advanced-logic/specs/payment-network-eth-input-data-0.2.0.md

@@ -10,7 +10,13 @@ Prerequisite: Having read the advanced logic specification (see [here](./advance
 ## Description
 
 This extension allows the payments and the refunds to be made in Ether on the Ethereum blockchain.
-A payment reference has to be given in input data when making the transfer to link the payment to the request.
+A payment reference has to be given when making the transfer to link the payment to the request.
+
+There are two ways to add a payment reference to a transfer:
+
+1. add the reference to the input data of the transfer
+2. call the ethereum proxy smart contract (see [Contract](#Contract))
+
 The payment reference is the last 8 bytes of a salted hash of the requestId: `last8Bytes(hash(lowercase(requestId + salt + address)))`:
 
 - `requestId` is the id of the request
@@ -22,13 +28,29 @@ The payment reference is the last 8 bytes of a salted hash of the requestId: `la
 As a payment network, this extension allows to deduce a payment `balance` for the request. (see
 [Interpretation](#Interpretation))
 
+## Contract
+
+The contract contains one function called `transferWithReference` which takes 2 arguments:
+
+- `to` is the destination address
+- `paymentReference` is the reference data used to track the transfer (see `paymentReference`)
+
+The `TransferWithReference` event is emitted when the Ether is transfered. This event contains the same 2 arguments as the `transferWithReference` function plus the `amount` of ethereum sent.
+
+[See smart contract source](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/smart-contracts/src/contracts/EthereumProxy.sol)
+
+| Network | Contract Address                           |
+| ------- | ------------------------------------------ |
+| Mainnet | 0x37a8f5f64f2a84f2377481537f04d2a59c9f59b6 |
+| Rinkeby | 0x9c6c7817e3679c4b3f9ef9486001eae5aaed25ff |
+
 ## Properties
 
 | Property                  | Type   | Description                                    | Requirement   |
 | ------------------------- | ------ | ---------------------------------------------- | ------------- |
 | **id**                    | String | constant value: "pn-eth-input-data"            | **Mandatory** |
 | **type**                  | String | constant value: "paymentNetwork"               | **Mandatory** |
-| **version**               | String | constant value: "0.1.0"                        | **Mandatory** |
+| **version**               | String | constant value: "0.2.0"                        | **Mandatory** |
 | **events**                | Array  | List of the actions performed by the extension | **Mandatory** |
 | **values**                | Object |                                                |               |
 | **values.paymentAddress** | String | Ethereum address for the payment               | Optional      |
@@ -49,7 +71,7 @@ Note: to use the Rinkeby testnet just set the `currency.network` to "rinkeby"
 | ----------------------------- | ------ | ----------------------------------- | ------------- |
 | **id**                        | String | Constant value: "pn-eth-input-data" | **Mandatory** |
 | **type**                      | String | Constant value: "paymentNetwork"    | **Mandatory** |
-| **version**                   | String | Constant value: "0.1.0"             | **Mandatory** |
+| **version**                   | String | Constant value: "0.2.0"             | **Mandatory** |
 | **parameters**                | Object |                                     |               |
 | **parameters.paymentAddress** | String | Ethereum address for the payment    | Optional      |
 | **parameters.refundAddress**  | String | Ethereum address for the refund     | Optional      |
@@ -82,7 +104,7 @@ A extension state is created with the following properties:
 | ------------------------- | -------------------------------------------------------------- |
 | **id**                    | "pn-eth-input-data"                                            |
 | **type**                  | "paymentNetwork"                                               |
-| **version**               | "0.1.0"                                                        |
+| **version**               | "0.2.0"                                                        |
 | **values**                |                                                                |
 | **values.paymentAddress** | `paymentAddress` from parameters if given, undefined otherwise |
 | **values.refundAddress**  | `refundAddress` from parameters if given, undefined otherwise  |
@@ -189,6 +211,17 @@ The 'addRefundAddress' event:
 
 ## Interpretation
 
+The proxy contract address is determined by the `request.currency.network` (see (table)[#Contract] with proxy contract addresses).
+
 The `balance` starts from `0`.
 Any ETH transaction to `paymentAddress` with exactly `last8Bytes(hash(requestId + salt + payment address))` in input data is considered as a payment. The `balance` is increased by the sum of the amounts of the transactions.
+Any `TransferWithReference` events emitted from the proxy contract with the following arguments are considered as a payment:
+
+- `to` `===` `paymentAddress`
+- `paymentReference` `===` `last8Bytes(hash(lowercase(requestId + salt + payment address)))`
+
 Any ETH transaction to `refundAddress` with exactly `last8Bytes(hash(requestId + salt + refund address))` in input data is considered as a refund. The `balance` is reduced by the sum of the amounts of the transactions.
+Any `TransferWithReference` events emitted from the proxy contract with the following arguments are considered as a refund:
+
+- `to` `===` `refundAddress`
+- `paymentReference` `===` `last8Bytes(hash(lowercase(requestId + salt + refund address)))`

packages/advanced-logic/specs/payment-network-eth-proxy-contract-0.1.0.md

@@ -2,6 +2,8 @@ import { ExtensionTypes, IdentityTypes, RequestLogicTypes } from '@requestnetwor
 
 import ReferenceBased from '../reference-based';
 
+const CURRENT_VERSION = '0.1.0';
+
 const walletAddressValidator = require('wallet-address-validator');
 
 /**
@@ -43,6 +45,7 @@ function createCreationAction(
   return ReferenceBased.createCreationAction(
     ExtensionTypes.ID.PAYMENT_NETWORK_ERC20_PROXY_CONTRACT,
     creationParameters,
+    CURRENT_VERSION,
   );
 }
 

packages/advanced-logic/src/extensions/payment-network/erc20/proxy-contract.ts

@@ -4,6 +4,8 @@ import ReferenceBased from '../reference-based';
 
 const walletAddressValidator = require('wallet-address-validator');
 
+const CURRENT_VERSION = '0.2.0';
+
 /**
  * Implementation of the payment network to pay in ETH based on input data.
  * With this extension, one request can have two Ethereum addresses (one for payment and one for refund) and a specific value to give as input data
@@ -43,6 +45,7 @@ function createCreationAction(
   return ReferenceBased.createCreationAction(
     ExtensionTypes.ID.PAYMENT_NETWORK_ETH_INPUT_DATA,
     creationParameters,
+    CURRENT_VERSION,
   );
 }
 

packages/advanced-logic/src/extensions/payment-network/ethereum/input-data.ts

@@ -12,8 +12,6 @@ export default {
   createCreationAction,
 };
 
-const CURRENT_VERSION = '0.1.0';
-
 // Regex for "at least 16 hexadecimal numbers". Used to validate the salt
 const eightHexRegex = /[0-9a-f]{16,}/;
 
@@ -27,6 +25,7 @@ const eightHexRegex = /[0-9a-f]{16,}/;
 function createCreationAction(
   extensionId: ExtensionTypes.ID,
   creationParameters: ExtensionTypes.PnReferenceBased.ICreationParameters,
+  version: string,
 ): ExtensionTypes.IAction {
   if (!creationParameters.salt) {
     throw Error('salt should not be empty');
@@ -43,7 +42,7 @@ function createCreationAction(
     action: ExtensionTypes.PnReferenceBased.ACTION.CREATE,
     id: extensionId,
     parameters: creationParameters,
-    version: CURRENT_VERSION,
+    version,
   };
 }
 
@@ -165,6 +164,9 @@ function applyCreation(
   extensionAction: ExtensionTypes.IAction,
   timestamp: number,
 ): ExtensionTypes.IState {
+  if (!extensionAction.version) {
+    throw Error('version is missing');
+  }
   if (
     extensionAction.parameters.paymentAddress &&
     !isValidAddress(extensionAction.parameters.paymentAddress)
@@ -196,7 +198,7 @@ function applyCreation(
       refundAddress: extensionAction.parameters.refundAddress,
       salt: extensionAction.parameters.salt,
     },
-    version: CURRENT_VERSION,
+    version: extensionAction.version,
   };
 }
 

packages/advanced-logic/src/extensions/payment-network/reference-based.ts

@@ -29,7 +29,7 @@ describe('extensions/payment-network/ethereum/input-data', () => {
           refundAddress: '0x0000000000000000000000000000000000000002',
           salt: 'ea3bc7caf64110ca',
         },
-        version: '0.1.0',
+        version: '0.2.0',
       });
     });
 
@@ -45,7 +45,7 @@ describe('extensions/payment-network/ethereum/input-data', () => {
         parameters: {
           salt: 'ea3bc7caf64110ca',
         },
-        version: '0.1.0',
+        version: '0.2.0',
       });
     });