⨎ FilSnap Monorepo

Filecoin Metamask Snap and related packages to enable developers to add Filecoin integration to their dapps.

This Snap enables storage of native Filecoin private keys in Metamask's local vault, to support native Filecoin addresses (e.g. f1 addresses or t1 testnet addresses).

For FEVM (Filecoin EVM) address support using Ethereum-style 0x addresses, you can also use regular Metamask directly without installing this Snap.

• If you're using FEVM, the Snap can also show your 0x address info and its equivalent Filecoin f410 address. (More info about 0x / f410 addresses can be found in the Filecoin Docs - Ethereum Address Manager.)

Resources

• Filecoin MetaMask Snap Wallet Demo
• Filecoin Metamask Snap Docs

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
• fil-forwarder-viem - Viem example to send FIL using FilForwarder contract.
• Fund Ring - Svelte dapp dapp that using filsnap to fund projects with Filecoin.

Checkout examples

You can use Codesandbox and start hacking right away.

To clone it locally:

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

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.