Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update docs for funds recovery #498

Merged
merged 3 commits into from
Jan 31, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 67 additions & 22 deletions docs/tutorial-resolving-stuck-funds.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,78 @@
# Tutorial: Resolving Stuck Funds Using the Old StarkNet Snap
# Tutorial: Resolving Stuck Funds Using the New StarkNet Snap Environment

khanti42 marked this conversation as resolved.
Show resolved Hide resolved
khanti42 marked this conversation as resolved.
Show resolved Hide resolved
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.
khanti42 marked this conversation as resolved.
Show resolved Hide resolved
2. Navigate to the installed Snaps section.
khanti42 marked this conversation as resolved.
Show resolved Hide resolved
3. Find the StarkNet Snap and select it.
4. Click on “Uninstall” or “Remove” to uninstall the StarkNet Snap.

khanti42 marked this conversation as resolved.
Show resolved Hide resolved
## 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

khanti42 marked this conversation as resolved.
Show resolved Hide resolved
### 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.

khanti42 marked this conversation as resolved.
Show resolved Hide resolved
### 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**.
khanti42 marked this conversation as resolved.
Show resolved Hide resolved
- 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.
khanti42 marked this conversation as resolved.
Show resolved Hide resolved
3. Confirm and authorize the transaction in your wallet.

---

## Part 2: Resolving Funds Stuck on a Non-Deployed Cairo 1 Account

khanti42 marked this conversation as resolved.
Show resolved Hide resolved
### 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.

khanti42 marked this conversation as resolved.
Show resolved Hide resolved
### 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.
khanti42 marked this conversation as resolved.
Show resolved Hide resolved
- 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:
khanti42 marked this conversation as resolved.
Show resolved Hide resolved
- 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:
khanti42 marked this conversation as resolved.
Show resolved Hide resolved
[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.
Loading