DataUnion types (#209)

Types for getAdminAddress, setAdminFee, executeWithdraw. After these modifications, and PR #207 all public methods of DataUnion are annotated with valid types.

Remove deployTxReceipt field which was not used

Author: teogeb

src/dataunion/Contracts.ts

@@ -1,6 +1,6 @@
 import { getCreate2Address, isAddress } from '@ethersproject/address'
 import { arrayify, hexZeroPad } from '@ethersproject/bytes'
-import { Contract } from '@ethersproject/contracts'
+import { Contract, ContractReceipt } from '@ethersproject/contracts'
 import { keccak256 } from '@ethersproject/keccak256'
 import { defaultAbiCoder } from '@ethersproject/abi'
 import { verifyMessage } from '@ethersproject/wallet'
@@ -218,14 +218,14 @@ export class Contracts {
         return trAMB
     }
 
-    async payForSignatureTransport(tr: { events: any[] }, options: { pollingIntervalMs?: number, retryTimeoutMs?: number } = {}) {
+    async payForSignatureTransport(tr: ContractReceipt, options: { pollingIntervalMs?: number, retryTimeoutMs?: number } = {}) {
         const {
             pollingIntervalMs = 1000,
             retryTimeoutMs = 60000,
         } = options
-        log(`Got receipt, filtering UserRequestForSignature from ${tr.events.length} events...`)
+        log(`Got receipt, filtering UserRequestForSignature from ${tr.events!.length} events...`)
         // event UserRequestForSignature(bytes32 indexed messageId, bytes encodedData);
-        const sigEventArgsArray = tr.events.filter((e: Todo) => e.event === 'UserRequestForSignature').map((e: Todo) => e.args)
+        const sigEventArgsArray = tr.events!.filter((e: Todo) => e.event === 'UserRequestForSignature').map((e: Todo) => e.args)
         if (sigEventArgsArray.length < 1) {
             throw new Error("No UserRequestForSignature events emitted from withdraw transaction, can't transport withdraw to mainnet")
         }
@@ -309,7 +309,7 @@ export class Contracts {
             duName,
             ethersOptions
         )
-        const tr = await tx.wait(confirmations)
+        await tx.wait(confirmations)
 
         log(`Data Union "${duName}" (mainnet: ${duMainnetAddress}, sidechain: ${duSidechainAddress}) deployed to mainnet, waiting for side-chain...`)
         await until(
@@ -320,8 +320,6 @@ export class Contracts {
 
         const dataUnion = new Contract(duMainnetAddress, dataUnionMainnetABI, mainnetWallet)
         // @ts-expect-error
-        dataUnion.deployTxReceipt = tr
-        // @ts-expect-error
         dataUnion.sidechain = new Contract(duSidechainAddress, dataUnionSidechainABI, sidechainProvider)
         return dataUnion
 

src/dataunion/DataUnion.ts

@@ -6,7 +6,7 @@ import { TransactionReceipt, TransactionResponse } from '@ethersproject/provider
 import debug from 'debug'
 import { Contracts } from './Contracts'
 import StreamrClient from '../StreamrClient'
-import { EthereumAddress, Todo } from '../types'
+import { EthereumAddress } from '../types'
 import { until, getEndpointUrl } from '../utils'
 import authFetch from '../rest/authFetch'
 
@@ -296,7 +296,7 @@ export class DataUnion {
         return +adminFeeBN.toString() / 1e18
     }
 
-    async getAdminAddress(): Promise<Todo> {
+    async getAdminAddress(): Promise<EthereumAddress> {
         const duMainnet = this.getContracts().getMainnetContractReadOnly(this.contractAddress)
         return duMainnet.owner()
     }
@@ -446,7 +446,7 @@ export class DataUnion {
     /**
      * Admin: set admin fee (between 0.0 and 1.0) for the data union
      */
-    async setAdminFee(newFeeFraction: number): Promise<Todo> {
+    async setAdminFee(newFeeFraction: number): Promise<TransactionReceipt> {
         if (newFeeFraction < 0 || newFeeFraction > 1) {
             throw new Error('newFeeFraction argument must be a number between 0...1, got: ' + newFeeFraction)
         }
@@ -539,7 +539,7 @@ export class DataUnion {
     // template for withdraw functions
     // client could be replaced with AMB (mainnet and sidechain)
     private async _executeWithdraw(
-        getWithdrawTxFunc: () => Promise<Todo & { events: any[] }>,
+        getWithdrawTxFunc: () => Promise<TransactionResponse>,
         recipientAddress: EthereumAddress,
         options: DataUnionWithdrawOptions = {}
     ): Promise<TransactionReceipt> {