Rename function & add comments

Author: SeiyaKobayashi

packages/core/src/jpyc.ts

@@ -4,7 +4,7 @@ import { getContract, GetContractReturnType, Hash, WalletClient } from 'viem';
 import { IJPYC, JPYC_V2_ABI } from './interfaces';
 import {
   Address,
-  addDecimals,
+  restoreDecimals,
   Bytes32,
   InvalidAddressError,
   InvalidTransactionError,
@@ -45,25 +45,25 @@ export class JPYC implements IJPYC {
   async minterAllowance(params: { minter: Address }): Promise<number> {
     const resp = await this.contract.read.minterAllowance([params.minter]);
 
-    return addDecimals(Uint256.from(resp as string));
+    return restoreDecimals(Uint256.from(resp as string));
   }
 
   async totalSupply(): Promise<number> {
     const resp = await this.contract.read.totalSupply();
 
-    return addDecimals(Uint256.from(resp as string));
+    return restoreDecimals(Uint256.from(resp as string));
   }
 
   async balanceOf(params: { account: Address }): Promise<number> {
     const resp = await this.contract.read.balanceOf([params.account]);
 
-    return addDecimals(Uint256.from(resp as string));
+    return restoreDecimals(Uint256.from(resp as string));
   }
 
   async allowance(params: { owner: Address; spender: Address }): Promise<number> {
     const resp = await this.contract.read.allowance([params.owner, params.spender]);
 
-    return addDecimals(Uint256.from(resp as string));
+    return restoreDecimals(Uint256.from(resp as string));
   }
 
   async nonces(params: { owner: Address }): Promise<Uint256> {

packages/core/src/utils/math.test.ts

@@ -1,6 +1,6 @@
 import { Uint256 } from 'soltypes';
 
-import { toUint256, removeDecimals, addDecimals } from './math';
+import { toUint256, removeDecimals, restoreDecimals } from './math';
 
 describe('Unit tests of toUint256()', () => {
   test('converts bigint to uint256 value', () => {
@@ -24,9 +24,9 @@ describe('Unit tests of removeDecimals()', () => {
   });
 });
 
-describe('Unit tests of addDecimals()', () => {
-  test('adds decimal places to bigint', () => {
-    const res = addDecimals(Uint256.from('100'));
+describe('Unit tests of restoreDecimals()', () => {
+  test('restores decimal places to bigint', () => {
+    const res = restoreDecimals(Uint256.from('100'));
     expect(typeof res).toBe('number');
     expect(res).toStrictEqual(0.0000000000000001);
   });

packages/core/src/utils/math.ts

@@ -3,14 +3,35 @@ import { Uint256 } from 'soltypes';
 const TOKEN_DECIMALS = 18;
 const DECIMALS_QUANTIFIER = 10 ** TOKEN_DECIMALS;
 
+/**
+ * Converts bigint to uint256
+ * @param value bigint value
+ * @returns value as uint256
+ */
 export const toUint256 = (value: bigint): Uint256 => {
   return Uint256.from(value.toString());
 };
 
+/**
+ * Removes decimal places to make sure that only integer values live on-chain.
+ * e.g.)
+ *        0.01 -> 10,000,000,000,000,000
+ *        100  -> 100,000,000,000,000,000,000
+ * @param value integer or decimal value
+ * @returns value as uint256
+ */
 export const removeDecimals = (value: number): Uint256 => {
   return toUint256(BigInt(value * DECIMALS_QUANTIFIER));
 };
 
-export const addDecimals = (value: Uint256): number => {
+/**
+ * Restores decimal places (mainly for display purpose).
+ * e.g.)
+ *        10,000,000,000,000,000 -> 0.01
+ *        100,000,000,000,000,000,000 -> 100
+ * @param value uint256 value
+ * @returns value as number (i.e., integer or decimal)
+ */
+export const restoreDecimals = (value: Uint256): number => {
   return Number(value.toString()) / DECIMALS_QUANTIFIER;
 };