Skip to content
Docs

Framegear

Framegear is a simple tool that allows you to run and test your frames locally:

  • without publishing
  • without casting
  • without spending warps

Installation and Usage

Framegear is currently distributed as part of the @coinbase/onchainkit Git repository.

npm
git clone https://github.com/coinbase/onchainkit.git
 
cd onchainkit/framegear
npm install
npm run dev

Visit http://localhost:1337 to start the Framegear interface. Enter the URL of your locally running frame (e.g., http://localhost:3000) and click Fetch to validate your frame response and start testing.

Fetch Frame]

Frame-specific setup

Framegear can validate the initial response of any frame. For more advanced debugging capabilities, consider building the frame using @coinbase/onchainkit (versions ^0.8.0). When using the getFrameMessage function, include the allowFramegear option to enable Framegear to send mock frame actions.

import { getFrameMessage } from '@coinbase/onchainkit/frame';
 
// ...
 
const { isValid, message } = await getFrameMessage(body, {
  allowFramegear: true, 
});

Security Tip

When setting up frames in production, remember not to include the allowFramegear option. The exact setup might vary based on the application, but here's one example:

import { getFrameMessage } from '@coinbase/onchainkit/frame';
 
const allowFramegear = process.env.NODE_ENV !== 'production'; 
 
// ...
 
const { isValid, message } = await getFrameMessage(body, {
  allowFramegear, 
});

Current Abilities

At present, Framegear is able to validate the initial frame response against the current Frame Specification and interact with frames through buttons using the post action.

Framegear is under active development and much more functionality is on the roadmap including (but not limited to):

  • more button actions
  • text input
  • simulated conditions
    • viewer followed
    • viewer liked
    • viewer recasted

A partial roadmap can be viewed at https://github.com/coinbase/onchainkit/issues/146