chore: refactor showAccountRequireUpgradeOrDeployModal (#311)

Author: stanleyyconsensys

packages/starknet-snap/src/declareContract.ts

@@ -9,12 +9,11 @@ import { toJson } from './utils/serializer';
 import {
   getNetworkFromChainId,
   getDeclareSnapTxt,
-  showAccountRequireUpgradeOrDeployModal,
+  verifyIfAccountNeedUpgradeOrDeploy,
 } from './utils/snapUtils';
 import {
   getKeysFromAddress,
   declareContract as declareContractUtil,
-  validateAccountRequireUpgradeOrDeploy,
 } from './utils/starknetUtils';
 
 /**
@@ -38,16 +37,7 @@ export async function declareContract(params: ApiParamsWithKeyDeriver) {
       senderAddress,
     );
 
-    try {
-      await validateAccountRequireUpgradeOrDeploy(
-        network,
-        senderAddress,
-        publicKey,
-      );
-    } catch (validateError) {
-      await showAccountRequireUpgradeOrDeployModal(wallet, validateError);
-      throw validateError;
-    }
+    await verifyIfAccountNeedUpgradeOrDeploy(network, senderAddress, publicKey);
 
     const snapComponents = getDeclareSnapTxt(
       senderAddress,

packages/starknet-snap/src/estimateFee.ts

@@ -8,9 +8,11 @@ import type {
 import { ACCOUNT_CLASS_HASH } from './utils/constants';
 import { logger } from './utils/logger';
 import { toJson } from './utils/serializer';
-import { getNetworkFromChainId } from './utils/snapUtils';
 import {
-  validateAccountRequireUpgradeOrDeploy,
+  getNetworkFromChainId,
+  verifyIfAccountNeedUpgradeOrDeploy,
+} from './utils/snapUtils';
+import {
   validateAndParseAddress,
   getKeysFromAddress,
   getCallDataArray,
@@ -64,10 +66,11 @@ export async function estimateFee(params: ApiParamsWithKeyDeriver) {
     const { privateKey: senderPrivateKey, publicKey } =
       await getKeysFromAddress(keyDeriver, network, state, senderAddress);
 
-    await validateAccountRequireUpgradeOrDeploy(
+    await verifyIfAccountNeedUpgradeOrDeploy(
       network,
       senderAddress,
       publicKey,
+      false,
     );
 
     const txnInvocation = {

packages/starknet-snap/src/executeTxn.ts

@@ -14,7 +14,7 @@ import {
   getNetworkFromChainId,
   getTxnSnapTxt,
   addDialogTxt,
-  showAccountRequireUpgradeOrDeployModal,
+  verifyIfAccountNeedUpgradeOrDeploy,
 } from './utils/snapUtils';
 import {
   getKeysFromAddress,
@@ -23,7 +23,6 @@ import {
   estimateFeeBulk,
   getAccContractAddressAndCallData,
   addFeesFromAllTransactions,
-  validateAccountRequireUpgradeOrDeploy,
 } from './utils/starknetUtils';
 
 /**
@@ -42,16 +41,7 @@ export async function executeTxn(params: ApiParamsWithKeyDeriver) {
       addressIndex,
     } = await getKeysFromAddress(keyDeriver, network, state, senderAddress);
 
-    try {
-      await validateAccountRequireUpgradeOrDeploy(
-        network,
-        senderAddress,
-        publicKey,
-      );
-    } catch (validateError) {
-      await showAccountRequireUpgradeOrDeployModal(wallet, validateError);
-      throw validateError;
-    }
+    await verifyIfAccountNeedUpgradeOrDeploy(network, senderAddress, publicKey);
 
     const txnInvocationArray = Array.isArray(requestParamsObj.txnInvocation)
       ? requestParamsObj.txnInvocation

packages/starknet-snap/src/extractPrivateKey.ts

@@ -6,13 +6,14 @@ import type {
 } from './types/snapApi';
 import { logger } from './utils/logger';
 import { toJson } from './utils/serializer';
-import { getNetworkFromChainId } from './utils/snapUtils';
+import {
+  getNetworkFromChainId,
+  verifyIfAccountNeedUpgradeOrDeploy,
+} from './utils/snapUtils';
 import {
   validateAndParseAddress,
   getKeysFromAddress,
-  validateAccountRequireUpgradeOrDeploy,
 } from './utils/starknetUtils';
-
 /**
  *
  * @param params
@@ -43,10 +44,12 @@ export async function extractPrivateKey(params: ApiParamsWithKeyDeriver) {
       state,
       userAddress,
     );
-    await validateAccountRequireUpgradeOrDeploy(
+
+    await verifyIfAccountNeedUpgradeOrDeploy(
       network,
       userAddress,
       publicKey,
+      false,
     );
 
     const response = await wallet.request({

packages/starknet-snap/src/extractPublicKey.ts

@@ -6,10 +6,13 @@ import type {
 } from './types/snapApi';
 import { logger } from './utils/logger';
 import { toJson } from './utils/serializer';
-import { getAccount, getNetworkFromChainId } from './utils/snapUtils';
+import {
+  getAccount,
+  getNetworkFromChainId,
+  verifyIfAccountNeedUpgradeOrDeploy,
+} from './utils/snapUtils';
 import {
   validateAndParseAddress,
-  validateAccountRequireUpgradeOrDeploy,
   getKeysFromAddress,
 } from './utils/starknetUtils';
 
@@ -48,10 +51,12 @@ export async function extractPublicKey(params: ApiParamsWithKeyDeriver) {
       state,
       userAddress,
     );
-    await validateAccountRequireUpgradeOrDeploy(
+
+    await verifyIfAccountNeedUpgradeOrDeploy(
       network,
       userAddress,
       publicKey,
+      false,
     );
 
     let userPublicKey;

packages/starknet-snap/src/signDeclareTransaction.ts

@@ -10,12 +10,11 @@ import { toJson } from './utils/serializer';
 import {
   getNetworkFromChainId,
   getSignTxnTxt,
-  showAccountRequireUpgradeOrDeployModal,
+  verifyIfAccountNeedUpgradeOrDeploy,
 } from './utils/snapUtils';
 import {
   getKeysFromAddress,
   signDeclareTransaction as signDeclareTransactionUtil,
-  validateAccountRequireUpgradeOrDeploy,
 } from './utils/starknetUtils';
 
 /**
@@ -38,16 +37,7 @@ export async function signDeclareTransaction(
       signerAddress,
     );
 
-    try {
-      await validateAccountRequireUpgradeOrDeploy(
-        network,
-        signerAddress,
-        publicKey,
-      );
-    } catch (validateError) {
-      await showAccountRequireUpgradeOrDeployModal(wallet, validateError);
-      throw validateError;
-    }
+    await verifyIfAccountNeedUpgradeOrDeploy(network, signerAddress, publicKey);
 
     logger.log(
       `signDeclareTransaction params: ${toJson(

packages/starknet-snap/src/signDeployAccountTransaction.ts

@@ -10,12 +10,11 @@ import { toJson } from './utils/serializer';
 import {
   getNetworkFromChainId,
   getSignTxnTxt,
-  showAccountRequireUpgradeOrDeployModal,
+  verifyIfAccountNeedUpgradeOrDeploy,
 } from './utils/snapUtils';
 import {
   getKeysFromAddress,
   signDeployAccountTransaction as signDeployAccountTransactionUtil,
-  validateAccountRequireUpgradeOrDeploy,
 } from './utils/starknetUtils';
 
 /**
@@ -38,16 +37,7 @@ export async function signDeployAccountTransaction(
       signerAddress,
     );
 
-    try {
-      await validateAccountRequireUpgradeOrDeploy(
-        network,
-        signerAddress,
-        publicKey,
-      );
-    } catch (validateError) {
-      await showAccountRequireUpgradeOrDeployModal(wallet, validateError);
-      throw validateError;
-    }
+    await verifyIfAccountNeedUpgradeOrDeploy(network, signerAddress, publicKey);
 
     logger.log(
       `signDeployAccountTransaction params: ${toJson(

packages/starknet-snap/src/signMessage.ts

@@ -9,13 +9,12 @@ import { toJson } from './utils/serializer';
 import {
   getNetworkFromChainId,
   addDialogTxt,
-  showAccountRequireUpgradeOrDeployModal,
+  verifyIfAccountNeedUpgradeOrDeploy,
 } from './utils/snapUtils';
 import {
   signMessage as signMessageUtil,
   getKeysFromAddress,
   validateAndParseAddress,
-  validateAccountRequireUpgradeOrDeploy,
 } from './utils/starknetUtils';
 
 /**
@@ -52,16 +51,7 @@ export async function signMessage(params: ApiParamsWithKeyDeriver) {
       );
     }
 
-    try {
-      await validateAccountRequireUpgradeOrDeploy(
-        network,
-        signerAddress,
-        publicKey,
-      );
-    } catch (validateError) {
-      await showAccountRequireUpgradeOrDeployModal(wallet, validateError);
-      throw validateError;
-    }
+    await verifyIfAccountNeedUpgradeOrDeploy(network, signerAddress, publicKey);
 
     const components = [];
     addDialogTxt(components, 'Message', toJson(typedDataMessage));

packages/starknet-snap/src/signTransaction.ts

@@ -10,13 +10,9 @@ import { toJson } from './utils/serializer';
 import {
   getNetworkFromChainId,
   getSignTxnTxt,
-  showAccountRequireUpgradeOrDeployModal,
+  verifyIfAccountNeedUpgradeOrDeploy,
 } from './utils/snapUtils';
-import {
-  getKeysFromAddress,
-  signTransactions,
-  validateAccountRequireUpgradeOrDeploy,
-} from './utils/starknetUtils';
+import { getKeysFromAddress, signTransactions } from './utils/starknetUtils';
 
 /**
  *
@@ -37,16 +33,7 @@ export async function signTransaction(
       signerAddress,
     );
 
-    try {
-      await validateAccountRequireUpgradeOrDeploy(
-        network,
-        signerAddress,
-        publicKey,
-      );
-    } catch (validateError) {
-      await showAccountRequireUpgradeOrDeployModal(wallet, validateError);
-      throw validateError;
-    }
+    await verifyIfAccountNeedUpgradeOrDeploy(network, signerAddress, publicKey);
 
     logger.log(
       `signTransaction params: ${toJson(requestParamsObj.transactions, 2)}}`,

packages/starknet-snap/src/utils/__mocks__/snap.ts

@@ -4,6 +4,8 @@ export const getBip44Deriver = jest.fn();
 
 export const confirmDialog = jest.fn();
 
+export const alertDialog = jest.fn();
+
 export const getStateData = jest.fn();
 
 export const setStateData = jest.fn();

packages/starknet-snap/src/utils/exceptions.ts

@@ -1,3 +1,17 @@
-export class UpgradeRequiredError extends Error {}
+import { SnapError } from '@metamask/snaps-sdk';
 
-export class DeployRequiredError extends Error {}
+// Extend SnapError to allow error message visible to client
+export class UpgradeRequiredError extends SnapError {
+  constructor(message?: string) {
+    super(message ?? 'Upgrade required');
+  }
+}
+
+export class DeployRequiredError extends SnapError {
+  constructor(message?: string) {
+    super(
+      message ??
+        'Cairo 0 contract address balance is not empty, deploy required',
+    );
+  }
+}

packages/starknet-snap/src/utils/snap.test.ts

@@ -46,6 +46,30 @@ describe('confirmDialog', () => {
   });
 });
 
+describe('alertDialog', () => {
+  it('calls snap_dialog', async () => {
+    const spy = jest.spyOn(snapUtil.getProvider(), 'request');
+    const components: Component[] = [
+      heading('header'),
+      text('subHeader'),
+      divider(),
+      row('Label1', text('Value1')),
+      text('**Label2**:'),
+      row('SubLabel1', text('SubValue1')),
+    ];
+
+    await snapUtil.alertDialog(components);
+
+    expect(spy).toHaveBeenCalledWith({
+      method: 'snap_dialog',
+      params: {
+        type: 'alert',
+        content: panel(components),
+      },
+    });
+  });
+});
+
 describe('getStateData', () => {
   it('gets state data', async () => {
     const spy = jest.spyOn(snapUtil.getProvider(), 'request');

packages/starknet-snap/src/utils/snap.ts

@@ -1,7 +1,7 @@
 import type { BIP44AddressKeyDeriver } from '@metamask/key-tree';
 import { getBIP44AddressKeyDeriver } from '@metamask/key-tree';
 import type { Component, DialogResult, Json } from '@metamask/snaps-sdk';
-import { panel, type SnapsProvider } from '@metamask/snaps-sdk';
+import { DialogType, panel, type SnapsProvider } from '@metamask/snaps-sdk';
 
 declare const snap: SnapsProvider;
 
@@ -41,7 +41,25 @@ export async function confirmDialog(
   return snap.request({
     method: 'snap_dialog',
     params: {
-      type: 'confirmation',
+      type: DialogType.Confirmation,
+      content: panel(components),
+    },
+  });
+}
+
+/**
+ * Displays a alert dialog with the specified components.
+ *
+ * @param components - An array of components to display in the dialog.
+ * @returns A Promise that resolves to the result of the dialog.
+ */
+export async function alertDialog(
+  components: Component[],
+): Promise<DialogResult> {
+  return snap.request({
+    method: 'snap_dialog',
+    params: {
+      type: DialogType.Alert,
       content: panel(components),
     },
   });