feat: cosmos

Author: ganchoradkov

packages/sign-client/src/constants/engine.ts

@@ -228,4 +228,9 @@ export const TVF_METHODS = {
   polkadot_signTransaction: {
     key: "",
   },
+
+  // cosmos
+  cosmos_signDirect: {
+    key: "",
+  },
 };

packages/sign-client/src/controllers/engine.ts

@@ -104,6 +104,7 @@ import {
   getNearTransactionIdFromSignedTransaction,
   getAlgorandTransactionId,
   buildSignedExtrinsicHash,
+  getSignDirectHash,
 } from "@walletconnect/utils";
 import EventEmmiter from "events";
 import {
@@ -3192,6 +3193,10 @@ export class Engine extends IEngine {
           : [getAlgorandTransactionId(result)];
       }
 
+      if (method === "cosmos_signDirect") {
+        return [getSignDirectHash(result)];
+      }
+
       // result = 0x...
       if (typeof result === "string") {
         return [result];

packages/sign-client/test/sdk/client.spec.ts

@@ -692,6 +692,11 @@ describe("Sign Client Integration", () => {
                   events: [],
                   chains: ["polkadot:mainnet"],
                 },
+                cosmos: {
+                  methods: ["cosmos_signDirect"],
+                  events: [],
+                  chains: ["cosmos:mainnet"],
+                },
               },
               namespaces: {
                 solana: {
@@ -767,6 +772,12 @@ describe("Sign Client Integration", () => {
                   chains: ["polkadot:mainnet"],
                   accounts: ["polkadot:mainnet:0x"],
                 },
+                cosmos: {
+                  methods: ["cosmos_signDirect"],
+                  events: [],
+                  chains: ["cosmos:mainnet"],
+                  accounts: ["cosmos:mainnet:0x"],
+                },
               },
             },
           );
@@ -2311,6 +2322,102 @@ describe("Sign Client Integration", () => {
             }),
           ]);
 
+          // cosmos cosmos_signDirect example
+          await Promise.all([
+            new Promise<void>((resolve) => {
+              clients.B.once("session_request", async (args) => {
+                const pendingRequests = clients.B.pendingRequest.getAll();
+                const { id, topic, params } = pendingRequests[0];
+                expect(params).toEqual(args.params);
+                expect(topic).toEqual(args.topic);
+                expect(id).toEqual(args.id);
+                const expectedTxHashes = [
+                  "A7284BA475C55983E5BCB7D52F5C82CBFF19FD75725F5E0E33BA4384FCFC6052",
+                ];
+                const signedResult = {
+                  signature: {
+                    pub_key: {
+                      type: "tendermint/PubKeySecp256k1",
+                      value: "AgSEjOuOr991QlHCORRmdE5ahVKeyBrmtgoYepCpQGOW",
+                    },
+                    signature:
+                      "S7BJEbiXQ6vxvF9o4Wj7qAcocMQqBsqz+NVH4wilhidFsRpyqpSP5XiXoQZxTDrT9uET/S5SH6+5gUmjYntH/Q==",
+                  },
+                  signed: {
+                    chainId: "cosmoshub-4",
+                    accountNumber: "1",
+                    authInfoBytes:
+                      "ClAKRgofL2Nvc21vcy5jcnlwdG8uc2VjcDI1NmsxLlB1YktleRIjCiEDNOXj4u60JFq00+VbLBCNBTYy76Pn864AvYNFG/9cQwMSBAoCCH8YAhITCg0KBXVhdG9tEgQ0NTM1EIaJCw==",
+                    bodyBytes:
+                      "CpoICikvaWJjLmFwcGxpY2F0aW9ucy50cmFuc2Zlci52MS5Nc2dUcmFuc2ZlchLsBwoIdHJhbnNmZXISC2NoYW5uZWwtMTQxGg8KBXVhdG9tEgYxODg4MDYiLWNvc21vczFhanBkZndsZmRqY240MG5yZXN5ZHJxazRhOGo2ZG0wemY0MGszcSo/b3NtbzEwYTNrNGh2azM3Y2M0aG54Y3R3NHA5NWZoc2NkMno2aDJybXgwYXVrYzZybTh1OXFxeDlzbWZzaDd1MgcIARDFt5YRQsgGeyJ3YXNtIjp7ImNvbnRyYWN0Ijoib3NtbzEwYTNrNGh2azM3Y2M0aG54Y3R3NHA5NWZoc2NkMno2aDJybXgwYXVrYzZybTh1OXFxeDlzbWZzaDd1IiwibXNnIjp7InN3YXBfYW5kX2FjdGlvbiI6eyJ1c2VyX3N3YXAiOnsic3dhcF9leGFjdF9hc3NldF9pbiI6eyJzd2FwX3ZlbnVlX25hbWUiOiJvc21vc2lzLXBvb2xtYW5hZ2VyIiwib3BlcmF0aW9ucyI6W3sicG9vbCI6IjE0MDAiLCJkZW5vbV9pbiI6ImliYy8yNzM5NEZCMDkyRDJFQ0NENTYxMjNDNzRGMzZFNEMxRjkyNjAwMUNFQURBOUNBOTdFQTYyMkIyNUY0MUU1RUIyIiwiZGVub21fb3V0IjoidW9zbW8ifSx7InBvb2wiOiIxMzQ3IiwiZGVub21faW4iOiJ1b3NtbyIsImRlbm9tX291dCI6ImliYy9ENzlFN0Q4M0FCMzk5QkZGRjkzNDMzRTU0RkFBNDgwQzE5MTI0OEZDNTU2OTI0QTJBODM1MUFFMjYzOEIzODc3In1dfX0sIm1pbl9hc3NldCI6eyJuYXRpdmUiOnsiZGVub20iOiJpYmMvRDc5RTdEODNBQjM5OUJGRkY5MzQzM0U1NEZBQTQ4MEMxOTEyNDhGQzU1NjkyNEEyQTgzNTFBRTI2MzhCMzg3NyIsImFtb3VudCI6IjMzOTQ2NyJ9fSwidGltZW91dF90aW1lc3RhbXAiOjE3NDc3NDY3MzM3OTU4OTgzNjQsInBvc3Rfc3dhcF9hY3Rpb24iOnsiaWJjX3RyYW5zZmVyIjp7ImliY19pbmZvIjp7InNvdXJjZV9jaGFubmVsIjoiY2hhbm5lbC02OTk0IiwicmVjZWl2ZXIiOiJjZWxlc3RpYTFhanBkZndsZmRqY240MG5yZXN5ZHJxazRhOGo2ZG0wemNsN3h0ZCIsIm1lbW8iOiIiLCJyZWNvdmVyX2FkZHJlc3MiOiJvc21vMWFqcGRmd2xmZGpjbjQwbnJlc3lkcnFrNGE4ajZkbTB6cHd1eDhqIn19fSwiYWZmaWxpYXRlcyI6W119fX19",
+                  },
+                };
+
+                const result = formatJsonRpcResult(id, signedResult);
+
+                let checkedWalletPublish = false;
+                clients.B.core.relayer.once(RELAYER_EVENTS.publish, (publishPayload: any) => {
+                  const tvf = publishPayload.tvf;
+                  if (!tvf) {
+                    return console.error("cosmos tvf is undefined");
+                  }
+                  if (!tvf.chainId || !tvf.rpcMethods || !tvf.txHashes) {
+                    return console.error("cosmos tvf is missing required fields");
+                  }
+                  if (tvf.rpcMethods.length !== 1 && tvf.rpcMethods[0] !== "cosmos_signDirect") {
+                    return console.error("cosmos tvf rpcMethods is invalid", tvf.rpcMethods);
+                  }
+                  if (tvf.txHashes.join(",") !== expectedTxHashes.join(",")) {
+                    return console.error(
+                      "cosmos txHashes do not match: transactionId",
+                      tvf.txHashes,
+                      expectedTxHashes,
+                    );
+                  }
+
+                  checkedWalletPublish = true;
+                });
+
+                await clients.B.respond({
+                  topic,
+                  response: result,
+                });
+
+                expect(checkedWalletPublish).to.be.true;
+                resolve();
+              });
+            }),
+            new Promise<void>(async (resolve) => {
+              const requestParams = {
+                method: "cosmos_signDirect",
+                params: {},
+              };
+              let checkedDappPublish = false;
+
+              clients.A.core.relayer.once(RELAYER_EVENTS.publish, (publishPayload: any) => {
+                checkedDappPublish = true;
+                const tvf = publishPayload.tvf;
+                expect(tvf).to.exist;
+                expect(tvf?.chainId).to.eq(TEST_REQUEST_PARAMS.chainId);
+                expect(tvf?.rpcMethods).to.eql([requestParams.method]);
+                expect(tvf?.txHashes).to.be.undefined;
+                expect(tvf?.contractAddresses).to.eql([requestParams.params[0].to]);
+              });
+
+              await clients.A.request({
+                topic,
+                ...TEST_REQUEST_PARAMS,
+                request: {
+                  ...TEST_REQUEST_PARAMS.request,
+                  ...requestParams,
+                },
+                chainId: "cosmos:mainnet",
+              });
+              expect(checkedDappPublish).to.be.true;
+              resolve();
+            }),
+          ]);
+
           await throttle(1_000);
           await deleteClients(clients);
         });

packages/utils/src/signatures.ts

@@ -202,3 +202,53 @@ export function getAlgorandTransactionId(transaction: string) {
   // Encode to base32 and remove padding
   return base32.encode(hash).replace(/=+$/, "");
 }
+
+function encodeVarint(value: number | bigint): Buffer {
+  const result: number[] = [];
+  let v = BigInt(value);
+  while (v >= 0x80n) {
+    result.push(Number((v & 0x7fn) | 0x80n));
+    v >>= 7n;
+  }
+  result.push(Number(v));
+  return Buffer.from(result);
+}
+
+export function getSignDirectHash(payload: {
+  signed: {
+    chainId: string;
+    accountNumber: string;
+    authInfoBytes: string;
+    bodyBytes: string;
+  };
+  signature: {
+    pub_key: {
+      type: string;
+      value: string;
+    };
+    signature: string;
+  };
+}) {
+  const bodyBytes = Buffer.from(payload.signed.bodyBytes, "base64");
+  const authInfoBytes = Buffer.from(payload.signed.authInfoBytes, "base64");
+  const signature = Buffer.from(payload.signature.signature, "base64");
+
+  const chunks: Buffer[] = [];
+
+  chunks.push(Buffer.from([0x0a]));
+  chunks.push(encodeVarint(bodyBytes.length));
+  chunks.push(bodyBytes);
+
+  chunks.push(Buffer.from([0x12]));
+  chunks.push(encodeVarint(authInfoBytes.length));
+  chunks.push(authInfoBytes);
+
+  chunks.push(Buffer.from([0x1a]));
+  chunks.push(encodeVarint(signature.length));
+  chunks.push(signature);
+
+  const txRawBytes = Buffer.concat(chunks);
+  const hashBytes = sha256(txRawBytes);
+
+  return Buffer.from(hashBytes).toString("hex").toUpperCase();
+}

packages/utils/test/signatures.spec.ts

@@ -6,6 +6,7 @@ import {
   extractSolanaTransactionId,
   getAlgorandTransactionId,
   getNearTransactionIdFromSignedTransaction,
+  getSignDirectHash,
   getSuiDigest,
   isValidEip191Signature,
   verifySignature,
@@ -489,5 +490,32 @@ Expiration Time: 2022-10-11T23:03:35.700Z`;
 
       expect(hash).toBe("0x48016b3c80b7b61d32d1db6f52038de70d7d30ef948da047442cc9c952b92e84");
     });
+
+    it("should derive sign direct hash", () => {
+      const result = {
+        signature: {
+          pub_key: {
+            type: "tendermint/PubKeySecp256k1",
+            value: "AgSEjOuOr991QlHCORRmdE5ahVKeyBrmtgoYepCpQGOW",
+          },
+          signature:
+            "S7BJEbiXQ6vxvF9o4Wj7qAcocMQqBsqz+NVH4wilhidFsRpyqpSP5XiXoQZxTDrT9uET/S5SH6+5gUmjYntH/Q==",
+        },
+        signed: {
+          chainId: "cosmoshub-4",
+          accountNumber: "1",
+          authInfoBytes:
+            "ClAKRgofL2Nvc21vcy5jcnlwdG8uc2VjcDI1NmsxLlB1YktleRIjCiEDNOXj4u60JFq00+VbLBCNBTYy76Pn864AvYNFG/9cQwMSBAoCCH8YAhITCg0KBXVhdG9tEgQ0NTM1EIaJCw==",
+          bodyBytes:
+            "CpoICikvaWJjLmFwcGxpY2F0aW9ucy50cmFuc2Zlci52MS5Nc2dUcmFuc2ZlchLsBwoIdHJhbnNmZXISC2NoYW5uZWwtMTQxGg8KBXVhdG9tEgYxODg4MDYiLWNvc21vczFhanBkZndsZmRqY240MG5yZXN5ZHJxazRhOGo2ZG0wemY0MGszcSo/b3NtbzEwYTNrNGh2azM3Y2M0aG54Y3R3NHA5NWZoc2NkMno2aDJybXgwYXVrYzZybTh1OXFxeDlzbWZzaDd1MgcIARDFt5YRQsgGeyJ3YXNtIjp7ImNvbnRyYWN0Ijoib3NtbzEwYTNrNGh2azM3Y2M0aG54Y3R3NHA5NWZoc2NkMno2aDJybXgwYXVrYzZybTh1OXFxeDlzbWZzaDd1IiwibXNnIjp7InN3YXBfYW5kX2FjdGlvbiI6eyJ1c2VyX3N3YXAiOnsic3dhcF9leGFjdF9hc3NldF9pbiI6eyJzd2FwX3ZlbnVlX25hbWUiOiJvc21vc2lzLXBvb2xtYW5hZ2VyIiwib3BlcmF0aW9ucyI6W3sicG9vbCI6IjE0MDAiLCJkZW5vbV9pbiI6ImliYy8yNzM5NEZCMDkyRDJFQ0NENTYxMjNDNzRGMzZFNEMxRjkyNjAwMUNFQURBOUNBOTdFQTYyMkIyNUY0MUU1RUIyIiwiZGVub21fb3V0IjoidW9zbW8ifSx7InBvb2wiOiIxMzQ3IiwiZGVub21faW4iOiJ1b3NtbyIsImRlbm9tX291dCI6ImliYy9ENzlFN0Q4M0FCMzk5QkZGRjkzNDMzRTU0RkFBNDgwQzE5MTI0OEZDNTU2OTI0QTJBODM1MUFFMjYzOEIzODc3In1dfX0sIm1pbl9hc3NldCI6eyJuYXRpdmUiOnsiZGVub20iOiJpYmMvRDc5RTdEODNBQjM5OUJGRkY5MzQzM0U1NEZBQTQ4MEMxOTEyNDhGQzU1NjkyNEEyQTgzNTFBRTI2MzhCMzg3NyIsImFtb3VudCI6IjMzOTQ2NyJ9fSwidGltZW91dF90aW1lc3RhbXAiOjE3NDc3NDY3MzM3OTU4OTgzNjQsInBvc3Rfc3dhcF9hY3Rpb24iOnsiaWJjX3RyYW5zZmVyIjp7ImliY19pbmZvIjp7InNvdXJjZV9jaGFubmVsIjoiY2hhbm5lbC02OTk0IiwicmVjZWl2ZXIiOiJjZWxlc3RpYTFhanBkZndsZmRqY240MG5yZXN5ZHJxazRhOGo2ZG0wemNsN3h0ZCIsIm1lbW8iOiIiLCJyZWNvdmVyX2FkZHJlc3MiOiJvc21vMWFqcGRmd2xmZGpjbjQwbnJlc3lkcnFrNGE4ajZkbTB6cHd1eDhqIn19fSwiYWZmaWxpYXRlcyI6W119fX19",
+        },
+      };
+
+      const expectedHash = "A7284BA475C55983E5BCB7D52F5C82CBFF19FD75725F5E0E33BA4384FCFC6052";
+
+      const hash = getSignDirectHash(result);
+      console.log("hash", hash);
+      expect(hash).toBe(expectedHash);
+    });
   });
 });