⨎ Filsnap

A MetaMask Snap to add Filecoin support to the MetaMask extension.

Features

• Enables dapps access to Filecoin accounts using Metamask.
• Manage Filecoin accounts, check balance, address, export private key and more.
• Send and receive FIL from native and FEVM addresses.
• Sign Filecoin messages and arbitrary data.
• Send Filecoin messages and estimate gas fees.
• Filecoin insights for FEVM transaction/signature requests.

Resources

• Companion App
• Documentation

Packages

• filsnap - Filecoin snap for Metamask
• filsnap-adapter - Adapter to interact with Filsnap from a dapp
• filsnap-adapter-react - React hooks to interact with Filsnap from a dapp

Examples

• demo - Preact demo dapp using filsnap-adapter to interact with filsnap.
• insights-wagmi - Wagmi example using filsnap-adapter to enable transaction insights for smart contract calls.
• fil-forwarder-viem - Viem example to send FIL using FilForwarder contract.
• Fund Ring - Svelte dapp dapp that using filsnap to fund projects with Filecoin.

Clone any example in the /examples folder on StackBlitz using:

https://stackblitz.com/github/filecoin-project/filsnap/tree/master/examples/insights-wagmi
Copy

To clone it locally:

npx tiged filecoin-project/filsnap/examples/demo filsnap-demo
cd filsnap-demo
pnpm install
pnpm dev
Copy

You can try any of the examples by replacing demo with the name of the example you want to try.

Contributing

Read contributing guidelines here.

License

Dual-licensed: MIT, Apache Software License v2, by way of the Permissive License Stack.

Security Audits

Filsnap v1.0.1 - The FilSnap v0.5.0 was audited by ConsenSys Diligence in August 2023 with a follow-up assessment of fixes conducted in October 2023, leading to the release of filsnap-v1.0.1. The complete audit report is available here in the audits/ directory as well as on the ConsenSys Diligence website.