fix comments and tests

polkadot-ui · Sep 13, 2024 · c348bf3 · c348bf3
1 parent 8246da3
commit c348bf3
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 8 deletions.
diff --git a/packages/utils/lib/unit.ts b/packages/utils/lib/unit.ts
@@ -19,16 +19,19 @@ export const remToUnit = (rem: string) =>
  * @description
  * Converts an on chain balance value in bigint planck to a decimal value in token unit
  */
-export const planckToUnit = (val: bigint, units: number): number => {
-  if (units < 0) {
+export const planckToUnit = (val?: bigint, units?: number): number => {
+  if (!val) {
+    throw new Error(`Value can not be undefined`)
+  }
+
+  if (!units || units < 0) {
     throw new Error(`Argument out of range: ${units}`)
   }
 
-  const str = val.toString().padStart(units + 1, '0')
-  //                               ^^^^^^^^^
+  const str = val.toString().padStart(units + 1, "0")
   const numb = str.slice(0, -units)
   const dec = str.slice(-units)
-  const result = Number(numb + '.' + dec)
+  const result = Number(numb + "." + dec)
   return !isNaN(result) ? result : 0
 }
 

diff --git a/packages/utils/tests/unit.test.ts b/packages/utils/tests/unit.test.ts
@@ -18,6 +18,22 @@ describe("Tests suite - planckToUnit Function", () => {
     expect(result).toEqual(expectedOutput)
   })
 
+  test("should correctly convert a BigInt to units", () => {
+    const inputValue = 100n
+    const units = 3
+    const expectedOutput = Number("0.1")
+    const result = fn.planckToUnit(inputValue, units)
+    expect(result).toEqual(expectedOutput)
+  })
+
+  test("should correctly convert a BigInt to units", () => {
+    const inputValue = 100n
+    const units = 9
+    const expectedOutput = Number("0.0000001")
+    const result = fn.planckToUnit(inputValue, units)
+    expect(result).toEqual(expectedOutput)
+  })
+
   test("should throw error when negative units", () => {
     const inputValue = 10000000n
     const units = -2
@@ -29,9 +45,9 @@ describe("Tests suite - planckToUnit Function", () => {
   test("should throw error when undefined value", () => {
     const inputValue = undefined
     const units = 2
-    const expectedOutput = Number("0")
-    const result = fn.planckToUnit(inputValue, units)
-    expect(result).toEqual(expectedOutput)
+    expect(() => fn.planckToUnit(inputValue, units)).toThrowError(
+      "Value can not be undefined"
+    )
   })
 })