change two utxo functions to protected and their logic to the actual …

…values

.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

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>,

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,
         [],

packages/abstract-chain/tests/TestUtxoChain.ts

@@ -1,4 +1,4 @@
-import { AbstractUtxoChain, BoxInfo } from '../lib';
+import { AbstractUtxoChain, AssetBalance, BoxInfo } from '../lib';
 import TestRosenDataExtractor from './extractor/TestRosenDataExtractor';
 
 class TestUtxoChain extends AbstractUtxoChain<string, string> {
@@ -31,6 +31,13 @@ class TestUtxoChain extends AbstractUtxoChain<string, string> {
   };
 
   serializeTx = (tx: string) => tx;
+  callGetCoveringBoxes = async (
+    address: string,
+    requiredAssets: AssetBalance,
+    forbiddenBoxIds: Array<string>,
+    trackMap: Map<string, string | undefined>
+  ) =>
+    this.getCoveringBoxes(address, requiredAssets, forbiddenBoxIds, trackMap);
 }
 
 export default TestUtxoChain;

packages/chains/bitcoin/lib/BitcoinChain.ts

@@ -123,16 +123,22 @@ class BitcoinChain extends AbstractUtxoChain<BitcoinTx, BitcoinUtxo> {
     );
 
     // fetch input boxes
+    const unwrappedRequiredAssets = ChainUtils.unwrapAssetBalance(
+      requiredAssets,
+      this.tokenMap,
+      this.NATIVE_TOKEN_ID,
+      this.CHAIN
+    );
     const coveredBoxes = await this.getCoveringBoxes(
       this.configs.addresses.lock,
-      requiredAssets,
+      unwrappedRequiredAssets,
       forbiddenBoxIds,
       trackMap
     );
     if (!coveredBoxes.covered) {
-      const neededBtc = this.unwrapBtc(requiredAssets.nativeToken);
+      const neededBtc = unwrappedRequiredAssets.nativeToken;
       throw new NotEnoughValidBoxesError(
-        `Available boxes didn't cover required assets. BTC: ${neededBtc.amount.toString()}`
+        `Available boxes didn't cover required assets. BTC: ${neededBtc.toString()}`
       );
     }
 
@@ -144,14 +150,12 @@ class BitcoinChain extends AbstractUtxoChain<BitcoinTx, BitcoinUtxo> {
         index: box.index,
         witnessUtxo: {
           script: Buffer.from(this.lockScript, 'hex'),
-          value: Number(this.unwrapBtc(box.value).amount),
+          value: Number(box.value),
         },
       });
     });
     // calculate input boxes assets
-    let remainingBtc = this.unwrapBtc(
-      coveredBoxes.boxes.reduce((a, b) => a + b.value, 0n)
-    ).amount;
+    let remainingBtc = coveredBoxes.boxes.reduce((a, b) => a + b.value, 0n);
     this.logger.debug(`Input BTC: ${remainingBtc}`);
 
     // add outputs
@@ -537,14 +541,15 @@ class BitcoinChain extends AbstractUtxoChain<BitcoinTx, BitcoinUtxo> {
 
   /**
    * 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
    */
-  getBoxInfo = (box: BitcoinUtxo): BoxInfo => {
+  protected getBoxInfo = (box: BitcoinUtxo): BoxInfo => {
     return {
       id: this.getBoxId(box),
       assets: {
-        nativeToken: this.wrapBtc(box.value).amount,
+        nativeToken: box.value,
         tokens: [],
       },
     };
@@ -639,13 +644,14 @@ class BitcoinChain extends AbstractUtxoChain<BitcoinTx, BitcoinUtxo> {
 
   /**
    * 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 requiredAssets the required assets (actual values)
    * @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>,

packages/chains/bitcoin/tests/BitcoinChain.spec.ts

@@ -51,7 +51,7 @@ describe('BitcoinChain', () => {
 
       // mock getCoveringBoxes, hasLockAddressEnoughAssets
       const bitcoinChain = testUtils.generateChainObject(network);
-      const getCovBoxesSpy = vi.spyOn(bitcoinChain, 'getCoveringBoxes');
+      const getCovBoxesSpy = vi.spyOn(bitcoinChain as any, 'getCoveringBoxes');
       getCovBoxesSpy.mockResolvedValue({
         covered: true,
         boxes: testData.lockAddressUtxos,
@@ -143,7 +143,7 @@ describe('BitcoinChain', () => {
     it('should throw error when bank boxes can not cover order assets', async () => {
       // mock getCoveringBoxes, hasLockAddressEnoughAssets
       const bitcoinChain = testUtils.generateChainObject(network);
-      const getCovBoxesSpy = vi.spyOn(bitcoinChain, 'getCoveringBoxes');
+      const getCovBoxesSpy = vi.spyOn(bitcoinChain as any, 'getCoveringBoxes');
       getCovBoxesSpy.mockResolvedValue({
         covered: false,
         boxes: testData.lockAddressUtxos,
@@ -194,7 +194,7 @@ describe('BitcoinChain', () => {
       // mock getCoveringBoxes, hasLockAddressEnoughAssets
       const bitcoinChain =
         testUtils.generateChainObjectWithMultiDecimalTokenMap(network);
-      const getCovBoxesSpy = vi.spyOn(bitcoinChain, 'getCoveringBoxes');
+      const getCovBoxesSpy = vi.spyOn(bitcoinChain as any, 'getCoveringBoxes');
       getCovBoxesSpy.mockResolvedValue({
         covered: true,
         boxes: testData.lockAddressUtxos,
@@ -242,7 +242,12 @@ describe('BitcoinChain', () => {
       ).amount;
       expect(getCovBoxesSpy).toHaveBeenCalledWith(
         testUtils.configs.addresses.lock,
-        expectedRequiredAssets,
+        ChainUtils.unwrapAssetBalance(
+          expectedRequiredAssets,
+          tokenMap,
+          bitcoinChain.NATIVE_TOKEN_ID,
+          bitcoinChain.CHAIN
+        ),
         testData.transaction1InputIds,
         new Map()
       );
@@ -716,15 +721,15 @@ describe('BitcoinChain', () => {
      * @expected
      * - it should return constructed BoxInfo
      */
-    it('should get box info successfully', async () => {
+    it('should get box info successfully', () => {
       // mock a BitcoinUtxo with assets
       const rawBox = testData.lockUtxo;
 
       // run test
       const bitcoinChain = testUtils.generateChainObject(network);
 
       // check returned value
-      const result = await bitcoinChain.getBoxInfo(rawBox);
+      const result = (bitcoinChain as any).getBoxInfo(rawBox);
       expect(result.id).toEqual(rawBox.txId + '.' + rawBox.index);
       expect(result.assets.nativeToken.toString()).toEqual(
         rawBox.value.toString()

packages/chains/cardano/lib/CardanoChain.ts

@@ -265,7 +265,7 @@ class CardanoChain extends AbstractUtxoChain<CardanoTx, CardanoUtxo> {
    * @param box the box
    * @returns an object containing the box id and assets
    */
-  getBoxInfo = (box: CardanoUtxo): BoxInfo => {
+  protected getBoxInfo = (box: CardanoUtxo): BoxInfo => {
     return {
       id: CardanoUtils.getBoxId(box),
       assets: {

packages/chains/cardano/tests/CardanoChain.spec.ts

@@ -51,7 +51,7 @@ describe('CardanoChain', () => {
 
       // mock getCoveringBoxes, hasLockAddressEnoughAssets
       const cardanoChain = TestUtils.generateChainObject(network);
-      const getCovBoxesSpy = spyOn(cardanoChain, 'getCoveringBoxes');
+      const getCovBoxesSpy = spyOn(cardanoChain as any, 'getCoveringBoxes');
       getCovBoxesSpy.mockResolvedValue({
         covered: true,
         boxes: bankBoxes,
@@ -133,7 +133,7 @@ describe('CardanoChain', () => {
 
       // mock getCoveringBoxes, hasLockAddressEnoughAssets
       const cardanoChain = TestUtils.generateChainObject(network);
-      const getCovBoxesSpy = spyOn(cardanoChain, 'getCoveringBoxes');
+      const getCovBoxesSpy = spyOn(cardanoChain as any, 'getCoveringBoxes');
       getCovBoxesSpy.mockResolvedValue({
         covered: true,
         boxes: bankBoxes.slice(2),
@@ -223,7 +223,7 @@ describe('CardanoChain', () => {
     it('should throw error when bank boxes can not cover order assets', async () => {
       // mock getCoveringBoxes, hasLockAddressEnoughAssets
       const cardanoChain = TestUtils.generateChainObject(network);
-      const getCovBoxesSpy = spyOn(cardanoChain, 'getCoveringBoxes');
+      const getCovBoxesSpy = spyOn(cardanoChain as any, 'getCoveringBoxes');
       getCovBoxesSpy.mockResolvedValue({
         covered: false,
         boxes: bankBoxes,
@@ -290,15 +290,15 @@ describe('CardanoChain', () => {
      * @expected
      * - it should return constructed BoxInfo
      */
-    it('should get box info successfully', async () => {
+    it('should get box info successfully', () => {
       // mock a CardanoBox with assets
       const rawBox = bankBoxes[0];
 
       // call the function
       const cardanoChain = TestUtils.generateChainObject(network);
 
       // check returned value
-      const result = await cardanoChain.getBoxInfo(rawBox);
+      const result = (cardanoChain as any).getBoxInfo(rawBox);
       expect(result.id).toEqual(rawBox.txId + '.' + rawBox.index);
       expect(result.assets.nativeToken.toString()).toEqual(
         rawBox.value.toString()

packages/chains/ergo/lib/ErgoChain.ts

@@ -713,7 +713,7 @@ class ErgoChain extends AbstractUtxoChain<wasm.Transaction, wasm.ErgoBox> {
    * @param box the box
    * @returns an object containing the box id and assets
    */
-  getBoxInfo = (box: wasm.ErgoBox): BoxInfo => {
+  protected getBoxInfo = (box: wasm.ErgoBox): BoxInfo => {
     return {
       id: box.box_id().to_str(),
       assets: ErgoUtils.getBoxAssets(box),