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

metamask documentation #99

Merged
merged 12 commits into from
Dec 5, 2023
Prev Previous commit
Next Next commit
Correct MetaMask casing
tomjeatt committed Dec 5, 2023
commit 3ff61aa9d92300edefa9603269807d6522523acf
14 changes: 7 additions & 7 deletions docs/docs/build/examples/metamask-ordinals/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Use Metamask to Inscribe and Transfer Ordinals, and Transfer BTC
# Use MetaMask to Inscribe and Transfer Ordinals, and Transfer BTC

This example demonstrates how a Metamask Snap can be used to inscribe and transfer ordinals, and transfer BTC, using only Metamask.
This example demonstrates how a MetaMask Snap can be used to inscribe and transfer ordinals, and transfer BTC, using only MetaMask.

:::info Example Code

@@ -12,21 +12,21 @@ The code for this example can be [found in the GitHub repository](https://github

We have created a testnet demo of the application at [https://ordinals.gobob.xyz](https://ordinals.gobob.xyz), allowing anyone to inscribe, view and transfer ordinals, and transfer BTC.

:::info Metamask Flask
:::info MetaMask Flask

This demo uses [Metamask Snaps](https://metamask.io/snaps/) and can only be used with [Metamask Flask](https://metamask.io/flask/). Metamask Snaps are not currently supported on mobile wallets, so this demo will only run in the desktop version of Chrome or Firefox.
This demo uses [MetaMask Snaps](https://metamask.io/snaps/) and can only be used with [MetaMask Flask](https://metamask.io/flask/). MetaMask Snaps are not currently supported on mobile wallets, so this demo will only run in the desktop version of Chrome or Firefox.

:::

### Creating a test profile

To use this demo, you will need to create a new browser profile to use with the Metamask Flask extension, as having Metamask and Metamask Flask installed in the same browser profile can cause issues.
To use this demo, you will need to create a new browser profile to use with the MetaMask Flask extension, as having MetaMask and MetaMask Flask installed in the same browser profile can cause issues.

We recommend creating two test profiles so that you can test transferring Ordinals and BTC between two accounts.

### Installing the Metamask Snap
### Installing the MetaMask Snap

Once you have installed Metamask Flask, click the 'Connect Wallet' button on https://ordinals.gobob.xyz. Metamask will prompt you to install the Snap, and give it permissions.
Once you have installed MetaMask Flask, click the 'Connect Wallet' button on https://ordinals.gobob.xyz. MetaMask will prompt you to install the Snap, and give it permissions.

### Funding your account

6 changes: 3 additions & 3 deletions docs/docs/build/examples/unified-assets-tracker/index.md
Original file line number Diff line number Diff line change
@@ -21,7 +21,7 @@ The source code for this demo can be found in [this repository](https://github.c
2. Move to API directory `$ cd api/`
3. Compile and run the service with `cargo run`
4. The API server should be now running at `localhost:8000`
5. The API documentation can be found in `api/README.md` directory.
5. The API documentation can be found in `api/README.md` directory.

## Installing the UI project

@@ -38,8 +38,8 @@ The source code for this demo can be found in [this repository](https://github.c

1. Run `pnpm dev` in `ui` directory.
2. The UI is now running locally on port 5173.
3. Go to `localhost:5173` and click on `Connect wallet`, your wallet will get connected and the Bitcoin snap extension will be installed. After this, you have to approve all the permissions in Metamask to access the Bitcoin addresses.
4. Now you have Bitcoin address derived from your Metamask account, you can send testnet BTC or brc20s to see them in the app and move them around.
3. Go to `localhost:5173` and click on `Connect wallet`, your wallet will get connected and the Bitcoin snap extension will be installed. After this, you have to approve all the permissions in MetaMask to access the Bitcoin addresses.
4. Now you have Bitcoin address derived from your MetaMask account, you can send testnet BTC or brc20s to see them in the app and move them around.

## Notes