Merge branch '103-decimals-drop-bitcoin' into 'dev'

Resolve "Decimal Drop: Bitcoin Refactor" Closes #103 See merge request ergo/rosen-bridge/rosen-chains!118
rosen-bridge · Jul 23, 2024 · b2df4ec · b2df4ec
2 parents a16a126 + 0d23b07
commit b2df4ec
Show file tree

Hide file tree

Showing 23 changed files with 581 additions and 130 deletions.
diff --git a/.changeset/curvy-rings-move.md b/.changeset/curvy-rings-move.md
@@ -0,0 +1,5 @@
+---
+'@rosen-chains/bitcoin': patch
+---
+
+export bitcoin native token id var
diff --git a/.changeset/selfish-waves-argue.md b/.changeset/selfish-waves-argue.md
@@ -0,0 +1,5 @@
+---
+'@rosen-chains/bitcoin': major
+---
+
+consider decimals drop
diff --git a/.changeset/six-jobs-exercise.md b/.changeset/six-jobs-exercise.md
@@ -0,0 +1,8 @@
+---
+'@rosen-chains/abstract-chain': major
+'@rosen-chains/bitcoin': major
+'@rosen-chains/cardano': major
+'@rosen-chains/ergo': major
+---
+
+changed `getBoxInfo` and `getCoveringBoxes` functions to protected
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/abstract-chain/lib/AbstractUtxoChain.ts b/packages/abstract-chain/lib/AbstractUtxoChain.ts
@@ -22,20 +22,22 @@ abstract class AbstractUtxoChain<
 
   /**
    * extracts box id and assets of a box
+   * Note: it returns the actual value
    * @param box the box
    * @returns an object containing the box id and assets
    */
   protected abstract getBoxInfo: (box: BoxType) => BoxInfo;
 
   /**
    * gets useful, allowable and last boxes for an address until required assets are satisfied
+   * Note: it returns the actual value
    * @param address the address
    * @param requiredAssets the required assets
    * @param forbiddenBoxIds the id of forbidden boxes
    * @param trackMap the mapping of a box id to it's next box
    * @returns an object containing the selected boxes with a boolean showing if requirements covered or not
    */
-  getCoveringBoxes = async (
+  protected getCoveringBoxes = async (
     address: string,
     requiredAssets: AssetBalance,
     forbiddenBoxIds: Array<string>,

diff --git a/packages/abstract-chain/lib/ChainUtils.ts b/packages/abstract-chain/lib/ChainUtils.ts
@@ -1,5 +1,6 @@
 import { AssetBalance, TokenInfo } from './types';
 import { ValueError } from './errors';
+import { TokenMap } from '@rosen-bridge/tokens';
 
 class ChainUtils {
   /**
@@ -102,6 +103,62 @@ class ChainUtils {
       tokens,
     };
   };
+
+  /**
+   * wraps amount of the native token and all tokens in AssetBalance
+   * @param a the AssetBalance object
+   * @param tokenMap
+   * @param nativeTokenId
+   * @param chain
+   */
+  static wrapAssetBalance = (
+    a: AssetBalance,
+    tokenMap: TokenMap,
+    nativeTokenId: string,
+    chain: string
+  ): AssetBalance => {
+    const result = structuredClone(a);
+    result.nativeToken = tokenMap.wrapAmount(
+      nativeTokenId,
+      result.nativeToken,
+      chain
+    ).amount;
+    result.tokens.forEach(
+      (token) =>
+        (token.value = tokenMap.wrapAmount(token.id, token.value, chain).amount)
+    );
+    return result;
+  };
+
+  /**
+   * unwraps amount of the native token and all tokens in AssetBalance
+   * @param a the AssetBalance object
+   * @param tokenMap
+   * @param nativeTokenId
+   * @param chain
+   */
+  static unwrapAssetBalance = (
+    a: AssetBalance,
+    tokenMap: TokenMap,
+    nativeTokenId: string,
+    chain: string
+  ): AssetBalance => {
+    const result = structuredClone(a);
+    result.nativeToken = tokenMap.unwrapAmount(
+      nativeTokenId,
+      result.nativeToken,
+      chain
+    ).amount;
+    result.tokens.forEach(
+      (token) =>
+        (token.value = tokenMap.unwrapAmount(
+          token.id,
+          token.value,
+          chain
+        ).amount)
+    );
+    return result;
+  };
 }
 
 export default ChainUtils;
diff --git a/packages/abstract-chain/package.json b/packages/abstract-chain/package.json
@@ -23,8 +23,8 @@
     "@rosen-bridge/abstract-logger": "^1.0.0",
     "@rosen-bridge/json-bigint": "^0.1.0",
     "@rosen-bridge/minimum-fee": "^2.1.0",
-    "@rosen-bridge/rosen-extractor": "^6.0.0",
-    "@rosen-bridge/tokens": "^1.2.0",
+    "@rosen-bridge/rosen-extractor": "^6.0.1",
+    "@rosen-bridge/tokens": "^1.2.1",
     "blakejs": "^1.2.1"
   },
   "devDependencies": {

diff --git a/packages/abstract-chain/tests/AbstractUtxoChain.spec.ts b/packages/abstract-chain/tests/AbstractUtxoChain.spec.ts
@@ -58,7 +58,7 @@ describe('AbstractUtxoChain', () => {
       };
 
       // Run test
-      const result = await chain.getCoveringBoxes(
+      const result = await chain.callGetCoveringBoxes(
         '',
         requiredAssets,
         [],
@@ -119,7 +119,7 @@ describe('AbstractUtxoChain', () => {
       };
 
       // Run test
-      const result = await chain.getCoveringBoxes(
+      const result = await chain.callGetCoveringBoxes(
         '',
         requiredAssets,
         [],
@@ -182,7 +182,7 @@ describe('AbstractUtxoChain', () => {
       };
 
       // Run test
-      const result = await chain.getCoveringBoxes(
+      const result = await chain.callGetCoveringBoxes(
         '',
         requiredAssets,
         [],
@@ -241,7 +241,7 @@ describe('AbstractUtxoChain', () => {
       };
 
       // Run test
-      const result = await chain.getCoveringBoxes(
+      const result = await chain.callGetCoveringBoxes(
         '',
         requiredAssets,
         [],
@@ -301,7 +301,7 @@ describe('AbstractUtxoChain', () => {
       };
 
       // Run test
-      const result = await chain.getCoveringBoxes(
+      const result = await chain.callGetCoveringBoxes(
         '',
         requiredAssets,
         [],
@@ -342,7 +342,7 @@ describe('AbstractUtxoChain', () => {
 
       // Run test
       const chain = generateUtxoChainObject(network);
-      const result = await chain.getCoveringBoxes(
+      const result = await chain.callGetCoveringBoxes(
         '',
         requiredAssets,
         [],
@@ -417,7 +417,7 @@ describe('AbstractUtxoChain', () => {
       };
 
       // Run test
-      const result = await chain.getCoveringBoxes(
+      const result = await chain.callGetCoveringBoxes(
         '',
         requiredAssets,
         [],
@@ -492,7 +492,7 @@ describe('AbstractUtxoChain', () => {
       };
 
       // Run test
-      const result = await chain.getCoveringBoxes(
+      const result = await chain.callGetCoveringBoxes(
         '',
         requiredAssets,
         [],
@@ -560,7 +560,7 @@ describe('AbstractUtxoChain', () => {
       };
 
       // Run test
-      const result = await chain.getCoveringBoxes(
+      const result = await chain.callGetCoveringBoxes(
         '',
         requiredAssets,
         forbiddenIds,
@@ -617,7 +617,7 @@ describe('AbstractUtxoChain', () => {
       };
 
       // Run test
-      const result = await chain.getCoveringBoxes(
+      const result = await chain.callGetCoveringBoxes(
         '',
         requiredAssets,
         [],
@@ -693,7 +693,7 @@ describe('AbstractUtxoChain', () => {
       };
 
       // Run test
-      const result = await chain.getCoveringBoxes(
+      const result = await chain.callGetCoveringBoxes(
         '',
         requiredAssets,
         [],

diff --git a/packages/abstract-chain/tests/ChainUtils.spec.ts b/packages/abstract-chain/tests/ChainUtils.spec.ts
@@ -1,4 +1,11 @@
+import { TokenMap } from '@rosen-bridge/tokens';
 import { AssetBalance, ChainUtils, ValueError } from '../lib';
+import {
+  actualBalance,
+  testTokenMap,
+  unwrappedBalance,
+  wrappedBalance,
+} from './testData';
 
 describe('ChainUtils', () => {
   describe('isEqualAssetBalance', () => {
@@ -587,4 +594,60 @@ describe('ChainUtils', () => {
       });
     });
   });
+
+  describe('wrapAssetBalance', () => {
+    /**
+     * @target ChainUtils.wrapAssetBalance should wrap all values successfully
+     * @dependencies
+     * @scenario
+     * - generate tokenMap object with multi decimals
+     * - run test
+     * - check returned value
+     * @expected
+     * - it should return the expected wrapped values
+     */
+    it('should wrap all values successfully', () => {
+      // mock an AssetBalance
+      const tokenMap = new TokenMap(testTokenMap);
+
+      // run test
+      const result = ChainUtils.wrapAssetBalance(
+        actualBalance,
+        tokenMap,
+        'test-native-token',
+        'test'
+      );
+
+      // check returned value
+      expect(result).toEqual(wrappedBalance);
+    });
+  });
+
+  describe('unwrapAssetBalance', () => {
+    /**
+     * @target ChainUtils.unwrapAssetBalance should unwrap all values successfully
+     * @dependencies
+     * @scenario
+     * - generate tokenMap object with multi decimals
+     * - run test
+     * - check returned value
+     * @expected
+     * - it should return the expected unwrapped values
+     */
+    it('should unwrap all values successfully', () => {
+      // mock an AssetBalance
+      const tokenMap = new TokenMap(testTokenMap);
+
+      // run test
+      const result = ChainUtils.unwrapAssetBalance(
+        wrappedBalance,
+        tokenMap,
+        'test-native-token',
+        'test'
+      );
+
+      // check returned value
+      expect(result).toEqual(unwrappedBalance);
+    });
+  });
 });