Pre-PIP:1
Author(s): Siddesh
Discussions: NA
Created: 5/17/2024
Simple Summary
Bringing Frames (mini-web apps embedded) support to Push Dapp and all Dapps using Push Chat. This implementation can open up a myriad of possibilities for Push Chat usage.
Abstract
Frames enable developers and other projects to build a mini-web-app, which, once shared in a Push Chat, will be embedded as an interactive, rich mini app that anyone can interact with from within the chat. With this implementation of Frames, developers have the flexibility to do a variety of things, including but not limited to:
- Letting users interact with their contracts, such as performing actions on-chain in any of the supported chains in Push Dapp.
- Allowing Frames developers to build gamified, rich apps with user contexts, enabling powerful utilities and actions.
- Letting users directly use their products without having to leave the Push Chat client.
Motivation
Frames is a new technology introduced by the Farcaster team in Warpcast. Initially, it had a remarkably positive impact on its user base, enabling developers to integrate their apps seamlessly within a social media platform. This allows users to access these apps without leaving the platform.
With numerous consumer applications available today, some of these apps can benefit greatly from being usable within an existing application with a larger user base. From a user standpoint, being able to make a swap on Uniswap and send a tip to someone within a social media app without leaving it is amazing, as it eliminates the need to switch between apps.
Frames has opened up a plethora of use cases and has the potential to become a significant innovation, with thousands of frames being built every day to solve various consumer problems. With Frames support in Push, chat groups become very exciting, allowing users to create a Push Channel from within a chat or share and play an adventure game or chess directly within the chat client itself and much more.
Specification
Overview
Frames is essentially a sanitized version of the OG protocol standard (developed by Facebook in 2010) used by almost all websites today to embed previews of other websites. Frames complement this by adding additional meta tags to a web app, which can then be processed by a client to embed the link as a Frame.
A Frame can perform several functions and consists of three components: an image, an optional text input, and up to four buttons. A web link can be embedded as a Frame if it follows the Open Frames Standard or the Farcaster Frame Standard, which have specific requirements for a valid Frame.
When there is a link in a message, the client fetches the metadata of the web link and parses it to extract the Frame-specific tags (according to the Open Frames or Farcaster specifications). If the link is valid, it can be embedded with the provided image and button information from the Frame.
Once embedded in the chat, every interaction with it triggers a POST request to the Frames server with information about the interaction. The Frames server processes this and returns a new Frame, which is then parsed and embedded for the user to continue the interaction.
A button in a Frame can have special actions, allowing the Push Client to understand how to process user interactions. Some of these actions include
Subscribe Action: This action lets the connected user subscribe to the channel provided in the Frame.
Transaction Action: Frames can have buttons that create on-chain transactions. The Frame’s developer can set a button as a transaction trigger, prompting the Push Client to send a GET request to the Frame to fetch transaction details. The Push Client then generates a transaction and asks the user to sign or reject it.
Frames offer a rich feature set, enabling context sharing between the connected user and the Frames server. This capability makes gaming and other use cases possible. Additionally, a Frame can request input from the interacting user.
References:
- Open Frames Standard
- Farcaster Frame Spec - [couldn’t add more links due to platform restriction]
Rationale
The introduction of Frames support within the Push Dapp and all Dapps using Push Chat is driven by several key considerations. Frames technology, as developed by the Farcaster team, has demonstrated significant potential in enhancing user engagement and developer flexibility within social media platforms. By integrating Frames, Push Chat can leverage this innovation to offer a more seamless and interactive experience for its users.
User Experience:
The primary motivation for this implementation is to enhance the user experience by allowing users to interact with mini-web apps directly within the Push Chat client. This eliminates the need to switch between different applications, thereby streamlining user interactions and increasing convenience.
Developer Flexibility:
Frames provide developers with the ability to create rich, interactive mini-apps that can be embedded within chats. This opens up opportunities for developers to build diverse applications, from on-chain transaction interfaces to interactive games, all accessible within a single platform. By Push following Open Frames Standard, developers can build cross functional frames which can work in multiple apps.
Increased Engagement:
By integrating Frames, Push Chat can significantly increase user engagement. Users can perform various actions, such as subscribing to channels, making on-chain transactions, or participating in interactive content, without leaving the chat environment. This continuous engagement is likely to boost user retention and satisfaction.
Implementation
Adding support for Frames in Push UiWeb package and develop SDKs that are needed to help Frames Developers, like Frames Validator Package.
Temperature Check
NA
