feat: reorder arguments in tx-link (#723)

Author: jinoosss

packages/adena-extension/src/common/provider/gno/gno-provider.ts

@@ -12,39 +12,15 @@ import {
   newRequest,
   parseABCI,
   RPCResponse,
+  stringToBase64,
   TransactionEndpoint,
   Tx,
   uint8ArrayToBase64,
 } from '@gnolang/tm2-js-client';
 import axios from 'axios';
 import { ResponseDeliverTx } from './proto/tm2/abci';
-import { parseProto } from './utils';
-
-interface ABCIAccount {
-  BaseAccount: {
-    address: string;
-    coins: string;
-    public_key: {
-      '@type': string;
-      value: string;
-    } | null;
-    account_number: string;
-    sequence: string;
-  };
-}
-
-export interface AccountInfo {
-  address: string;
-  coins: string;
-  chainId: string;
-  status: 'ACTIVE' | 'IN_ACTIVE';
-  publicKey: {
-    '@type': string;
-    value: string;
-  } | null;
-  accountNumber: string;
-  sequence: string;
-}
+import { ABCIAccount, AccountInfo, GnoDocumentInfo, VMQueryType } from './types';
+import { fetchABCIResponse, makeRequestQueryPath, parseProto, postABCIResponse } from './utils';
 
 export class GnoProvider extends GnoJSONRPCProvider {
   private chainId?: string;
@@ -67,25 +43,14 @@ export class GnoProvider extends GnoJSONRPCProvider {
       accountNumber: '0',
       sequence: '0',
     };
-    const params = {
-      request: newRequest(ABCIEndpoint.ABCI_QUERY, [
-        `auth/accounts/${address}`,
-        '',
-        `${height ?? 0}`,
-        false,
-      ]),
-    };
+    const requestBody = newRequest(ABCIEndpoint.ABCI_QUERY, [
+      `auth/accounts/${address}`,
+      '',
+      `${height ?? 0}`,
+      false,
+    ]);
 
-    const abciResponse = await fetch(this.baseURL, {
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/json',
-      },
-      body: JSON.stringify(params.request),
-    })
-      .then((res) => res.json())
-      .then((data) => data as RPCResponse<ABCIResponse>)
-      .catch(() => null);
+    const abciResponse = await postABCIResponse(this.baseURL, requestBody).catch(() => null);
 
     const abciData = abciResponse?.result?.response.ResponseBase.Data;
     // Make sure the response is initialized
@@ -213,4 +178,28 @@ export class GnoProvider extends GnoJSONRPCProvider {
       return response.gasUsed.toInt();
     });
   }
+
+  public async getRealmDocument(packagePath: string): Promise<GnoDocumentInfo | null> {
+    const query = VMQueryType.QUERY_DOCUMENT;
+    const base64PackagePath = stringToBase64(packagePath);
+    const requestQuery = this.makeRequestQueryPath(query, base64PackagePath);
+
+    try {
+      const abciResponse = await fetchABCIResponse(requestQuery, false);
+      const abciData = abciResponse?.result?.response.ResponseBase.Data;
+      if (!abciData) {
+        return null;
+      }
+
+      return parseABCI<GnoDocumentInfo>(abciData);
+    } catch (e) {
+      console.info(e);
+    }
+
+    return null;
+  }
+
+  private makeRequestQueryPath(path: string, data: string): string {
+    return makeRequestQueryPath(this.baseURL, path, data);
+  }
 }

packages/adena-extension/src/common/provider/gno/index.ts

@@ -0,0 +1,2 @@
+export * from './gno-provider';
+export * from './types';

packages/adena-extension/src/common/provider/gno/types.ts

@@ -0,0 +1,65 @@
+export enum VMQueryType {
+  QUERY_DOCUMENT = 'vm/qdoc',
+  QUERY_VALUE = 'vm/qval',
+}
+
+export interface ABCIAccount {
+  BaseAccount: {
+    address: string;
+    coins: string;
+    public_key: {
+      '@type': string;
+      value: string;
+    } | null;
+    account_number: string;
+    sequence: string;
+  };
+}
+
+export interface AccountInfo {
+  address: string;
+  coins: string;
+  chainId: string;
+  status: 'ACTIVE' | 'IN_ACTIVE';
+  publicKey: {
+    '@type': string;
+    value: string;
+  } | null;
+  accountNumber: string;
+  sequence: string;
+}
+
+export interface GnoDocumentInfo {
+  package_path: string;
+  package_line: string;
+  package_doc: string;
+  values: GnoPackageValue[];
+  funcs: GnoFunction[];
+}
+
+export interface GnoPackageValue {
+  signature: string;
+  const: boolean;
+  values: GnoDocumentValue[];
+  doc: string;
+}
+
+export interface GnoDocumentValue {
+  name: string;
+  doc: string;
+  type: string;
+}
+
+export interface GnoFunction {
+  type: string;
+  name: string;
+  signature: string;
+  doc: string;
+  params: GnoFunctionParam[];
+  results: GnoFunctionParam[];
+}
+
+export interface GnoFunctionParam {
+  name: string;
+  type: string;
+}

packages/adena-extension/src/common/provider/gno/utils.ts

@@ -1,4 +1,5 @@
 import { BinaryReader } from '@bufbuild/protobuf/wire';
+import { ABCIResponse, RPCRequest, RPCResponse } from '@gnolang/tm2-js-client';
 
 export const parseProto = <T>(
   data: string | Uint8Array,
@@ -9,3 +10,42 @@ export const parseProto = <T>(
 
   return protoData;
 };
+
+export const fetchABCIResponse = async (
+  url: string,
+  withCache?: boolean,
+): Promise<RPCResponse<ABCIResponse>> => {
+  const response = await fetch(url, {
+    cache: withCache ? 'force-cache' : 'default',
+  });
+  const data = await response.json();
+  return data;
+};
+
+export const postABCIResponse = async (
+  url: string,
+  body: RPCRequest,
+): Promise<RPCResponse<ABCIResponse>> => {
+  const response = await fetch(url, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+    },
+    body: JSON.stringify(body),
+  });
+  const data = await response.json();
+  return data;
+};
+
+export const makeRequestQueryPath = (baseUrl: string, path: string, data: string): string => {
+  const requestUri = `${baseUrl}/abci_query?path="${path}"&data="${data}"`;
+
+  if (baseUrl.startsWith('http') || baseUrl.startsWith('https')) {
+    return requestUri;
+  }
+
+  const isLocal = baseUrl.startsWith('localhost') || baseUrl.startsWith('127.0.0.1');
+  const protocol = isLocal ? 'http' : 'https';
+
+  return `${protocol}://${requestUri}`;
+};

packages/adena-extension/src/inject/message/command-handler.ts

@@ -1,5 +1,7 @@
 import { WalletResponseFailureType, WalletResponseSuccessType } from '@adena-wallet/sdk';
 import { DEFAULT_GAS_WANTED } from '@common/constants/tx.constant';
+import { GnoDocumentInfo } from '@common/provider/gno';
+import { GnoProvider } from '@common/provider/gno/gno-provider';
 import { MemoryProvider } from '@common/provider/memory/memory-provider';
 import { AdenaExecutor } from '@inject/executor';
 import { ContractMessage, TransactionParams } from '@inject/types';
@@ -12,6 +14,7 @@ import {
 } from './commands/encrypt';
 import { clearPopup } from './commands/popup';
 import {
+  GnoArgumentInfo,
   GnoConnectInfo,
   GnoMessageInfo,
   parseGnoConnectInfo,
@@ -120,10 +123,25 @@ export class CommandHandler {
       return;
     }
 
-    // Make TransactionParams
-    const transactionParams = makeTransactionMessage(gnoMessageInfo, gnoConnectInfo);
+    const gnoProvider = new GnoProvider(gnoConnectInfo.rpc, gnoConnectInfo.chainId);
+    const realmDocument = await gnoProvider.getRealmDocument(gnoMessageInfo.packagePath);
+    if (!realmDocument) {
+      console.info('Realm document not found');
+      return;
+    }
 
-    executor.doContract(transactionParams).then(console.info).catch(console.error);
+    try {
+      // Make TransactionParams
+      const transactionParams = makeTransactionMessage(
+        gnoMessageInfo,
+        gnoConnectInfo,
+        realmDocument,
+      );
+
+      executor.doContract(transactionParams).then(console.info);
+    } catch (error) {
+      console.info(error);
+    }
   };
 }
 
@@ -145,11 +163,27 @@ function makeInternalErrorResponse(message: CommandMessageData): CommandMessageD
 function makeTransactionMessage(
   gnoMessageInfo: GnoMessageInfo,
   gnoConnectInfo: GnoConnectInfo,
+  realmDocument: GnoDocumentInfo,
 ): TransactionParams & { gasFee: number; gasWanted: number } {
-  const args =
-    gnoMessageInfo.args?.map((arg) => {
-      return arg.value;
-    }) || [];
+  const func = realmDocument.funcs.find((f) => f.name === gnoMessageInfo.functionName);
+  if (!func) {
+    throw new Error(`Function not found: ${gnoMessageInfo.functionName}`);
+  }
+
+  const gnoArguments: GnoArgumentInfo[] = func.params.map((param, index) => {
+    const arg = gnoMessageInfo.args?.find((arg) => arg.key === param.name);
+    const value = arg?.value || '';
+
+    return {
+      index,
+      key: param.name,
+      value,
+    };
+  });
+
+  const messageArguments = gnoArguments.map((arg) => {
+    return arg.value;
+  });
 
   const messages: ContractMessage[] = [
     {
@@ -159,7 +193,7 @@ function makeTransactionMessage(
         send: gnoMessageInfo.send,
         pkg_path: gnoMessageInfo.packagePath,
         func: gnoMessageInfo.functionName,
-        args,
+        args: messageArguments,
       },
     },
   ];
@@ -172,6 +206,6 @@ function makeTransactionMessage(
       chainId: gnoConnectInfo.chainId,
       rpcUrl: gnoConnectInfo.rpc,
     },
-    arguments: gnoMessageInfo.args,
+    arguments: gnoArguments,
   };
 }

packages/adena-extension/src/inject/message/methods/gno-connect.ts

@@ -78,7 +78,7 @@ export function parseGnoConnectInfo(): GnoConnectInfo | null {
  *   https://gno.land/r/demo/boards$help&func=CreateThread&bid=2&send=100ugnot
  *   - $help acts as a marker to split the pathname.
  *   - func= specifies functionName.
- *   - send= specifies the amount to send.
+ *   - .send= specifies the amount to send.
  *   - other parameters are collected in the args array.
  *
  * @returns GnoMessageInfo object (packagePath, functionName, send, args)
@@ -128,7 +128,7 @@ export function parseGnoMessageInfo(href: string): GnoMessageInfo | null {
       continue;
     }
 
-    if (key === 'send') {
+    if (key === '.send') {
       messageInfo.send = value || '';
       continue;
     }

packages/adena-extension/src/services/wallet/wallet-account.ts

@@ -1,4 +1,4 @@
-import { AccountInfo, GnoProvider } from '@common/provider/gno/gno-provider';
+import { AccountInfo, GnoProvider } from '@common/provider/gno';
 import { WalletAccountRepository } from '@repositories/wallet';
 import { Account } from 'adena-module';
 
@@ -83,11 +83,9 @@ export class WalletAccountService {
     return this.walletAccountRepository.getAccountNames();
   };
 
-  public updateAccountNames = async (
-    accountNames: {
-      [key in string]: string;
-    },
-  ): Promise<boolean> => {
+  public updateAccountNames = async (accountNames: {
+    [key in string]: string;
+  }): Promise<boolean> => {
     return this.walletAccountRepository.updateAccountNames(accountNames);
   };