Merge pull request #763 from input-output-hk/fix/ledger-assets-ordering

rhyslbw · web-flow · commit d64543fa0ed8 · 2023-06-13T09:25:44.000+01:00
fix: correct ledger mapping canonical asset and asset group ordering
diff --git a/packages/hardware-ledger/src/transformers/assets.ts b/packages/hardware-ledger/src/transformers/assets.ts
@@ -2,18 +2,15 @@ import * as Ledger from '@cardano-foundation/ledgerjs-hw-app-cardano';
 import { Cardano } from '@cardano-sdk/core';
 
 const compareAssetNameCanonically = (a: Ledger.Token, b: Ledger.Token) => {
-  if (a.assetNameHex === b.assetNameHex) {
+  if (a.assetNameHex.length === b.assetNameHex.length) {
     return a.assetNameHex > b.assetNameHex ? 1 : -1;
   } else if (a.assetNameHex.length > b.assetNameHex.length) return 1;
   return -1;
 };
 
-const comparePolicyIdCanonically = (a: Ledger.AssetGroup, b: Ledger.AssetGroup) => {
-  if (a.policyIdHex === b.policyIdHex) {
-    return a.policyIdHex > b.policyIdHex ? 1 : -1;
-  } else if (a.policyIdHex.length > b.policyIdHex.length) return 1;
-  return -1;
-};
+const comparePolicyIdCanonically = (a: Ledger.AssetGroup, b: Ledger.AssetGroup) =>
+  // PolicyId is always of the same length
+  a.policyIdHex > b.policyIdHex ? 1 : -1;
 
 const tokenMapToAssetGroup = (tokenMap: Cardano.TokenMap): Ledger.AssetGroup[] => {
   const map = new Map<string, Array<Ledger.Token>>();
diff --git a/packages/hardware-ledger/test/transformers/assets.test.ts b/packages/hardware-ledger/test/transformers/assets.test.ts
@@ -16,19 +16,19 @@ describe('assets', () => {
 
       expect(ledgerAssets).toEqual([
         {
-          policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',
-          tokens: [
-            { amount: 40n, assetNameHex: '' },
-            { amount: 30n, assetNameHex: '504154415445' }
-          ]
+          policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',
+          tokens: [{ amount: 20n, assetNameHex: '' }]
         },
         {
           policyIdHex: '659f2917fb63f12b33667463ee575eeac1845bbc736b9c0bbc40ba82',
           tokens: [{ amount: -50n, assetNameHex: '54534c41' }]
         },
         {
-          policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',
-          tokens: [{ amount: 20n, assetNameHex: '' }]
+          policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',
+          tokens: [
+            { amount: 40n, assetNameHex: '' },
+            { amount: 30n, assetNameHex: '504154415445' }
+          ]
         }
       ]);
     });
diff --git a/packages/hardware-ledger/test/transformers/tx.test.ts b/packages/hardware-ledger/test/transformers/tx.test.ts
@@ -47,15 +47,11 @@ describe('tx', () => {
         ],
         mint: [
           {
-            policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',
+            policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',
             tokens: [
               {
-                amount: 40n,
+                amount: 20n,
                 assetNameHex: ''
-              },
-              {
-                amount: 30n,
-                assetNameHex: '504154415445'
               }
             ]
           },
@@ -69,11 +65,15 @@ describe('tx', () => {
             ]
           },
           {
-            policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',
+            policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',
             tokens: [
               {
-                amount: 20n,
+                amount: 40n,
                 assetNameHex: ''
+              },
+              {
+                amount: 30n,
+                assetNameHex: '504154415445'
               }
             ]
           }
@@ -96,15 +96,11 @@ describe('tx', () => {
             format: Ledger.TxOutputFormat.ARRAY_LEGACY,
             tokenBundle: [
               {
-                policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',
+                policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',
                 tokens: [
                   {
-                    amount: 40n,
+                    amount: 20n,
                     assetNameHex: ''
-                  },
-                  {
-                    amount: 30n,
-                    assetNameHex: '504154415445'
                   }
                 ]
               },
@@ -118,11 +114,15 @@ describe('tx', () => {
                 ]
               },
               {
-                policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',
+                policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',
                 tokens: [
                   {
-                    amount: 20n,
+                    amount: 40n,
                     assetNameHex: ''
+                  },
+                  {
+                    amount: 30n,
+                    assetNameHex: '504154415445'
                   }
                 ]
               }
diff --git a/packages/hardware-ledger/test/transformers/txOut.test.ts b/packages/hardware-ledger/test/transformers/txOut.test.ts
@@ -79,15 +79,11 @@ describe('txOut', () => {
         format: Ledger.TxOutputFormat.ARRAY_LEGACY,
         tokenBundle: [
           {
-            policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',
+            policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',
             tokens: [
               {
-                amount: 40n,
+                amount: 20n,
                 assetNameHex: ''
-              },
-              {
-                amount: 30n,
-                assetNameHex: '504154415445'
               }
             ]
           },
@@ -101,11 +97,15 @@ describe('txOut', () => {
             ]
           },
           {
-            policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',
+            policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',
             tokens: [
               {
-                amount: 20n,
+                amount: 40n,
                 assetNameHex: ''
+              },
+              {
+                amount: 30n,
+                assetNameHex: '504154415445'
               }
             ]
           }
@@ -144,15 +144,11 @@ describe('txOut', () => {
         format: Ledger.TxOutputFormat.ARRAY_LEGACY,
         tokenBundle: [
           {
-            policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',
+            policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',
             tokens: [
               {
-                amount: 40n,
+                amount: 20n,
                 assetNameHex: ''
-              },
-              {
-                amount: 30n,
-                assetNameHex: '504154415445'
               }
             ]
           },
@@ -166,11 +162,15 @@ describe('txOut', () => {
             ]
           },
           {
-            policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',
+            policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',
             tokens: [
               {
-                amount: 20n,
+                amount: 40n,
                 assetNameHex: ''
+              },
+              {
+                amount: 30n,
+                assetNameHex: '504154415445'
               }
             ]
           }
diff --git a/packages/util-dev/src/mockProviders/mockUtxoProvider.ts b/packages/util-dev/src/mockProviders/mockUtxoProvider.ts
@@ -38,7 +38,10 @@ export const utxo: Cardano.Utxo[] = [
         'addr_test1qq585l3hyxgj3nas2v3xymd23vvartfhceme6gv98aaeg9muzcjqw982pcftgx53fu5527z2cj2tkx2h8ux2vxsg475q2g7k3g'
       ),
       value: {
-        assets: new Map([[AssetId.TSLA, 15n]]),
+        assets: new Map([
+          [AssetId.TSLA, 15n],
+          [AssetId.PXL, 20n]
+        ]),
         coins: 3_289_566n
       }
     }
diff --git a/packages/wallet/test/hardware/ledger/LedgerKeyAgent.test.ts b/packages/wallet/test/hardware/ledger/LedgerKeyAgent.test.ts
@@ -110,7 +110,10 @@ describe('LedgerKeyAgent', () => {
           'addr_test1qz2fxv2umyhttkxyxp8x0dlpdt3k6cwng5pxj3jhsydzer3jcu5d8ps7zex2k2xt3uqxgjqnnj83ws8lhrn648jjxtwq2ytjqp'
         ),
         value: {
-          assets: new Map([[AssetId.TSLA, 6n]]),
+          assets: new Map([
+            [AssetId.PXL, 10n],
+            [AssetId.TSLA, 6n]
+          ]),
           coins: 5n
         }
       }

Original file line number	Diff line number	Diff line change
`@@ -47,15 +47,11 @@ describe('tx', () => {`
`47`	`47`	`],`
`48`	`48`	`mint: [`
`49`	`49`	`{`
`50`		`- policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',`
	`50`	`+ policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',`
`51`	`51`	`tokens: [`
`52`	`52`	`{`
`53`		`- amount: 40n,`
	`53`	`+ amount: 20n,`
`54`	`54`	`assetNameHex: ''`
`55`		`- },`
`56`		`- {`
`57`		`- amount: 30n,`
`58`		`- assetNameHex: '504154415445'`
`59`	`55`	`}`
`60`	`56`	`]`
`61`	`57`	`},`
`@@ -69,11 +65,15 @@ describe('tx', () => {`
`69`	`65`	`]`
`70`	`66`	`},`
`71`	`67`	`{`
`72`		`- policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',`
	`68`	`+ policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',`
`73`	`69`	`tokens: [`
`74`	`70`	`{`
`75`		`- amount: 20n,`
	`71`	`+ amount: 40n,`
`76`	`72`	`assetNameHex: ''`
	`73`	`+ },`
	`74`	`+ {`
	`75`	`+ amount: 30n,`
	`76`	`+ assetNameHex: '504154415445'`
`77`	`77`	`}`
`78`	`78`	`]`
`79`	`79`	`}`
`@@ -96,15 +96,11 @@ describe('tx', () => {`
`96`	`96`	`format: Ledger.TxOutputFormat.ARRAY_LEGACY,`
`97`	`97`	`tokenBundle: [`
`98`	`98`	`{`
`99`		`- policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',`
	`99`	`+ policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',`
`100`	`100`	`tokens: [`
`101`	`101`	`{`
`102`		`- amount: 40n,`
	`102`	`+ amount: 20n,`
`103`	`103`	`assetNameHex: ''`
`104`		`- },`
`105`		`- {`
`106`		`- amount: 30n,`
`107`		`- assetNameHex: '504154415445'`
`108`	`104`	`}`
`109`	`105`	`]`
`110`	`106`	`},`
`@@ -118,11 +114,15 @@ describe('tx', () => {`
`118`	`114`	`]`
`119`	`115`	`},`
`120`	`116`	`{`
`121`		`- policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',`
	`117`	`+ policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',`
`122`	`118`	`tokens: [`
`123`	`119`	`{`
`124`		`- amount: 20n,`
	`120`	`+ amount: 40n,`
`125`	`121`	`assetNameHex: ''`
	`122`	`+ },`
	`123`	`+ {`
	`124`	`+ amount: 30n,`
	`125`	`+ assetNameHex: '504154415445'`
`126`	`126`	`}`
`127`	`127`	`]`
`128`	`128`	`}`
Original file line number	Diff line number	Diff line change
`@@ -79,15 +79,11 @@ describe('txOut', () => {`
`79`	`79`	`format: Ledger.TxOutputFormat.ARRAY_LEGACY,`
`80`	`80`	`tokenBundle: [`
`81`	`81`	`{`
`82`		`- policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',`
	`82`	`+ policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',`
`83`	`83`	`tokens: [`
`84`	`84`	`{`
`85`		`- amount: 40n,`
	`85`	`+ amount: 20n,`
`86`	`86`	`assetNameHex: ''`
`87`		`- },`
`88`		`- {`
`89`		`- amount: 30n,`
`90`		`- assetNameHex: '504154415445'`
`91`	`87`	`}`
`92`	`88`	`]`
`93`	`89`	`},`
`@@ -101,11 +97,15 @@ describe('txOut', () => {`
`101`	`97`	`]`
`102`	`98`	`},`
`103`	`99`	`{`
`104`		`- policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',`
	`100`	`+ policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',`
`105`	`101`	`tokens: [`
`106`	`102`	`{`
`107`		`- amount: 20n,`
	`103`	`+ amount: 40n,`
`108`	`104`	`assetNameHex: ''`
	`105`	`+ },`
	`106`	`+ {`
	`107`	`+ amount: 30n,`
	`108`	`+ assetNameHex: '504154415445'`
`109`	`109`	`}`
`110`	`110`	`]`
`111`	`111`	`}`
`@@ -144,15 +144,11 @@ describe('txOut', () => {`
`144`	`144`	`format: Ledger.TxOutputFormat.ARRAY_LEGACY,`
`145`	`145`	`tokenBundle: [`
`146`	`146`	`{`
`147`		`- policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',`
	`147`	`+ policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',`
`148`	`148`	`tokens: [`
`149`	`149`	`{`
`150`		`- amount: 40n,`
	`150`	`+ amount: 20n,`
`151`	`151`	`assetNameHex: ''`
`152`		`- },`
`153`		`- {`
`154`		`- amount: 30n,`
`155`		`- assetNameHex: '504154415445'`
`156`	`152`	`}`
`157`	`153`	`]`
`158`	`154`	`},`
`@@ -166,11 +162,15 @@ describe('txOut', () => {`
`166`	`162`	`]`
`167`	`163`	`},`
`168`	`164`	`{`
`169`		`- policyIdHex: '2a286ad895d091f2b3d168a6091ad2627d30a72761a5bc36eef00740',`
	`165`	`+ policyIdHex: '7eae28af2208be856f7a119668ae52a49b73725e326dc16579dcc373',`
`170`	`166`	`tokens: [`
`171`	`167`	`{`
`172`		`- amount: 20n,`
	`168`	`+ amount: 40n,`
`173`	`169`	`assetNameHex: ''`
	`170`	`+ },`
	`171`	`+ {`
	`172`	`+ amount: 30n,`
	`173`	`+ assetNameHex: '504154415445'`
`174`	`174`	`}`
`175`	`175`	`]`
`176`	`176`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,10 @@ export const utxo: Cardano.Utxo[] = [`
`38`	`38`	`'addr_test1qq585l3hyxgj3nas2v3xymd23vvartfhceme6gv98aaeg9muzcjqw982pcftgx53fu5527z2cj2tkx2h8ux2vxsg475q2g7k3g'`
`39`	`39`	`),`
`40`	`40`	`value: {`
`41`		`- assets: new Map([[AssetId.TSLA, 15n]]),`
	`41`	`+ assets: new Map([`
	`42`	`+ [AssetId.TSLA, 15n],`
	`43`	`+ [AssetId.PXL, 20n]`
	`44`	`+ ]),`
`42`	`45`	`coins: 3_289_566n`
`43`	`46`	`}`
`44`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,10 @@ describe('LedgerKeyAgent', () => {`
`110`	`110`	`'addr_test1qz2fxv2umyhttkxyxp8x0dlpdt3k6cwng5pxj3jhsydzer3jcu5d8ps7zex2k2xt3uqxgjqnnj83ws8lhrn648jjxtwq2ytjqp'`
`111`	`111`	`),`
`112`	`112`	`value: {`
`113`		`- assets: new Map([[AssetId.TSLA, 6n]]),`
	`113`	`+ assets: new Map([`
	`114`	`+ [AssetId.PXL, 10n],`
	`115`	`+ [AssetId.TSLA, 6n]`
	`116`	`+ ]),`
`114`	`117`	`coins: 5n`
`115`	`118`	`}`
`116`	`119`	`}`