Merge pull request #244 from Zilliqa/feat/pendingtxn

feat/pendingtxn

Author: bb111189

.gitignore

@@ -7,6 +7,7 @@ dist
 includes
 tsconfig.tsbuildinfo
 .env
+.idea/
 coverage
 devTestOnly/
 @zilliqa-js*

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

@@ -25,6 +25,7 @@ import {
   DsBlockObj,
   GET_TX_ATTEMPTS,
   PendingTxnResult,
+  TransactionStatus,
   PendingTxns,
   Provider,
   RPCMethod,
@@ -43,6 +44,30 @@ import { toTxParams } from './util';
 export class Blockchain implements ZilliqaModule {
   signer: Wallet;
   provider: Provider;
+  pendingErrorMap: { [key: number]: string } = {
+    0: 'Txn was already processed and confirmed',
+    1: 'Pending - nonce too high',
+    2: 'Pending - blk gas limit exceeded',
+    3: 'Pending - consensus failure',
+    4: 'Error - txn not found',
+    10: 'Dropped - math error',
+    11: 'Dropped - scilla invocation error',
+    12: 'Dropped - account init error',
+    13: 'Dropped - invalid source account',
+    14: 'Dropped - gas limit too high',
+    15: 'Dropped - txn type unknown',
+    16: 'Dropped - txn in wrong shard',
+    17: 'Dropped - account in wrong shard',
+    18: 'Dropped - code size too large',
+    19: 'Dropped - txn verification error',
+    20: 'Dropped - gas limit too low',
+    21: 'Dropped - insuff balance',
+    22: 'Dropped - insuff gas for checker',
+    23: 'Dropped - duplicate txn found',
+    24: 'Dropped - txn w/ higher gas found',
+    25: 'Dropped - invalid dest account',
+    26: 'Dropped - state addition error',
+  };
 
   constructor(provider: Provider, signer: Wallet) {
     this.provider = provider;
@@ -474,28 +499,48 @@ export class Blockchain implements ZilliqaModule {
    * See the pending status of transaction
    * @param txId
    */
-  getPendingTxn(txId: string): Promise<RPCResponse<PendingTxnResult, string>> {
-    return this.provider.send(
-      RPCMethod.GetPendingTxn,
-      txId.replace('0x', '').toLowerCase(),
-    );
+  async getPendingTxn(txId: string): Promise<PendingTxnResult> {
+    try {
+      const response = await this.provider.send(
+        RPCMethod.GetPendingTxn,
+        txId.replace('0x', '').toLowerCase(),
+      );
+
+      if (response.error) {
+        return Promise.reject(response.error);
+      }
+
+      response.result.info = this.pendingErrorMap[response.result.code];
+
+      return response.result;
+    } catch (err) {
+      throw err;
+    }
   }
 
   /**
    * getPendingTxns
    *
    * Returns the pending status of all unvalidated Transactions.
    *
-   * For each entry, the possible results are:
-   *
-   * confirmed	code	     info
-   * false	     0	  Txn not pending
-   * false	     1	  Nonce too high
-   * false	     2	  Could not fit in as microblock gas limit reached
-   * false	     3	  Transaction valid but consensus not reached
    */
-  getPendingTxns(): Promise<RPCResponse<PendingTxns, any>> {
-    return this.provider.send(RPCMethod.GetPendingTxns);
+  async getPendingTxns(): Promise<PendingTxns> {
+    try {
+      const response = await this.provider.send(RPCMethod.GetPendingTxns);
+      if (response.error) {
+        return Promise.reject(response.error);
+      }
+
+      if (response.result.Txns.length) {
+        response.result.Txns.forEach((txn: TransactionStatus) => {
+          txn.info = this.pendingErrorMap[txn.code];
+        });
+      }
+
+      return response.result;
+    } catch (err) {
+      throw err;
+    }
   }
 
   /**

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

@@ -292,7 +292,7 @@ describe('Module: Blockchain', () => {
         result: {
           Txns: [
             {
-              Status: 1,
+              code: 1,
               TxnHash:
                 'ec5ef8110a285563d0104269081aa77820058067091a9b3f3ae70f38b94abda3',
             },
@@ -303,13 +303,14 @@ describe('Module: Blockchain', () => {
 
     fetch.mockResponses(...responses);
     const result = await blockchain.getPendingTxns();
-    expect(result.result).toBeDefined();
+    expect(result.Txns).toBeDefined();
     // @ts-ignore
-    expect(result.result.Txns).toEqual([
+    expect(result.Txns).toEqual([
       {
-        Status: 1,
+        code: 1,
         TxnHash:
           'ec5ef8110a285563d0104269081aa77820058067091a9b3f3ae70f38b94abda3',
+        info: 'Pending - nonce too high',
       },
     ]);
   });

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

@@ -115,7 +115,7 @@ export interface BlockList {
   maxPages: number;
 }
 
-const enum TxBlockType {
+enum TxBlockType {
   MICRO,
   FINAL,
 }
@@ -209,6 +209,7 @@ export interface EventLogEntry {
 }
 
 export interface TransitionEntry {
+  accepted: boolean;
   addr: string;
   depth: number;
   msg: TransitionMsg;
@@ -232,8 +233,9 @@ export interface PendingTxns {
 }
 
 export interface TransactionStatus {
-  Status: number;
+  code: number;
   TxnHash: string;
+  info: string;
 }
 
 export interface PendingTxnResult {

packages/zilliqa-js-crypto/src/util.ts

@@ -216,8 +216,9 @@ export const normaliseAddress = (address: string): string => {
 };
 
 /**
- * encodeBase58
+ * encodeBase58 -the function currently not in use, so we will deprecate it
  *
+ * @deprecated since version 1.0.0
  * @param {string} hex - base 16 encoded string
  * @returns {string} - big endian base 58 encoded string
  */
@@ -251,8 +252,9 @@ export const encodeBase58 = (hex: string): string => {
 };
 
 /**
- * decodeBase58
+ * decodeBase58 - the function currently not in use, so we will deprecate it
  *
+ * @deprecated since version 1.0.0
  * @param {string} raw - base 58 string
  * @returns {string} - big endian base 16 string
  */

packages/zilliqa-js-crypto/test/util.spec.ts

@@ -16,7 +16,6 @@
 //  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 import { decodeBase58, encodeBase58, normalizePrivateKey } from '../src/util';
-import { randomBytes } from '../src/random';
 import testCases from './b58.fixtures.json';
 
 describe('crypto utils', () => {
@@ -35,7 +34,7 @@ describe('crypto utils', () => {
   });
 
   it('should encode and decode to the same strings', () => {
-    const b16 = randomBytes(20);
+    const b16 = 'fa629547ab288cdd7f726fc0610abe944c982a1d';
     const b58 = encodeBase58(b16);
     expect(decodeBase58(b58)).toEqual(b16);
   });