Metamask Snap Demo

This repository is a fork of the MetaMask template-snap-monorepo and utilizes a range of cutting-edge technologies to deliver a seamless decentralized experience.

Technologies

• Linea Network
• Infura
• Metamask SDK
• Metamask Snaps
• Foundry
• React
• TypeScript

Packages Overview

contracts

The contracts package houses the smart contracts essential for our NFT Pool Demo. Leveraging Foundry, for build, test, and deploy smart contracts seamlessly. The setup is configured to interact flawlessly with the Linea Network using Infura as an RPC provider.

See full details in contracts/README.md

site

The site package contains the frontend application of our NFT Pool Demo, developed with React and TypeScript. Within this package, you'll discover a collection of custom hooks designed to facilitate MetaMask wallet instantiation and interaction with smart contracts deployed on the Linea Network. Additionally, explore the snap file for insights on integrating the frontend application with the Snap feature.

See full details in site/README.md

snap

The snap package, crafted entirely in TypeScript, houses the snaps for our NFT Pool Demo, demonstrating the innovative capabilities of MetaMask Snaps.

See full details in snap/README.md

Getting Started

Clone the template-snap repository using this template and set up the development environment:

yarn install && yarn start

Cloning

This repository contains GitHub Actions that you may find useful, see .github/workflows and Releasing & Publishing below for more information.

If you clone or create this repository outside the MetaMask GitHub organization, you probably want to run ./scripts/cleanup.sh to remove some files that will not work properly outside the MetaMask GitHub organization.

If you don't wish to use any of the existing GitHub actions in this repository, simply delete the .github/workflows directory.

Contributing

Testing and Linting

Run yarn test to run the tests once.

Run yarn lint to run the linter, or run yarn lint:fix to run the linter and fix any automatically fixable issues.

Using NPM packages with scripts

Scripts are disabled by default for security reasons. If you need to use NPM packages with scripts, you can run yarn allow-scripts auto, and enable the script in the lavamoat.allowScripts section of package.json.

See the documentation for @lavamoat/allow-scripts for more information.