Merge pull request #47 from iamnotstatic/impr/payload

refactor: standardize wallet helper functions to use structured paylo…

Author: iamnotstatic

package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.2.9",
+  "version": "0.2.10",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

src/common/helpers/bitcoinHelper.ts

@@ -10,13 +10,25 @@ import * as utxolib from '@bitgo/utxo-lib';
 
 import { _apiFallbacks } from '../fallbacks/btc';
 import { fallback, retryNTimes } from '../utils/retry';
-import { GetTransactionPayload, TransferPayload } from '../utils/types';
+import {
+  BalancePayload,
+  CreateWalletPayload,
+  GenerateWalletFromMnemonicPayload,
+  GetAddressFromPrivateKeyPayload,
+  GetTransactionPayload,
+  IResponse,
+  Network,
+  TransferPayload,
+} from '../utils/types';
 import { BitgoUTXOLib } from '../libs/bitgoUtxoLib';
 
 const bip32 = BIP32Factory(ecc);
 const ECPair = ECPairFactory(ecc);
 
-const createWallet = (network: string, derivationPath?: string) => {
+const createWallet = ({
+  network,
+  derivationPath,
+}: CreateWalletPayload): IResponse => {
   if (derivationPath) {
     const purpose = derivationPath?.split('/')[1];
     if (purpose !== "44'") {
@@ -30,12 +42,7 @@ const createWallet = (network: string, derivationPath?: string) => {
 
   const node = bip32.fromSeed(seed);
   const child = node.derivePath(path);
-  const actualNetwork =
-    network === 'bitcoin'
-      ? bitcoin.networks.bitcoin
-      : network === 'bitcoin-testnet'
-      ? bitcoin.networks.testnet
-      : bitcoin.networks.bitcoin;
+  const actualNetwork = getNetwork(network);
 
   const { address } = bitcoin.payments.p2pkh({
     pubkey: child.publicKey,
@@ -51,11 +58,11 @@ const createWallet = (network: string, derivationPath?: string) => {
   });
 };
 
-const generateWalletFromMnemonic = (
-  network: string,
-  mnemonic: string,
-  derivationPath?: string
-) => {
+const generateWalletFromMnemonic = ({
+  network,
+  mnemonic,
+  derivationPath,
+}: GenerateWalletFromMnemonicPayload): IResponse => {
   if (derivationPath) {
     const purpose = derivationPath?.split('/')[1];
     if (purpose !== "44'") {
@@ -68,12 +75,7 @@ const generateWalletFromMnemonic = (
 
   const node = bip32.fromSeed(seed);
   const child = node.derivePath(path);
-  const actualNetwork =
-    network === 'bitcoin'
-      ? bitcoin.networks.bitcoin
-      : network === 'bitcoin-testnet'
-      ? bitcoin.networks.testnet
-      : bitcoin.networks.bitcoin;
+  const actualNetwork = getNetwork(network);
 
   const { address } = bitcoin.payments.p2pkh({
     pubkey: child.publicKey,
@@ -89,13 +91,11 @@ const generateWalletFromMnemonic = (
   });
 };
 
-const getAddressFromPrivateKey = (privateKey: string, network: string) => {
-  const actualNetwork =
-    network === 'bitcoin'
-      ? bitcoin.networks.bitcoin
-      : network === 'bitcoin-testnet'
-      ? bitcoin.networks.testnet
-      : bitcoin.networks.bitcoin;
+const getAddressFromPrivateKey = ({
+  privateKey,
+  network,
+}: GetAddressFromPrivateKeyPayload): IResponse => {
+  const actualNetwork = getNetwork(network);
 
   const keyPair = ECPair.fromWIF(privateKey);
 
@@ -109,9 +109,11 @@ const getAddressFromPrivateKey = (privateKey: string, network: string) => {
   });
 };
 
-const getBalance = async (address: string, network: string) => {
-  const testnet =
-    network === 'bitcoin' ? false : network === 'bitcoin-testnet' ? true : true;
+const getBalance = async ({
+  address,
+  network,
+}: BalancePayload): Promise<IResponse> => {
+  const testnet = isTestnet(network);
 
   const endpoints = _apiFallbacks.fetchUTXOs(testnet, address, 0);
   const utxos = await fallback(endpoints);
@@ -125,13 +127,8 @@ const getBalance = async (address: string, network: string) => {
   });
 };
 
-const transfer = async (args: TransferPayload) => {
-  const testnet =
-    args.network === 'bitcoin'
-      ? false
-      : args.network === 'bitcoin-testnet'
-      ? true
-      : true;
+const transfer = async (args: TransferPayload): Promise<IResponse> => {
+  const testnet = isTestnet(args.network);
 
   const keyPair = ECPair.fromWIF(args.privateKey);
 
@@ -142,8 +139,10 @@ const transfer = async (args: TransferPayload) => {
       : utxolib.networks.testnet
   );
 
-  const fromAddress = getAddressFromPrivateKey(args.privateKey, args.network)
-    .address;
+  const fromAddress = getAddressFromPrivateKey({
+    privateKey: args.privateKey,
+    network: args.network,
+  }).address;
 
   const changeAddress = fromAddress;
   const endpoints = _apiFallbacks.fetchUTXOs(testnet, fromAddress, 0);
@@ -196,14 +195,15 @@ const transfer = async (args: TransferPayload) => {
   }
 };
 
-const getTransaction = async ({ hash, network }: GetTransactionPayload) => {
-  const testnet =
-    network === 'bitcoin' ? false : network === 'bitcoin-testnet' ? true : true;
+const getTransaction = async ({
+  hash,
+  network,
+}: GetTransactionPayload): Promise<IResponse> => {
+  const testnet = isTestnet(network);
 
   const transaction = await fallback(_apiFallbacks.fetchUTXO(testnet, hash, 0));
   const bigAmount = new BigNumber(transaction.amount);
 
-  // Convert amount from Satoshi to Bitcoin
   const amount = bigAmount.dividedBy(new BigNumber(10).exponentiatedBy(8));
 
   return successResponse({
@@ -212,6 +212,18 @@ const getTransaction = async ({ hash, network }: GetTransactionPayload) => {
   });
 };
 
+function getNetwork(network: Network) {
+  return network === 'bitcoin'
+    ? bitcoin.networks.bitcoin
+    : network === 'bitcoin-testnet'
+    ? bitcoin.networks.testnet
+    : bitcoin.networks.bitcoin;
+}
+
+function isTestnet(network: Network) {
+  return network === 'bitcoin-testnet';
+}
+
 export default {
   createWallet,
   generateWalletFromMnemonic,

src/common/helpers/ethereumHelper.ts

@@ -10,6 +10,10 @@ import {
   IGetTokenInfoPayload,
   ITokenInfo,
   ISmartContractCallPayload,
+  CreateWalletPayload,
+  GetAddressFromPrivateKeyPayload,
+  GenerateWalletFromMnemonicPayload,
+  IResponse,
 } from '../utils/types';
 import { successResponse } from '../utils';
 
@@ -64,7 +68,7 @@ const getContract = async ({
   };
 };
 
-const createWallet = (derivationPath?: string) => {
+const createWallet = ({ derivationPath }: CreateWalletPayload): IResponse => {
   const path = derivationPath || "m/44'/60'/0'/0/0";
   const wallet = ethers.Wallet.createRandom({
     path,
@@ -77,18 +81,20 @@ const createWallet = (derivationPath?: string) => {
   });
 };
 
-const getAddressFromPrivateKey = (privateKey: string) => {
+const getAddressFromPrivateKey = ({
+  privateKey,
+}: GetAddressFromPrivateKeyPayload): IResponse => {
   const wallet = new ethers.Wallet(privateKey);
 
   return successResponse({
     address: wallet.address,
   });
 };
 
-const generateWalletFromMnemonic = (
-  mnemonic: string,
-  derivationPath?: string
-) => {
+const generateWalletFromMnemonic = ({
+  mnemonic,
+  derivationPath,
+}: GenerateWalletFromMnemonicPayload): IResponse => {
   const path = derivationPath || "m/44'/60'/0'/0/0";
   const wallet = ethers.Wallet.fromMnemonic(mnemonic, path);
 
@@ -103,7 +109,7 @@ const getBalance = async ({
   rpcUrl,
   tokenAddress,
   address,
-}: BalancePayload) => {
+}: BalancePayload): Promise<IResponse> => {
   const { contract, providerInstance } = await getContract({
     rpcUrl,
     contractAddress: tokenAddress,
@@ -137,7 +143,7 @@ const transfer = async ({
   tokenAddress,
   rpcUrl,
   ...args
-}: TransferPayload) => {
+}: TransferPayload): Promise<IResponse> => {
   const { contract, providerInstance, gasPrice, nonce } = await getContract({
     rpcUrl,
     privateKey,
@@ -189,7 +195,7 @@ const transfer = async ({
   }
 };
 
-const getTransaction = async ({ hash, rpcUrl }: GetTransactionPayload) => {
+const getTransaction = async ({ hash, rpcUrl }: GetTransactionPayload): Promise<IResponse> => {
   const { providerInstance } = await getContract({ rpcUrl });
 
   try {
@@ -204,7 +210,7 @@ const getTransaction = async ({ hash, rpcUrl }: GetTransactionPayload) => {
 
 const getEncryptedJsonFromPrivateKey = async (
   args: GetEncryptedJsonFromPrivateKey
-) => {
+): Promise<IResponse> => {
   const wallet = new ethers.Wallet(args.privateKey);
   const json = await wallet.encrypt(args.password);
 
@@ -213,7 +219,7 @@ const getEncryptedJsonFromPrivateKey = async (
 
 const getWalletFromEncryptedJson = async (
   args: GetWalletFromEncryptedjsonPayload
-) => {
+): Promise<IResponse> => {
   const wallet = await ethers.Wallet.fromEncryptedJson(
     args.json,
     args.password
@@ -225,7 +231,7 @@ const getWalletFromEncryptedJson = async (
   });
 };
 
-const getTokenInfo = async ({ address, rpcUrl }: IGetTokenInfoPayload) => {
+const getTokenInfo = async ({ address, rpcUrl }: IGetTokenInfoPayload): Promise<IResponse> => {
   const { contract } = await getContract({ contractAddress: address, rpcUrl });
 
   if (contract) {
@@ -249,7 +255,7 @@ const getTokenInfo = async ({ address, rpcUrl }: IGetTokenInfoPayload) => {
   throw new Error('Contract not found');
 };
 
-const smartContractCall = async (args: ISmartContractCallPayload) => {
+const smartContractCall = async (args: ISmartContractCallPayload): Promise<IResponse> => {
   const { contract, gasPrice, nonce } = await getContract({
     rpcUrl: args.rpcUrl,
     contractAddress: args.contractAddress,