/openfort-fc-frames-demo

Primary LanguageSolidity

Openfort x Frames Demo

This is an example Farcaster Frame to demonstrate how you can use Frames alongside Openfort's accounts feature to create novel experiences for your users.

When a user first sees this demo Frame in their Farcaster client, they can click a button to redeem a testnet NFT. Behind the scenes, Openfort creates an smart wallet with the current Farcaster user and airdrops an NFT to it. Users can view their NFT by visiting any explorerwith their new smart account address. This is a testnet NFT on the Base Sepolia testnet.

This app is built with ExpressJs, and makes uses of libraries like @coinbase/onchainkit, @farcaster/hub-node-js, and viem for interacting with the blockchain and the Farcaster protocol.

Live Demo

To see this demo in action, share https://openfort-frames-demo.onrender.com in any Farcaster client that supports Frames (e.g. Warpcast) and interact with it. You can then go to any explorer with your new address to view your NFT.

Setup

  1. Fork this repository, clone it, and open it in your command line:
git clone https://github.com/<your-github-handle>/openfort-frames-demo
  1. Install the necessary dependencies using your preferred package manager:
npm i

  1. Using a fresh development wallet, deploy an ERC-721 contract at to the Base Sepolia testnet. Do not use a real wallet, as you must store the development wallet's seed phrase as an environment secret. You can use a tool like Remix or hardhat to deploy your contract.

  2. Initialize your environment variables by copying the contents of .env.example to a new .env file, and fill in the required values. You'll need to set a base URL, your contract ID, policy ID, developer account ID, and your Openfort API key.

  3. Import the contract: Checkout the guide.

  4. Create a Policy to sponsor the transactions: Checkout the guide. For this demo, you must include two policy rules. One of type 'account_functions' to allow for smart contract deployment, and another rule of type 'contract_functions' to allow sponsoring the mint gaslessly.

  5. Creating a Developer Account to mint the assets: Checkout the guide.

NEXT_PUBLIC_BASE_URL=<insert-the-url-for-your-frame>
CONTRACT_ID=<insert-your-contract-id>
POLICY_ID=<insert-your-policy-id>
DEVELOPER_ACCOUNT_ID=<insert-your-developer-account-id>
OPENFORT_API_KEY=<insert-your-openfort-api-secret>

That's it! To run the demo locally, execute npm run dev and open http://localhost:3000.

Testing the frame

You can test this Frame using Warpcast Embed Tools to preview the frame interaction. Please note that a localhost URL will not work with Warpcast Embed Tools, so you should set up a public tunnel to your local app using a tool like ngrok or Cloudflare.

Check out

  • src/lib/smart-wallet.ts to see how to use Openfort to pre-generate smart wallets for a user's Farcaster accounts
  • src/lib/farcaster.ts to see how Frames are generated and how to verify a user's Farcaster account and query the protocol for their Farcaster data
  • src/lib/nft.ts to see how to airdrop the ERC-721 you deployed to a user's wallet address
  • src/services/wallet.ts to see how the first Frame interaction generates an embedded wallet for the user
  • src/services/mint.ts to see how the second Frame interaction airdrops an NFT to the user
  • contracts/src/OpenfortFrameNFT.sol for the sample contract used.