Upgrade version to 1.7.0 (obsolete)

__tests__/__snapshots__/ain.test.ts.snap

@@ -169,6 +169,20 @@ Object {
 }
 `;
 
+exports[`ain-js Database getProofHash 1`] = `"0x88496dfee3566db91f487aa4cbf69a0c42a3e2a5d0a65bfd4897d699e8734785"`;
+
+exports[`ain-js Database getStateInfo 1`] = `
+Object {
+  "#num_children": 1,
+  "#state_ph": "0x985a1f057d5047b1dee392127eb776571fbbe79da7ae6114f8f8f18c4f786135",
+  "#tree_bytes": 1840,
+  "#tree_height": 2,
+  "#tree_max_siblings": 1,
+  "#tree_size": 3,
+  "#version": "erased",
+}
+`;
+
 exports[`ain-js Database matchFunction 1`] = `
 Object {
   "matched_config": Object {

__tests__/test_util.ts

@@ -1,6 +1,16 @@
+import { set } from 'lodash';
+
 export declare function fail(error?: any): never;
 
-export function eraseProtoVer(retVal) {
-  retVal.protoVer = 'erased';
-  return retVal;
+export function eraseProtoVer(result) {
+  const erased = JSON.parse(JSON.stringify(result));
+  set(erased, 'protoVer', 'erased');
+  return erased;
+}
+
+export function eraseStateVersion(result) {
+  const erased = JSON.parse(JSON.stringify(result));
+  set(erased, '#version', 'erased');
+  return erased;
 }
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ainblockchain/ain-js",
-  "version": "1.6.3",
+  "version": "1.7.0",
   "description": "",
   "main": "lib/ain.js",
   "scripts": {

src/ain-db/ref.ts

@@ -11,6 +11,7 @@ import {
   EvalRuleInput,
   EvalOwnerInput,
   MatchInput,
+  StateInfoInput,
   GetOptions,
 } from '../types';
 import Ain from '../ain';
@@ -347,6 +348,42 @@ export default class Reference {
     return this._ain.provider.send('ain_matchOwner', request);
   }
 
+  /**
+   * Fetches the state proof of a global blockchain state path.
+   * @param {StateInfoInput} params The state info input.
+   * @returns {Promise<any>} The return value of the blockchain API.
+   */
+  getStateProof(params?: StateInfoInput): Promise<any> {
+    const request = {
+      ref: Reference.extendPath(this.path, params ? params.ref : undefined)
+    }
+    return this._ain.provider.send('ain_getStateProof', request);
+  }
+
+  /**
+   * Fetches the proof hash of a global blockchain state path.
+   * @param {StateInfoInput} params The state info input.
+   * @returns {Promise<any>} The return value of the blockchain API.
+   */
+  getProofHash(params?: StateInfoInput): Promise<any> {
+    const request = {
+      ref: Reference.extendPath(this.path, params ? params.ref : undefined)
+    }
+    return this._ain.provider.send('ain_getProofHash', request);
+  }
+
+  /**
+   * Fetches the state information of a global blockchain state path.
+   * @param {StateInfoInput} params The state info input.
+   * @returns {Promise<any>} The return value of the blockchain API.
+   */
+  getStateInfo(params?: StateInfoInput): Promise<any> {
+    const request = {
+      ref: Reference.extendPath(this.path, params ? params.ref : undefined)
+    }
+    return this._ain.provider.send('ain_getStateInfo', request);
+  }
+
   // TODO(liayoo): Add this function.
   ///**
   // * Attaches an listener for database events.

src/ain.ts

@@ -85,54 +85,175 @@ export default class Ain {
   }
 
   /**
-   * Fetches a block with a block hash or block number.
-   * @param {string | number} blockHashOrBlockNumber The block hash or block number.
+   * Fetches the last block.
+   * @returns {Promise<Block>}
+   */
+  getLastBlock(): Promise<Block> {
+    return this.provider.send('ain_getLastBlock', {});
+  }
+
+  /**
+   * Fetches the last block number.
+   * @returns {Promise<Number>}
+   */
+  getLastBlockNumber(): Promise<Block> {
+    return this.provider.send('ain_getLastBlockNumber', {});
+  }
+
+  /**
+   * Fetches a block with a block number.
+   * @param {number} blockNumber The block number.
    * @param {boolean} returnTransactionObjects If it's true, returns a block with full transaction objects.
    * Otherwise, returns a block with only transaction hashes.
    * @returns {Promise<Block>}
    */
-  getBlock(blockHashOrBlockNumber: string | number, returnTransactionObjects?: boolean): Promise<Block> {
-    const byHash = typeof blockHashOrBlockNumber === 'string'
-    const rpcMethod = byHash ? 'ain_getBlockByHash' : 'ain_getBlockByNumber';
-    const data = Object.assign({},
-        { getFullTransactions: !!returnTransactionObjects,
-          [byHash ? 'hash' : 'number']: blockHashOrBlockNumber });
-    return this.provider.send(rpcMethod, data);
+  getBlockByNumber(blockNumber: number, returnTransactionObjects?: boolean): Promise<Block> {
+    const data =
+        Object.assign({}, { getFullTransactions: !!returnTransactionObjects, number: blockNumber });
+    return this.provider.send('ain_getBlockByNumber', data);
+  }
+
+  /**
+   * Fetches a block with a block hash.
+   * @param {string} blockHash The block hash.
+   * @param {boolean} returnTransactionObjects If it's true, returns a block with full transaction objects.
+   * Otherwise, returns a block with only transaction hashes.
+   * @returns {Promise<Block>}
+   */
+  getBlockByHash(blockHash: string, returnTransactionObjects?: boolean): Promise<Block> {
+    const data =
+        Object.assign({}, { getFullTransactions: !!returnTransactionObjects, hash: blockHash });
+    return this.provider.send('ain_getBlockByHash', data);
+  }
+
+  /**
+   * Fetches blocks with a block number range.
+   * @param {number} from The begining block number (inclusive).
+   * @param {number} to The ending block number (exclusive).
+   * @returns {Promise<Array<Block>>}
+   */
+  getBlockList(from: number, to: number): Promise<Array<Block>> {
+    return this.provider.send('ain_getBlockList', { from, to });
   }
 
   /**
-   * Fetches the forger's address of a block with a block hash or block number.
-   * @param {string | number} blockHashOrBlockNumber The block hash or block number.
+   * Fetches block headers with a block number range.
+   * @param {number} from The begining block number (inclusive).
+   * @param {number} to The ending block number (exclusive).
+   * @returns {Promise<Array<Block>>}
+   */
+  getBlockHeadersList(from: number, to: number): Promise<Array<Block>> {
+    return this.provider.send('ain_getBlockHeadersList', { from, to });
+  }
+
+  /**
+   * Fetches block transaction count with a block number.
+   * @param {number} number The block number.
+   * @returns {Promise<Number>}
+   */
+  getBlockTransactionCountByNumber(number: number): Promise<Number> {
+    return this.provider.send('ain_getBlockTransactionCountByNumber', { number });
+  }
+
+  /**
+   * Fetches block transaction count with a block hash.
+   * @param {string} hash The block hash.
+   * @returns {Promise<Number>}
+   */
+  getBlockTransactionCountByHash(hash: string): Promise<Number> {
+    return this.provider.send('ain_getBlockTransactionCountByHash', { hash });
+  }
+
+  /**
+   * Fetches the information of the given validator address.
+   * @param {string} address The validator address.
+   * @returns {Promise<any>}
+   */
+  getValidatorInfo(address: string): Promise<any> {
+    return this.provider.send('ain_getValidatorInfo', { address });
+  }
+
+  /**
+   * Fetches the validator list of a block with a block number.
+   * @param {number} blockNumber The block number.
+   * @returns {Promise<any>}
+   */
+  getValidatorsByNumber(blockNumber: number): Promise<any> {
+    return this.provider.send('ain_getValidatorsByNumber', { number: blockNumber });
+  }
+
+  /**
+   * Fetches the validator list of a block with a block hash.
+   * @param {string} blockHash The block hash.
+   * @returns {Promise<any>}
+   */
+  getValidatorsByHash(blockHash: string): Promise<any> {
+    return this.provider.send('ain_getValidatorsByHash', { hash: blockHash });
+  }
+
+  /**
+   * Fetches the block proproser's address of a block with a block number.
+   * @param {number} blockNumber The block number.
    * @returns {Promise<string>}
    */
-  getProposer(blockHashOrBlockNumber: string | number): Promise<string> {
-    const byHash = typeof blockHashOrBlockNumber === 'string'
-    const rpcMethod = byHash ? 'ain_getProposerByHash' : 'ain_getProposerByNumber';
-    return this.provider.send(rpcMethod,
-        {[byHash ? 'hash' : 'number']: blockHashOrBlockNumber});
+  getProposerByNumber(blockNumber: number): Promise<string> {
+    return this.provider.send('ain_getProposerByNumber', { number: blockNumber });
   }
 
   /**
-   * Fetches the validator list of a block with a block hash or block number.
-   * @param {string | number} blockHashOrBlockNumber The block hash or block number.
-   * @returns {Promise<string[]>}
+   * Fetches the block proproser's address of a block with a block hash.
+   * @param {string} blockHash The block hash.
+   * @returns {Promise<string>}
    */
-  getValidators(blockHashOrBlockNumber: string | number): Promise<string[]> {
-    const byHash = typeof blockHashOrBlockNumber === 'string'
-    const rpcMethod = byHash ? 'ain_getValidatorsByHash' : 'ain_getValidatorsByNumber';
-    return this.provider.send(rpcMethod,
-        {[byHash ? 'hash' : 'number']: blockHashOrBlockNumber});
+  getProposerByHash(blockHash: string): Promise<string> {
+    return this.provider.send('ain_getProposerByHash', { hash: blockHash });
+  }
+
+  /**
+   * Fetches pending transaction.
+   * @returns {Promise<any>}
+   */
+  getPendingTransactions(): Promise<any> {
+    return this.provider.send('ain_getPendingTransactions', {});
+  }
+
+  /**
+   * Fetches transaction pool size utilization.
+   * @returns {Promise<any>}
+   */
+  getTransactionPoolSizeUtilization(): Promise<any> {
+    return this.provider.send('ain_getTransactionPoolSizeUtilization', {});
   }
 
   /**
    * Fetches a transaction's information with a transaction hash.
    * @param {string} transactionHash The transaction hash.
    * @returns {Promise<TransactionInfo>}
    */
-  getTransaction(transactionHash: string): Promise<TransactionInfo> {
+  getTransactionByHash(transactionHash: string): Promise<TransactionInfo> {
     return this.provider.send('ain_getTransactionByHash', { hash: transactionHash });
   }
 
+  /**
+   * Fetches a transaction's information with a block hash and an index.
+   * @param {string} blockHash The block hash.
+   * @param {number} index The transaction index in the block
+   * @returns {Promise<TransactionInfo>}
+   */
+  getTransactionByBlockHashAndIndex(blockHash: string, index: Number): Promise<TransactionInfo> {
+    return this.provider.send('ain_getTransactionByBlockHashAndIndex', { block_hash: blockHash, index });
+  }
+
+  /**
+   * Fetches a transaction's information with a block hash and an index.
+   * @param {string} blockNumber The block number.
+   * @param {number} index The transaction index in the block
+   * @returns {Promise<TransactionInfo>}
+   */
+  getTransactionByBlockNumberAndIndex(blockNumber: Number, index: Number): Promise<TransactionInfo> {
+    return this.provider.send('ain_getTransactionByBlockNumberAndIndex', { block_number: blockNumber, index });
+  }
+
   /**
    * Fetches a blockchain app's state usage information with an app name.
    * @param {string} appName The blockchain app name.

src/provider.ts

@@ -37,6 +37,14 @@ export default class Provider {
     this.httpClient = axios.create(axiosConfig);
   }
 
+  /**
+   * Fetches the blockchain node's address.
+   * @returns {Promise<number>} The address value.
+   */
+  getAddress(): Promise<number> {
+    return this.send('ain_getAddress', {})
+  }
+
   /**
    * Creates a JSON-RPC payload and sends it to the network.
    * @param {string} rpcMethod The JSON-RPC method.

src/signer/default-signer.ts

@@ -124,31 +124,11 @@ export class DefaultSigner implements Signer {
     }
     let nonce = transactionInput.nonce;
     if (nonce === undefined) {
-      nonce = await this.getNonce({ address, from: "pending" });
+      nonce = await this.wallet.getNonce({ address, from: "pending" });
     }
     const timestamp = transactionInput.timestamp ? transactionInput.timestamp : Date.now();
     const gasPrice = transactionInput.gas_price || 0;
     const billing = transactionInput.billing;
     return Object.assign(tx, { nonce, timestamp, gas_price: gasPrice, billing });
   }
-
-  /**
-   * Fetches an account's nonce value, which is the current transaction count of the account.
-   * @param {object} args The ferch options.
-   * It may contain a string 'address' value and a string 'from' value.
-   * The 'address' is the address of the account to get the nonce of,
-   * and the 'from' is the source of the data.
-   * It could be either the pending transaction pool ("pending") or
-   * the committed blocks ("committed"). The default value is "committed".
-   * @returns {Promise<number>} The nonce value.
-   */
-  getNonce(args: { address?: string, from?: string }): Promise<number> {
-    if (!args) { args = {}; }
-    const address = args.address ? Ain.utils.toChecksumAddress(args.address)
-      : this.getAddress(args.address);
-    if (args.from !== undefined && args.from !== 'pending' && args.from !== 'committed') {
-      throw Error("'from' should be either 'pending' or 'committed'");
-    }
-    return this.provider.send('ain_getNonce', { address, from: args.from })
-  }
-}
+  };

src/types.ts

@@ -291,6 +291,13 @@ export interface MatchInput {
   is_global?: boolean;
 }
 
+/**
+ * An interface for state information input.
+ */
+export interface StateInfoInput {
+  ref?: string;
+}
+
 /**
  * An interface for state usage information.
  */