feat: refactor RPC starkNet_getTransactions with StarkScan (#463)

* feat: refactor RPC `starkNet_getTransactions` with `StarkScan` DataClient (#453) * feat: add stark scan client * chore: add starkscan config * chore: lint * chore: add interface * chore: support multiple txn * chore: update starkscan * chore: update stark scan client * chore: update contract func name * chore: fix test * chore: update data client * chore: re-structure starkscan type * chore: add test coverage * chore: factory and config * chore: add backward compatibility for transactions type * chore: add comment * chore: lint * chore: resolve review comment * chore: change dataVersion to enum * chore: lint * chore: update test helper and refactor ContractAddressFilter * chore: lint * chore: add test for dataVersion filter * chore: update txn state mgr test * chore: update search condition * chore: update starkscan to handle missing selector_name * chore: apply starkscan for list transaction * chore: update list transactions handle * chore: resolve comment * chore: update function name --------- Co-authored-by: khanti42 <[email protected]> * chore: handle multi calls on RPC `starkNet_executeTxn` (#457) * feat: add stark scan client * chore: add starkscan config * chore: lint * chore: add interface * chore: support multiple txn * chore: update starkscan * chore: update stark scan client * chore: update contract func name * chore: fix test * chore: update data client * chore: re-structure starkscan type * chore: add test coverage * chore: factory and config * chore: add backward compatibility for transactions type * chore: add comment * chore: lint * chore: resolve review comment * chore: change dataVersion to enum * chore: lint * chore: update test helper and refactor ContractAddressFilter * chore: lint * chore: add test for dataVersion filter * chore: update txn state mgr test * chore: update search condition * chore: update starkscan to handle missing selector_name * chore: apply starkscan for list transaction * chore: update list transactions handle * chore: refactor execute txn * chore: refactor execute txn * chore: update create account and upgrade account * chore: lint * Revert "chore: lint" This reverts commit 12be249. * Revert "chore: update create account and upgrade account" This reverts commit cf64931. * chore: resolve comment * chore: resolve comment * chore: remove space --------- Co-authored-by: khanti42 <[email protected]> * chore: update RPCs - `starkNet_createAccount` , `starkNet_createAccountLegacy`, `starkNet_upgradeAccContract` to handle new txn state (#458) * feat: add stark scan client * chore: add starkscan config * chore: lint * chore: add interface * chore: support multiple txn * chore: update starkscan * chore: update stark scan client * chore: update contract func name * chore: fix test * chore: update data client * chore: re-structure starkscan type * chore: add test coverage * chore: factory and config * chore: add backward compatibility for transactions type * chore: add comment * chore: lint * chore: resolve review comment * chore: change dataVersion to enum * chore: lint * chore: update test helper and refactor ContractAddressFilter * chore: lint * chore: add test for dataVersion filter * chore: update txn state mgr test * chore: update search condition * chore: update starkscan to handle missing selector_name * chore: apply starkscan for list transaction * chore: update list transactions handle * chore: refactor execute txn * chore: refactor execute txn * chore: update create account and upgrade account * chore: lint * Revert "chore: lint" This reverts commit 12be249. * Revert "chore: update create account and upgrade account" This reverts commit cf64931. * chore: update rpcs to handle v2 data * chore: update rpcs to handle new txn state data * chore: fix naming --------- Co-authored-by: khanti42 <[email protected]> * chore: update wallet-ui to match new getTransactions rpc format (#459) * feat: add stark scan client * chore: add starkscan config * chore: lint * chore: add interface * chore: support multiple txn * chore: update starkscan * chore: update stark scan client * chore: update contract func name * chore: fix test * chore: update data client * chore: re-structure starkscan type * chore: add test coverage * chore: factory and config * chore: add backward compatibility for transactions type * chore: add comment * chore: lint * chore: resolve review comment * chore: change dataVersion to enum * chore: lint * chore: update test helper and refactor ContractAddressFilter * chore: lint * chore: add test for dataVersion filter * chore: update txn state mgr test * chore: update search condition * chore: update starkscan to handle missing selector_name * chore: apply starkscan for list transaction * chore: update list transactions handle * chore: resolve comment * chore: update wallet-ui to handle new starkNet_getTransactions * chore: rename type * chore: remove unecessary input param * chore: remove unecessary input param * chore: change explorer link to starkscan * chore: fix comments --------- Co-authored-by: stanleyyuen <[email protected]> * chore: refine snap for starkscan migration (#462) * chore: refine wallet ui for starkscan migration (#461) --------- Co-authored-by: khanti42 <[email protected]>
Consensys · Dec 12, 2024 · 5b72ef9 · 5b72ef9
1 parent 8027bc2
commit 5b72ef9
Show file tree

Hide file tree

Showing 38 changed files with 2,522 additions and 811 deletions.
diff --git a/packages/starknet-snap/src/__tests__/helper.ts b/packages/starknet-snap/src/__tests__/helper.ts
@@ -26,6 +26,7 @@ import type {
 } from '../chain/data-client/starkscan.type';
 import { FeeToken } from '../types/snapApi';
 import {
+  ContractFuncName,
   TransactionDataVersion,
   type AccContract,
   type Transaction,
@@ -268,7 +269,7 @@ export function generateTransactions({
     const txnType = getRandomData(_txnTypes);
     const contractFuncName =
       txnType == TransactionType.INVOKE
-        ? getRandomData(['transfer', 'upgrade'])
+        ? getRandomData(Object.values(ContractFuncName))
         : '';
 
     transactions.push(
@@ -303,6 +304,8 @@ function getTransactionTemplate() {
     finalityStatus: '',
     accountCalls: null,
     version: 1,
+    maxFee: null,
+    actualFee: null,
     dataVersion: TransactionDataVersion.V2,
   };
 }
@@ -464,7 +467,7 @@ export function generateTransactionRequests({
             to: address,
             amount: '1',
           }),
-          entrypoint: 'transfer',
+          entrypoint: ContractFuncName.Transfer,
         },
       ],
       includeDeploy: false,

diff --git a/packages/starknet-snap/src/chain/data-client/starkscan.ts b/packages/starknet-snap/src/chain/data-client/starkscan.ts
@@ -1,24 +1,18 @@
 import { TransactionType, constants } from 'starknet';
 import type { Struct } from 'superstruct';
 
-import {
-  ContractFuncName,
-  TransactionDataVersion,
-  type Network,
-  type Transaction,
-  type TranscationAccountCall,
-} from '../../types/snapState';
-import {
-  TRANSFER_SELECTOR_HEX,
-  UPGRADE_SELECTOR_HEX,
-} from '../../utils/constants';
+import type { V2Transaction } from '../../types/snapState';
+import { type Network, type Transaction } from '../../types/snapState';
 import { InvalidNetworkError } from '../../utils/exceptions';
+import {
+  newDeployTransaction,
+  newInvokeTransaction,
+} from '../../utils/transaction';
 import type { HttpHeaders } from '../api-client';
 import { ApiClient, HttpMethod } from '../api-client';
 import type { IDataClient } from '../data-client';
 import type { StarkScanTransactionsResponse } from './starkscan.type';
 import {
-  type StarkScanAccountCall,
   type StarkScanTransaction,
   type StarkScanOptions,
   StarkScanTransactionsResponseStruct,
@@ -185,10 +179,6 @@ export class StarkScanClient extends ApiClient implements IDataClient {
     return tx.transaction_type === TransactionType.DEPLOY_ACCOUNT;
   }
 
-  protected isFundTransferTransaction(entrypoint: string): boolean {
-    return entrypoint === TRANSFER_SELECTOR_HEX;
-  }
-
   protected getContractAddress(tx: StarkScanTransaction): string {
     // backfill the contract address if it is null
     return tx.contract_address ?? '';
@@ -207,94 +197,64 @@ export class StarkScanClient extends ApiClient implements IDataClient {
   }
 
   protected toTransaction(tx: StarkScanTransaction): Transaction {
-    /* eslint-disable @typescript-eslint/naming-convention */
+    /* eslint-disable @typescript-eslint/naming-convention, camelcase */
     const {
       transaction_hash: txnHash,
       transaction_type: txnType,
       timestamp,
       transaction_finality_status: finalityStatus,
       transaction_execution_status: executionStatus,
-      max_fee: maxFee,
+      max_fee,
       actual_fee: actualFee,
-      revert_error: failureReason,
+      revert_error,
+      // account_calls representing the calls to invoke from the account contract, it can be multiple
+      // If the transaction is a deploy transaction, the account_calls is a empty array
       account_calls: calls,
-      version,
+      version: txnVersion,
     } = tx;
 
-    // account_calls representing the calls to invoke from the account contract, it can be multiple
-    // If the transaction is a deploy transaction, the account_calls is a empty array
-    const accountCalls = this.toAccountCall(calls);
+    const { chainId } = this.network;
+    const senderAddress = this.getSenderAddress(tx);
+    const failureReason = revert_error ?? '';
+    const maxFee = max_fee ?? '0';
+
+    let transaction: V2Transaction;
+
+    // eslint-disable-next-line no-negated-condition
+    if (!this.isDeployTransaction(tx)) {
+      transaction = newInvokeTransaction({
+        txnHash,
+        senderAddress,
+        chainId,
+        maxFee,
+        calls: calls.map((call) => ({
+          contractAddress: call.contract_address,
+          entrypoint: call.selector,
+          calldata: call.calldata,
+        })),
+        txnVersion,
+      });
+    } else {
+      transaction = newDeployTransaction({
+        txnHash,
+        senderAddress,
+        chainId,
+        txnVersion,
+      });
+    }
 
     return {
-      txnHash,
-      txnType,
-      chainId: this.network.chainId,
-      senderAddress: this.getSenderAddress(tx),
+      ...transaction,
+      // Override the fields from the StarkScanTransaction
       timestamp,
       finalityStatus,
       executionStatus,
-      maxFee,
       actualFee,
+      maxFee,
       contractAddress: this.getContractAddress(tx),
-      accountCalls,
-      failureReason: failureReason ?? '',
-      version,
-      dataVersion: TransactionDataVersion.V2,
+      failureReason,
+      txnType,
     };
-
     /* eslint-enable */
   }
-
-  protected toAccountCall(
-    accountCalls: StarkScanAccountCall[],
-  ): Record<string, TranscationAccountCall[]> | null {
-    if (!accountCalls || accountCalls.length === 0) {
-      return null;
-    }
-
-    return accountCalls.reduce(
-      (
-        data: Record<string, TranscationAccountCall[]>,
-        accountCallArg: StarkScanAccountCall,
-      ) => {
-        const {
-          contract_address: contract,
-          selector,
-          calldata: contractCallData,
-        } = accountCallArg;
-
-        const contractFuncName = this.selectorHexToName(selector);
-        if (!Object.prototype.hasOwnProperty.call(data, contract)) {
-          data[contract] = [];
-        }
-
-        const accountCall: TranscationAccountCall = {
-          contract,
-          contractFuncName,
-          contractCallData,
-        };
-
-        if (this.isFundTransferTransaction(selector)) {
-          accountCall.recipient = accountCallArg.calldata[0];
-          accountCall.amount = accountCallArg.calldata[1];
-        }
-
-        data[contract].push(accountCall);
-
-        return data;
-      },
-      {},
-    );
-  }
-
-  protected selectorHexToName(selector: string): string {
-    switch (selector.toLowerCase()) {
-      case TRANSFER_SELECTOR_HEX.toLowerCase():
-        return ContractFuncName.Transfer;
-      case UPGRADE_SELECTOR_HEX.toLowerCase():
-        return ContractFuncName.Upgrade;
-      default:
-        return selector;
-    }
-  }
 }