CSUB-578: Properly parse floating point amounts

creditcoin-js/src/index.ts

@@ -2,7 +2,8 @@ export * from './creditcoin-api';
 export * from './types';
 export * from './model';
 
-export { providers, Wallet } from 'ethers';
+export { providers, Wallet, FixedNumber, BigNumber } from 'ethers';
+export { parseUnits } from 'ethers/lib/utils';
 export { Guid } from 'js-guid';
 
 export { ApiPromise, WsProvider, Keyring } from '@polkadot/api';

scripts/cc-cli/src/commands/bond.ts

@@ -5,9 +5,16 @@ import {
   getStashSeedFromEnvOrPrompt,
   initKeyringPair,
 } from "../utils/account";
-import { Balance, getBalance, toMicrounits } from "../utils/balance";
 import { bond, parseRewardDestination } from "../utils/bond";
 import { promptContinue } from "../utils/promptContinue";
+import {
+  Balance,
+  getBalance,
+  parseCTCString,
+  toCTCString,
+  checkAmount,
+} from "../utils/balance";
+import { BN } from "creditcoin-js";
 
 export function makeBondCommand() {
   const cmd = new Command("bond");
@@ -29,23 +36,16 @@ export function makeBondCommand() {
 async function bondAction(options: OptionValues) {
   const { api } = await newApi(options.url);
 
-  // If no controller error and exit
-  checkAddress(options.controller, api);
-
-  // If no amount error and exit
-  if (!options.amount || !parseInt(options.amount, 10)) {
-    console.log("Must specify amount to bond");
-    process.exit(1);
-  }
-
   const stashSeed = await getStashSeedFromEnvOrPrompt();
-
-  // Check balance
   const stashKeyring = initKeyringPair(stashSeed);
   const stashAddress = stashKeyring.address;
-  const balance = await getBalance(stashAddress, api);
-  const amount = parseInt(options.amount, 10);
-  checkBalanceAgainstBondAmount(balance, amount);
+
+  const amount = parseCTCString(options.amount);
+
+  // Check inputs
+  checkAddress(options.controller, api);
+  checkAmount(amount);
+  await checkBalance(amount, api, stashAddress);
 
   const rewardDestination = options.rewardDestination
     ? parseRewardDestination(options.rewardDestination)
@@ -54,7 +54,7 @@ async function bondAction(options: OptionValues) {
   console.log("Creating bond transaction...");
   console.log("Controller address:", options.controller);
   console.log("Reward destination:", rewardDestination);
-  console.log("Amount:", parseInt(options.amount, 10));
+  console.log("Amount:", toCTCString(amount));
 
   await promptContinue();
 
@@ -73,10 +73,19 @@ async function bondAction(options: OptionValues) {
   process.exit(0);
 }
 
-function checkBalanceAgainstBondAmount(balance: Balance, amount: number) {
-  if (balance.free.sub(balance.miscFrozen).lt(toMicrounits(amount))) {
-    throw new Error(
-      `Insufficient funds to bond ${toMicrounits(amount).toString()}`
+async function checkBalance(amount: BN, api: any, address: string) {
+  const balance = await getBalance(address, api);
+  checkBalanceAgainstBondAmount(balance, amount);
+}
+
+function checkBalanceAgainstBondAmount(balance: Balance, amount: BN) {
+  const available = balance.free.sub(balance.miscFrozen);
+  if (available.lt(amount)) {
+    console.error(
+      `Insufficient funds to bond ${toCTCString(amount)}, only ${toCTCString(
+        available
+      )} available`
     );
+    process.exit(1);
   }
 }

scripts/cc-cli/src/commands/send.ts

@@ -7,7 +7,7 @@ import {
   initECDSAKeyringPairFromPK,
   initKeyringPair,
 } from "../utils/account";
-import { toMicrounits } from "../utils/balance";
+import { parseCTCString } from "../utils/balance";
 
 export function makeSendCommand() {
   const cmd = new Command("send");
@@ -36,7 +36,6 @@ async function sendAction(options: OptionValues) {
     const hash = await sendFromSr25519(options, api);
     console.log("Transfer transaction hash: " + hash.toHex());
   }
-
   process.exit(0);
 }
 
@@ -55,7 +54,7 @@ async function sendFromSr25519(options: OptionValues, api: ApiPromise) {
   // Send transaction
   const tx = api.tx.balances.transfer(
     options.to,
-    toMicrounits(options.amount).toString()
+    parseCTCString(options.amount).toString()
   );
   const hash = await tx.signAndSend(caller);
   return hash;
@@ -65,12 +64,11 @@ async function sendFromECDSA(options: OptionValues, api: ApiPromise) {
   // Build account
   const callerSeed = await getCallerSeedFromEnvOrPrompt();
   const caller = initECDSAKeyringPairFromPK(callerSeed);
-  console.log(caller.address);
 
   // Send transaction
   const tx = api.tx.balances.transfer(
     options.to,
-    toMicrounits(options.amount).toString()
+    parseCTCString(options.amount).toString()
   );
   const hash = await tx.signAndSend(caller);
   return hash;

scripts/cc-cli/src/commands/unbond.ts

@@ -4,7 +4,7 @@ import {
   getControllerSeedFromEnvOrPrompt,
   initKeyringPair,
 } from "../utils/account";
-import { toMicrounits } from "../utils/balance";
+import { parseCTCString } from "../utils/balance";
 import { getStatus, requireStatus } from "../utils/status";
 
 export function makeUnbondCommand() {
@@ -35,7 +35,7 @@ async function unbondAction(options: OptionValues) {
   requireStatus(stashStatus, "bonded");
 
   // Unbond transaction
-  const tx = api.tx.staking.unbond(toMicrounits(options.amount).toString());
+  const tx = api.tx.staking.unbond(parseCTCString(options.amount).toString());
 
   const hash = await tx.signAndSend(controllerKeyring);
 

scripts/cc-cli/src/commands/wizard.ts

@@ -9,8 +9,10 @@ import {
 import {
   Balance,
   getBalance,
+  parseCTCString,
   printBalance,
-  toMicrounits,
+  toCTCString,
+  checkAmount,
 } from "../utils/balance";
 import { bond, parseRewardDestination } from "../utils/bond";
 import { perbillFromPercent, percentFromPerbill } from "../utils/perbill";
@@ -49,9 +51,10 @@ export function makeWizardCommand() {
     const controllerAddress = controllerKeyring.address;
 
     // Bond prefs
-    const amount: string = options.amount
-      ? parseInt(options.amount, 10).toString()
-      : "0";
+    const amount = parseCTCString(options.amount);
+
+    checkAmount(amount);
+
     const rewardDestination = options.rewardDestination
       ? parseRewardDestination(options.rewardDestination)
       : "Staked";
@@ -70,7 +73,7 @@ export function makeWizardCommand() {
     console.log("Using the following parameters:");
     console.log(`💰 Stash account: ${stashAddress}`);
     console.log(`🕹️  Controller account: ${controllerAddress}`);
-    console.log(`🪙  Amount to bond: ${amount} CTC`);
+    console.log(`🪙  Amount to bond: ${toCTCString(amount)}`);
     console.log(`🎁 Reward destination: ${rewardDestination}`);
     console.log(`📡 Node URL: ${nodeUrl}`);
     console.log(`💸 Commission: ${percentFromPerbill(commission).toString()}`);
@@ -82,22 +85,22 @@ export function makeWizardCommand() {
     // Check both accounts have funds
     const stashBalance = await getBalance(stashAddress, api);
     const controllerBalance = await getBalance(controllerAddress, api);
-    checkStashBalance(stashAddress, stashBalance, options.amount);
-    checkControllerBalance(controllerAddress, controllerBalance, 1);
-    const bondExtra: boolean = checkIfAlreadyBonded(stashAddress, stashBalance);
+    checkStashBalance(stashAddress, stashBalance, amount);
+    checkControllerBalance(controllerAddress, controllerBalance, new BN(2));
+    const bondExtra: boolean = checkIfAlreadyBonded(stashBalance);
 
     if (bondExtra) {
       console.log(
         "⚠️  Warning: Stash account already bonded. This will increase the amount bonded."
       );
       if (await promptContinueOrSkip(`Continue or skip bonding extra funds?`)) {
-        checkStashBalance(stashAddress, stashBalance, options.amount);
+        checkStashBalance(stashAddress, stashBalance, amount);
         // Bond extra
         console.log("Sending bond transaction...");
         const bondTxHash = await bond(
           stashSeed,
           controllerAddress,
-          parseInt(options.amount, 10),
+          amount,
           rewardDestination,
           api,
           bondExtra
@@ -110,7 +113,7 @@ export function makeWizardCommand() {
       const bondTxHash = await bond(
         stashSeed,
         controllerAddress,
-        parseInt(options.amount, 10),
+        amount,
         rewardDestination,
         api
       );
@@ -151,12 +154,8 @@ export function makeWizardCommand() {
   return cmd;
 }
 
-function checkControllerBalance(
-  address: string,
-  balance: Balance,
-  amount: number
-) {
-  if (balance.free < new BN(amount)) {
+function checkControllerBalance(address: string, balance: Balance, amount: BN) {
+  if (balance.free.lt(amount)) {
     console.log(
       "Controller account does not have enough funds to pay transaction fees"
     );
@@ -168,8 +167,8 @@ function checkControllerBalance(
   }
 }
 
-function checkStashBalance(address: string, balance: Balance, amount: number) {
-  if (balance.free.sub(balance.miscFrozen).lt(toMicrounits(amount))) {
+function checkStashBalance(address: string, balance: Balance, amount: BN) {
+  if (balance.free.sub(balance.miscFrozen).lt(amount)) {
     console.log(
       `Stash account does not have enough funds to bond ${amount.toString()} CTC`
     );
@@ -179,7 +178,7 @@ function checkStashBalance(address: string, balance: Balance, amount: number) {
   }
 }
 
-function checkIfAlreadyBonded(address: string, balance: Balance) {
+function checkIfAlreadyBonded(balance: Balance) {
   if (balance.miscFrozen.gt(new BN(0))) {
     return true;
   } else {

scripts/cc-cli/src/utils/balance.ts

@@ -1,17 +1,22 @@
-import { BN } from "creditcoin-js";
+import { BN, parseUnits } from "creditcoin-js";
 
-const MICROUNITS_PER_CTC = new BN("1000000000000000000");
+export const MICROUNITS_PER_CTC = new BN("1000000000000000000");
 
 export function parseCTCString(amount: string): BN {
-  return new BN(amount).mul(MICROUNITS_PER_CTC);
-}
-
-export function toMicrounits(amount: number | BN): BN {
-  return new BN(amount).mul(MICROUNITS_PER_CTC);
+  try {
+    const parsed = parseUnits(amount, 18);
+    return new BN(parsed.toString());
+  } catch (e) {
+    console.error(`Unable to parse CTC amount: ${amount}`);
+    process.exit(1);
+  }
 }
 
 export function toCTCString(amount: BN): string {
-  return amount.div(MICROUNITS_PER_CTC).toString() + " CTC";
+  const CTC = amount.div(MICROUNITS_PER_CTC);
+  const remainder = amount.mod(MICROUNITS_PER_CTC);
+  const remainderString = remainder.toString().padStart(18, "0");
+  return `${CTC.toString()}.${remainderString} CTC`;
 }
 
 export function readAmount(amount: string): BN {
@@ -50,3 +55,15 @@ export function printBalance(balance: Balance) {
   console.log("Misc Frozen:", toCTCString(balance.miscFrozen));
   console.log("Fee Frozen:", toCTCString(balance.feeFrozen));
 }
+
+export function checkAmount(amount: BN) {
+  if (!amount) {
+    console.log("Must specify amount to bond");
+    process.exit(1);
+  } else {
+    if (amount.lt(new BN(1).mul(MICROUNITS_PER_CTC))) {
+      console.log("Bond amount must be at least 1 CTC");
+      process.exit(1);
+    }
+  }
+}

scripts/cc-cli/src/utils/bond.ts

@@ -1,18 +1,20 @@
-import { ApiPromise } from "creditcoin-js";
+import { ApiPromise, BN } from "creditcoin-js";
 import { initKeyringPair } from "./account";
+import { MICROUNITS_PER_CTC } from "./balance";
 
 export async function bond(
   stashSeed: string,
   controllerAddress: string,
-  amount: number,
+  amount: BN,
   rewardDestination: "Staked" | "Stash" | "Controller",
   api: ApiPromise,
   extra = false
 ) {
-  if (amount < 1) {
+  if (amount.lt(new BN(1).mul(MICROUNITS_PER_CTC))) {
     throw new Error("Amount to bond must be at least 1");
   }
-  const amountInMicroUnits = BigInt(amount) * BigInt(1000000000000000000); // Multiply by to convert to micro units
+
+  const amountInMicroUnits = amount;
 
   let bondTx;
 

scripts/cc-cli/src/utils/promptContinue.ts

@@ -5,9 +5,13 @@ export async function promptContinue() {
     type: "confirm",
     name: "confirm",
     message: "Continue?",
-    initial: true,
+    initial: false,
   });
 
+  if (!promptResult.confirm) {
+    process.exit(0);
+  }
+
   return promptResult.confirm;
 }
 

scripts/cc-cli/yarn.lock

@@ -2020,7 +2020,11 @@ create-require@^1.1.0:
 
 "creditcoin-js@file:../../creditcoin-js/creditcoin-js-v0.9.5.tgz":
   version "0.9.5"
+<<<<<<< HEAD
   resolved "file:../../creditcoin-js/creditcoin-js-v0.9.5.tgz#9b51fa1b480b211209174db858b6261878364f9a"
+=======
+  resolved "file:../../creditcoin-js/creditcoin-js-v0.9.5.tgz#699b5c8cf04475e6455b689a6794e2b73947dced"
+>>>>>>> e179b919 (Replace CTC string parsing with FixedNumber implementation; Export)
   dependencies:
     "@polkadot/api" "9.14.2"
     ethers "^5.7.1"