Merge pull request #269 from Zilliqa/feat/transactionstatus

feat/transactionstatus

Author: bb111189

examples/callContract.js

@@ -88,6 +88,7 @@ async function testBlockchain() {
       false,
     );
 
+    console.log(callTx.bytes);
     // check the pending status
     const pendingStatus = await zilliqa.blockchain.getPendingTxn(callTx.id);
     console.log(`Pending status is: `);

examples/queryTransactionStatus.js

@@ -0,0 +1,33 @@
+//  Copyright (C) 2020 Zilliqa
+//
+//  This file is part of Zilliqa-Javascript-Library.
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+const { Zilliqa } = require('@zilliqa-js/zilliqa');
+
+const zilliqa = new Zilliqa('https://dev-api.zilliqa.com');
+
+async function test() {
+  try {
+    const status = await zilliqa.blockchain.getTransactionStatus(
+      '96ba63371a57c9d4d7cbf448dbdd78d209c888a76a30413abd72691c16efffbb',
+    );
+    console.log(status);
+  } catch (e) {
+    console.log(e);
+  }
+}
+
+test();

packages/zilliqa-js-blockchain/src/chain.ts

@@ -25,6 +25,7 @@ import {
   DsBlockObj,
   GET_TX_ATTEMPTS,
   PendingTxnResult,
+  TransactionStatusObj,
   TransactionStatus,
   PendingTxns,
   Provider,
@@ -70,6 +71,38 @@ export class Blockchain implements ZilliqaModule {
     255: 'Error - Internal database error',
   };
 
+  transactionStatusMap: { [key: number]: { [key: number]: string } } = {
+    0: { 0: 'Transaction not found', 1: ' Pending - Dispatched' },
+    1: {
+      2: 'Pending - Soft-confirmed (awaiting Tx block generation)',
+      4: 'Pending - Nonce is higher than expected',
+      5: 'Pending - Microblock gas limit exceeded',
+      6: 'Pending - Consensus failure in network',
+    },
+    2: {
+      3: 'Confirmed',
+      10: 'Rejected - Transaction caused math error',
+      11: 'Rejected - Scilla invocation error',
+      12: 'Rejected - Contract account initialization error',
+      13: 'Rejected - Invalid source account',
+      14: 'Rejected - Gas limit higher than shard gas limit',
+      15: 'Rejected - Unknown transaction type',
+      16: 'Rejected - Transaction sent to wrong shard',
+      17: 'Rejected - Contract & source account cross-shard issue',
+      18: 'Rejected - Code size exceeded limit',
+      19: 'Rejected - Transaction verification failed',
+      20: 'Rejected - Gas limit too low',
+      21: 'Rejected - Insufficient balance',
+      22: 'Rejected - Insufficient gas to invoke Scilla checker',
+      23: 'Rejected - Duplicate transaction exists',
+      24: 'Rejected - Transaction with higher gas price exists',
+      25: 'Rejected - Invalid destination address',
+      26: 'Rejected - Failed to add contract account to state',
+      27: 'Rejected - Nonce is lower than expected',
+      255: 'Rejected - Internal error',
+    },
+  };
+
   constructor(provider: Provider, signer: Wallet) {
     this.provider = provider;
     this.provider.middleware.request.use(
@@ -396,7 +429,7 @@ export class Blockchain implements ZilliqaModule {
    * a rejected Transaction instance is returned.
    *
    * @param {string} txHash
-   * @returns {Promise<any>}
+   * @returns {Promise<Transaction>}
    */
   async getTransaction(txHash: string): Promise<Transaction> {
     try {
@@ -417,6 +450,35 @@ export class Blockchain implements ZilliqaModule {
     }
   }
 
+  /**
+   * Returns the status of a specified transaction.
+   * This API is available from Zilliqa `V7.0.0` onwards and supports all transaction statuses
+   * (unconfirmed, confirmed, and rejected).
+   *
+   * @param txHash
+   * @returns {Promise<TransactionStatusObj>}
+   */
+  async getTransactionStatus(txHash: string): Promise<TransactionStatusObj> {
+    try {
+      const response = await this.provider.send<TransactionStatusObj>(
+        RPCMethod.GetTransactionStatus,
+        txHash,
+      );
+      if (response.error) {
+        return Promise.reject(response.error);
+      }
+
+      const modificationState = response.result.modificationState;
+      const status = response.result.status;
+      response.result.statusMessage = this.transactionStatusMap[
+        modificationState
+      ][status];
+      return response.result;
+    } catch (err) {
+      throw err;
+    }
+  }
+
   /**
    * getRecentTransactions
    *

packages/zilliqa-js-blockchain/test/chain.spec.ts

@@ -284,6 +284,30 @@ describe('Module: Blockchain', () => {
     expect(result.result[0].ID).toEqual('some_hash');
   });
 
+  it('should receive transaction status with confirmed', async () => {
+    const responses = [
+      {
+        id: 1,
+        jsonrpc: '2.0',
+        result: {
+          ID:
+            '96ba63371a57c9d4d7cbf448dbdd78d209c888a76a30413abd72691c16efffbb',
+          gasLimit: '1',
+          gasPrice: '2000000000',
+          modificationState: 2,
+          status: 3,
+        },
+      },
+    ].map((res) => [JSON.stringify(res)] as [string]);
+
+    fetch.mockResponses(...responses);
+
+    const result = await blockchain.getTransactionStatus(
+      '96ba63371a57c9d4d7cbf448dbdd78d209c888a76a30413abd72691c16efffbb',
+    );
+    expect(result.statusMessage).toEqual('Confirmed');
+  });
+
   it('should receive pending transaction list', async () => {
     const responses = [
       {

packages/zilliqa-js-core/src/net.ts

@@ -51,6 +51,7 @@ export enum RPCMethod {
   // Transaction-related methods
   CreateTransaction = 'CreateTransaction',
   GetTransaction = 'GetTransaction',
+  GetTransactionStatus = 'GetTransactionStatus',
   GetRecentTransactions = 'GetRecentTransactions',
   GetTransactionsForTxBlock = 'GetTransactionsForTxBlock',
   GetTxnBodiesForTxBlock = 'GetTxnBodiesForTxBlock',

packages/zilliqa-js-core/src/types.ts

@@ -88,6 +88,30 @@ export interface TransactionObj {
   receipt: TransactionReceiptObj;
 }
 
+export interface TransactionStatusObj {
+  ID: string;
+  _id: StatusID;
+  amount: string;
+  epochInserted: string;
+  epochUpdated: string;
+  gasLimit: string;
+  gasPrice: string;
+  lastModified: string;
+  modificationState: number;
+  nonce: string;
+  senderAddr: string;
+  signature: string;
+  status: number;
+  success: boolean;
+  toAddr: string;
+  version: string;
+  statusMessage: string;
+}
+
+export interface StatusID {
+  $oid: string;
+}
+
 export interface DsBlockHeader {
   BlockNum: string;
   Difficulty: number;