chore: update get-starknet to match new rpcs endpoints (#349)

* chore: rollback keep legacy send txn * fix: get-starknet to match new rpcs parameters * docs: mark abis as deprecated in get-starknet signTransaction * fix: address comments * chore: lint + prettier * fix: return resource bound in estimateFee and use it in executeTxn * fix: return resource bound in estimateFee and use it in executeTxn * fix: return resource bound in estimateFee and use it in executeTxn * fix: apply suggestions from code review Co-authored-by: Stanley Yuen <[email protected]> * fix: address comment --------- Co-authored-by: stanleyyuen <[email protected]>
Consensys · Sep 6, 2024 · ac41722 · ac41722
1 parent 6f2b099
commit ac41722
Show file tree

Hide file tree

Showing 15 changed files with 770 additions and 544 deletions.
diff --git a/packages/get-starknet/src/signer.ts b/packages/get-starknet/src/signer.ts
@@ -32,16 +32,23 @@ export class MetaMaskSigner implements SignerInterface {
     return new ec.starkCurve.Signature(numUtils.toBigInt(result[0]), numUtils.toBigInt(result[1]));
   }
 
+  /**
+   * Signs a transaction calling the Snap.
+   *
+   * @param transactions - The array of transactions to be signed.
+   * @param transactionsDetail - The details required for signing the transactions.
+   * @param _abis - [Deprecated] The ABI definitions for the contracts involved in the transactions. This parameter is optional and may be undefined.
+   * @returns A promise that resolves to the transaction signature.
+   */
   async signTransaction(
     transactions: Call[],
     transactionsDetail: InvocationsSignerDetails,
-    abis?: Abi[] | undefined,
+    _abis?: Abi[] | undefined,
   ): Promise<Signature> {
     const result = (await this.#snap.signTransaction(
       this.#address,
       transactions,
       transactionsDetail,
-      abis,
     )) as ArraySignatureType;
     return new ec.starkCurve.Signature(numUtils.toBigInt(result[0]), numUtils.toBigInt(result[1]));
   }

diff --git a/packages/get-starknet/src/snap.ts b/packages/get-starknet/src/snap.ts
@@ -45,10 +45,9 @@ export class MetaMaskSnap {
   }
 
   async signTransaction(
-    signerAddress: string,
+    address: string,
     transactions: Call[],
     transactionsDetail: InvocationsSignerDetails,
-    abis?: Abi[],
   ): Promise<Signature> {
     return (await this.#provider.request({
       method: 'wallet_invokeSnap',
@@ -57,10 +56,9 @@ export class MetaMaskSnap {
         request: {
           method: 'starkNet_signTransaction',
           params: this.removeUndefined({
-            signerAddress,
+            address,
             transactions,
             transactionsDetail,
-            abis,
             ...(await this.#getSnapParams()),
           }),
         },
@@ -106,10 +104,10 @@ export class MetaMaskSnap {
   }
 
   async execute(
-    senderAddress: string,
-    txnInvocation: AllowArray<Call>,
+    address: string,
+    calls: AllowArray<Call>,
     abis?: Abi[],
-    invocationsDetails?: InvocationsDetails,
+    details?: InvocationsDetails,
   ): Promise<InvokeFunctionResponse> {
     return (await this.#provider.request({
       method: 'wallet_invokeSnap',
@@ -118,9 +116,9 @@ export class MetaMaskSnap {
         request: {
           method: 'starkNet_executeTxn',
           params: this.removeUndefined({
-            senderAddress,
-            txnInvocation,
-            invocationsDetails,
+            address,
+            calls,
+            details,
             abis,
             ...(await this.#getSnapParams()),
           }),
@@ -129,15 +127,15 @@ export class MetaMaskSnap {
     })) as InvokeFunctionResponse;
   }
 
-  async signMessage(typedDataMessage: TypedData, enableAuthorize: boolean, signerAddress: string): Promise<Signature> {
+  async signMessage(typedDataMessage: TypedData, enableAuthorize: boolean, address: string): Promise<Signature> {
     return (await this.#provider.request({
       method: 'wallet_invokeSnap',
       params: {
         snapId: this.#snapId,
         request: {
           method: 'starkNet_signMessage',
           params: this.removeUndefined({
-            signerAddress,
+            address,
             typedDataMessage,
             enableAuthorize,
             ...(await this.#getSnapParams()),

diff --git a/packages/starknet-snap/src/__tests__/helper.ts b/packages/starknet-snap/src/__tests__/helper.ts
@@ -4,7 +4,7 @@ import {
 } from '@metamask/key-tree';
 import { generateMnemonic } from 'bip39';
 import { getRandomValues } from 'crypto';
-import type { constants } from 'starknet';
+import type { constants, EstimateFee } from 'starknet';
 import {
   ec,
   CallData,
@@ -284,3 +284,38 @@ export function generateTransactions({
 
   return transactions.sort((a, b) => b.timestamp - a.timestamp);
 }
+
+/**
+ * Method to generate a mock estimate fee response.
+ *
+ * @returns An array containing a mock EstimateFee object.
+ */
+export function getEstimateFees() {
+  return [
+    {
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      overall_fee: BigInt(1500000000000000).toString(10),
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      gas_consumed: BigInt('0x0'),
+      suggestedMaxFee: BigInt(1500000000000000).toString(10),
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      gas_price: BigInt('0x0'),
+      resourceBounds: {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        l1_gas: {
+          // eslint-disable-next-line @typescript-eslint/naming-convention
+          max_amount: '0',
+          // eslint-disable-next-line @typescript-eslint/naming-convention
+          max_price_per_unit: '0',
+        },
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        l2_gas: {
+          // eslint-disable-next-line @typescript-eslint/naming-convention
+          max_amount: '0',
+          // eslint-disable-next-line @typescript-eslint/naming-convention
+          max_price_per_unit: '0',
+        },
+      },
+    } as unknown as EstimateFee,
+  ];
+}
diff --git a/packages/starknet-snap/src/executeTxn.ts b/packages/starknet-snap/src/executeTxn.ts
diff --git a/packages/starknet-snap/src/index.ts b/packages/starknet-snap/src/index.ts
@@ -23,7 +23,6 @@ import { createAccount } from './createAccount';
 import { declareContract } from './declareContract';
 import { estimateAccDeployFee } from './estimateAccountDeployFee';
 import { estimateFees } from './estimateFees';
-import { executeTxn as executeTxnLegacy } from './executeTxn';
 import { extractPublicKey } from './extractPublicKey';
 import { getCurrentNetwork } from './getCurrentNetwork';
 import { getErc20TokenBalance } from './getErc20TokenBalance';
@@ -54,6 +53,7 @@ import {
   signDeclareTransaction,
   verifySignature,
 } from './rpcs';
+import { sendTransaction } from './sendTransaction';
 import { signDeployAccountTransaction } from './signDeployAccountTransaction';
 import { switchNetwork } from './switchNetwork';
 import type {
@@ -218,8 +218,8 @@ export const onRpcRequest: OnRpcRequestHandler = async ({ request }) => {
 
       case 'starkNet_sendTransaction':
         apiParams.keyDeriver = await getAddressKeyDeriver(snap);
-        return await executeTxn.execute(
-          apiParams.requestParams as unknown as ExecuteTxnParams,
+        return await sendTransaction(
+          apiParams as unknown as ApiParamsWithKeyDeriver,
         );
 
       case 'starkNet_getValue':
@@ -267,9 +267,8 @@ export const onRpcRequest: OnRpcRequestHandler = async ({ request }) => {
         );
 
       case 'starkNet_executeTxn':
-        apiParams.keyDeriver = await getAddressKeyDeriver(snap);
-        return await executeTxnLegacy(
-          apiParams as unknown as ApiParamsWithKeyDeriver,
+        return await executeTxn.execute(
+          apiParams.requestParams as unknown as ExecuteTxnParams,
         );
 
       case 'starkNet_estimateFees':

diff --git a/packages/starknet-snap/src/rpcs/estimateFee.test.ts b/packages/starknet-snap/src/rpcs/estimateFee.test.ts
@@ -3,6 +3,7 @@ import type { Invocations } from 'starknet';
 import { constants, TransactionType } from 'starknet';
 import type { Infer } from 'superstruct';
 
+import { getEstimateFees } from '../__tests__/helper';
 import { FeeTokenUnit } from '../types/snapApi';
 import { STARKNET_SEPOLIA_TESTNET_NETWORK } from '../utils/constants';
 import * as starknetUtils from '../utils/starknetUtils';
@@ -44,11 +45,14 @@ const prepareMockEstimateFee = ({
     details: { version },
   } as unknown as EstimateFeeParams;
 
+  const estimateResults = getEstimateFees();
+
   const estimateBulkFeeRespMock = {
     suggestedMaxFee: BigInt(1000000000000000).toString(10),
     overallFee: BigInt(1500000000000000).toString(10),
     unit: FeeTokenUnit.ETH,
     includeDeploy,
+    estimateResults,
   };
 
   const getEstimatedFeesSpy = jest.spyOn(starknetUtils, 'getEstimatedFees');
@@ -89,7 +93,12 @@ describe('estimateFee', () => {
         version: constants.TRANSACTION_VERSION.V1,
       },
     );
-    expect(result).toStrictEqual(estimateBulkFeeRespMock);
+    expect(result).toStrictEqual({
+      includeDeploy: estimateBulkFeeRespMock.includeDeploy,
+      overallFee: estimateBulkFeeRespMock.overallFee,
+      suggestedMaxFee: estimateBulkFeeRespMock.suggestedMaxFee,
+      unit: estimateBulkFeeRespMock.unit,
+    });
   });
 
   it('throws `InvalidParamsError` when request parameter is not correct', async () => {

diff --git a/packages/starknet-snap/src/rpcs/estimateFee.ts b/packages/starknet-snap/src/rpcs/estimateFee.ts
@@ -71,7 +71,12 @@ export class EstimateFeeRpc extends AccountRpcController<
       details,
     );
 
-    return estimateFeeResp;
+    return {
+      suggestedMaxFee: estimateFeeResp.suggestedMaxFee,
+      overallFee: estimateFeeResp.overallFee,
+      unit: estimateFeeResp.unit,
+      includeDeploy: estimateFeeResp.includeDeploy,
+    };
   }
 }