Added automatic event parsing for contract transaction receipts from …

…tx.wait.
ethers-io · Oct 4, 2018 · 2481581 · 2481581
1 parent f5c7ccb
commit 2481581
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 5 deletions.
diff --git a/src.ts/contract.ts b/src.ts/contract.ts
@@ -53,6 +53,14 @@ export interface Event extends Log {
     getTransactionReceipt: () => Promise<TransactionReceipt>;
 }
 
+export interface ContractReceipt extends TransactionReceipt {
+    events?: Array<Event>;
+}
+
+export interface ContractTransaction extends TransactionResponse {
+    wait(confirmations?: number): Promise<ContractReceipt>;
+}
+
 ///////////////////////////////
 
 export class VoidSigner extends Signer {
@@ -256,7 +264,42 @@ function runMethod(contract: Contract, functionName: string, estimateOnly: boole
                     errors.throwError('cannot override from in a transaction', errors.UNSUPPORTED_OPERATION, { operation: 'sendTransaction' })
                 }
 
-                return contract.signer.sendTransaction(tx);
+                return contract.signer.sendTransaction(tx).then((tx) => {
+                    let wait = tx.wait.bind(tx);
+
+                    tx.wait = (confirmations?: number) => {
+                        return wait(confirmations).then((receipt: ContractReceipt) => {
+                            receipt.events = receipt.logs.map((log) => {
+                                 let event: Event = (<Event>deepCopy(log));
+
+                                 let parsed = this.interface.parseLog(log);
+                                 if (parsed) {
+                                     event.args = parsed.values;
+                                     event.decode = parsed.decode;
+                                     event.event = parsed.name;
+                                     event.eventSignature = parsed.signature;
+                                }
+
+                                event.removeListener = () => { return this.provider; }
+                                event.getBlock = () => {
+                                    return this.provider.getBlock(receipt.blockHash);
+                                }
+                                event.getTransaction = () => {
+                                    return this.provider.getTransaction(receipt.transactionHash);
+                                }
+                                event.getTransactionReceipt = () => {
+                                    return Promise.resolve(receipt);
+                                }
+
+                                return event;
+                            });
+
+                            return receipt;
+                        });
+                    };
+
+                    return tx;
+                });
             }
 
             throw new Error('invalid type - ' + method.type);

diff --git a/src.ts/ethers.ts b/src.ts/ethers.ts
@@ -26,7 +26,7 @@ import { version } from './_version';
 ////////////////////////
 // Types
 
-import { ContractFunction, Event, EventFilter } from './contract';
+import { ContractFunction, ContractTransaction, Event, EventFilter } from './contract';
 
 
 ////////////////////////
@@ -72,6 +72,7 @@ export {
     // Types
 
     ContractFunction,
+    ContractTransaction,
     Event,
     EventFilter
 };

diff --git a/src.ts/providers/abstract-provider.ts b/src.ts/providers/abstract-provider.ts
@@ -103,7 +103,7 @@ export interface TransactionResponse extends Transaction {
     raw?: string,
 
     // This function waits until the transaction has been mined
-    wait: (timeout?: number) => Promise<TransactionReceipt>
+    wait: (confirmations?: number) => Promise<TransactionReceipt>
 };
 
 export type EventType = string | Array<string> | Filter;

diff --git a/src.ts/providers/base-provider.ts b/src.ts/providers/base-provider.ts
@@ -702,13 +702,13 @@ export class BaseProvider extends Provider {
 
     _setFastBlockNumber(blockNumber: number): void {
         // Older block, maybe a stale request
-        if (blockNumber < this._fastBlockNumber) { return; }
+        if (this._fastBlockNumber != null && blockNumber < this._fastBlockNumber) { return; }
 
         // Update the time we updated the blocknumber
         this._fastQueryDate = getTime();
 
         // Newer block number, use  it
-        if (blockNumber > this._fastBlockNumber) {
+        if (this._fastBlockNumber == null || blockNumber > this._fastBlockNumber) {
             this._fastBlockNumber = blockNumber;
             this._fastBlockNumberPromise = Promise.resolve(blockNumber);
         }