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

WIP: Starknet Snap docs #1509

Open
wants to merge 39 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
e6bd15c
rough skeleton
joaniefromtheblock Aug 28, 2024
f8c3685
update menu sidebar
joaniefromtheblock Aug 28, 2024
1130adf
Add Starknet Snap API reference docs
alexandratran Aug 31, 2024
9401571
Merge branch 'main' into wip-starknet-snap
alexandratran Sep 5, 2024
a43f196
Clean up files and placeholders
alexandratran Sep 5, 2024
c27a96d
add changes for connect
joaniefromtheblock Sep 12, 2024
6bac10a
update branch
joaniefromtheblock Sep 12, 2024
473a71d
examples added
joaniefromtheblock Sep 12, 2024
25821bb
rewrite of connect section
joaniefromtheblock Sep 14, 2024
0251bcc
rough additions of troubleshoot section
joaniefromtheblock Sep 14, 2024
3d8ef91
updates with suggestions
joaniefromtheblock Sep 18, 2024
b915696
add additional suggestions
joaniefromtheblock Sep 18, 2024
5b6e1cf
apply suggestions
joaniefromtheblock Sep 19, 2024
f2074ef
more suggestions
joaniefromtheblock Sep 19, 2024
455aaec
updates
joaniefromtheblock Sep 19, 2024
d832af8
updates
joaniefromtheblock Sep 19, 2024
df73570
Merge branch 'main' into wip-starknet-snap
alexandratran Sep 20, 2024
0e4ef69
Edit non-EVM intro and Starknet intro
alexandratran Sep 20, 2024
8e75cb8
Edit Connect to Starknet
alexandratran Sep 20, 2024
8501a8b
Edit About get-starknet
alexandratran Sep 20, 2024
baa2b16
Edit Manage Starknet accounts
alexandratran Sep 20, 2024
f6f30a2
Edit Manage networks, API reference, etc
alexandratran Sep 20, 2024
81d3bb2
add docs
joaniefromtheblock Sep 20, 2024
c5f1762
fix table
joaniefromtheblock Sep 20, 2024
333cef5
Apply suggestions from code review
joaniefromtheblock Sep 24, 2024
5786849
Apply suggestions from code review
joaniefromtheblock Sep 24, 2024
8e467fa
update troubleshoot section
joaniefromtheblock Sep 25, 2024
151e759
update troubleshoot sections
joaniefromtheblock Sep 25, 2024
a1fe114
update text for tutorial
joaniefromtheblock Sep 25, 2024
ff7df58
add dual examples
joaniefromtheblock Sep 26, 2024
faba7f4
copy edits
joaniefromtheblock Sep 26, 2024
1617eab
copy edits
joaniefromtheblock Sep 26, 2024
4a64f9b
copy edits
joaniefromtheblock Sep 26, 2024
07ad89e
Edit content for style and formatting
alexandratran Sep 26, 2024
0cadd60
Merge and edit branch 'wip-starknet-snap' of github.com:MetaMask/meta…
alexandratran Sep 26, 2024
d432e98
add template text
joaniefromtheblock Sep 26, 2024
99839e7
add note
joaniefromtheblock Sep 26, 2024
f92fdc3
Merge branch 'main' into wip-starknet-snap
joaniefromtheblock Sep 30, 2024
cc4cb52
Apply suggestions from code review
joaniefromtheblock Sep 30, 2024
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
6 changes: 6 additions & 0 deletions wallet-sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ const sidebar = {
type: "doc",
id: "reference/sdk-unity-api",
},
{
type: "category",
label: "Non-EVM APIs",
link: { type: "generated-index", slug: "/reference/non-evm-apis" },
items: [{ type: "autogenerated", dirName: "reference/non-evm-apis" }],
},
{
type: "doc",
id: "reference/provider-api",
Expand Down
4 changes: 4 additions & 0 deletions wallet/how-to/connect/access-accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ When accessing a user's accounts:
- **Always** disable the connect button while the connection request is pending.
- **Never** initiate a connection request on page load.

:::note
You can also access users' accounts on some [non-EVM networks](/wallet/how-to/use-non-evm-networks).
:::

## Create a connect button

:::caution Important
Expand Down
8 changes: 4 additions & 4 deletions wallet/how-to/manage-networks/add-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ The confirmations look like the following:
</div>
</div>

:::note

To add a local development network such as [Hardhat](https://hardhat.org) to MetaMask, see [Run a development network](../run-devnet.md).

:::info Development and non-EVM networks
- To add a local development network such as [Hardhat](https://hardhat.org) to MetaMask, see [Run a development network](../run-devnet.md).
- To add a non-EVM network such as [Starknet](../use-non-evm-networks/starknet/index.md) to MetaMask,
see [Use non-EVM networks](/wallet/how-to/use-non-evm-networks).
:::

## Example
Expand Down
2 changes: 1 addition & 1 deletion wallet/how-to/run-devnet.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Configure and connect to a Ganache development network.
sidebar_position: 9
sidebar_position: 10
---

# Run a development network
Expand Down
9 changes: 9 additions & 0 deletions wallet/how-to/use-non-evm-networks/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
joaniefromtheblock marked this conversation as resolved.
Show resolved Hide resolved
"label": "Use non-EVM networks",
"position": 9,
"link": {
"type": "generated-index",
"slug": "how-to/use-non-evm-networks",
"description": "You can interact with users' accounts on non-EVM networks in MetaMask."
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
description: Connect to the Starknet network in MetaMask.
sidebar_position: 1
---

# Connect to Starknet
8 changes: 8 additions & 0 deletions wallet/how-to/use-non-evm-networks/starknet/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
description: Interact with users' Starknet accounts in MetaMask.
sidebar_position: 1
---

# Starknet

You can interact with users' Starknet accounts in MetaMask by installing the Starknet Snap.
alexandratran marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
description: Manage Starknet accounts in MetaMask.
sidebar_position: 2
---

# Manage Starknet accounts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
description: Manage Starknet networks in MetaMask.
sidebar_position: 3
---

# Manage Starknet networks

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
description: Send Starknet transactions in MetaMask.
sidebar_position: 4
---

# Send Starknet transactions
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
description: Sign Starknet data in MetaMask.
sidebar_position: 5
---

# Sign Starknet data
joaniefromtheblock marked this conversation as resolved.
Show resolved Hide resolved
joaniefromtheblock marked this conversation as resolved.
Show resolved Hide resolved
6 changes: 6 additions & 0 deletions wallet/how-to/use-non-evm-networks/starknet/troubleshoot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
description: Troubleshoot common Starknet issues.
sidebar_position: 6
---

# Troubleshoot
Loading
Loading