Merge branch 'feat/add-stark-scan-client' into chore/refactor-txn-mgr

Consensys · Dec 5, 2024 · 6391e81 · 6391e81
2 parents 38e5d63 + 63e3030
commit 6391e81
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 10 deletions.
diff --git a/packages/starknet-snap/src/chain/data-client/starkscan.test.ts b/packages/starknet-snap/src/chain/data-client/starkscan.test.ts
@@ -5,6 +5,7 @@ import {
   generateStarkScanTransactions,
 } from '../../__tests__/helper';
 import {
+  ContractFuncName,
   TransactionDataVersion,
   type Network,
   type Transaction,
@@ -345,11 +346,8 @@ describe('StarkScanClient', () => {
       const client = createMockClient();
       const result = client.toTransaction(mockTx);
 
-      const {
-        contract_address: contract,
-        selector_name: contractFuncName,
-        calldata: contractCallData,
-      } = mockTx.account_calls[0];
+      const { contract_address: contract, calldata: contractCallData } =
+        mockTx.account_calls[0];
 
       expect(result).toStrictEqual({
         txnHash: mockTx.transaction_hash,
@@ -367,7 +365,7 @@ describe('StarkScanClient', () => {
           [contract]: [
             {
               contract,
-              contractFuncName,
+              contractFuncName: ContractFuncName.Transfer,
               contractCallData,
               recipient: contractCallData[0],
               amount: contractCallData[1],

diff --git a/packages/starknet-snap/src/chain/data-client/starkscan.ts b/packages/starknet-snap/src/chain/data-client/starkscan.ts
@@ -2,11 +2,16 @@ 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 { InvalidNetworkError } from '../../utils/exceptions';
 import type { HttpHeaders } from '../api-client';
 import { ApiClient, HttpMethod } from '../api-client';
@@ -181,7 +186,7 @@ export class StarkScanClient extends ApiClient implements IDataClient {
   }
 
   protected isFundTransferTransaction(entrypoint: string): boolean {
-    return entrypoint === 'transfer';
+    return entrypoint === TRANSFER_SELECTOR_HEX;
   }
 
   protected getContractAddress(tx: StarkScanTransaction): string {
@@ -254,10 +259,11 @@ export class StarkScanClient extends ApiClient implements IDataClient {
       ) => {
         const {
           contract_address: contract,
-          selector_name: contractFuncName,
+          selector,
           calldata: contractCallData,
         } = accountCallArg;
 
+        const contractFuncName = this.selectorHexToName(selector);
         if (!Object.prototype.hasOwnProperty.call(data, contract)) {
           data[contract] = [];
         }
@@ -268,7 +274,7 @@ export class StarkScanClient extends ApiClient implements IDataClient {
           contractCallData,
         };
 
-        if (this.isFundTransferTransaction(contractFuncName)) {
+        if (this.isFundTransferTransaction(selector)) {
           accountCall.recipient = accountCallArg.calldata[0];
           accountCall.amount = accountCallArg.calldata[1];
         }
@@ -280,4 +286,15 @@ export class StarkScanClient extends ApiClient implements IDataClient {
       {},
     );
   }
+
+  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;
+    }
+  }
 }
diff --git a/packages/starknet-snap/src/chain/data-client/starkscan.type.ts b/packages/starknet-snap/src/chain/data-client/starkscan.type.ts
@@ -13,7 +13,7 @@ const NullableStringArrayStruct = nullable(array(string()));
 export const StarkScanAccountCallStruct = object({
   contract_address: string(),
   calldata: array(string()),
-  selector_name: string(),
+  selector: string(),
 });
 
 export const StarkScanTransactionStruct = object({

diff --git a/packages/starknet-snap/src/types/snapState.ts b/packages/starknet-snap/src/types/snapState.ts
@@ -147,6 +147,11 @@ export enum TransactionDataVersion {
   V2 = 'V2',
 }
 
+export enum ContractFuncName {
+  Upgrade = 'upgrade',
+  Transfer = 'transfer',
+}
+
 export type V2Transaction = {
   txnHash: string; // in hex
   txnType: StarkNetTransactionType;