From 086c8e8712c5cf698b8bfa43190ab4dd92749d78 Mon Sep 17 00:00:00 2001 From: Florin Dzeladini Date: Mon, 27 Jan 2025 07:26:06 +0100 Subject: [PATCH 1/2] chore: update docs --- docs/tutorial-resolving-stuck-funds.md | 89 +++++++++++++++++++------- 1 file changed, 67 insertions(+), 22 deletions(-) diff --git a/docs/tutorial-resolving-stuck-funds.md b/docs/tutorial-resolving-stuck-funds.md index d3c9c172..41f37772 100644 --- a/docs/tutorial-resolving-stuck-funds.md +++ b/docs/tutorial-resolving-stuck-funds.md @@ -1,33 +1,78 @@ -# Tutorial: Resolving Stuck Funds Using the Old StarkNet Snap +# Tutorial: Resolving Stuck Funds Using the New StarkNet Snap Environment -If your funds are currently stuck, follow these steps to resolve the issue by reverting to an older version of the StarkNet Snap. +If your funds are stuck on a non-deployed Cairo 0 or Cairo 1 account, follow the steps below to resolve the issue. -## Step 1: Uninstall the Current StarkNet Snap +--- + +## Preamble: Uninstall the Current StarkNet Snap 1. Open your wallet application. 2. Navigate to the installed Snaps section. 3. Find the StarkNet Snap and select it. 4. Click on “Uninstall” or “Remove” to uninstall the StarkNet Snap. -## Step 2: Access the Dev StarkNet Snap Website to Install the Old StarkNet Snap -1. Go to the dev environment here: [https://staging.snaps.consensys.io/starknet](https://staging.snaps.consensys.io/starknet) -2. On the dev website, connect your MetaMask. -3. Follow the instructions to install the older version of the StarkNet Snap. - -## Step 3: Deploy Your Cairo 0 Account by Initiating a Transaction -1. From the website, you should now see your Cairo 0 non-deployed address. -2. Fund your account with a little bit of ETH. -3. Initiate the first transaction (sending token to another address). This will automatically deploy your Cairo 0 account by following the on-screen instructions provided by the Snap. -4. Make sure to confirm and authorize the transaction in your wallet. - -## Step 4: Transfer Funds Back to Your Cairo 1 Address -1. Once your Cairo 0 account is deployed, you should be able to act on your funds. -2. Transfer all your funds from the Cairo 0 address to your Cairo 1 address. -3. Ensure you enter the correct Cairo 1 address to avoid any loss of funds. +--- + +## Part 1: Resolving Funds Stuck on a Non-Deployed Cairo 0 Account + +### Step 1: Use the Link to Force Cairo 0 Deployment +1. Open your browser and go to the following URL: + [Force Cairo 0 Deployment](https://staging.snaps.consensys.io/starknet?accountDiscovery=FORCE_CAIRO_0) +2. Connect your MetaMask wallet when prompted. +3. Follow the instructions to install a special version of the StarkNet Snap. + +### Step 2: Fund the Cairo 0 Account and Deploy It +1. Fund your Cairo 0 account with a small amount of ETH. +2. Reload the page after funding the account. +3. A pop-up will appear prompting you to **deploy your Cairo 0 account**. + - Follow the on-screen instructions to deploy the account. + - Confirm and authorize the transaction in your wallet. + +### Step 3: Upgrade the Cairo 0 Account +1. Once the Cairo 0 account is deployed, another pop-up will appear prompting you to **upgrade the account**. + - Follow the on-screen instructions to upgrade your account. + - Confirm and authorize the transaction in your wallet. +2. After the upgrade, your Cairo 0 account will be fully functional, and you will be able to send funds. + +### Step 4: Transfer Funds to Your Cairo 1 Account +1. Once your Cairo 0 account is functional, check your balance to confirm the funds are available. +2. Transfer all funds from the Cairo 0 account to your Cairo 1 account. + - Ensure you use the correct Cairo 1 address to avoid any loss of funds. +3. Confirm and authorize the transaction in your wallet. + +--- + +## Part 2: Resolving Funds Stuck on a Non-Deployed Cairo 1 Account + +### Step 1: Use the Link to Force Cairo 1 Deployment +1. Open your browser and go to the following URL: + [Force Cairo 1 Deployment](https://staging.snaps.consensys.io/starknet?accountDiscovery=FORCE_CAIRO_1) +2. Connect your MetaMask wallet when prompted. +3. Follow the instructions to install a special version of the StarkNet Snap. + +### Step 2: Deploy the Cairo 1 Account by Initiating a Transaction +1. Once connected, fund your Cairo 1 account with a small amount of ETH (if not already funded). +2. Initiate any transaction (e.g., sending tokens) from the Cairo 1 account. +3. This transaction will automatically deploy the Cairo 1 account. 4. Confirm and authorize the transaction in your wallet. -## Step 5: Update to the Latest StarkNet Snap -1. Go to the official StarkNet Snap installation website: [snaps.consensys.io/starknet](https://snaps.consensys.io/starknet) -2. Connect your wallet and follow the instructions to update back to the latest version. +### Step 3: Transfer Funds from Cairo 0 to Cairo 1 +1. Once your Cairo 1 account is deployed, return to the link for [Force Cairo 0 Deployment](https://staging.snaps.consensys.io/starknet?accountDiscovery=FORCE_CAIRO_0) to view your Cairo 0 account. +2. Transfer all funds from the Cairo 0 account to the deployed Cairo 1 account. + - Ensure you enter the correct Cairo 1 address to avoid any loss of funds. +3. Confirm and authorize the transaction in your wallet. + +--- + +## Final Step: Install the Production StarkNet Snap +1. Uninstall the special StarkNet Snap version by: + - Opening your wallet application. + - Navigating to the installed Snaps section. + - Finding the special StarkNet Snap and selecting "Uninstall" or "Remove." +2. Install the production version of the StarkNet Snap from the official website: + [Production StarkNet Snap](https://snaps.consensys.io/starknet) +3. Connect your wallet and follow the on-screen instructions to complete the installation. +4. Once installed, check your wallet to ensure the deployed Cairo 1 address is visible and active. -By following these steps, you should be able to resolve the issue with your stuck funds. If you encounter any issues during this process, please contact support for further assistance. +--- +By following these steps, you should be able to resolve the issue with your stuck funds. If you encounter any issues during this process, please contact support for assistance. \ No newline at end of file From a91d68df629b29ffaec2e522ecf00888ecb34464 Mon Sep 17 00:00:00 2001 From: Florin Dzeladini Date: Wed, 29 Jan 2025 12:05:31 +0100 Subject: [PATCH 2/2] chore: fix comments --- docs/tutorial-resolving-stuck-funds.md | 63 +++++++++++++++----------- 1 file changed, 37 insertions(+), 26 deletions(-) diff --git a/docs/tutorial-resolving-stuck-funds.md b/docs/tutorial-resolving-stuck-funds.md index 41f37772..892fcc6f 100644 --- a/docs/tutorial-resolving-stuck-funds.md +++ b/docs/tutorial-resolving-stuck-funds.md @@ -1,78 +1,89 @@ # Tutorial: Resolving Stuck Funds Using the New StarkNet Snap Environment -If your funds are stuck on a non-deployed Cairo 0 or Cairo 1 account, follow the steps below to resolve the issue. +If your funds are stuck on a non-deployed Cairo 0 or Cairo 1 account, follow the appropriate guide below to resolve the issue. ---- +## Scenario 1: Resolving Funds Stuck on a Non-Deployed Cairo 0 Account -## Preamble: Uninstall the Current StarkNet Snap -1. Open your wallet application. +## Step 1: Uninstall the Current StarkNet Snap +1. Open your MetaMask wallet extension in the browser. 2. Navigate to the installed Snaps section. 3. Find the StarkNet Snap and select it. -4. Click on “Uninstall” or “Remove” to uninstall the StarkNet Snap. - ---- +4. Click on “Remove” to uninstall the StarkNet Snap. -## Part 1: Resolving Funds Stuck on a Non-Deployed Cairo 0 Account -### Step 1: Use the Link to Force Cairo 0 Deployment +### Step 2: Use the Link to Force Cairo 0 Deployment 1. Open your browser and go to the following URL: [Force Cairo 0 Deployment](https://staging.snaps.consensys.io/starknet?accountDiscovery=FORCE_CAIRO_0) 2. Connect your MetaMask wallet when prompted. -3. Follow the instructions to install a special version of the StarkNet Snap. +3. Follow the instructions to install a special version of the StarkNet Snap (`3.1.0-staging`). -### Step 2: Fund the Cairo 0 Account and Deploy It +### Step 3: Fund the Cairo 0 Account and Deploy It 1. Fund your Cairo 0 account with a small amount of ETH. -2. Reload the page after funding the account. +2. Reload the page after funding the account (e.g. using the F5 key) 3. A pop-up will appear prompting you to **deploy your Cairo 0 account**. - Follow the on-screen instructions to deploy the account. - Confirm and authorize the transaction in your wallet. -### Step 3: Upgrade the Cairo 0 Account +### Step 4: Upgrade the Cairo 0 Account 1. Once the Cairo 0 account is deployed, another pop-up will appear prompting you to **upgrade the account**. - Follow the on-screen instructions to upgrade your account. - Confirm and authorize the transaction in your wallet. 2. After the upgrade, your Cairo 0 account will be fully functional, and you will be able to send funds. -### Step 4: Transfer Funds to Your Cairo 1 Account +### Step 5: Transfer Funds to Your Cairo 1 Account 1. Once your Cairo 0 account is functional, check your balance to confirm the funds are available. 2. Transfer all funds from the Cairo 0 account to your Cairo 1 account. - - Ensure you use the correct Cairo 1 address to avoid any loss of funds. + - Ensure you use the correct Cairo 1 address to avoid any loss of funds. In case you don't know your Cairo 1 account address you can get it from here [Force Cairo 1 Deployment](https://staging.snaps.consensys.io/starknet?accountDiscovery=FORCE_CAIRO_1). 3. Confirm and authorize the transaction in your wallet. +## Step 6: Install the Production StarkNet Snap +1. Uninstall the special StarkNet Snap version by: + - Opening your wallet application. + - Navigating to the installed Snaps section. + - Finding the special StarkNet Snap and selecting "Remove". +2. Install the production version of the StarkNet Snap from the official website: + [Production StarkNet Snap](https://snaps.consensys.io/starknet) +3. Connect your wallet and follow the on-screen instructions to complete the installation. +4. Once installed, check your wallet to ensure the deployed Cairo 1 address is visible and active. + + --- -## Part 2: Resolving Funds Stuck on a Non-Deployed Cairo 1 Account +## Scenario 2: Resolving Funds Stuck on a Non-Deployed Cairo 1 Account -### Step 1: Use the Link to Force Cairo 1 Deployment +## Step 1: Uninstall the Current StarkNet Snap +1. Open your MetaMask wallet extension in the browser. +2. Navigate to the installed Snaps section. +3. Find the StarkNet Snap and select it. +4. Click on “Remove” to uninstall the StarkNet Snap. + +### Step 2: Use the Link to Force Cairo 1 Deployment 1. Open your browser and go to the following URL: [Force Cairo 1 Deployment](https://staging.snaps.consensys.io/starknet?accountDiscovery=FORCE_CAIRO_1) 2. Connect your MetaMask wallet when prompted. -3. Follow the instructions to install a special version of the StarkNet Snap. +3. Follow the instructions to install a special version of the StarkNet Snap (`3.1.0-staging`). -### Step 2: Deploy the Cairo 1 Account by Initiating a Transaction +### Step 3: Deploy the Cairo 1 Account by Initiating a Transaction 1. Once connected, fund your Cairo 1 account with a small amount of ETH (if not already funded). 2. Initiate any transaction (e.g., sending tokens) from the Cairo 1 account. 3. This transaction will automatically deploy the Cairo 1 account. 4. Confirm and authorize the transaction in your wallet. -### Step 3: Transfer Funds from Cairo 0 to Cairo 1 -1. Once your Cairo 1 account is deployed, return to the link for [Force Cairo 0 Deployment](https://staging.snaps.consensys.io/starknet?accountDiscovery=FORCE_CAIRO_0) to view your Cairo 0 account. +### Step 4: Transfer Funds from Cairo 0 to Cairo 1 +1. Once your Cairo 1 account is deployed copy your Cairo 1 address and return to the link for [Force Cairo 0 Deployment](https://staging.snaps.consensys.io/starknet?accountDiscovery=FORCE_CAIRO_0) to view your Cairo 0 account. 2. Transfer all funds from the Cairo 0 account to the deployed Cairo 1 account. - Ensure you enter the correct Cairo 1 address to avoid any loss of funds. 3. Confirm and authorize the transaction in your wallet. ---- - -## Final Step: Install the Production StarkNet Snap +## Step 5: Install the Production StarkNet Snap 1. Uninstall the special StarkNet Snap version by: - Opening your wallet application. - Navigating to the installed Snaps section. - - Finding the special StarkNet Snap and selecting "Uninstall" or "Remove." + - Finding the special StarkNet Snap and selecting "Remove". 2. Install the production version of the StarkNet Snap from the official website: [Production StarkNet Snap](https://snaps.consensys.io/starknet) 3. Connect your wallet and follow the on-screen instructions to complete the installation. 4. Once installed, check your wallet to ensure the deployed Cairo 1 address is visible and active. ---- By following these steps, you should be able to resolve the issue with your stuck funds. If you encounter any issues during this process, please contact support for assistance. \ No newline at end of file