feat: cairo 1 support

packages/starknet-snap/index.html

@@ -359,6 +359,15 @@ <h1>Hello, Snaps!</h1>
         <input type="submit" id="estimateFees" value="Estimate Fees" />
       </fieldset>
     </form>
+    <form id="upgrade">
+      <fieldset>
+        <legend>Upgrade Cairo Version from 0 to 1</legend>
+        <label for="upgrade_contractAddress">Contract Address</label>
+        <input type="text" id="upgrade_contractAddress" name="upgrade_contractAddress" /><br />
+        <input type="submit" id="upgrade" value="Upgrade" />
+      </fieldset>
+    </form>
+
   </body>
 
   <script type="module">
@@ -479,6 +488,10 @@ <h1>Hello, Snaps!</h1>
         id: 'estimateFees',
         method: estimateFees,
       },
+      {
+        id: 'upgrade',
+        method: upgrade,
+      },
     ];
 
     for (const form of formWithSubmit) {
@@ -876,6 +889,16 @@ <h1>Hello, Snaps!</h1>
       });
     }
 
+    async function upgrade(e) {
+      e.preventDefault(); // to prevent default form behavior
+
+      const contractAddress = document.getElementById('upgrade_contractAddress').value;
+
+      await callSnap('starkNet_upgradeAccContract', {
+        contractAddress
+      });
+    }
+
     async function callSnap(method, params) {
       try {
         const chainId = document.getElementById('targetChainId').value;
@@ -901,5 +924,8 @@ <h1>Hello, Snaps!</h1>
         alert(`${method} problem happened: ${err.message || err}`);
       }
     }
+
   </script>
+
+
 </html>

packages/starknet-snap/openrpc/starknet_snap_api_openrpc.json

@@ -367,6 +367,49 @@
       },
       "errors": []
     },
+    {
+      "name": "starkNet_upgradeAccContract",
+      "summary": "Upgrade Account Contract",
+      "paramStructure": "by-name",
+      "params": [
+        {
+          "name": "contractAddress",
+          "summary": "Address of the target contract",
+          "description": "Address of the target contract",
+          "required": true,
+          "schema": {
+            "$ref": "#/components/schemas/ADDRESS"
+          }
+        },
+        {
+          "name": "maxFee",
+          "summary": "Maximum gas fee allowed from the sender",
+          "description": "Maximum gas fee allowed from the sender (if not given, the max fee will be automatically calculated)",
+          "required": false,
+          "schema": {
+            "$ref": "#/components/schemas/NUM_AS_HEX"
+          }
+        },
+        {
+          "name": "chainId",
+          "summary": "Id of the target Starknet network",
+          "description": "Id of the target Starknet network (default to Starknet Goerli Testnet)",
+          "required": false,
+          "schema": {
+            "$ref": "#/components/schemas/CHAIN_ID"
+          }
+        }
+      ],
+      "result": {
+        "name": "result",
+        "summary": "Response from Starknet’s \"gateway/call_contract\" endpoint",
+        "description": "Response from Starknet’s \"gateway/call_contract\" endpoint",
+        "schema": {
+          "$ref": "#/components/schemas/SEND_TRANSACTION_RESULT"
+        }
+      },
+      "errors": []
+    },
     {
       "name": "starkNet_getTransactionStatus",
       "summary": "Gets the status of a transaction",

packages/starknet-snap/package.json

@@ -24,6 +24,7 @@
     "lint:fix": "eslint '**/*.{js,ts,tsx}' --fix",
     "test": "yarn run test:unit && yarn run cover:report",
     "test:unit": "nyc --check-coverage --statements 80 --branches 80 --functions 80 --lines 80 mocha --colors -r ts-node/register \"test/**/*.test.ts\"",
+    "test:unit:one": "nyc --check-coverage --statements 80 --branches 80 --functions 80 --lines 80 mocha --colors -r ts-node/register",
     "cover:report": "nyc report --reporter=lcov --reporter=text"
   },
   "keywords": [],

packages/starknet-snap/snap.manifest.json

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

packages/starknet-snap/src/createAccount.ts

@@ -3,9 +3,9 @@ import {
   getKeysFromAddressIndex,
   getAccContractAddressAndCallData,
   deployAccount,
-  callContract,
+  getBalance,
   estimateAccountDeployFee,
-  getSigner,
+  isAccountDeployed,
   waitForTransaction,
 } from './utils/starknetUtils';
 import {
@@ -53,8 +53,6 @@ export async function createAccount(params: ApiParams, silentMode = false, waitM
 
     let failureReason = '';
     let estimateDeployFee: EstimateFee;
-    let signerAssigned = true;
-    let signer = '';
 
     if (deploy) {
       if (!silentMode) {
@@ -80,24 +78,16 @@ export async function createAccount(params: ApiParams, silentMode = false, waitM
           };
       }
 
-      try {
-        signer = await getSigner(contractAddress, network);
-        logger.log(`createAccount:\ngetSigner: contractAddress = ${contractAddress}, signerPublicKey= ${signer}`);
-        failureReason = 'The account address had already been deployed';
-      } catch (err) {
-        signerAssigned = false;
-        logger.log(`createAccount:\ngetSigner: err in get signer: ${toJson(err)}`);
-      }
+      const signerAssigned = await isAccountDeployed(network, contractAddress);
 
       if (!signerAssigned) {
         try {
-          const getBalanceResp = await callContract(
-            network,
+          const balance = await getBalance(
             getEtherErc20Token(state, network.chainId)?.address,
-            'balanceOf',
-            [num.toBigInt(contractAddress).toString(10)],
+            num.toBigInt(contractAddress).toString(10),
+            network,
           );
-          logger.log(`createAccount:\ngetBalanceResp: ${toJson(getBalanceResp)}`);
+          logger.log(`createAccount:\ngetBalanceResp: ${balance}`);
           estimateDeployFee = await estimateAccountDeployFee(
             network,
             contractAddress,
@@ -106,7 +96,7 @@ export async function createAccount(params: ApiParams, silentMode = false, waitM
             privateKey,
           );
           logger.log(`createAccount:\nestimateDeployFee: ${toJson(estimateDeployFee)}`);
-          if (Number(getBalanceResp[0]) < Number(estimateDeployFee.suggestedMaxFee)) {
+          if (Number(balance) < Number(estimateDeployFee.suggestedMaxFee)) {
             const gasFeeStr = ethers.utils.formatUnits(estimateDeployFee.suggestedMaxFee.toString(10), 18);
             const gasFeeFloat = parseFloat(gasFeeStr).toFixed(6); // 6 decimal places for ether
             const gasFeeInEther = Number(gasFeeFloat) === 0 ? '0.000001' : gasFeeFloat;
@@ -118,9 +108,17 @@ export async function createAccount(params: ApiParams, silentMode = false, waitM
         }
       }
 
-      const deployResp = await deployAccount(network, contractAddress, contractCallData, publicKey, privateKey, {
-        maxFee: estimateDeployFee?.suggestedMaxFee,
-      });
+      const deployResp = await deployAccount(
+        network,
+        contractAddress,
+        contractCallData,
+        publicKey,
+        privateKey,
+        undefined,
+        {
+          maxFee: estimateDeployFee?.suggestedMaxFee,
+        },
+      );
 
       if (deployResp.contract_address && deployResp.transaction_hash) {
         const userAccount: AccContract = {

packages/starknet-snap/src/estimateFee.ts

@@ -11,17 +11,22 @@ import {
   estimateFeeBulk,
   addFeesFromAllTransactions,
   isAccountDeployed,
+  isUpgradeRequired,
 } from './utils/starknetUtils';
-
-import { PROXY_CONTRACT_HASH } from './utils/constants';
+import { ACCOUNT_CLASS_HASH } from './utils/constants';
 import { logger } from './utils/logger';
 
 export async function estimateFee(params: ApiParams) {
   try {
     const { state, keyDeriver, requestParams } = params;
     const requestParamsObj = requestParams as EstimateFeeRequestParams;
+    const contractAddress = requestParamsObj.contractAddress;
+    const contractFuncName = requestParamsObj.contractFuncName;
+    const contractCallData = getCallDataArray(requestParamsObj.contractCallData);
+    const senderAddress = requestParamsObj.senderAddress;
+    const network = getNetworkFromChainId(state, requestParamsObj.chainId);
 
-    if (!requestParamsObj.contractAddress || !requestParamsObj.senderAddress || !requestParamsObj.contractFuncName) {
+    if (!contractAddress || !requestParamsObj.senderAddress || !contractFuncName) {
       throw new Error(
         `The given contract address, sender address, and function name need to be non-empty string, got: ${toJson(
           requestParamsObj,
@@ -30,21 +35,20 @@ export async function estimateFee(params: ApiParams) {
     }
 
     try {
-      validateAndParseAddress(requestParamsObj.contractAddress);
+      validateAndParseAddress(contractAddress);
     } catch (err) {
-      throw new Error(`The given contract address is invalid: ${requestParamsObj.contractAddress}`);
+      throw new Error(`The given contract address is invalid: ${contractAddress}`);
     }
     try {
-      validateAndParseAddress(requestParamsObj.senderAddress);
+      validateAndParseAddress(senderAddress);
     } catch (err) {
-      throw new Error(`The given sender address is invalid: ${requestParamsObj.senderAddress}`);
+      throw new Error(`The given sender address is invalid: ${senderAddress}`);
+    }
+
+    if (await isUpgradeRequired(network, senderAddress)) {
+      throw new Error('Upgrade required');
     }
 
-    const contractAddress = requestParamsObj.contractAddress;
-    const contractFuncName = requestParamsObj.contractFuncName;
-    const contractCallData = getCallDataArray(requestParamsObj.contractCallData);
-    const senderAddress = requestParamsObj.senderAddress;
-    const network = getNetworkFromChainId(state, requestParamsObj.chainId);
     const { privateKey: senderPrivateKey, publicKey } = await getKeysFromAddress(
       keyDeriver,
       network,
@@ -61,7 +65,7 @@ export async function estimateFee(params: ApiParams) {
     logger.log(`estimateFee:\ntxnInvocation: ${toJson(txnInvocation)}`);
 
     //Estimate deploy account fee if the signer has not been deployed yet
-    const accountDeployed = await isAccountDeployed(network, publicKey);
+    const accountDeployed = await isAccountDeployed(network, senderAddress);
     let bulkTransactions: Invocations = [
       {
         type: TransactionType.INVOKE,
@@ -71,7 +75,7 @@ export async function estimateFee(params: ApiParams) {
     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/estimateFees.ts

@@ -20,7 +20,7 @@ export async function estimateFees(params: ApiParams) {
       senderAddress,
       senderPrivateKey,
       requestParamsObj.invocations,
-      requestParamsObj.invocationDetails ? requestParamsObj.invocationDetails : undefined,
+      requestParamsObj.invocationDetails,
     );
 
     return fees.map((fee) => ({

packages/starknet-snap/src/extractPrivateKey.ts

@@ -2,7 +2,7 @@ import { toJson } from './utils/serializer';
 import { validateAndParseAddress } from '../src/utils/starknetUtils';
 import { ApiParams, ExtractPrivateKeyRequestParams } from './types/snapApi';
 import { getNetworkFromChainId } from './utils/snapUtils';
-import { getKeysFromAddress } from './utils/starknetUtils';
+import { getKeysFromAddress, isUpgradeRequired } from './utils/starknetUtils';
 import { DialogType } from '@metamask/rpc-methods';
 import { copyable, panel, text } from '@metamask/snaps-sdk';
 import { logger } from './utils/logger';
@@ -11,17 +11,20 @@ export async function extractPrivateKey(params: ApiParams) {
   try {
     const { state, wallet, keyDeriver, requestParams } = params;
     const requestParamsObj = requestParams as ExtractPrivateKeyRequestParams;
-
-    if (!requestParamsObj.userAddress) {
-      throw new Error(
-        `The given user address need to be non-empty string, got: ${toJson(requestParamsObj.userAddress)}`,
-      );
+    const network = getNetworkFromChainId(state, requestParamsObj.chainId);
+    const userAddress = requestParamsObj.userAddress;
+    if (!userAddress) {
+      throw new Error(`The given user address need to be non-empty string, got: ${toJson(userAddress)}`);
     }
 
     try {
-      validateAndParseAddress(requestParamsObj.userAddress);
+      validateAndParseAddress(userAddress);
     } catch (err) {
-      throw new Error(`The given user address is invalid: ${requestParamsObj.userAddress}`);
+      throw new Error(`The given user address is invalid: ${userAddress}`);
+    }
+
+    if (await isUpgradeRequired(network, userAddress)) {
+      throw new Error('Upgrade required');
     }
 
     const response = await wallet.request({
@@ -33,8 +36,6 @@ export async function extractPrivateKey(params: ApiParams) {
     });
 
     if (response === true) {
-      const userAddress = requestParamsObj.userAddress;
-      const network = getNetworkFromChainId(state, requestParamsObj.chainId);
       const { privateKey: userPrivateKey } = await getKeysFromAddress(keyDeriver, network, state, userAddress);
 
       await wallet.request({

packages/starknet-snap/src/extractPublicKey.ts

@@ -1,6 +1,6 @@
 import { toJson } from './utils/serializer';
 import { constants, num } from 'starknet';
-import { validateAndParseAddress } from '../src/utils/starknetUtils';
+import { validateAndParseAddress, isUpgradeRequired } from '../src/utils/starknetUtils';
 import { ApiParams, ExtractPublicKeyRequestParams } from './types/snapApi';
 import { getAccount, getNetworkFromChainId } from './utils/snapUtils';
 import { getKeysFromAddress } from './utils/starknetUtils';
@@ -26,6 +26,10 @@ export async function extractPublicKey(params: ApiParams) {
       throw new Error(`The given user address is invalid: ${requestParamsObj.userAddress}`);
     }
 
+    if (await isUpgradeRequired(network, userAddress)) {
+      throw new Error('Upgrade required');
+    }
+
     let userPublicKey;
     const accContract = getAccount(state, userAddress, network.chainId);
     if (!accContract?.publicKey || num.toBigInt(accContract.publicKey) === constants.ZERO) {

packages/starknet-snap/src/index.ts

@@ -45,6 +45,7 @@ import { estimateFees } from './estimateFees';
 import { declareContract } from './declareContract';
 import { signDeclareTransaction } from './signDeclareTransaction';
 import { signDeployAccountTransaction } from './signDeployAccountTransaction';
+import { upgradeAccContract } from './upgradeAccContract';
 import { logger } from './utils/logger';
 import { getStarkName } from './getStarkName';
 
@@ -211,6 +212,10 @@ export const onRpcRequest: OnRpcRequestHandler = async ({ origin, request }) =>
         apiParams.keyDeriver = await getAddressKeyDeriver(snap);
         return await estimateFees(apiParams);
 
+      case 'starkNet_upgradeAccContract':
+        apiParams.keyDeriver = await getAddressKeyDeriver(snap);
+        return upgradeAccContract(apiParams);
+
       case 'starkNet_declareContract':
         apiParams.keyDeriver = await getAddressKeyDeriver(snap);
         return await declareContract(apiParams);
@@ -248,7 +253,7 @@ export const onInstall: OnInstallHandler = async () => {
 export const onUpdate: OnUpdateHandler = async () => {
   const component = panel([
     text('Features released with this update:'),
-    text('Deprecation of the Starknet Goerli Testnet'),
+    text('Cairo contract upgrade support.'),
   ]);
 
   await snap.request({