feat: sanitize abi (#56)

Sanitize ABI events with parameters name which conflict with web3 0.X.X

specs/txUtils.spec.ts

@@ -2,6 +2,7 @@ import { expect } from 'chai'
 import { deployContract } from './deployContract'
 import { eth, txUtils } from '../dist'
 import { testGeth } from './helpers'
+import { sleep } from '../dist/utils'
 
 testGeth(provider => {
   it('initializes eth provider', async () => {
@@ -13,11 +14,15 @@ testGeth(provider => {
       it('should return the confirmed transaction status and its receipt', async function() {
         this.timeout(100000)
 
+        await sleep(500)
         const contract = await deployContract(eth.wallet, 'MANA', require('./fixtures/MANAToken.json'))
+        await sleep(500)
+
         /* tslint:disable-next-line:no-unnecessary-type-assertion */
         const { receipt, ...tx } = (await txUtils.getTransaction(
           contract.transactionHash
         )) as txUtils.ConfirmedTransaction
+        await sleep(500)
 
         expect(tx).to.include.keys([
           'type',

src/contracts/DecentralandInvite.ts

@@ -1,13 +1,11 @@
 import { Contract } from '../ethereum'
-import { fulfillContractMethods } from './verification'
 
 const { abi } = require('./artifacts/DecentralandInvite.json')
 
 /** DecentralandInvite contract class */
 export class DecentralandInvite extends Contract {
   constructor(address: string) {
     super(address, abi)
-    fulfillContractMethods(this, abi)
   }
 
   getContractName() {

src/contracts/DecentralandVesting.ts

@@ -1,5 +1,4 @@
 import { eth, Contract } from '../ethereum'
-import { fulfillContractMethods } from './verification'
 import { BigNumber } from 'bignumber.js'
 
 const { abi } = require('./artifacts/DecentralandVesting.json')
@@ -8,7 +7,6 @@ const { abi } = require('./artifacts/DecentralandVesting.json')
 export class DecentralandVesting extends Contract {
   constructor(address: string = process.env.TERRAFORM_RESERVE_CONTRACT_ADDRESS) {
     super(address, abi)
-    fulfillContractMethods(this, abi)
   }
 
   getContractName() {

src/contracts/ERC20Token.ts

@@ -1,13 +1,11 @@
 import { Contract } from '../ethereum'
-import { fulfillContractMethods } from './verification'
 
 const { abi } = require('./artifacts/ERC20Token.json')
 
 /** ERC20Token contract class */
 export class ERC20Token extends Contract {
   constructor(address: string) {
     super(address, abi)
-    fulfillContractMethods(this, abi)
   }
 
   getContractName() {

src/contracts/ERC721Bid.ts

@@ -1,12 +1,10 @@
 import { Contract } from '../ethereum'
-import { fulfillContractMethods } from './verification'
 
 const { abi } = require('./artifacts/ERC721Bid.json')
 
 export class ERC721Bid extends Contract {
   constructor(address: string) {
     super(address, abi)
-    fulfillContractMethods(this, abi)
   }
 
   getContractName() {

src/contracts/ERC721Token.ts

@@ -1,5 +1,4 @@
 import { Contract } from '../ethereum'
-import { fulfillContractMethods } from './verification'
 
 const { abi } = require('./artifacts/ERC721Token.json')
 
@@ -8,7 +7,6 @@ const { abi } = require('./artifacts/ERC721Token.json')
 export class ERC721Token extends Contract {
   constructor(address: string) {
     super(address, abi)
-    fulfillContractMethods(this, abi)
   }
 
   getContractName() {

src/contracts/EstateRegistry.ts

@@ -1,12 +1,10 @@
 import { Contract } from '../ethereum'
-import { fulfillContractMethods } from './verification'
 
 const { abi } = require('./artifacts/EstateRegistry.json')
 
 export class EstateRegistry extends Contract {
   constructor(address: string) {
     super(address, abi)
-    fulfillContractMethods(this, abi)
   }
 
   getContractName() {

src/contracts/LANDAuction.ts

@@ -1,12 +1,10 @@
 import { Contract } from '../ethereum'
-import { fulfillContractMethods } from './verification'
 
 const { abi } = require('./artifacts/LANDAuction.json')
 
 export class LANDAuction extends Contract {
   constructor(address: string) {
     super(address, abi)
-    fulfillContractMethods(this, abi)
   }
 
   getContractName() {

src/contracts/LANDRegistry.ts

@@ -1,6 +1,5 @@
 import * as CSV from 'comma-separated-values'
 import { Contract } from '../ethereum'
-import { fulfillContractMethods } from './verification'
 const { abi } = require('./artifacts/LANDRegistry.json')
 
 const MAX_NAME_LENGTH = 50
@@ -19,7 +18,6 @@ export class LANDRegistry extends Contract {
 
   constructor(address: string) {
     super(address, abi)
-    fulfillContractMethods(this, abi)
   }
 
   static decodeLandData(data = '') {

src/contracts/LegacyMarketplace.ts

@@ -1,13 +1,11 @@
 import { Contract } from '../ethereum'
-import { fulfillContractMethods } from './verification'
 
 const { abi } = require('./artifacts/LegacyMarketplace.json')
 
 /** LegacyMarketplace contract class */
 export class LegacyMarketplace extends Contract {
   constructor(address: string) {
     super(address, abi)
-    fulfillContractMethods(this, abi)
   }
 
   getContractName() {

src/contracts/MANAToken.ts

@@ -1,5 +1,4 @@
 import { eth, Contract } from '../ethereum'
-import { fulfillContractMethods } from './verification'
 
 const { abi } = require('./artifacts/MANAToken.json')
 
@@ -25,7 +24,6 @@ export interface MANAToken {
 export class MANAToken extends Contract {
   constructor(address: string) {
     super(address, abi)
-    fulfillContractMethods(this, abi)
   }
 
   getContractName() {

src/contracts/Marketplace.ts

@@ -1,13 +1,11 @@
 import { Contract } from '../ethereum'
-import { fulfillContractMethods } from './verification'
 
 const { abi } = require('./artifacts/Marketplace.json')
 
 /** Marketplace contract class */
 export class Marketplace extends Contract {
   constructor(address: string) {
     super(address, abi)
-    fulfillContractMethods(this, abi)
   }
 
   getContractName() {

src/contracts/MortgageHelper.ts

@@ -1,12 +1,10 @@
 import { Contract } from '../ethereum'
-import { fulfillContractMethods } from './verification'
 const { abi } = require('./artifacts/MortgageHelper.json')
 
 /** MortgageCreator contract class */
 export class MortgageHelper extends Contract {
   constructor(address: string) {
     super(address, abi)
-    fulfillContractMethods(this, abi)
   }
 
   getContractName() {

src/contracts/MortgageManager.ts

@@ -1,12 +1,10 @@
 import { Contract } from '../ethereum'
-import { fulfillContractMethods } from './verification'
 const { abi } = require('./artifacts/MortgageManager.json')
 
 /** MortgageManager contract class */
 export class MortgageManager extends Contract {
   constructor(address: string) {
     super(address, abi)
-    fulfillContractMethods(this, abi)
   }
 
   getContractName() {

src/contracts/RCNEngine.ts

@@ -1,12 +1,10 @@
 import { Contract } from '../ethereum'
-import { fulfillContractMethods } from './verification'
 const { abi } = require('./artifacts/RCNEngine.json')
 
 /** RCNEngine contract class */
 export class RCNEngine extends Contract {
   constructor(address: string) {
     super(address, abi)
-    fulfillContractMethods(this, abi)
   }
 
   getContractName() {

src/ethereum/Contract.ts

@@ -1,6 +1,7 @@
 import { promisify } from '../utils'
 import { Abi } from './abi'
 import { Event } from './Event'
+import { fulfillContractMethods } from '../contracts/verification'
 
 /** Class to work with Ethereum contracts */
 export abstract class Contract<T = any> {
@@ -14,7 +15,11 @@ export abstract class Contract<T = any> {
    */
   constructor(address: string, abi: object) {
     this.setAddress(address)
-    this.setAbi(abi)
+    const sanitizedABI = Abi.sanitize(abi)
+
+    this.setAbi(sanitizedABI)
+
+    fulfillContractMethods(this, sanitizedABI)
 
     this.instance = null
   }

src/ethereum/abi/Abi.ts

@@ -43,6 +43,28 @@ const abi = {
     if (param) {
       return param.value
     }
+  },
+
+  /**
+   * Sanitize ABI.
+   * Web3 0.X.X has "owner" as a reserved word, so if one of the event parameters name is "owner"
+   * it will break. This method will change every "owner" to "_owner"
+   * @param  {array} ABI
+   * @return {array} - Sanitized ABI
+   */
+  sanitize(abi) {
+    return abi.map(prop => {
+      let inputs = prop.inputs
+      if (prop.name && prop.type === 'event') {
+        inputs = prop.inputs.map(input => {
+          if (input.name === 'owner') {
+            input.name = '_owner'
+          }
+          return input
+        })
+      }
+      return { ...prop, inputs }
+    })
   }
 }