[NayNay] File Restructure: Base Class + Balance Restructure

CHANGELOG.md

@@ -27,10 +27,15 @@ Version header format: `[version] Name - year-month-day (entropy-core compatibil
 - new: 'src/flows/user-program-management/view.ts' - service file for pure functions of viewing user programs
 - new: 'src/flows/user-program-management/helpers/utils.ts' - utility helper file for user program management specific methods
 - new: './src/flows/user-program-management/remove.ts' - service file for removing user program pure function
+- new: './src/common/base.ts' - base abstract class for new command classes
+- new: './src/balance' - new file structure for our CLI/TUI flows
+  - new: './src/balance/command.ts' - main entry file for balance command for tui/cli
+  - new: './src/balance/utils.ts' - utilities and helper methods for all things balance
 
 ### Changed
 - folder name for user programs to match the kebab-case style for folder namespace
 - updated SDK version to v0.2.3
+- logger to handle nested contexts for better organization of logs
 
 ## [0.0.3] Blade - 2024-07-17 (entropy-core compatibility: 0.2.0)
 

src/balance/command.ts

@@ -0,0 +1,18 @@
+import Entropy from "@entropyxyz/sdk"
+import { BaseCommand } from "../common/base-command"
+import * as BalanceUtils from "./utils"
+import { FLOW_CONTEXT } from "./constants"
+
+export class BalanceCommand extends BaseCommand {
+  constructor (entropy: Entropy, endpoint: string) {
+    super(entropy, endpoint, FLOW_CONTEXT)
+  }
+
+  public async getBalance (address: string) {
+    const balance = await BalanceUtils.getBalance(this.entropy, address)
+
+    this.logger.log(`Current balance of ${address}: ${balance}`, `${BalanceCommand.name}`)
+
+    return `${balance.toLocaleString('en-US')} BITS`
+  }
+}

src/balance/constants.ts

@@ -0,0 +1 @@
+export const FLOW_CONTEXT = 'ENTROPY-BALANCE'

src/balance/utils.ts

@@ -0,0 +1,24 @@
+import Entropy from "@entropyxyz/sdk";
+import { BalanceInfo } from "./types";
+
+const hexToBigInt = (hexString: string) => BigInt(hexString)
+
+export async function getBalance (entropy: Entropy, address: string): Promise<number> {
+  const accountInfo = (await entropy.substrate.query.system.account(address)) as any
+  return parseInt(hexToBigInt(accountInfo.data.free).toString())
+}
+
+export async function getBalances (entropy: Entropy, addresses: string[]): Promise<BalanceInfo> {
+  const balanceInfo: BalanceInfo = {}
+  await Promise.all(addresses.map(async address => {
+    try {
+      const balance = await getBalance(entropy, address)
+
+      balanceInfo[address] = { balance }
+    } catch (error) {
+      balanceInfo[address] = { error: error.message }
+    }
+  }))
+
+  return balanceInfo
+}

src/common/base-command.ts

@@ -0,0 +1,12 @@
+import Entropy from "@entropyxyz/sdk";
+import { EntropyLogger } from "./logger";
+
+export abstract class BaseCommand {
+  protected logger: EntropyLogger
+  protected entropy: Entropy
+
+  constructor (entropy: Entropy, endpoint: string, flowContext: string) {
+    this.logger = new EntropyLogger(flowContext, endpoint)
+    this.entropy = entropy
+  }
+}

src/common/logger.ts

@@ -117,7 +117,7 @@ export class EntropyLogger {
     this.winstonLogger.log({
       level,
       message: maskPayload(message),
-      context: context || this.context,
+      context: context ? `${this.context}:${context}` : this.context,
       endpoint: this.endpoint,
       description,
       stack,

src/flows/balance/cli.ts

@@ -1,8 +1,10 @@
+import { BalanceCommand } from 'src/balance/command'
 import { initializeEntropy } from '../../common/initializeEntropy'
 import * as config from '../../config'
-import { getBalance } from './balance'
 import { EntropyLogger } from 'src/common/logger'
 
+// TO-DO: move entropy initialization and account retrieval to a shared container
+// should remove the need to initialize entropy every time
 export async function cliGetBalance ({ address, password, endpoint }) {
   const logger = new EntropyLogger('CLI::CHECK_BALANCE', endpoint)
   const storedConfig = await config.get()
@@ -17,8 +19,9 @@ export async function cliGetBalance ({ address, password, endpoint }) {
   }
 
   const entropy = await initializeEntropy({ keyMaterial: account.data, password, endpoint })
-  const balance = await getBalance(entropy, address)
+  const balanceCommand = new BalanceCommand(entropy, endpoint)
+  const balance = await balanceCommand.getBalance(address)
 
-  return `${balance.toLocaleString('en-US')} BITS`
+  return balance
 }
 

src/flows/balance/index.ts

@@ -1,10 +1,12 @@
 import { EntropyLogger } from "src/common/logger";
 import { initializeEntropy } from "../../common/initializeEntropy"
 import { print, getSelectedAccount } from "../../common/utils"
-import { getBalance } from "./balance";
+import { BalanceCommand } from "src/balance/command";
 
-// TO-DO setup flow method to provide options to allow users to select account,
+// TO-DO: setup flow method to provide options to allow users to select account,
 // use external address, or get balances for all accounts in config
+// TO-DO: move entropy initialization and account retrieval to a shared container
+// should remove the need to initialize entropy every time
 export async function checkBalance ({ accounts, selectedAccount: selectedAccountAddress }, options, logger: EntropyLogger) {
   const FLOW_CONTEXT = 'CHECK_BALANCE'
   const { endpoint } = options
@@ -13,7 +15,8 @@ export async function checkBalance ({ accounts, selectedAccount: selectedAccount
   const selectedAccount = getSelectedAccount(accounts, selectedAccountAddress)
   logger.log(selectedAccount, FLOW_CONTEXT)
   const entropy = await initializeEntropy({ keyMaterial: selectedAccount.data, endpoint });
+  const balanceCommand = new BalanceCommand(entropy, endpoint)
   const accountAddress = selectedAccountAddress
-  const freeBalance = await getBalance(entropy, accountAddress)
-  print(`Address ${accountAddress} has a balance of: ${freeBalance.toLocaleString('en-US')} BITS`)
+  const freeBalanceString = await balanceCommand.getBalance(accountAddress)
+  print(`Address ${accountAddress} has a balance of: ${freeBalanceString}`)
 }

tests/balance.test.ts

@@ -1,32 +1,31 @@
 import test from 'tape'
 
-import { getBalance, getBalances } from '../src/flows/balance/balance'
 import { setupTest, charlieStashAddress as richAddress } from './testing-utils'
+import * as BalanceUtils from 'src/balance/utils'
 
 const networkType = 'two-nodes'
 
 test('getBalance + getBalances', async (t) => {
-  const { run, entropy } = await setupTest(t, { networkType })
-
+  const { run, entropy, endpoint } = await setupTest(t, { networkType })
   const newAddress = entropy.keyring.accounts.registration.address
 
   /* getBalance */
   const newAddressBalance = await run(
     'getBalance (newSeed)',
-    getBalance(entropy, newAddress)
+    BalanceUtils.getBalance(entropy, newAddress)
   )
   t.equal(newAddressBalance, 0, 'newSeed balance = 0')
 
   const richAddressBalance = await run(
     'getBalance (richAddress)',
-    getBalance(entropy, richAddress)
+    BalanceUtils.getBalance(entropy, richAddress)
   )
   t.true(richAddressBalance > BigInt(10e10), 'richAddress balance >>> 0')
 
   /* getBalances */
   const balances = await run(
     'getBalances',
-    getBalances(entropy, [newAddress, richAddress])
+    BalanceUtils.getBalances(entropy, [newAddress, richAddress])
   )
   t.deepEqual(
     balances,
@@ -40,7 +39,7 @@ test('getBalance + getBalances', async (t) => {
   const badAddresses = ['5Cz6BfUaxxXCA3jninzxdan4JdmC1NVpgkiRPYhXbhr', '5Cz6BfUaxxXCA3jninzxdan4JdmC1NVpgkiRPYhXbhrfnD']
   const balancesWithNoGoodAddress = await run(
     'getBalances::one good address',
-    getBalances(entropy, badAddresses)
+    BalanceUtils.getBalances(entropy, badAddresses)
   )
 
   badAddresses.forEach(addr => {

tests/testing-utils/setup-test.ts

@@ -12,16 +12,18 @@ import { makeSeed, promiseRunner, sleep } from './'
 interface SetupTestOpts {
   configPath?: string
   networkType?: string
-  seed?: string,
+  seed?: string
+  endpoint?: string
 }
 const NETWORK_TYPE_DEFAULT = 'two-nodes'
 let counter = 0
 
-export async function setupTest (t: Test, opts?: SetupTestOpts): Promise<{ entropy: Entropy; run: any }> {
+export async function setupTest (t: Test, opts?: SetupTestOpts): Promise<{ entropy: Entropy; run: any; endpoint: string }> {
   const {
     configPath = `/tmp/entropy-cli-${Date.now()}_${counter++}.json`,
     networkType = NETWORK_TYPE_DEFAULT,
-    seed = makeSeed()
+    seed = makeSeed(),
+    endpoint = 'ws://127.0.0.1:9944',
   } = opts || {}
 
   const run = promiseRunner(t)
@@ -45,11 +47,11 @@ export async function setupTest (t: Test, opts?: SetupTestOpts): Promise<{ entro
   const keyring = new Keyring({ seed, debug: true })
   const entropy = await initializeEntropy({
     keyMaterial: keyring.getAccount(),
-    endpoint: 'ws://127.0.0.1:9944',
+    endpoint,
     configPath
   })
 
   await run('entropy ready', entropy.ready)
 
-  return { entropy, run }
+  return { entropy, run, endpoint }
 }

tests/transfer.test.ts

@@ -11,12 +11,13 @@ import {
   spinNetworkDown
 } from './testing-utils'
 
-import { getBalance } from '../src/flows/balance/balance'
 import { initializeEntropy } from 'src/common/initializeEntropy'
 import { charlieStashAddress, charlieStashSeed } from './testing-utils/constants'
 import { transfer } from 'src/flows/entropyTransfer/transfer'
+import * as BalanceUtils from 'src/balance/utils'
 
 const networkType = 'two-nodes'
+const endpoint = 'ws://127.0.0.1:9944'
 
 test('Transfer', async (t) => {
   /* Setup */
@@ -37,8 +38,8 @@ test('Transfer', async (t) => {
   const naynayKeyring = new Keyring({ seed: naynaySeed, debug: true })
   const charlieKeyring = new Keyring({ seed: charlieStashSeed, debug: true })
 
-  const entropy = await initializeEntropy({ keyMaterial: naynayKeyring.getAccount(), endpoint: 'ws://127.0.0.1:9944', })
-  const charlieEntropy = await initializeEntropy({ keyMaterial: charlieKeyring.getAccount(), endpoint: 'ws://127.0.0.1:9944', })
+  const entropy = await initializeEntropy({ keyMaterial: naynayKeyring.getAccount(), endpoint, })
+  const charlieEntropy = await initializeEntropy({ keyMaterial: charlieKeyring.getAccount(), endpoint, })
   await run('entropy ready', entropy.ready)
   await run('charlie ready', charlieEntropy.ready)
 
@@ -47,14 +48,14 @@ test('Transfer', async (t) => {
   // Check Balance of new account
   let naynayBalance = await run(
     'getBalance (naynay)',
-    getBalance(entropy, recipientAddress)
+    BalanceUtils.getBalance(entropy, recipientAddress)
   )
 
   t.equal(naynayBalance, 0, 'naynay is broke')
 
   let charlieBalance = await run(
     'getBalance (charlieStash)',
-    getBalance(entropy, charlieStashAddress)
+    BalanceUtils.getBalance(entropy, charlieStashAddress)
   )
 
   t.equal(charlieBalance, 1e17, 'charlie got bank')
@@ -73,7 +74,7 @@ test('Transfer', async (t) => {
   // Re-Check Balance of new account
   naynayBalance = await run(
     'getBalance (naynay)',
-    getBalance(entropy, recipientAddress)
+    BalanceUtils.getBalance(entropy, recipientAddress)
   )
 
   t.equal(naynayBalance, 1000 * 10e10, 'naynay is rolling in it!')