Use type inference instead of specifying the return type on TransactionBuilders.

Author: Inwon Kim

lib/Wallet.ts

@@ -10,14 +10,14 @@ import { addHxPrefix } from "./data/Hexadecimal";
 import { sign } from "./data/Util";
 import { isPrivateKey } from "./data/Validator";
 import { WalletError } from "./Exception";
-import { isString, isObject } from "./data/Type";
+import { isString } from "./data/Type";
 
 const secp256k1 = require("secp256k1");
 
 // eslint-disable-next-line no-unused-vars
 type Keccak256 = { toString(str: string): string };
 
-interface KeyStore {
+export interface KeyStore {
   version: 3;
   id: string;
   address: string;
@@ -121,13 +121,14 @@ export default class Wallet {
       throw error.toString();
     }
 
-    const json: KeyStore = isObject(keystore)
-      ? keystore
-      : JSON.parse(
-          nonStrict
-            ? ((keystore as unknown) as string).toLowerCase()
-            : (keystore as string)
-        );
+    const json: KeyStore =
+      typeof keystore === "object"
+        ? keystore
+        : JSON.parse(
+            nonStrict
+              ? ((keystore as unknown) as string).toLowerCase()
+              : (keystore as string)
+          );
 
     if (json.version !== 3) {
       const error = new WalletError("This is not a V3 wallet.");
@@ -280,10 +281,10 @@ export default class Wallet {
 
   /**
    * Generate signature string by signing transaction object.
-   * @param {Buffer} data - The serialized transaction object.
+   * @param {string} data - The serialized transaction object.
    * @return {string} The signature string.
    */
-  sign(data: typeof Buffer): string {
+  sign(data: string): string {
     const signature = sign(data, this.privKey);
     return Buffer.from(signature).toString("base64");
   }

lib/builder/transaction/CallTransaction.ts

@@ -81,7 +81,7 @@ export class CallTransactionBuilder extends IcxTransactionBuilder {
    * @param {string} method - The method name of SCORE API
    * @return {CallTransactionBuilder} this.
    */
-  method(method: string): CallTransactionBuilder {
+  method(method: string) {
     this.private(this).method = method;
 
     return this;
@@ -92,7 +92,7 @@ export class CallTransactionBuilder extends IcxTransactionBuilder {
    * @param {object} params - The input params for method
    * @return {CallTransactionBuilder} this.
    */
-  params(params: any): CallTransactionBuilder {
+  params(params: any) {
     this.private(this).params = params;
 
     return this;
@@ -102,7 +102,7 @@ export class CallTransactionBuilder extends IcxTransactionBuilder {
    * Build 'CallTransaction' object
    * @return {CallTransaction} 'CallTransaction' instance exported by 'CallTransactionBuilder'.
    */
-  build(): CallTransaction {
+  build() {
     return new CallTransaction(
       this.private(this).to,
       this.private(this).from,

lib/builder/transaction/DeployTransaction.ts

@@ -79,7 +79,7 @@ export default class DeployTransactionBuilder extends IcxTransactionBuilder {
    * @param {string} contentType - The content type of content
    * @return {DeployTransactionBuilder} this.
    */
-  contentType(contentType: string): DeployTransactionBuilder {
+  contentType(contentType: string) {
     this.private(this).contentType = contentType;
 
     return this;
@@ -90,7 +90,7 @@ export default class DeployTransactionBuilder extends IcxTransactionBuilder {
    * @param {string} content - The content to deploy.
    * @return {DeployTransactionBuilder} this.
    */
-  content(content: string): DeployTransactionBuilder {
+  content(content: string) {
     this.private(this).content = content;
 
     return this;
@@ -101,7 +101,7 @@ export default class DeployTransactionBuilder extends IcxTransactionBuilder {
    * @param {object} params - The input params for deploying content
    * @return {DeployTransactionBuilder} this.
    */
-  params(params: any): DeployTransactionBuilder {
+  params(params: any) {
     this.private(this).params = params;
 
     return this;
@@ -111,7 +111,7 @@ export default class DeployTransactionBuilder extends IcxTransactionBuilder {
    * Build 'DeployTransaction' object
    * @return {DeployTransaction} 'DeployTransaction' instance exported by 'DeployTransactionBuilder'
    */
-  build(): DeployTransaction {
+  build() {
     return new DeployTransaction(
       this.private(this).to,
       this.private(this).from,

lib/builder/transaction/DepositTransaction.ts

@@ -82,7 +82,7 @@ export default class DepositTransactionBuilder extends IcxTransactionBuilder {
    * @param {string} action - add | withdraw
    * @return {DepositTransactionBuilder} this.
    */
-  action(action: string): DepositTransactionBuilder {
+  action(action: string) {
     this.private(this).action = action;
 
     return this;
@@ -93,7 +93,7 @@ export default class DepositTransactionBuilder extends IcxTransactionBuilder {
    * @param {string} id - Identifier of deposit to withdraw
    * @return {DepositTransactionBuilder} this.
    */
-  id(id: string): DepositTransactionBuilder {
+  id(id: string) {
     this.private(this).id = id;
 
     return this;
@@ -104,7 +104,7 @@ export default class DepositTransactionBuilder extends IcxTransactionBuilder {
    * @param {string} amount - amount of deposit to withdraw
    * @return {DepositTransactionBuilder} this.
    */
-  amount(amount: Hash): DepositTransactionBuilder {
+  amount(amount: Hash) {
     this.private(this).amount = amount;
     return this;
   }
@@ -114,7 +114,7 @@ export default class DepositTransactionBuilder extends IcxTransactionBuilder {
    * @return {DepositTransaction} 'DepositTransaction'
    * instance exported by 'DepositTransactionBuilder'
    */
-  build(): DepositTransaction {
+  build() {
     return new DepositTransaction(
       this.private(this).to,
       this.private(this).from,

lib/builder/transaction/IcxTransaction.ts

@@ -75,7 +75,7 @@ export class IcxTransactionBuilder {
    * @param {string} to - The EOA or SCORE address.
    * @return {IcxTransactionBuilder} this.
    */
-  to(to: string): IcxTransactionBuilder {
+  to(to: string) {
     this.private(this).to = to;
 
     return this;
@@ -86,7 +86,7 @@ export class IcxTransactionBuilder {
    * @param {string} from - The EOA address.
    * @return {IcxTransactionBuilder} this.
    */
-  from(from: string): IcxTransactionBuilder {
+  from(from: string) {
     this.private(this).from = from;
 
     return this;
@@ -97,7 +97,7 @@ export class IcxTransactionBuilder {
    * @param {string|BigNumber|number} value - The sending amount of ICX in loop unit.
    * @return {IcxTransactionBuilder} this.
    */
-  value(value: Hash): IcxTransactionBuilder {
+  value(value: Hash) {
     this.private(this).value = value;
 
     return this;
@@ -108,7 +108,7 @@ export class IcxTransactionBuilder {
    * @param {string|BigNumber|number} stepLimit - The step limit.
    * @return {IcxTransactionBuilder} this.
    */
-  stepLimit(stepLimit: Hash): IcxTransactionBuilder {
+  stepLimit(stepLimit: Hash) {
     this.private(this).stepLimit = stepLimit;
 
     return this;
@@ -119,7 +119,7 @@ export class IcxTransactionBuilder {
    * @param {string|BigNumber|number} nid - The nid (network ID)
    * @return {IcxTransactionBuilder} this.
    */
-  nid(nid: Hash): IcxTransactionBuilder {
+  nid(nid: Hash) {
     this.private(this).nid = nid;
 
     return this;
@@ -130,7 +130,7 @@ export class IcxTransactionBuilder {
    * @param {string|BigNumber|number} nonce - The nonce.
    * @return {IcxTransactionBuilder} this.
    */
-  nonce(nonce: Hash): IcxTransactionBuilder {
+  nonce(nonce: Hash) {
     this.private(this).nonce = nonce;
 
     return this;
@@ -141,7 +141,7 @@ export class IcxTransactionBuilder {
    * @param {string|BigNumber|number} version - The network version.
    * @return {IcxTransactionBuilder} this.
    */
-  version(version: Hash): IcxTransactionBuilder {
+  version(version: Hash) {
     this.private(this).version = version;
 
     return this;
@@ -152,13 +152,13 @@ export class IcxTransactionBuilder {
    * @param {string|BigNumber|number} timestamp - The timestamp.
    * @return {IcxTransactionBuilder} this.
    */
-  timestamp(timestamp: Hash): IcxTransactionBuilder {
+  timestamp(timestamp: Hash) {
     this.private(this).timestamp = timestamp;
 
     return this;
   }
 
-  build(): IcxTransaction {
+  build() {
     return new IcxTransaction(
       this.private(this).to,
       this.private(this).from,

lib/builder/transaction/MessageTransaction.ts

@@ -76,7 +76,7 @@ export default class MessageTransactionBuilder extends IcxTransactionBuilder {
    * @param {string} data - The data to send.
    * @return {MessageTransactionBuilder} this.
    */
-  data(data: string): MessageTransactionBuilder {
+  data(data: string) {
     this.private(this).data = data;
 
     return this;
@@ -86,7 +86,7 @@ export default class MessageTransactionBuilder extends IcxTransactionBuilder {
    * Build 'MessageTransaction' object
    * @return {MessageTransaction} 'MessageTransaction' instance
    */
-  build(): MessageTransaction {
+  build() {
     return new MessageTransaction(
       this.private(this).to,
       this.private(this).from,

lib/data/Converter.ts

@@ -20,11 +20,6 @@ import { add0xPrefix } from "./Hexadecimal";
 import { isString, isBigNumber, isHex, isInteger } from "./Type";
 import { DataError } from "../Exception";
 import { Hash } from "../types/hash";
-import { IcxTransaction } from "../builder/transaction/IcxTransaction";
-import { MessageTransaction } from "../builder/transaction/MessageTransaction";
-import { CallTransaction } from "../builder/transaction/CallTransaction";
-import { DeployTransaction } from "../builder/transaction/DeployTransaction";
-import { DepositTransaction } from "../builder/transaction/DepositTransaction";
 
 /**
  * Convert UTF-8 text to hex string.
@@ -168,14 +163,7 @@ export function toHex(value: Hash): string {
  * @param {object} transaction - the transaction object.
  * @return {object} the raw transaction object.
  */
-export function toRawTransaction(
-  transaction:
-    | IcxTransaction
-    | MessageTransaction
-    | CallTransaction
-    | DeployTransaction
-    | DepositTransaction
-) {
+export function toRawTransaction(transaction) {
   const {
     to,
     from,

lib/data/Type.ts

@@ -15,7 +15,6 @@
  */
 
 import BigNumber from "bignumber.js";
-import { Hash } from "../types/hash";
 
 export function isString(value) {
   return typeof value === "string" || value instanceof String;
@@ -25,21 +24,15 @@ export function isByte(value) {
   return Boolean(value) && value.byteLength !== undefined;
 }
 
-export function isObject(obj) {
-  return typeof obj === "object";
-}
-
 export function isArray(obj) {
   return Array.isArray(obj);
 }
 
-export function isBigNumber(
-  value: string | number | BigNumber
-): value is BigNumber {
+export function isBigNumber(value): value is BigNumber {
   return BigNumber.isBigNumber(value);
 }
 
-export function isHex(value: Hash): boolean {
+export function isHex(value: string): boolean {
   return /^(0x)[0-9a-f]+$/g.test(<string>value);
 }
 

lib/data/Util.ts

@@ -18,7 +18,7 @@
 /* eslint-disable no-global-assign */
 
 import { sha3_256 as sha3256 } from "js-sha3";
-import { isObject, isArray, isString } from "./Type";
+import { isArray, isString } from "./Type";
 
 const secp256k1 = require("secp256k1");
 
@@ -42,7 +42,7 @@ export function isGenesisBlock(height: number): boolean {
 }
 
 export function hasProperties(obj, propertySet): boolean {
-  if (!isObject(obj)) {
+  if (typeof obj !== "object") {
     return false;
   }
 
@@ -64,15 +64,13 @@ export function hasProperties(obj, propertySet): boolean {
 
 export function createPrivate() {
   const weakMap = new WeakMap();
-  const internal = (key) => {
+  return (key) => {
     if (!weakMap.has(key)) {
       weakMap.set(key, {});
     }
 
     return weakMap.get(key);
   };
-
-  return internal;
 }
 
 export function makeTxHash(rawTrasaction) {
@@ -83,18 +81,13 @@ export function makeTxHash(rawTrasaction) {
 
 export function serialize(trasaction) {
   const phraseToSign = generateHashKey(trasaction);
-  const hashcode = sha3256.update(phraseToSign).hex();
-
-  return hashcode;
+  return sha3256.update(phraseToSign).hex();
 }
 
 export function generateHashKey(obj) {
-  let resultStrReplaced = "";
   const resultStr = objTraverse(obj);
-  resultStrReplaced = resultStr.substring(1).slice(0, -1);
-  const result = `icx_sendTransaction.${resultStrReplaced}`;
-
-  return result;
+  let resultStrReplaced: string = resultStr.substring(1).slice(0, -1);
+  return `icx_sendTransaction.${resultStrReplaced}`;
 }
 
 export function arrTraverse(arr) {
@@ -198,7 +191,5 @@ export function sign(data, privKey) {
   const signing = (secp256k1 as any).sign(Buffer.from(data, "hex"), privKey);
   const recovery = new Uint8Array(1);
   recovery[0] = signing.recovery;
-  const signature = concatTypedArrays(signing.signature, recovery);
-
-  return signature;
+  return concatTypedArrays(signing.signature, recovery);
 }

lib/data/Validator.ts

@@ -64,11 +64,7 @@ export function isScoreAddress(address) {
  * @return {boolean} returns true if the input value is a EOA or SCORE address.
  */
 export function isAddress(address) {
-  if (isEoaAddress(address) || isScoreAddress(address)) {
-    return true;
-  }
-
-  return false;
+  return isEoaAddress(address) || isScoreAddress(address);
 }
 
 /**
@@ -94,7 +90,7 @@ export function hasBlank(value) {
  * @param {any} value - the input value.
  * @return {boolean} returns true if the input value is a block number.
  */
-export function isNonNegative(value: string | BigNumber): boolean {
+export function isNonNegative(value: string | BigNumber | number): boolean {
   try {
     if (hasUppercase(value.toString()) || hasBlank(value)) {
       return false;