TRACKING: Filsnap Updates

[hugomrdias]

Tasks

Developer tooling and experience improvements

• Move repo to some PL Org
• Create a new npm package with PL bot
• Setup CI to publish with PL bot
• Change repo tooling to something more up to date and canonical for easier development and contributions
• Make sure all npm scripts and local dev is fully functional, documented and easy to use.
• Update dependencies specially from metamask and filecoin.
• Move tests from https://github.com/hugomrdias/filsnap-testing to the filsnap repo
• Move CI from https://github.com/hugomrdias/filsnap-testing to the filsnap repo
• Added notice about repo the new repo on https://github.com/ChainSafe/filsnap

Code Improvements

• Zod schemas with validations and types for RPC messages and metamask state
• RPC client for lotus using zod schemas
• onRpcRequest should check if fil_configure was called already and build up a "context" for other methods with snap, config, api client, keypair etc avoiding multiple instances and async tasks to get snap state.
• Remove dependency on @zondax/filecoin-signing-tools and Buffer
• Swap all the validation in src/utils/params.ts for zod schemas
• Check new snaps UI https://docs.metamask.io/snaps/reference/rpc-api/#snap_dialog and src/util/confirmation.ts
• Add pnpm patch to snaps-cli/dist/utils/misc.js changing config file to snap.config.cjs
• Write new RPC or use some other client like izari-filecoin
• compress snap bundle https://github.com/terser/terser
• flask now forces semver in the snap version option change metamask-testing-tools to account for that
• tests need to have the snap version injected from the snap manifest
• export private key MM popup needs rework
• sign raw popup rework
• send message popup rework

Metamask 10.28+ compatibility

• Research metamask new flask/snap permissions system (caveats based) and plan changes needed in filsnap.
• Update filsnap to the new permissions system
• Document changes and how it works to make future changes easier. (metamask said it may change again multiples until 10.29.0/end of the year)
• Unit and e2e tests for these changes.
• Check snap config type and check if we need to refactor it and where all the properties are used.
• Make sure the snap manifest gets updated and committed in the CI

Filsnap adapter

• Merge Update adapter and demo #6
• Make sure there are no breaking changes to the adapter API
• Rework the demo
• Publish demo
• Check filsnap icons for the install snap popup
• Publish new package to npm
• e2e tests running against the demo app
• Fix selection highlight in the demo app
• deploy with npm:filsnap SNAP_ID

Support FEVM transactions

• Research FVM/FEVM transactions, requirements, flows and tools.
• Support send FIL to f410 addrs
• Handle FEVM transactions (cbor encoded)
• New unit and e2e tests for FEVM features
• Update demo page with FEVM features
• Collaborate with Glif to validate filsnap works as expected

Others

• Write up about moving aways from zondax dependencies
• Improve packages readme and add a few examples
• Improve js docs descriptions
• Ledger metamask <-> snap #35 (not possible)
• endowment:transaction-insight to add extra info to FEVM transations #36
• move metamask-testing-tools to this repo #37
• extract react hook from demo into a standalone package #38

References

• https://github.com/ChainSafe/dappeteer#usage-with-snaps
• https://github.com/MetaMask/snaps-monorepo
• https://www.npmjs.com/package/@metamask/snaps-cli
• https://docs.metamask.io/guide/snaps.html
• https://github.com/ChainSafe/filsnap
• Original issue add regression testing and CI ChainSafe/filsnap#132
• https://hyperspace.yoga/#faucet
• https://faucet.calibration.fildev.network/
• https://github.com/Zondax/izari-filecoin
• https://github.com/glifio/modules

Notes

• Glif RPC nodes docs https://api.node.glif.io/