feat: show upgrade dialog on get-starknet calls

packages/get-starknet/webpack.config.local.js

@@ -1,7 +1,11 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
+const { merge } = require('webpack-merge');
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const common = require('./webpack.common.js');
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const path = require('path');
 
-module.exports = {
+module.exports = (env) => merge(common, {
   mode: 'development',
   output: {
     publicPath: process.env.GET_STARKNET_PUBLIC_PATH ?? 'http://localhost:8082/', // Adjust the development publicPath as needed
@@ -11,4 +15,4 @@ module.exports = {
     compress: true,
     port: 8082,
   }
-};
+});

packages/starknet-snap/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/ConsenSys/starknet-snap.git"
   },
   "source": {
-    "shasum": "kl5iM2GRyXtFYwezb2vvrh2iTNC4Gw4K1I3PVOttXJ4=",
+    "shasum": "w/9IComQVArE5jU1RHIW8Y5CnN//nBoHKBQDFRhM8yI=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/starknet-snap/src/declareContract.ts

@@ -1,7 +1,7 @@
 import { toJson } from './utils/serializer';
 import { ApiParams, DeclareContractRequestParams } from './types/snapApi';
-import { getNetworkFromChainId, getDeclareSnapTxt } from './utils/snapUtils';
-import { getKeysFromAddress, declareContract as declareContractUtil } from './utils/starknetUtils';
+import { getNetworkFromChainId, getDeclareSnapTxt, showUpgradeRequestModal } from './utils/snapUtils';
+import { getKeysFromAddress, declareContract as declareContractUtil, isUpgradeRequired } from './utils/starknetUtils';
 import { DialogType } from '@metamask/rpc-methods';
 import { heading, panel } from '@metamask/snaps-sdk';
 import { logger } from './utils/logger';
@@ -17,6 +17,11 @@ export async function declareContract(params: ApiParams) {
     const network = getNetworkFromChainId(state, requestParamsObj.chainId);
     const { privateKey } = await getKeysFromAddress(keyDeriver, network, state, senderAddress);
 
+    if (await isUpgradeRequired(network, senderAddress)) {
+      await showUpgradeRequestModal(wallet);
+      throw new Error('Upgrade required');
+    }
+
     const snapComponents = getDeclareSnapTxt(
       senderAddress,
       network,

packages/starknet-snap/src/executeTxn.ts

@@ -1,19 +1,20 @@
 import { Invocations, TransactionType } from 'starknet';
-import { getNetworkFromChainId, getTxnSnapTxt, addDialogTxt } from './utils/snapUtils';
+import { getNetworkFromChainId, getTxnSnapTxt, addDialogTxt, showUpgradeRequestModal } from './utils/snapUtils';
 import {
   getKeysFromAddress,
   executeTxn as executeTxnUtil,
   isAccountDeployed,
   estimateFeeBulk,
   getAccContractAddressAndCallData,
   addFeesFromAllTransactions,
+  isUpgradeRequired,
 } from './utils/starknetUtils';
 import { ApiParams, ExecuteTxnRequestParams } from './types/snapApi';
 import { createAccount } from './createAccount';
 import { DialogType } from '@metamask/rpc-methods';
 import { heading, panel, divider } from '@metamask/snaps-sdk';
 import { logger } from './utils/logger';
-import { PROXY_CONTRACT_HASH } from './utils/constants';
+import { ACCOUNT_CLASS_HASH } from './utils/constants';
 
 export async function executeTxn(params: ApiParams) {
   try {
@@ -27,18 +28,23 @@ export async function executeTxn(params: ApiParams) {
       addressIndex,
     } = await getKeysFromAddress(keyDeriver, network, state, senderAddress);
 
+    if (await isUpgradeRequired(network, senderAddress)) {
+      await showUpgradeRequestModal(wallet);
+      throw new Error('Upgrade required');
+    }
+
     const txnInvocationArray = Array.isArray(requestParamsObj.txnInvocation)
       ? requestParamsObj.txnInvocation
       : [requestParamsObj.txnInvocation];
     const bulkTransactions: Invocations = txnInvocationArray.map((ele) => ({
       type: TransactionType.INVOKE,
       payload: ele,
     }));
-    const accountDeployed = await isAccountDeployed(network, publicKey);
+    const accountDeployed = await isAccountDeployed(network, senderAddress);
     if (!accountDeployed) {
       const { callData } = getAccContractAddressAndCallData(publicKey);
       const deployAccountpayload = {
-        classHash: PROXY_CONTRACT_HASH,
+        classHash: ACCOUNT_CLASS_HASH,
         contractAddress: senderAddress,
         constructorCalldata: callData,
         addressSalt: publicKey,

packages/starknet-snap/src/signDeclareTransaction.ts

@@ -1,8 +1,12 @@
 import { toJson } from './utils/serializer';
 import { Signature } from 'starknet';
 import { ApiParams, SignDeclareTransactionRequestParams } from './types/snapApi';
-import { getKeysFromAddress, signDeclareTransaction as signDeclareTransactionUtil } from './utils/starknetUtils';
-import { getNetworkFromChainId, getSignTxnTxt } from './utils/snapUtils';
+import {
+  getKeysFromAddress,
+  signDeclareTransaction as signDeclareTransactionUtil,
+  isUpgradeRequired,
+} from './utils/starknetUtils';
+import { getNetworkFromChainId, getSignTxnTxt, showUpgradeRequestModal } from './utils/snapUtils';
 import { DialogType } from '@metamask/rpc-methods';
 import { heading, panel } from '@metamask/snaps-sdk';
 import { logger } from './utils/logger';
@@ -15,6 +19,11 @@ export async function signDeclareTransaction(params: ApiParams): Promise<Signatu
     const network = getNetworkFromChainId(state, requestParamsObj.chainId);
     const { privateKey } = await getKeysFromAddress(keyDeriver, network, state, signerAddress);
 
+    if (await isUpgradeRequired(network, signerAddress)) {
+      await showUpgradeRequestModal(wallet);
+      throw new Error('Upgrade required');
+    }
+
     logger.log(`signDeclareTransaction params: ${toJson(requestParamsObj.transaction, 2)}}`);
 
     const snapComponents = getSignTxnTxt(signerAddress, network, requestParamsObj.transaction);

packages/starknet-snap/src/signDeployAccountTransaction.ts

@@ -4,8 +4,9 @@ import { ApiParams, SignDeployAccountTransactionRequestParams } from './types/sn
 import {
   getKeysFromAddress,
   signDeployAccountTransaction as signDeployAccountTransactionUtil,
+  isUpgradeRequired,
 } from './utils/starknetUtils';
-import { getNetworkFromChainId, getSignTxnTxt } from './utils/snapUtils';
+import { getNetworkFromChainId, getSignTxnTxt, showUpgradeRequestModal } from './utils/snapUtils';
 import { DialogType } from '@metamask/rpc-methods';
 import { heading, panel } from '@metamask/snaps-sdk';
 import { logger } from '../src/utils/logger';
@@ -18,6 +19,11 @@ export async function signDeployAccountTransaction(params: ApiParams): Promise<S
     const network = getNetworkFromChainId(state, requestParamsObj.chainId);
     const { privateKey } = await getKeysFromAddress(keyDeriver, network, state, signerAddress);
 
+    if (await isUpgradeRequired(network, signerAddress)) {
+      await showUpgradeRequestModal(wallet);
+      throw new Error('Upgrade required');
+    }
+
     logger.log(`signDeployAccountTransaction params: ${toJson(requestParamsObj.transaction, 2)}}`);
 
     const snapComponents = getSignTxnTxt(signerAddress, network, requestParamsObj.transaction);

packages/starknet-snap/src/signMessage.ts

@@ -1,8 +1,12 @@
 import { toJson } from './utils/serializer';
-import { signMessage as signMessageUtil, getKeysFromAddress, isUpgradeRequired } from './utils/starknetUtils';
-import { getNetworkFromChainId, addDialogTxt } from './utils/snapUtils';
+import {
+  signMessage as signMessageUtil,
+  getKeysFromAddress,
+  isUpgradeRequired,
+  validateAndParseAddress,
+} from './utils/starknetUtils';
+import { getNetworkFromChainId, addDialogTxt, showUpgradeRequestModal } from './utils/snapUtils';
 import { ApiParams, SignMessageRequestParams } from './types/snapApi';
-import { validateAndParseAddress } from '../src/utils/starknetUtils';
 import { DialogType } from '@metamask/rpc-methods';
 import { heading, panel } from '@metamask/snaps-sdk';
 import { logger } from './utils/logger';
@@ -15,6 +19,11 @@ export async function signMessage(params: ApiParams) {
     const typedDataMessage = requestParamsObj.typedDataMessage;
     const network = getNetworkFromChainId(state, requestParamsObj.chainId);
 
+    if (await isUpgradeRequired(network, signerAddress)) {
+      await showUpgradeRequestModal(wallet);
+      throw new Error('Upgrade required');
+    }
+
     logger.log(`signMessage:\nsignerAddress: ${signerAddress}\ntypedDataMessage: ${toJson(typedDataMessage)}`);
 
     if (!signerAddress) {

packages/starknet-snap/src/signTransaction.ts

@@ -1,8 +1,8 @@
 import { toJson } from './utils/serializer';
 import { Signature } from 'starknet';
 import { ApiParams, SignTransactionRequestParams } from './types/snapApi';
-import { getKeysFromAddress, signTransactions } from './utils/starknetUtils';
-import { getNetworkFromChainId, getSignTxnTxt } from './utils/snapUtils';
+import { getKeysFromAddress, signTransactions, isUpgradeRequired } from './utils/starknetUtils';
+import { getNetworkFromChainId, getSignTxnTxt, showUpgradeRequestModal } from './utils/snapUtils';
 import { DialogType } from '@metamask/rpc-methods';
 import { heading, panel } from '@metamask/snaps-sdk';
 import { logger } from '../src/utils/logger';
@@ -15,6 +15,11 @@ export async function signTransaction(params: ApiParams): Promise<Signature | bo
     const network = getNetworkFromChainId(state, requestParamsObj.chainId);
     const { privateKey } = await getKeysFromAddress(keyDeriver, network, state, signerAddress);
 
+    if (await isUpgradeRequired(network, signerAddress)) {
+      await showUpgradeRequestModal(wallet);
+      throw new Error('Upgrade required');
+    }
+
     logger.log(`signTransaction params: ${toJson(requestParamsObj.transactions, 2)}}`);
 
     const snapComponents = getSignTxnTxt(signerAddress, network, requestParamsObj.transactions);

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

@@ -11,7 +11,7 @@ import {
   constants,
 } from 'starknet';
 import { validateAndParseAddress } from './starknetUtils';
-import { Component, text, copyable } from '@metamask/snaps-sdk';
+import { Component, text, copyable, panel, heading } from '@metamask/snaps-sdk';
 import {
   Network,
   Erc20Token,
@@ -42,6 +42,7 @@ import {
   ChainIdFilter,
 } from './transaction/filter';
 import { logger } from './logger';
+import { DialogType } from '@metamask/rpc-methods';
 
 function hasOnlyAsciiChars(str: string) {
   return /^[ -~]+$/.test(str);
@@ -757,3 +758,18 @@ export function dappUrl(envt: string) {
       return DAPP.prod;
   }
 }
+
+export async function showUpgradeRequestModal(wallet) {
+  await wallet.request({
+    method: 'snap_dialog',
+    params: {
+      type: DialogType.Alert,
+      content: panel([
+        heading('Account Upgrade Mandatory!'),
+        text(
+          `Visit the [companion dapp for Starknet](${dappUrl(process.env.SNAP_ENV)}) and click “Upgrade”.\nThank you!`,
+        ),
+      ]),
+    },
+  });
+}

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

@@ -3,6 +3,7 @@ import sinon from 'sinon';
 import sinonChai from 'sinon-chai';
 import { WalletMock } from '../wallet.mock.test';
 import * as utils from '../../src/utils/starknetUtils';
+import * as snapsUtil from '../../src/utils/snapUtils';
 import { declareContract } from '../../src/declareContract';
 import { SnapState } from '../../src/types/snapState';
 import { STARKNET_MAINNET_NETWORK, STARKNET_SEPOLIA_TESTNET_NETWORK } from '../../src/utils/constants';
@@ -55,7 +56,23 @@ describe('Test function: declareContract', function () {
     sandbox.restore();
   });
 
+  it('should 1) throw an error and 2) show upgrade modal if account deployed required', async function () {
+    const isUpgradeRequiredStub = sandbox.stub(utils, 'isUpgradeRequired').resolves(true);
+    const showUpgradeRequestModalStub = sandbox.stub(snapsUtil, 'showUpgradeRequestModal').resolves();
+    let result;
+    try {
+      result = await declareContract(apiParams);
+    } catch (err) {
+      result = err;
+    } finally {
+      expect(isUpgradeRequiredStub).to.have.been.calledOnceWith(STARKNET_SEPOLIA_TESTNET_NETWORK, account1.address);
+      expect(showUpgradeRequestModalStub).to.have.been.calledOnce;
+      expect(result).to.be.an('Error');
+    }
+  });
+
   it('should declareContract correctly', async function () {
+    sandbox.stub(utils, 'isUpgradeRequired').resolves(false);
     const declareContractStub = sandbox.stub(utils, 'declareContract').resolves({
       transaction_hash: 'transaction_hash',
       class_hash: 'class_hash',
@@ -83,6 +100,7 @@ describe('Test function: declareContract', function () {
   });
 
   it('should throw error if declareContract fail', async function () {
+    sandbox.stub(utils, 'isUpgradeRequired').resolves(false);
     const declareContractStub = sandbox.stub(utils, 'declareContract').rejects('error');
     const { privateKey } = await utils.getKeysFromAddress(
       apiParams.keyDeriver,
@@ -109,6 +127,7 @@ describe('Test function: declareContract', function () {
   });
 
   it('should return false if user rejected to sign the transaction', async function () {
+    sandbox.stub(utils, 'isUpgradeRequired').resolves(false);
     walletStub.rpcStubs.snap_dialog.resolves(false);
     const declareContractStub = sandbox.stub(utils, 'declareContract').resolves({
       transaction_hash: 'transaction_hash',

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

@@ -14,6 +14,7 @@ import {
   estimateFeeResp,
 } from '../constants.test';
 import * as createAccountUtils from '../../src/createAccount';
+import * as snapsUtil from '../../src/utils/snapUtils';
 import { getAddressKeyDeriver } from '../../src/utils/keyPair';
 import { Mutex } from 'async-mutex';
 import { ApiParams, ExecuteTxnRequestParams } from '../../src/types/snapApi';
@@ -79,7 +80,23 @@ describe('Test function: executeTxn', function () {
     apiParams.requestParams = requestObject;
   });
 
+  it('should 1) throw an error and 2) show upgrade modal if account deployed required', async function () {
+    const isUpgradeRequiredStub = sandbox.stub(utils, 'isUpgradeRequired').resolves(true);
+    const showUpgradeRequestModalStub = sandbox.stub(snapsUtil, 'showUpgradeRequestModal').resolves();
+    let result;
+    try {
+      result = await executeTxn(apiParams);
+    } catch (err) {
+      result = err;
+    } finally {
+      expect(isUpgradeRequiredStub).to.have.been.calledOnceWith(STARKNET_MAINNET_NETWORK, account1.address);
+      expect(showUpgradeRequestModalStub).to.have.been.calledOnce;
+      expect(result).to.be.an('Error');
+    }
+  });
+
   it('should executeTxn correctly and deploy an account', async function () {
+    sandbox.stub(utils, 'isUpgradeRequired').resolves(false);
     sandbox.stub(utils, 'isAccountDeployed').resolves(false);
     const createAccountStub = sandbox.stub(createAccountUtils, 'createAccount').resolvesThis();
     const stub = sandbox.stub(utils, 'executeTxn').resolves({
@@ -111,6 +128,7 @@ describe('Test function: executeTxn', function () {
   });
 
   it('should executeTxn multiple and deploy an account', async function () {
+    sandbox.stub(utils, 'isUpgradeRequired').resolves(false);
     sandbox.stub(utils, 'isAccountDeployed').resolves(false);
     const createAccountStub = sandbox.stub(createAccountUtils, 'createAccount').resolvesThis();
     const stub = sandbox.stub(utils, 'executeTxn').resolves({
@@ -171,6 +189,7 @@ describe('Test function: executeTxn', function () {
 
   it('should executeTxn and not deploy an account', async function () {
     const createAccountStub = sandbox.stub(createAccountUtils, 'createAccount');
+    sandbox.stub(utils, 'isUpgradeRequired').resolves(false);
     sandbox.stub(utils, 'isAccountDeployed').resolves(true);
     const stub = sandbox.stub(utils, 'executeTxn').resolves({
       transaction_hash: 'transaction_hash',
@@ -204,6 +223,7 @@ describe('Test function: executeTxn', function () {
 
   it('should executeTxn multiple and not deploy an account', async function () {
     const createAccountStub = sandbox.stub(createAccountUtils, 'createAccount');
+    sandbox.stub(utils, 'isUpgradeRequired').resolves(false);
     sandbox.stub(utils, 'isAccountDeployed').resolves(true);
     const stub = sandbox.stub(utils, 'executeTxn').resolves({
       transaction_hash: 'transaction_hash',
@@ -262,6 +282,7 @@ describe('Test function: executeTxn', function () {
   });
 
   it('should throw error if executeTxn fail', async function () {
+    sandbox.stub(utils, 'isUpgradeRequired').resolves(false);
     sandbox.stub(utils, 'isAccountDeployed').resolves(true);
     const stub = sandbox.stub(utils, 'executeTxn').rejects('error');
     const { privateKey } = await utils.getKeysFromAddress(
@@ -295,6 +316,7 @@ describe('Test function: executeTxn', function () {
 
   it('should return false if user rejected to sign the transaction', async function () {
     sandbox.stub(utils, 'isAccountDeployed').resolves(true);
+    sandbox.stub(utils, 'isUpgradeRequired').resolves(false);
     walletStub.rpcStubs.snap_dialog.resolves(false);
     const stub = sandbox.stub(utils, 'executeTxn').resolves({
       transaction_hash: 'transaction_hash',