Overview

MiniKit is easiest way to build Mini Apps on Base, allowing developers to easily build applications without needing to know the details of the SDK implementation. It integrates seamlessly with OnchainKit components and provides Coinbase Wallet-specific hooks.

​

Why MiniKit?

MiniKit streamlines mini-app development by providing a comprehensive toolkit that makes complex Frames SDK interactions intuitive:

​

Use Cases

And many more possibilities!

​

Quick Start

The fastest way to get started with MiniKit is to use the CLI to bootstrap a new project:

npx create-onchain --mini

This command will:

After running the command, follow the prompts to configure your project.

​

Provider

The MiniKitProvider wraps your application and provides global access to the SDK’s context. It handles initialization, events, and automatically applies client safeAreaInsets to ensure your app doesn’t overlap parent application elements.

import { MiniKitProvider } from '@coinbase/onchainkit/minikit';

function App({ children }) {
  return (
    <MiniKitProvider
      projectId="your-project-id"
      notificationProxyUrl="/api/notification"
    >
      {children}
    </MiniKitProvider>
  );
}

​

Props

The MiniKitProvider accepts the following props:

The provider sets up wagmi and react-query providers automatically. It configures connectors to use the Farcaster connector if sdk.context is set, with a fallback to CoinbaseWallet. This allows the same application to run both in frames and as a standalone application.

​

Hooks

MiniKit provides several utility hooks that wrap the SDK functionality, making it easy to access different features.

​

useMiniKit

This hook handles initialization of the application and provides access to the SDK context.

const { setFrameReady, isFrameReady, context, updateClientContext, notificationProxyUrl } = useMiniKit();

// Call setFrameReady() when your app is ready to be shown
useEffect(() => {
  if (!isFrameReady) {
    setFrameReady();
  }
}, [isFrameReady, setFrameReady]);

Returns:

​

useAddFrame

This hook adds a frame to the user’s list of frames and returns notification details.

const addFrame = useAddFrame();

// Usage
const handleAddFrame = async () => {
  const result = await addFrame();
  if (result) {
    console.log('Frame added:', result.url, result.token);
  }
};

Returns:

​

useNotification

This hook allows sending notifications to users who have added your frame. It requires a token and URL, which are returned when a user adds your frame.

const sendNotification = useNotification();

// Usage
const handleSendNotification = () => {
  sendNotification({
    title: 'New High Score!',
    body: 'Congratulations on your new high score!'
  });
};

​

useOpenUrl

This hook wraps sdk.actions.openUrl and falls back to window.open when outside a frame context.

const openUrl = useOpenUrl();

// Usage
<button onClick={() => openUrl('https://example.com')}>Visit Website</button>

​

useClose

This hook wraps the sdk.actions.close functionality.

const close = useClose();

// Usage
<button onClick={close}>Close</button>

​

usePrimaryButton

This hook accepts primary button options and a callback which will be called on click.

usePrimaryButton(
  { text: 'Submit Score' },
  () => {
    // Handle button click
    submitScore();
  }
);

​

useViewProfile

This hook wraps sdk.actions.viewProfile, accepting an FID but falling back to the client’s FID.

const viewMyProfile = useViewProfile(); // Uses client's FID
const viewUserProfile = useViewProfile(123456); // Uses specified FID

// Usage
<button onClick={viewMyProfile}>View My Profile</button>
<button onClick={viewUserProfile}>View User Profile</button>

​

useAuthenticate

This hook allows users to sign in with Farcaster. It wraps the SDK’s signIn message, adding a default nonce and verification.

const { signIn } = useAuthenticate();

// Usage
const handleSignIn = async () => {
  const result = await signIn({
    domain: 'your-domain.com',
    siweUri: 'https://your-domain.com/login'
  });

  if (result) {
    // Handle successful authentication
    console.log('Authenticated:', result);
  }
};

​

CLI

The MiniKit CLI is the easiest way to get started. It automatically creates a sample application that integrates different parts of the SDK and some OnchainKit components.

npx create-onchain --mini

​

Features

The CLI creates an application with:

​

Demo Application

The CLI also creates a demo snake game application that showcases:

• Buttons to add the frame and connect your wallet
• High score tracking with attestations using OnchainKit’s <Transaction/> component
• Score display using OnchainKit’s <Identity/> components to resolve ENS names
• Notifications for high scores (rate limited to one every 30 seconds)

​

Next Steps

Now that you have MiniKit set up, you can:

Enjoy building!