Skip to content

Integrate farcaster mini app sdk and haptics #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
mykcryptodev wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Integrate farcaster mini app sdk and haptics #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 26 additions & 8 deletions docs/FARCASTER_MINIAPP_INTEGRATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,31 @@
# Farcaster Mini App Integration

This document describes the integration of Wallet Sweep as a Farcaster mini app.
This document describes the integration of Wallet Sweep as a Farcaster mini app using the official @farcaster/miniapp-sdk.

## Overview

Wallet Sweep has been configured as a Farcaster mini app, allowing it to be embedded and launched from Farcaster clients. Users can discover the app through social feeds and add it to their Farcaster client for quick access.
Wallet Sweep has been configured as a Farcaster mini app, allowing it to be embedded and launched from Farcaster clients. Users can discover the app through social feeds and add it to their Farcaster client for quick access. The integration now uses the official Farcaster Mini App SDK for enhanced functionality and native features.

## Implementation Details

### 1. Mini App Embed Metatags
### 1. Farcaster Mini App SDK Integration

The app now uses the official `@farcaster/miniapp-sdk` for native Farcaster functionality:

- **SDK Initialization**: The SDK is initialized in `FarcasterProvider.tsx` which wraps the entire app
- **Ready Signal**: The app calls `sdk.actions.ready()` on load to hide the splash screen
- **Haptic Feedback**: All haptic feedback now uses `sdk.actions.haptics('light')` instead of manual `navigator.vibrate()`
- **Context Provider**: A React context provides SDK functionality throughout the app

Key features provided by the SDK:
- Native haptic feedback with different intensity levels
- Authentication and user context
- Wallet interactions (Ethereum/Solana)
- Share functionality
- Events and notifications
- Back navigation handling

### 2. Mini App Embed Metatags

The app includes the required metatags in `src/app/layout.tsx`:

Expand Down Expand Up @@ -94,8 +111,9 @@ To test your mini app integration:

1. Generate proper account association signature
2. Test the mini app in a Farcaster client
3. Consider implementing the SDK for enhanced functionality:
- User authentication with SIWE
- Access to Farcaster context
- Native sharing capabilities
- Push notifications
3. Extend SDK functionality:
- Implement user authentication with the SDK's auth features
- Add native sharing capabilities using `sdk.actions.share()`
- Implement wallet interactions for on-chain operations
- Add push notifications support
- Use SDK events for better app lifecycle management
Loading