add pubkey decoder logic to accountFromAny

Author: Zetazzz

networks/cosmos/src/utils/index.ts

@@ -32,6 +32,10 @@ export interface Account {
   readonly sequence: number;
 }
 
+export interface AccountFromAnyOption {
+  readonly pubkeyDecoders?: Record<string, (pubkey: Any) => Pubkey>;
+}
+
 /**
  * Extracts a BaseAccount from simple wrapper account types using binary parsing.
  * This handles simple wrapper account types like ModuleAccount that contain
@@ -86,13 +90,14 @@ function extractBaseAccountFromWrapper(value: Uint8Array): BaseAccount | null {
  * @returns A standardized Account object
  * @throws Error if the account type is not supported
  */
-export function accountFromAny(accountAny: Any): Account {
+export function accountFromAny(accountAny: Any, opts?: AccountFromAnyOption): Account {
+  const pubkeyDecoders = opts?.pubkeyDecoders;
   switch (accountAny.typeUrl) {
     case "/cosmos.auth.v1beta1.BaseAccount": {
       const baseAccount = BaseAccount.decode(accountAny.value);
       return {
         address: baseAccount.address,
-        pubkey: decodeOptionalPubkey(baseAccount.pubKey),
+        pubkey: decodeOptionalPubkey(baseAccount.pubKey, pubkeyDecoders),
         accountNumber: Number(baseAccount.accountNumber),
         sequence: Number(baseAccount.sequence),
       };
@@ -107,7 +112,7 @@ export function accountFromAny(accountAny: Any): Account {
 
       return {
         address: baseAccount.address,
-        pubkey: decodeOptionalPubkey(baseAccount.pubKey),
+        pubkey: decodeOptionalPubkey(baseAccount.pubKey, pubkeyDecoders),
         accountNumber: Number(baseAccount.accountNumber),
         sequence: Number(baseAccount.sequence),
       };
@@ -122,7 +127,7 @@ export function accountFromAny(accountAny: Any): Account {
 
       return {
         address: baseAccount.address,
-        pubkey: decodeOptionalPubkey(baseAccount.pubKey),
+        pubkey: decodeOptionalPubkey(baseAccount.pubKey, pubkeyDecoders),
         accountNumber: Number(baseAccount.accountNumber),
         sequence: Number(baseAccount.sequence),
       };
@@ -137,7 +142,7 @@ export function accountFromAny(accountAny: Any): Account {
 
       return {
         address: baseAccount.address,
-        pubkey: decodeOptionalPubkey(baseAccount.pubKey),
+        pubkey: decodeOptionalPubkey(baseAccount.pubKey, pubkeyDecoders),
         accountNumber: Number(baseAccount.accountNumber),
         sequence: Number(baseAccount.sequence),
       };
@@ -152,7 +157,7 @@ export function accountFromAny(accountAny: Any): Account {
 
       return {
         address: baseAccount.address,
-        pubkey: decodeOptionalPubkey(baseAccount.pubKey),
+        pubkey: decodeOptionalPubkey(baseAccount.pubKey, pubkeyDecoders),
         accountNumber: Number(baseAccount.accountNumber),
         sequence: Number(baseAccount.sequence),
       };
@@ -164,7 +169,7 @@ export function accountFromAny(accountAny: Any): Account {
       if (baseAccount) {
         return {
           address: baseAccount.address,
-          pubkey: decodeOptionalPubkey(baseAccount.pubKey),
+          pubkey: decodeOptionalPubkey(baseAccount.pubKey, pubkeyDecoders),
           accountNumber: Number(baseAccount.accountNumber),
           sequence: Number(baseAccount.sequence),
         };
@@ -235,4 +240,3 @@ export { generateMnemonic };
 
 // Re-export fee helpers
 export * from './fee';
-

networks/cosmos/src/utils/utils.test.ts

@@ -71,6 +71,43 @@ describe("accountFromAny", () => {
         sequence: 7,
       });
     });
+
+    it("should use custom pubkey decoder when decodePubkey fails", () => {
+      const customTypeUrl = "/custom.crypto.v1.CustomPubKey";
+      const fallbackPubkey = testPubkey;
+
+      const baseAccount: BaseAccount = {
+        address: testAddress,
+        pubKey: {
+          typeUrl: customTypeUrl,
+          value: Uint8Array.from([1, 2, 3]),
+        },
+        accountNumber: testAccountNumber,
+        sequence: testSequence,
+      };
+
+      const accountAny: Any = {
+        typeUrl: "/cosmos.auth.v1beta1.BaseAccount",
+        value: BaseAccount.encode(baseAccount).finish(),
+      };
+
+      const decoder = jest.fn().mockReturnValue(fallbackPubkey);
+
+      const result = accountFromAny(accountAny, {
+        pubkeyDecoders: {
+          [customTypeUrl]: decoder,
+        },
+      });
+
+      expect(decoder).toHaveBeenCalledTimes(1);
+      expect(decoder).toHaveBeenCalledWith(expect.objectContaining({ typeUrl: customTypeUrl }));
+      expect(result).toEqual({
+        address: testAddress,
+        pubkey: fallbackPubkey,
+        accountNumber: 42,
+        sequence: 7,
+      });
+    });
   });
 
   describe("Wrapper account types using binary parsing", () => {
@@ -295,4 +332,3 @@ describe("accountFromAny", () => {
     });
   });
 });
-

packages/pubkey/src/pubkey.ts

@@ -108,12 +108,23 @@ export function decodePubkey(pubkey: Any): Pubkey {
  * This supports single pubkeys such as Cosmos ed25519 and secp256k1 keys
  * as well as multisig threshold pubkeys.
  */
-export function decodeOptionalPubkey(pubkey: Any | null | undefined): Pubkey | null {
+export function decodeOptionalPubkey(
+  pubkey: Any | null | undefined,
+  pubkeyDecoders?: Record<string, (pubkey: Any) => Pubkey>
+): Pubkey | null {
   if (!pubkey) return null;
   if (pubkey.typeUrl) {
     if (pubkey.value.length) {
       // both set
-      return decodePubkey(pubkey);
+      try {
+        return decodePubkey(pubkey);
+      } catch (error) {
+        const decoder = pubkeyDecoders?.[pubkey.typeUrl];
+        if (decoder) {
+          return decoder(pubkey);
+        }
+        throw error;
+      }
     } else {
       throw new Error(`Pubkey is an Any with type URL '${pubkey.typeUrl}' but an empty value`);
     }