Home

Welcome to Filecoin snap wiki!

Filecoin snap (plugin) enables Filecoin network inside Metamask and by doing this provides DAPPs easy integration.

Wiki covers snap architecture and integration steps, as well as detailed API documentation.

Contents

• Architecture
• Integration
• API Documentation

Architecture

Filecoin Metamask snap is installed using filsnap-adapter. Usage flow is represented in the diagram below and described in more detail inside integration steps.

Integration

Prerequisites

• Add filsnap-adapter package to your project.

npm i @chainsafe/filsnap-adapter

• [Optional] Add types for the adapter to your project in case you will interact with snap specific API.

npm i @chainsafe/filsnap-types

---

Integration steps

1. Install snap by calling enableFilecoinSnap from @chainsafe/filsnap-adapter package.

This will prompt the user to:

• accept the snap installation
• accept all snap permissions

This function accepts the configuration object for defining network properties, the same as configure method from Filecoin Snap API. After successful installation, it will return MetamaskFilecoinSnap object (see Architecture overview for details).

2. Invoke Filecoin Snap API

MetamaskFilecoinSnap object has an exposed method for obtaining API getFilecoinSnapApi. For more details about exposed API see API documentation.