Fix: LIVE-12068 [cosmos]Adapt LL code to avoid using deprecated endpoints

.changeset/neat-ads-brake.md

@@ -0,0 +1,5 @@
+---
+"@ledgerhq/live-common": patch
+---
+
+fix cosmos code to avoid using deprecated endpoints

libs/ledger-live-common/src/families/cosmos/api/Cosmos.ts

@@ -9,6 +9,7 @@ import { patchOperationWithHash } from "../../../operation";
 import cryptoFactory from "../chain/chain";
 import cosmosBase from "../chain/cosmosBase";
 import * as CosmosSDKTypes from "./types";
+import semver from "semver";
 import {
   CosmosDelegation,
   CosmosDelegationStatus,
@@ -23,6 +24,13 @@ export class CosmosAPI {
   protected defaultEndpoint: string;
   private version: string;
   private chainInstance: cosmosBase;
+  private _cosmosSDKVersion: Promise<string> | null = null;
+  private get cosmosSDKVersion(): Promise<string> {
+    if (!this._cosmosSDKVersion) {
+      this._cosmosSDKVersion = this.getCosmosSDKVersion();
+    }
+    return this._cosmosSDKVersion;
+  }
 
   constructor(currencyId: string) {
     const crypto = cryptoFactory(currencyId);
@@ -85,6 +93,12 @@ export class CosmosAPI {
     }
   };
 
+  private getCosmosSDKVersion = async (): Promise<string> => {
+    const { application_version } = await this.getNodeInfo();
+    const cosmosSDKVersion = application_version.cosmos_sdk_version;
+    return cosmosSDKVersion;
+  };
+
   /**
    * @sdk https://docs.cosmos.network/api#tag/Query/operation/Account
    * @warning return is technically "any" based on documentation and may differ depending on the chain
@@ -138,15 +152,14 @@ export class CosmosAPI {
    * @sdk https://docs.cosmos.network/api#tag/Service/operation/GetNodeInfo
    * @notice returns { application_versoin: { ..., cosmos_sdk_version } } (Since: cosmos-sdk 0.43)
    */
-  getChainId = async (): Promise<string> => {
-    const {
-      data: { default_node_info: defaultNodeInfo },
-    } = await network<CosmosSDKTypes.GetNodeInfosSDK>({
-      method: "GET",
-      url: `${this.defaultEndpoint}/cosmos/base/tendermint/${this.version}/node_info`,
-    });
-
-    return defaultNodeInfo.network;
+  getNodeInfo = async (): Promise<CosmosSDKTypes.GetNodeInfosSDK> => {
+    const data = (
+      await network<CosmosSDKTypes.GetNodeInfosSDK>({
+        method: "GET",
+        url: `${this.defaultEndpoint}/cosmos/base/tendermint/${this.version}/node_info`,
+      })
+    ).data;
+    return data;
   };
 
   /**
@@ -403,14 +416,20 @@ export class CosmosAPI {
     txs: CosmosTx[];
     total: number;
   }> {
+    let cosmosSDKVersion = await this.cosmosSDKVersion;
+    cosmosSDKVersion = semver.coerce(cosmosSDKVersion).version;
+    let queryparam = "events";
+    if (semver.gte(cosmosSDKVersion, "0.50.0")) {
+      queryparam = "query";
+    }
     let serializedOptions = "";
     for (const key of Object.keys(options)) {
       serializedOptions += options[key] != null ? `&${key}=${options[key]}` : "";
     }
     const { data } = await network<CosmosSDKTypes.GetTxsEvents>({
       method: "GET",
       url:
-        `${nodeUrl}/cosmos/tx/${this.version}/txs?events=` +
+        `${nodeUrl}/cosmos/tx/${this.version}/txs?${queryparam}=` +
         encodeURI(`${filterOn}='${address}'`) +
         serializedOptions,
     });
@@ -423,7 +442,7 @@ export class CosmosAPI {
 
   /**
    * @sdk https://docs.cosmos.network/api#tag/Service/operation/BroadcastTx
-   * @depreacted body {..., mode } -> BROADCAST_MODE_BLOCK (Deprecated: post v0.47 use BROADCAST_MODE_SYNC instead)
+   * @deprecated body {..., mode } -> BROADCAST_MODE_BLOCK (Deprecated: post v0.47 use BROADCAST_MODE_SYNC instead)
    * @notice returns {..., events } (Since: cosmos-sdk 0.42.11, 0.44.5, 0.45)
    */
   broadcast = async ({ signedOperation: { operation, signature } }): Promise<Operation> => {

libs/ledger-live-common/src/families/cosmos/api/Cosmos.unit.test.ts

@@ -260,6 +260,14 @@ describe("CosmosApi", () => {
               ],
             },
           });
+        } else if (networkOptions.url.includes("node_info")) {
+          return Promise.resolve({
+            data: {
+              application_version: {
+                cosmos_sdk_version: "0.44.0",
+              },
+            },
+          });
         } else {
           return Promise.resolve({
             data: {
@@ -279,20 +287,32 @@ describe("CosmosApi", () => {
       const simulatedTotal = 500;
       // @ts-expect-error method is mocked
       network.mockImplementation((networkOptions: { method: string; url: string }) => {
-        const pageOffset: string = networkOptions.url.split("pagination.offset=")[1].split("&")[0];
+        if (networkOptions.url.includes("recipient") || networkOptions.url.includes("sender")) {
+          const pageOffset: string = networkOptions.url
+            .split("pagination.offset=")[1]
+            .split("&")[0];
 
-        const pageSize = Number(networkOptions.url.split("pagination.limit=")[1].split("&")[0]);
+          const pageSize = Number(networkOptions.url.split("pagination.limit=")[1].split("&")[0]);
 
-        return Promise.resolve({
-          data: {
-            pagination: { total: simulatedTotal },
-            tx_responses: Array(pageSize)
-              .fill({})
-              .map((_, i) => ({
-                txhash: `${pageOffset}_${i}`,
-              })),
-          },
-        });
+          return Promise.resolve({
+            data: {
+              pagination: { total: simulatedTotal },
+              tx_responses: Array(pageSize)
+                .fill({})
+                .map((_, i) => ({
+                  txhash: `${pageOffset}_${i}`,
+                })),
+            },
+          });
+        } else if (networkOptions.url.includes("node_info")) {
+          return Promise.resolve({
+            data: {
+              application_version: {
+                cosmos_sdk_version: "0.44.0",
+              },
+            },
+          });
+        }
       });
       const txs = await cosmosApi.getTransactions("address", 10);
       // sender + recipient
@@ -310,7 +330,7 @@ describe("CosmosApi", () => {
         reverse: true,
       };
       // @ts-expect-error method is mocked
-      network.mockImplementationOnce(({ url }) => {
+      network.mockImplementation(({ url }) => {
         if (
           url ===
           `${nodeUrl}/cosmos/tx/v1beta1/txs?events=message.sender='${sender}'&pagination.limit=${pagination.limit}&pagination.offset=${pagination.offset}&pagination.reverse=${pagination.reverse}`
@@ -580,6 +600,14 @@ describe("CosmosApi", () => {
               total: "1",
             },
           };
+        } else if (url.includes("node_info")) {
+          return Promise.resolve({
+            data: {
+              application_version: {
+                cosmos_sdk_version: "0.44.0",
+              },
+            },
+          });
         }
       });
       // using as object to access private method

libs/ledger-live-common/src/families/cosmos/datasets/__snapshots__/cosmos.integration.test.ts.snap

@@ -171,22 +171,24 @@ exports[`cosmos currency bridge scanAccounts cosmos seed 1 2`] = `
       "contract": undefined,
       "extra": {
         "memo": "Ledger Live",
+        "validators": [
+          {
+            "address": "cosmosvaloper1crqm3598z6qmyn2kkcl9dz7uqs4qdqnr6s8jdn",
+            "amount": "234590",
+          },
+        ],
       },
       "fee": "2500",
       "hasFailed": true,
       "hash": "04CA428FE20A51E9C0F0D18818AC24DF5BD2ED5056B7485071620E6CC1D6C13B",
-      "id": "js:2:cosmos:cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl:-04CA428FE20A51E9C0F0D18818AC24DF5BD2ED5056B7485071620E6CC1D6C13B-OUT",
+      "id": "js:2:cosmos:cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl:-04CA428FE20A51E9C0F0D18818AC24DF5BD2ED5056B7485071620E6CC1D6C13B-UNDELEGATE",
       "operator": undefined,
-      "recipients": [
-        "cosmos17xpfvakm2amg962yls6f84z3kell8c5lserqta",
-      ],
-      "senders": [
-        "cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl",
-      ],
+      "recipients": [],
+      "senders": [],
       "standard": undefined,
       "tokenId": undefined,
       "transactionSequenceNumber": 121,
-      "type": "OUT",
+      "type": "UNDELEGATE",
       "value": "2500",
     },
     {
@@ -750,19 +752,15 @@ exports[`cosmos currency bridge scanAccounts cosmos seed 1 2`] = `
       "fee": "3500",
       "hasFailed": true,
       "hash": "3A2EFD293BADC0E880F2C6466C4762F89D370919123C3560F51F49C94877B4FC",
-      "id": "js:2:cosmos:cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl:-3A2EFD293BADC0E880F2C6466C4762F89D370919123C3560F51F49C94877B4FC-OUT",
+      "id": "js:2:cosmos:cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl:-3A2EFD293BADC0E880F2C6466C4762F89D370919123C3560F51F49C94877B4FC-REWARD",
       "operator": undefined,
-      "recipients": [
-        "cosmos17xpfvakm2amg962yls6f84z3kell8c5lserqta",
-      ],
-      "senders": [
-        "cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl",
-      ],
+      "recipients": [],
+      "senders": [],
       "standard": undefined,
       "tokenId": undefined,
       "transactionSequenceNumber": 114,
-      "type": "OUT",
-      "value": "3500",
+      "type": "REWARD",
+      "value": "0",
     },
     {
       "accountId": "js:2:cosmos:cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl:",
@@ -842,22 +840,25 @@ exports[`cosmos currency bridge scanAccounts cosmos seed 1 2`] = `
       "contract": undefined,
       "extra": {
         "memo": "Ledger Live",
+        "sourceValidator": "cosmosvaloper1hjct6q7npsspsg3dgvzk3sdf89spmlpfdn6m9d",
+        "validators": [
+          {
+            "address": "cosmosvaloper10wljxpl03053h9690apmyeakly3ylhejrucvtm",
+            "amount": "16833",
+          },
+        ],
       },
       "fee": "7500",
       "hasFailed": true,
       "hash": "4309BEE6A8F72579012AA2800696078B3C3F488F2346E4738D57C7E1932D653C",
-      "id": "js:2:cosmos:cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl:-4309BEE6A8F72579012AA2800696078B3C3F488F2346E4738D57C7E1932D653C-OUT",
+      "id": "js:2:cosmos:cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl:-4309BEE6A8F72579012AA2800696078B3C3F488F2346E4738D57C7E1932D653C-REDELEGATE",
       "operator": undefined,
-      "recipients": [
-        "cosmos17xpfvakm2amg962yls6f84z3kell8c5lserqta",
-      ],
-      "senders": [
-        "cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl",
-      ],
+      "recipients": [],
+      "senders": [],
       "standard": undefined,
       "tokenId": undefined,
       "transactionSequenceNumber": 116,
-      "type": "OUT",
+      "type": "REDELEGATE",
       "value": "7500",
     },
     {
@@ -1023,7 +1024,7 @@ exports[`cosmos currency bridge scanAccounts cosmos seed 1 2`] = `
       "id": "js:2:cosmos:cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl:-6FCA6C291F87DFB1480B01EF2886BB87C39F52CB6872B409B0CE64B63E74DFB7-OUT",
       "operator": undefined,
       "recipients": [
-        "cosmos1aqas7uqu6wazrlwc9ng4rzfax2nnmc8qhngtjs",
+        "neutron1g84934jpu3v5de5yqukkkhxmcvsw3u2ake9rhc",
       ],
       "senders": [
         "cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl",
@@ -1046,7 +1047,7 @@ exports[`cosmos currency bridge scanAccounts cosmos seed 1 2`] = `
       "id": "js:2:cosmos:cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl:-7048A7DE774CBF591BF3556639C0177908F334C665C0BB2861E89ADEE1363BF2-OUT",
       "operator": undefined,
       "recipients": [
-        "cosmos1aqas7uqu6wazrlwc9ng4rzfax2nnmc8qhngtjs",
+        "neutron1g84934jpu3v5de5yqukkkhxmcvsw3u2ake9rhc",
       ],
       "senders": [
         "cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl",
@@ -1688,7 +1689,7 @@ exports[`cosmos currency bridge scanAccounts cosmos seed 1 2`] = `
       "id": "js:2:cosmos:cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl:-AA20D046757A926C7A86B977FAE27FCC9B09CA9FAAD79C8D737D1D833C444293-OUT",
       "operator": undefined,
       "recipients": [
-        "cosmos1aqas7uqu6wazrlwc9ng4rzfax2nnmc8qhngtjs",
+        "neutron1g84934jpu3v5de5yqukkkhxmcvsw3u2ake9rhc",
       ],
       "senders": [
         "cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl",
@@ -1959,7 +1960,7 @@ exports[`cosmos currency bridge scanAccounts cosmos seed 1 2`] = `
       "id": "js:2:cosmos:cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl:-C165D8AF57713C105C5D3839A7943D21C5CC42750FA21F5887F5E466F489D6BE-OUT",
       "operator": undefined,
       "recipients": [
-        "cosmos1x54ltnyg88k0ejmk8ytwrhd3ltm84xehrnlslf",
+        "osmo1g84934jpu3v5de5yqukkkhxmcvsw3u2a6al3md",
       ],
       "senders": [
         "cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl",
@@ -2005,7 +2006,7 @@ exports[`cosmos currency bridge scanAccounts cosmos seed 1 2`] = `
       "id": "js:2:cosmos:cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl:-C36D5FCAC54DA5B1362A30884F14D7ADC61BD3E3B679588CA6A5AD95F289E033-OUT",
       "operator": undefined,
       "recipients": [
-        "cosmos1aqas7uqu6wazrlwc9ng4rzfax2nnmc8qhngtjs",
+        "neutron1g84934jpu3v5de5yqukkkhxmcvsw3u2ake9rhc",
       ],
       "senders": [
         "cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl",
@@ -2106,7 +2107,7 @@ exports[`cosmos currency bridge scanAccounts cosmos seed 1 2`] = `
         "cosmos1g84934jpu3v5de5yqukkkhxmcvsw3u2ajxvpdl",
       ],
       "senders": [
-        "cosmos1aqas7uqu6wazrlwc9ng4rzfax2nnmc8qhngtjs",
+        "neutron1g84934jpu3v5de5yqukkkhxmcvsw3u2ake9rhc",
       ],
       "standard": undefined,
       "tokenId": undefined,
@@ -2579,22 +2580,25 @@ exports[`cosmos currency bridge scanAccounts cosmos seed 1 2`] = `
       "contract": undefined,
       "extra": {
         "memo": "Ledger Live",
+        "sourceValidator": "cosmosvaloper1sjllsnramtg3ewxqwwrwjxfgc4n4ef9u2lcnj0",
+        "validators": [
+          {
+            "address": "cosmosvaloper10wljxpl03053h9690apmyeakly3ylhejrucvtm",
+            "amount": "50000",
+          },
+        ],
       },
       "fee": "6250",
       "hasFailed": true,
       "hash": "700A6749B7AE4E4D853096BD2E7BFF77942CCA8E4670FC4CEFB044369FE14A54",
-      "id": "js:2:cosmos:cosmos108uy5q9jt59gwugq5yrdhkzcd9jryslmpcstk5:-700A6749B7AE4E4D853096BD2E7BFF77942CCA8E4670FC4CEFB044369FE14A54-OUT",
+      "id": "js:2:cosmos:cosmos108uy5q9jt59gwugq5yrdhkzcd9jryslmpcstk5:-700A6749B7AE4E4D853096BD2E7BFF77942CCA8E4670FC4CEFB044369FE14A54-REDELEGATE",
       "operator": undefined,
-      "recipients": [
-        "cosmos17xpfvakm2amg962yls6f84z3kell8c5lserqta",
-      ],
-      "senders": [
-        "cosmos108uy5q9jt59gwugq5yrdhkzcd9jryslmpcstk5",
-      ],
+      "recipients": [],
+      "senders": [],
       "standard": undefined,
       "tokenId": undefined,
       "transactionSequenceNumber": 13,
-      "type": "OUT",
+      "type": "REDELEGATE",
       "value": "6250",
     },
     {

libs/ledger-live-common/src/families/cosmos/helpers.ts

@@ -1,12 +1,17 @@
-import { CosmosMessage } from "./types";
+interface CosmosEventMessage {
+  type: string;
+  [key: string]: any;
+}
 
-export const getMainMessage = (messages: CosmosMessage[]): CosmosMessage => {
+export const getMainMessage = (messages: CosmosEventMessage[]): CosmosEventMessage => {
   const messagePriorities: string[] = [
-    "unbond",
-    "redelegate",
-    "delegate",
-    "withdraw_rewards",
-    "transfer",
+    "MsgUndelegate",
+    "MsgBeginRedelegate",
+    "MsgDelegate",
+    "MsgWithdrawDelegatorReward",
+    "MsgTransfer",
+    "MsgRecvPacket",
+    "MsgSend",
   ];
   const sortedTypes = messages
     .filter(m => messagePriorities.includes(m.type))