Skip to content

frames v2 developer playground preview

Jump to bottom
Tony D'Addeo edited this page Nov 24, 2024 · 6 revisions 
 , ,  _   ,_ ,_ ,  ,
 |_|,'|\  |_)|_)\_/ 
'| |  |-\'| '| , /` 
 ' `  '  `'  '(_/   
 __,,_  _    , ,  _, _,  _, ___,   ,___,,  ,  _,  
'|_,|_)'|\  |\/| /_,(_, / _' | \  /' |  |\ | / _  
 | '| \ |-\ | `|'\_  _)'\_|`_|_,\/` _|_,|'\|'\_|` 
 '  '  `'  `'  `   `'    _|'    '  '    '  `  _|  
                        '                    '

If you haven't already, read through the Frames v2 FIP.

frames v2 dev playground

Warpcast is opening up a playground that devs can use to start prototyping v2 frames. The playground may be buggy and the Frames SDK is unstable and not yet documented.

If you want to be on the bleeding edge and help us with feedback you can use it.

accessing the playground

Make sure you are on the latest version of Warpcast and have the latest Over-the-Air update.

The playground can be access in the Warpcast mobile application at https://warpcast.com/~/developers/frame-playground. It's not yet available on web.

The tool provides 3 inputs:

  • url - this is the URL that will be opened
  • splash image url
  • splash background color

Fill out at least url and then click Launch to open your frame. The url must use https and be accessible on the public internet. Use a tool like ngrok or cloudflared to develop against localhost.

developing your frame

A v2 frame is a web application. Use whatever tools you feel most comfortable developing web apps with.

Install @farcaster/frame-sdk. There isn't documentation yet and the API is unstable. The typing should help or read the source code.

Import the sdk with import sdk from "@farcaster/frame-sdk";

The most interesting thing you can do with the sdk at this point is interact with the users connected wallet via sdk.wallet.ethProvider.

Check out the reference demo repo to see how to interact with the wallet using wagmi.

feedback

Please give us feedback early and often in the Devs: Frames v2 group chat in Warpcast. Check the known issues section below first.

If you aren't in the chat get in touch with @deodad or @horsefacts.eth and we'll get you in there.

know issues

  • Connecting a wallet for the first time doesn't work smoothly. Some combination of exiting and / or force quitting the Warpcast app and trying again will resolve.

faq

  • how do I test embeds? you can't yet with this tool. will come soon. embeds will just be a dynamic image + single button with the same options as this menu here, for now use your imagination.
Clone this wiki locally