Skip to content

Commit

Permalink
docs(snap): add little page explaining how to build
Browse files Browse the repository at this point in the history
  • Loading branch information
Pitasi committed Mar 12, 2024
1 parent f6ceaf5 commit fc9e2ff
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 40 additions & 0 deletions docs/docs/developers/metamask-snap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# MetaMask Snap

Warden Protocol maintains a [MetaMask Snap](https://metamask.io/snaps/) to
bring your Warden Protocol Ethereum addresses to any dApp that already supports
MetaMask.

![MetaMask accounts list with a Warden Protocol controlled address](./metamask-snap-accounts-preview.jpg)


## Build

Clone the Warden Protocol repo:

```sh
git clone https://github.com/warden-protocol/wardenprotocol

cd wardenprotocol/snap
```

Install the required dependencies:

```sh
npm install
```

Run the server (it will monitor changes and rebuild automatically):

```sh
npm start
```

Now SpaceWard can load the MetaMask Snap using the origin
`local:http://localhost:8123`.


## Publish

MetaMask Snaps are published as npm packages. At this time, the Warden Protocol
MetaMask Snap is not published to npm, but you can build and test it
locally.

0 comments on commit fc9e2ff

Please sign in to comment.