[ARCHIVED] AleoSnap - MetaMask Snap for Aleo ecosystem

Caution

This repository is no longer active. It has been superseded by AleoHQ/aleo-snap-chainsafe.

Table of Contents

1. Introduction
2. Prerequisites
3. Getting Started
4. Building and Running the Snap
5. Testing
6. Linting and Formatting

Introduction

AleoSnap is a MetaMask Snap that enables MetaMask users to interact with Aleo blockchain.

This project is a monorepo containing the MetaMask Snap package, managed by Yarn 3 Workspaces. The goal of this project is to provide native interaction with the Aleo blockchain inside MetaMask using the Snaps system.

Prerequisites

Before you can start working with the project, make sure you have the following software installed:

• nvm (or you can use Node.js 18)
• corepack
  • will enable yarn 3.x

Getting Started

To get started with the project:

1. Clone the repository:

git clone https://github.com/ChainSafe/aleo-snap.git

2. Navigate to the project root:

cd aleo-snap

3. Set node to compatible version of project (skip if you use manual approach)

nvm use

4. Utilize corepack

corepack enable

5. Install the dependencies

yarn install

Building and Running the Snap

To build and run the project, follow these steps:

1. Build all packages:

yarn build

2. Run the MetaMask Snap:

yarn start

Testing

To run tests for all packages:

yarn test

Linting and Formatting

This project uses ESLint to enforce code style and formatting. To check code quality with the linter, run:

yarn lint

To lint and format the code, run:

yarn lint:style:fix