FVM Hackathon Cheat Sheet

[trruckerfling]

This page has moved! We are retiring this good ol' page and moving this awesome cheatsheet to awesome Filecoin 👉 here 👈

Hi there hacker! Not sure where to begin? Too many docs to navigate? Here’s a cheat sheet to get you from zero to hero. This cheat sheet provides a guide to the following, in order:

💡 Filecoin & FVM concepts
📍 Navigate what you need to use for your hackathon project
🚀 Resources to get you building

Introduction

• Filecoin 101: you know nothing BUT that's okay, this will help!
• The Filecoin Virtual Machine EVM: welcome EVM hacker, here's what allows you to build on Filecoin.

Navigate to what you need

Filecoin? FVM? IPFS? What should I use for my hackathon project? We got you. Follow the decision-making guide below, to see which resource is recommended for your use case:

Resources

Recommended resources from guide above

1. Deal aggregation: this allows you to store smaller pieces of data (<4GB) to Filecoin that aggregators can pick up and form a larger deal (data sizes <4GB are too small for Storage Providers to pick up directly and you might not get your deal made)
   • with Filecoin Data Tools (FDT), use this daemon contract to trigger a deal aggregation workflow with Filecoin Data Tools' Edge-UR tool.
   • with Lighthouse.storage
2. Direct deal making with Storage Providers with Deal Making Starter Kit: use the Client Contract here to make a deal proposal, directly with the Storage Provider, for data >4GB.
3. HackFS 2023 FVM Starter Ideas: detailed description for solutions and tools to build with and/or to support programmatic storage
4. DataDAO Starter Kit: uses Client Contract for storage and Open Zepplin's Governor contract to quickly spin up a dataDAO. Keep building from there!
5. Storage Onramps: easy API integration for non-programmatic storage in your dApp

FVM Developer Basics

• FVM Docs: Quickstarts & concepts
• EVM vs EVM-compatible FVM (FEVM): Differences to note
• Calibration Testnet: Main Filecoin testnet that supports FVM, strongly recommended to deploy here for hackathon submission & share your contract address. The faucet accepts ETH addresses and will send it testFIL. (Please note that the previous Hyperspace testnet has been deprecated since 31 May).
• Filecoin.sol: Solidity library for FEVM development to call methods on system/built-in actors on Filecoin. Please ensure you’re using the latest release v4.0.1. To learn how to use Filecoin.sol check out the FEVM Hardhat Starter Kit's Filecoin API contract examples here. If you’re curious about the methods of built-in actors and what they can do, you can see here.
• ERC20 quickstart with Remix Tutorial FROM SCRATCH: Deploy your first FEVM actor (smart contract equivalent).

FVM Project Ideas & Blueprints

• Data + FVM See how we are thinking about new concepts on Programmable Storage Markets, including dataDAOs and decentralized data aggregators
• Request for Startups L2 solution ideas built on top of FVM & FVM tooling ideas. These are some ideas that Filecoin finds valuable to the ecosystem, but is not a finite list.

More FVM-compatible tools

• Network analytics APIs
  • Zondax Beryx API: Open API for indexing Filecoin. There is a Beryx client for JS
  • Spacescope API: Protocol-generated APIs for indexing Filecoin
  • Storage Provider FilRep reputation system API: query storage provider reputations. FilRep is not FEVM-compatible yet but is a useful resource to reference for reputation systems
• Decentralized compute
  • Bacalhau with FVM
  • Shale Protocol Shale-Serve API is a production-ready inference API for open-source LLMs (large language models). It currently supports Vicuna-13b. It can be used as a drop-in replacement for the OpenAI API (specifically GPT3.5-turbo) in any language, including Python, cURL, and HTTP requests.
• Access control
  • Medusa access control APIs: Simple programmatic access control without keys
  • Lighthouse Kavach access control SDK: Access control encryption SDK to build trustless applications using distributed key shards with threshold cryptography
• DeFi
  • Magmo Nitro State Channels for payment: ultra-low cost, near-zero-latency conditional transfer of cryptoassets via a "layer 2" network that sits above the blockchain
  • BANYAN interface for SushiSwap: DEX template, need to configure to point to hyperspace instead of wallaby
• Oracles
  • Tellor oracle: list of testnet contract addresses
• FVM smart contract templates
  • Cookbook.dev
• Naming Service
  • Spheron's Filecoin Naming Service SDK
• Gaming
  • LYNC Integrate FVM into any game and enable features such as dynamic NFTs and more

FAQs

• How can I use FVM to store data to Filecoin? / How can I store data with FVM? The intent of FEVM/FVM is to compute over state data (the metadata of your stored data). Storage Providers are the ones that are able to store your data and upload the deal to the Filecoin network. You can check out the deal flow here, where various steps can benefit from integrating FEVM! Data retrieval happens via Retrieval Providers, accepting the client's ask to retrieve and working with Storage Providers to decrypt the data to deliver to the client. FEVM/FVM is able to build logic around these 2 processes and automate, add verification and proofs, time-lock retrievals etc.
  • Awesome! But what specifically can I do today to automate filecoin storage deals on FVM? As of today, we allow you to create deal bounties to incentivize the storage of data through FEVM. Read more here (this repo is specifically tracks the creation of deal bounties to build a DataDAO; the same pattern applies for any other dapps that need to incentivize the creation of data deals). This means that you need to incentivize the storage of the deal off-chain, and then a user of your dapp can claim the rewards on-chain. We recommend this approach for the hackathon. In the future, we aim to allow you to do this in a few different ways, which will make an exciting landscape to incentivize the storage of deals.
• When a storage deal is made, is the data only stored by a single storage provider? What would happen if the storage provider (for some reason) removed all the data, would it be recoverable or is it lost completely? When a SP stores your data and the deal is active, over time, the SP has to provide Proof of Replication (porep) of the stored data. They also have to provide Proofs of Spacetime (PoST), where randomly selected SPs have to provide PoReps for randomly selected storage sectors they maintain. So your data is replicated and not easily lost. and SPs get slashed if they are unable to provide the proofs so they are not incentivized to delete your data. However, let's say a miner does delete your data for some reason, then to prevent against that, the individual client can choose to store with various SPs. Or you can upload your data via storage helpers like web3storage and estuary, who do the replication across various SPs for you. more reading https://filecoin.io/blog/posts/filecoin-features-verifiable-storage/ https://docs.filecoin.io/developers/storage-helpers/overview/
• How do I close a storage deal on Filecoin and stop Storage Providers from storing my data on-chain? How can I manipulate storage deals? It’s not impossible but SPs are incentivized not to close the storage deal as they are slashed for not providing Proof of Spacetime (PoST). Someone has to pay for the broken promise a miner makes to the chain and you need a custom market actor for it most likely to make the deal. You need to make deals for a certain amount of time - right now the boundaries are 6-18 months. You cannot ask a storage provider to take down your data without contacting them off-chain.
• What’s the benefit of deploying EVM to FVM/Filecoin instead of Ethereum network? Or write a dApp that way? What are the unique features of Filecoin as compared to Ethereum? Need narrative/article on why Eth devs should care about FVM, covering gas expectations, performance, dApp benefits. Our current answer is around using FVM for storage-heavy parts of the dApp (at exabibyte level) which might not be priority for most devs.
• Do I have to install Lotus to work with FVM? How do I install it? How do I install it on Hyperspace? Here is a public lotus node you can use https://api.hyperspace.node.glif.io/rpc/v0
• How do I check SP’s balance with their FEVM address? You can query balance of any address https://docs.zondax.ch/openapi#get-/account/balance/-address-
• Who is the beneficiary role, in the deal flow process? The beneficiary role takes on the financial control from the Storage Provider, who then focuses on node control. The node owner, who is the SP, has overarching control over both roles. See more here.
• How do I control access or encrypt data before storing on Filecoin? You can check out lighthouse.storage. They are an FVM Early Builder who has built an access control SDK https://github.com/lighthouse-web3/encryption-sdk
• For the frontend, what's a recommended framework(s) to use? Most frontend that works for EVM works for FEVM too including Flutter, Dart, Ethers.js, web.js, ReactJs. These can also query events on the frontend.
• How is the Filecoin network accessed through Solidity? We have a feature-complete Ethereum JSON-RPC API that enables EVM tooling to deploy seamlessly to Filecoin. This is a good talk to learn more about the various architectural considerations and features https://youtu.be/TD-LsOpFeMU?t=6665
• Could someone tell me the characteristics of fvm robust addresses and f4 addresses? https://docs.filecoin.io/developers/smart-contracts/concepts/accounts-and-assets/
• Can someone explain what the t0 and t1 addresses are?
  • 0 - ID Address
  • 1 - SECP256K1 Public Key Address
  • 2 - Actor Address
  • 3 - BLS Public Key Address
  • 4 - F4 translated address from foreign runtime to Filecoin
• I am still trying to understand the built-in actors. https://docs.filecoin.io/developers/smart-contracts/concepts/actors-and-contracts/
• Where can I see other projects built on FEVM?
  • Filecoin Ecosystem Dashboard (with FVM filter) - these showcase our early builders and is still being updated through next week
  • ETHGlobal HackFEVM Finalists - we ran a FEVM-focused smaller hackathon in Nov 2022, before the latest release of FEVM.

[jennijuju]

Could you please add the filecoin/lotus json RPC api docs here ? https://docs.filecoin.io/developers/reference/json-rpc/introduction/

[jennijuju]

Related https://api.hyperspace.node.glif.io/eth-rpc/

[trruckerfling]

Added! Thanks

…

On Jan 21, 2023, at 4:20 PM, Jiaying Wang ***@***.***> wrote: Could you please add the filecoin/lotus json RPC api docs here ? https://docs.filecoin.io/developers/reference/json-rpc/introduction/ <https://docs.filecoin.io/developers/reference/json-rpc/introduction/> — Reply to this email directly, view it on GitHub <#585 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A3AU2IYYVHUPICOKLOT2J3DWTR4N5ANCNFSM6AAAAAAUBEURWA>. You are receiving this because you authored the thread.

[aashidham]

Where was this added? Couldn't find it

[trruckerfling]

Lotus JSON-RPC API: how to interact with the Filecoin network
Eth methods for Ethereum JSON-RPC API: Ethereum-compatible JSON-RPC calls
Eth API request methods for Glif endpoint on Hyperspace (updating to reflect Hyperspace instead of Wallaby but the list is sound and works for Hyperspace endpoint)

[Cyri11]

We missed the registration to the hackathon getting ready to it :) Will there be a kind of late registration open? Or another opportunity to jump on the event?

[trruckerfling]

Hey unfortunately reg is closed now! You can check out https://spacewarp.fvm.dev/ to be part of the FEVM launch activities other than the hack!

[Cyri11]

Thank you for a reply!

[figureouter]

You can also follow other hackathons that will have FVM prizes on https://hackathons.filecoin.io/ 😊

[holyaustin]

Great Resources. It gave me the foundation I needed to build.

[trruckerfling]

aww thank you!! glad it helped, lmk if there are gaps in the journey and we'll try to find a resource

[degencodebeast]

Is there an API I can use to interact with NFTs on FVM, just like how the alchemy NFT API allows me to?
I'm trying to figure out how to query an address to see the NFT tokens it has

[ChrisLally]

Quick heads up, Chainstack seems broken

[figureouter]

@trruckerfling can we call this the "FVM Hackathon Cheat Sheet" please?

[trruckerfling]

done!

[NorVirae]

Hi is it possible to connect FVM to an indexer, like subgraphs, so data can be easily indexed?

[figureouter]

Have you tried posting your question on Filecoin slack #fil-builders or ETHGlobal Discord #mentorship-help channels? You'll get a quicker response there.

[Stefitoooo]

Nice

[alirezafarhadi850]

Nice project and congratulations to the team for their efforts and dedication and highly appreciated the visionary thought of the projector, it will create history and go to the moon.

[The-Wayvy]

Hey Sarah

I have a question.

Where can I find the gas costs for miner transactions related to making and maintaining deals?

For example PublishStorageDeal or SubmitWindowedPoSt

[The-Wayvy]

Is this the right place? I can't really understand it.

https://github.com/filecoin-project/ref-fvm/blob/master/fvm/src/gas/price_list.rs

https://github.com/filecoin-project/lotus/blob/master/chain/vm/gas.go

https://github.com/filecoin-project/lotus/blob/594c52b96537a8c8728389b446482a2d7ea5617c/chain/vm/gas_v0.go#L42

[trruckerfling]

@The-Wayvy not a pro here, can you try asking in #fil-lotus-help on filecoin slack?