formatting

This commit is contained in:
Shreyaschorge 2025-07-07 14:10:47 +05:30
parent f42a5f8d33
commit 193dffe03a
No known key found for this signature in database
64 changed files with 6398 additions and 985 deletions

29
.editorconfig Normal file
View File

@ -0,0 +1,29 @@
# EditorConfig is awesome: https://EditorConfig.org
# top-most EditorConfig file
root = true
# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
charset = utf-8
# Matches multiple files with brace expansion notation
[*.{js,jsx,ts,tsx,json,css,scss,md,mdx,yml,yaml}]
indent_style = space
indent_size = 2
# Tab indentation (no size specified)
[Makefile]
indent_style = tab
# Matches the exact files
[{package.json,.travis.yml}]
indent_style = space
indent_size = 2
# Markdown files
[*.md]
trim_trailing_whitespace = false

92
.eslintignore Normal file
View File

@ -0,0 +1,92 @@
# Dependencies
node_modules/
.pnp/
.pnp.*
# Build outputs
.next/
out/
build/
dist/
# Environment files
.env*
!.env.example
# Generated files
next-env.d.ts
*.tsbuildinfo
# Package manager lock files
package-lock.json
yarn.lock
pnpm-lock.yaml
# Vercel
.vercel/
# Logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.pnpm-debug.log*
# OS generated files
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db
# Editor files
.vscode/
.idea/
*.swp
*.swo
*~
# Git
.git/
# Temporary files
tmp/
temp/
# Coverage
coverage/
.nyc_output
# Cache directories
.cache/
.parcel-cache/
.eslintcache
# Storybook build outputs
storybook-static
# Database
*.db
*.sqlite
# Documentation
docs/
# Auto-generated files
*.d.ts
!src/**/*.d.ts
!types/**/*.d.ts
# Test coverage
*.lcov
# Compiled binary addons
build/Release
# Yarn
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz

View File

@ -1,3 +1,75 @@
{ {
"extends": ["next/core-web-vitals", "next/typescript"] "root": true,
"env": {
"browser": true,
"es2022": true,
"node": true
},
"extends": [
"eslint:recommended",
"@typescript-eslint/recommended",
"next/core-web-vitals",
"next/typescript",
"prettier"
],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": "latest",
"sourceType": "module",
"ecmaFeatures": {
"jsx": true
},
"project": "./tsconfig.json"
},
"plugins": ["@typescript-eslint", "prettier"],
"rules": {
"prettier/prettier": "error",
"@typescript-eslint/no-unused-vars": [
"error",
{
"argsIgnorePattern": "^_",
"varsIgnorePattern": "^_",
"caughtErrorsIgnorePattern": "^_"
}
],
"@typescript-eslint/explicit-function-return-type": "off",
"@typescript-eslint/explicit-module-boundary-types": "off",
"@typescript-eslint/no-explicit-any": "warn",
"@typescript-eslint/prefer-const": "error",
"@typescript-eslint/no-floating-promises": "error",
"@typescript-eslint/await-thenable": "error",
"@typescript-eslint/no-misused-promises": "error",
"@typescript-eslint/require-await": "error",
"react/display-name": "off",
"react/prop-types": "off",
"react/jsx-uses-react": "off",
"react/react-in-jsx-scope": "off",
"no-console": ["warn", { "allow": ["warn", "error"] }],
"prefer-const": "error",
"no-var": "error",
"no-multiple-empty-lines": ["error", { "max": 1, "maxEOF": 0 }],
"no-trailing-spaces": "error",
"eol-last": "error",
"comma-dangle": ["error", "es5"],
"semi": ["error", "always"],
"quotes": ["error", "single", { "avoidEscape": true }]
},
"overrides": [
{
"files": ["*.js", "*.jsx"],
"rules": {
"@typescript-eslint/no-var-requires": "off",
"@typescript-eslint/no-floating-promises": "off",
"@typescript-eslint/await-thenable": "off",
"@typescript-eslint/no-misused-promises": "off",
"@typescript-eslint/require-await": "off"
}
},
{
"files": ["*.config.js", "*.config.ts", "next.config.*"],
"rules": {
"@typescript-eslint/no-var-requires": "off"
}
}
]
} }

22
.gitignore vendored
View File

@ -39,3 +39,25 @@ yarn-error.log*
# typescript # typescript
*.tsbuildinfo *.tsbuildinfo
next-env.d.ts next-env.d.ts
# IDE and editor files
.vscode/settings.json
.idea/
*.swp
*.swo
*~
# Linting and formatting cache
.eslintcache
.prettierignore.bak
# OS generated files
Thumbs.db
# Package manager files
.pnpm-debug.log*
.yarn-integrity
# Temporary files
tmp/
temp/

4
.lintstagedrc Normal file
View File

@ -0,0 +1,4 @@
{
"*.{js,jsx,ts,tsx}": ["eslint --fix", "prettier --write"],
"*.{json,css,scss,md,mdx,yml,yaml}": ["prettier --write"]
}

204
.prettierignore Normal file
View File

@ -0,0 +1,204 @@
# Dependencies
node_modules/
.pnp/
.pnp.*
# Build outputs
.next/
out/
build/
dist/
# Environment files
.env*
!.env.example
# Logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.pnpm-debug.log*
lerna-debug.log*
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Coverage directory used by tools like istanbul
coverage/
*.lcov
# nyc test coverage
.nyc_output
# Dependency directories
node_modules/
jspm_packages/
# Snowpack dependency directory
web_modules/
# TypeScript cache
*.tsbuildinfo
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# parcel-bundler cache
.cache
.parcel-cache
# Stores VSCode versions used for testing VSCode extensions
.vscode-test
# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
# Generated files
next-env.d.ts
# Package manager lock files
package-lock.json
yarn.lock
pnpm-lock.yaml
# Vercel
.vercel/
# OS generated files
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db
# Temporary files
tmp/
temp/
# Database
*.db
*.sqlite
# Compiled binary addons
build/Release
# Documentation
docs/
# Git
.git/
.gitignore
# Editor files
*.swp
*.swo
*~
# Changelog
CHANGELOG.md
# Auto-generated documentation
api-docs/
# Dependency directories
node_modules/
# TypeScript cache
*.tsbuildinfo
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache
# Next.js build output
.next
# Nuxt.js build / generate output
.nuxt
dist
# Storybook build outputs
.out
.storybook-out
# Temporary folders
tmp/
temp/
# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
# OS generated files
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db
# Vercel
.vercel
# Package manager lock files
package-lock.json
yarn.lock
pnpm-lock.yaml
# Git
.git/

17
.prettierrc Normal file
View File

@ -0,0 +1,17 @@
{
"semi": true,
"trailingComma": "es5",
"singleQuote": true,
"printWidth": 80,
"tabWidth": 2,
"useTabs": false,
"bracketSpacing": true,
"bracketSameLine": false,
"arrowParens": "avoid",
"endOfLine": "lf",
"quoteProps": "as-needed",
"proseWrap": "preserve",
"htmlWhitespaceSensitivity": "css",
"embeddedLanguageFormatting": "auto",
"singleAttributePerLine": false
}

13
.vscode/extensions.json vendored Normal file
View File

@ -0,0 +1,13 @@
{
"recommendations": [
"esbenp.prettier-vscode",
"dbaeumer.vscode-eslint",
"bradlc.vscode-tailwindcss",
"ms-vscode.vscode-typescript-next",
"editorconfig.editorconfig",
"christian-kohler.path-intellisense",
"ms-vscode.vscode-json",
"formulahendry.auto-rename-tag",
"christian-kohler.npm-intellisense"
]
}

226
FORMATTING.md Normal file
View File

@ -0,0 +1,226 @@
# Formatting and Code Style Guide
This project uses a comprehensive set of tools to ensure consistent code formatting and quality across the entire codebase.
## Tools Configured
### 🎨 **Prettier** - Code Formatter
- Automatically formats JavaScript, TypeScript, CSS, JSON, and Markdown files
- Configuration: `.prettierrc`
- Ignore patterns: `.prettierignore`
### 🔍 **ESLint** - Linter and Code Quality
- Enforces code quality rules and catches potential bugs
- Configuration: `.eslintrc.json`
- Ignore patterns: `.eslintignore`
### ⚙️ **EditorConfig** - Cross-Editor Consistency
- Ensures consistent indentation and line endings across different editors
- Configuration: `.editorconfig`
### 🔧 **VS Code Settings**
- Pre-configured workspace settings for optimal development experience
- Configuration: `.vscode/settings.json`
- Recommended extensions: `.vscode/extensions.json`
## Quick Start
### Installation
When you create a new project using this template, all formatting tools are already configured. Simply run:
```bash
npm install
```
### Available Scripts
#### Formatting
```bash
npm run format # Format all files with Prettier
npm run format:check # Check if files are properly formatted
npm run format:fix # Format files and fix ESLint issues
```
#### Linting
```bash
npm run lint # Run ESLint
npm run lint:fix # Run ESLint and auto-fix issues
npm run lint:check # Run ESLint with zero warnings tolerance
```
#### Type Checking
```bash
npm run type-check # Run TypeScript compiler without emitting files
```
#### Combined Checks
```bash
npm run check # Run type-check, lint:check, and format:check
```
## Editor Setup
### VS Code (Recommended)
1. Install recommended extensions when prompted
2. Formatting and linting will work automatically on save
3. Key extensions:
- **Prettier**: Code formatter
- **ESLint**: Linting and error detection
- **EditorConfig**: Consistent editor settings
### Other Editors
- **WebStorm/IntelliJ**: Built-in support for Prettier and ESLint
- **Vim/Neovim**: Use appropriate plugins for Prettier and ESLint
- **Emacs**: Configure with prettier-js and flycheck-eslint
## Configuration Details
### Prettier Configuration (`.prettierrc`)
```json
{
"semi": true,
"trailingComma": "es5",
"singleQuote": true,
"printWidth": 80,
"tabWidth": 2,
"useTabs": false,
"bracketSpacing": true,
"bracketSameLine": false,
"arrowParens": "avoid",
"endOfLine": "lf"
}
```
### Key ESLint Rules
- TypeScript and React best practices
- Prettier integration (no conflicts)
- Async/await safety rules
- Import organization
- Console warnings (allows warn/error)
### EditorConfig Settings
- 2-space indentation for most files
- LF line endings
- UTF-8 encoding
- Trim trailing whitespace
- Insert final newline
## Git Hooks (Optional)
You can set up pre-commit hooks using `husky` and `lint-staged`:
```bash
npm install --save-dev husky lint-staged
npx husky install
npx husky add .husky/pre-commit "npx lint-staged"
```
The project includes a `.lintstagedrc` configuration that will:
- Run ESLint and Prettier on staged JS/TS files
- Run Prettier on staged JSON, CSS, and Markdown files
## Team Guidelines
### Before Committing
1. Run `npm run check` to ensure code quality
2. Fix any linting errors or formatting issues
3. Commit your changes
### Pull Request Requirements
- All checks must pass
- Code must be properly formatted
- No ESLint warnings or errors
- TypeScript compilation must succeed
### Customization
If you need to modify the formatting rules:
1. **Prettier**: Edit `.prettierrc`
2. **ESLint**: Edit `.eslintrc.json`
3. **EditorConfig**: Edit `.editorconfig`
Remember to discuss any changes with your team first!
## Troubleshooting
### Common Issues
#### "Prettier and ESLint conflict"
- This shouldn't happen as we use `eslint-config-prettier`
- If it does, check that Prettier rules come last in ESLint extends
#### "Format on save not working"
- Ensure Prettier extension is installed and enabled
- Check VS Code settings for `editor.formatOnSave: true`
- Verify the file type is in ESLint validation array
#### "TypeScript errors in JavaScript files"
- Check file extension (.js vs .ts)
- Verify ESLint overrides for JavaScript files
#### "Formatting different in CI vs local"
- Ensure same Node.js version
- Check line ending settings (LF vs CRLF)
- Verify Prettier version consistency
### Getting Help
- Check the documentation for [Prettier](https://prettier.io/)
- Check the documentation for [ESLint](https://eslint.org/)
- Review [Next.js ESLint configuration](https://nextjs.org/docs/basic-features/eslint)
## Best Practices
### File Organization
- Keep configuration files in project root
- Use meaningful names for custom ESLint rules
- Group related imports together
### Code Style
- Use meaningful variable names
- Prefer `const` over `let` when possible
- Use template literals for string interpolation
- Keep functions small and focused
- Add JSDoc comments for complex functions
### React Specific
- Use functional components with hooks
- Prefer explicit prop types (TypeScript interfaces)
- Use meaningful component names
- Keep components focused on single responsibility
### TypeScript
- Enable strict mode
- Use proper types instead of `any`
- Leverage type inference where appropriate
- Use proper generic constraints
---
_This formatting guide is automatically included with every new project created from this template._

View File

@ -11,24 +11,51 @@ Check out [this Neynar docs page](https://docs.neynar.com/docs/create-farcaster-
## Getting Started ## Getting Started
To create a new mini app project, run: To create a new mini app project, run:
```{bash} ```{bash}
npx @neynar/create-farcaster-mini-app@latest npx @neynar/create-farcaster-mini-app@latest
``` ```
To run the project: To run the project:
```{bash} ```{bash}
cd <PROJECT_NAME> cd <PROJECT_NAME>
npm run dev npm run dev
``` ```
## Code Formatting & Linting
This template includes comprehensive formatting and linting tools to ensure consistent code quality:
- **Prettier**: Automatic code formatting
- **ESLint**: Code linting with Next.js and TypeScript support
- **EditorConfig**: Cross-editor consistency
### Available Scripts
```bash
npm run format # Format all files with Prettier
npm run format:check # Check if files are properly formatted
npm run lint # Run ESLint
npm run lint:fix # Fix ESLint issues automatically
npm run type-check # Run TypeScript type checking
npm run check # Run all checks (types, lint, format)
```
See [FORMATTING.md](./FORMATTING.md) for detailed configuration and setup information.
### Importing the CLI ### Importing the CLI
To invoke the CLI directly in JavaScript, add the npm package to your project and use the following import statement: To invoke the CLI directly in JavaScript, add the npm package to your project and use the following import statement:
```{javascript} ```{javascript}
import { init } from '@neynar/create-farcaster-mini-app'; import { init } from '@neynar/create-farcaster-mini-app';
``` ```
## Deploying to Vercel ## Deploying to Vercel
For projects that have made minimal changes to the quickstart template, deploy to vercel by running: For projects that have made minimal changes to the quickstart template, deploy to vercel by running:
```{bash} ```{bash}
npm run deploy:vercel npm run deploy:vercel
``` ```
@ -36,6 +63,7 @@ npm run deploy:vercel
## Building for Production ## Building for Production
To create a production build, run: To create a production build, run:
```{bash} ```{bash}
npm run build npm run build
``` ```
@ -51,11 +79,12 @@ This section is only for working on the script and template. If you simply want
To iterate on the CLI and test changes in a generated app without publishing to npm: To iterate on the CLI and test changes in a generated app without publishing to npm:
1. In your installer/template repo (this repo), run: 1. In your installer/template repo (this repo), run:
```bash ```bash
npm link npm link
``` ```
This makes your local version globally available as a symlinked package.
This makes your local version globally available as a symlinked package.
1. Now, when you run: 1. Now, when you run:
```bash ```bash
@ -76,4 +105,3 @@ However, this does not fully replicate the npx install flow and may not catch al
### Environment Variables and Scripts ### Environment Variables and Scripts
If you update environment variable handling, remember to replicate any changes in the `dev`, `build`, and `deploy` scripts as needed. The `build` and `deploy` scripts may need further updates and are less critical for most development workflows. If you update environment variable handling, remember to replicate any changes in the `dev`, `build`, and `deploy` scripts as needed. The `build` and `deploy` scripts may need further updates and are less critical for most development workflows.

View File

@ -25,7 +25,7 @@ if (autoAcceptDefaults && !projectName) {
autoAcceptDefaults = false; autoAcceptDefaults = false;
} }
init(projectName, autoAcceptDefaults).catch((err) => { init(projectName, autoAcceptDefaults).catch(err => {
console.error('Error:', err); console.error('Error:', err);
process.exit(1); process.exit(1);
}); });

View File

@ -1,18 +1,19 @@
#!/usr/bin/env node #!/usr/bin/env node
import inquirer from 'inquirer';
import { fileURLToPath } from 'url';
import { dirname } from 'path';
import { execSync } from 'child_process'; import { execSync } from 'child_process';
import fs from 'fs';
import path from 'path';
import crypto from 'crypto'; import crypto from 'crypto';
import fs from 'fs';
import inquirer from 'inquirer';
import path, { dirname } from 'path';
import { fileURLToPath } from 'url';
const __filename = fileURLToPath(import.meta.url); const __filename = fileURLToPath(import.meta.url);
const __dirname = dirname(__filename); const __dirname = dirname(__filename);
const REPO_URL = 'https://github.com/neynarxyz/create-farcaster-mini-app.git'; const REPO_URL = 'https://github.com/neynarxyz/create-farcaster-mini-app.git';
const SCRIPT_VERSION = JSON.parse(fs.readFileSync(path.join(__dirname, '..', 'package.json'), 'utf8')).version; const SCRIPT_VERSION = JSON.parse(
fs.readFileSync(path.join(__dirname, '..', 'package.json'), 'utf8')
).version;
// ANSI color codes // ANSI color codes
const purple = '\x1b[35m'; const purple = '\x1b[35m';
@ -48,8 +49,8 @@ async function queryNeynarApp(apiKey) {
`https://api.neynar.com/portal/app_by_api_key?starter_kit=true`, `https://api.neynar.com/portal/app_by_api_key?starter_kit=true`,
{ {
headers: { headers: {
'x-api-key': apiKey 'x-api-key': apiKey,
} },
} }
); );
const data = await response.json(); const data = await response.json();
@ -80,16 +81,17 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
{ {
type: 'confirm', type: 'confirm',
name: 'useNeynar', name: 'useNeynar',
message: `🪐 ${purple}${bright}${italic}Neynar is an API that makes it easy to build on Farcaster.${reset}\n\n` + message:
'Benefits of using Neynar in your mini app:\n' + `🪐 ${purple}${bright}${italic}Neynar is an API that makes it easy to build on Farcaster.${reset}\n\n` +
'- Pre-configured webhook handling (no setup required)\n' + 'Benefits of using Neynar in your mini app:\n' +
'- Automatic mini app analytics in your dev portal\n' + '- Pre-configured webhook handling (no setup required)\n' +
'- Send manual notifications from dev.neynar.com\n' + '- Automatic mini app analytics in your dev portal\n' +
'- Built-in rate limiting and error handling\n\n' + '- Send manual notifications from dev.neynar.com\n' +
`${purple}${bright}${italic}A demo API key is included if you would like to try out Neynar before signing up!${reset}\n\n` + '- Built-in rate limiting and error handling\n\n' +
'Would you like to use Neynar in your mini app?', `${purple}${bright}${italic}A demo API key is included if you would like to try out Neynar before signing up!${reset}\n\n` +
default: true 'Would you like to use Neynar in your mini app?',
} default: true,
},
]); ]);
} }
@ -98,8 +100,10 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
break; break;
} }
console.log('\n🪐 Find your Neynar API key at: https://dev.neynar.com/app\n'); console.log(
'\n🪐 Find your Neynar API key at: https://dev.neynar.com/app\n'
);
let neynarKeyAnswer; let neynarKeyAnswer;
if (autoAcceptDefaults) { if (autoAcceptDefaults) {
neynarKeyAnswer = { neynarApiKey: null }; neynarKeyAnswer = { neynarApiKey: null };
@ -109,8 +113,8 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
type: 'password', type: 'password',
name: 'neynarApiKey', name: 'neynarApiKey',
message: 'Enter your Neynar API key (or press enter to skip):', message: 'Enter your Neynar API key (or press enter to skip):',
default: null default: null,
} },
]); ]);
} }
@ -126,15 +130,21 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
type: 'confirm', type: 'confirm',
name: 'useDemo', name: 'useDemo',
message: 'Would you like to try the demo Neynar API key?', message: 'Would you like to try the demo Neynar API key?',
default: true default: true,
} },
]); ]);
} }
if (useDemoKey.useDemo) { if (useDemoKey.useDemo) {
console.warn('\n⚠ Note: the demo key is for development purposes only and is aggressively rate limited.'); console.warn(
console.log('For production, please sign up for a Neynar account at https://neynar.com/ and configure the API key in your .env or .env.local file with NEYNAR_API_KEY.'); '\n⚠ Note: the demo key is for development purposes only and is aggressively rate limited.'
console.log(`\n${purple}${bright}${italic}Neynar now has a free tier! See https://neynar.com/#pricing for details.\n${reset}`); );
console.log(
'For production, please sign up for a Neynar account at https://neynar.com/ and configure the API key in your .env or .env.local file with NEYNAR_API_KEY.'
);
console.log(
`\n${purple}${bright}${italic}Neynar now has a free tier! See https://neynar.com/#pricing for details.\n${reset}`
);
neynarApiKey = 'FARCASTER_V2_FRAMES_DEMO'; neynarApiKey = 'FARCASTER_V2_FRAMES_DEMO';
} }
} }
@ -144,14 +154,16 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
useNeynar = false; useNeynar = false;
break; break;
} }
console.log('\n⚠ No valid API key provided. Would you like to try again?'); console.log(
'\n⚠ No valid API key provided. Would you like to try again?'
);
const { retry } = await inquirer.prompt([ const { retry } = await inquirer.prompt([
{ {
type: 'confirm', type: 'confirm',
name: 'retry', name: 'retry',
message: 'Try configuring Neynar again?', message: 'Try configuring Neynar again?',
default: true default: true,
} },
]); ]);
if (!retry) { if (!retry) {
useNeynar = false; useNeynar = false;
@ -176,9 +188,10 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
{ {
type: 'confirm', type: 'confirm',
name: 'retry', name: 'retry',
message: '⚠️ Could not find a client ID for this API key. Would you like to try configuring Neynar again?', message:
default: true '⚠️ Could not find a client ID for this API key. Would you like to try configuring Neynar again?',
} default: true,
},
]); ]);
if (!retry) { if (!retry) {
useNeynar = false; useNeynar = false;
@ -191,7 +204,10 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
break; break;
} }
const defaultMiniAppName = (neynarAppName && !neynarAppName.toLowerCase().includes('demo')) ? neynarAppName : undefined; const defaultMiniAppName =
neynarAppName && !neynarAppName.toLowerCase().includes('demo')
? neynarAppName
: undefined;
let answers; let answers;
if (autoAcceptDefaults) { if (autoAcceptDefaults) {
@ -203,7 +219,7 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
buttonText: 'Launch Mini App', buttonText: 'Launch Mini App',
useWallet: true, useWallet: true,
useTunnel: true, useTunnel: true,
enableAnalytics: true enableAnalytics: true,
}; };
} else { } else {
// If autoAcceptDefaults is false but we have a projectName, we still need to ask for other options // If autoAcceptDefaults is false but we have a projectName, we still need to ask for other options
@ -213,26 +229,27 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
name: 'projectName', name: 'projectName',
message: 'What is the name of your mini app?', message: 'What is the name of your mini app?',
default: projectName || defaultMiniAppName, default: projectName || defaultMiniAppName,
validate: (input) => { validate: input => {
if (input.trim() === '') { if (input.trim() === '') {
return 'Project name cannot be empty'; return 'Project name cannot be empty';
} }
return true; return true;
} },
} },
]); ]);
answers = await inquirer.prompt([ answers = await inquirer.prompt([
{ {
type: 'input', type: 'input',
name: 'description', name: 'description',
message: 'Give a one-line description of your mini app (optional):', message: 'Give a one-line description of your mini app (optional):',
default: 'A Farcaster mini app created with Neynar' default: 'A Farcaster mini app created with Neynar',
}, },
{ {
type: 'list', type: 'list',
name: 'primaryCategory', name: 'primaryCategory',
message: 'It is strongly recommended to choose a primary category and tags to help users discover your mini app.\n\nSelect a primary category:', message:
'It is strongly recommended to choose a primary category and tags to help users discover your mini app.\n\nSelect a primary category:',
choices: [ choices: [
new inquirer.Separator(), new inquirer.Separator(),
{ name: 'Skip (not recommended)', value: null }, { name: 'Skip (not recommended)', value: null },
@ -249,36 +266,37 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
{ name: 'Education', value: 'education' }, { name: 'Education', value: 'education' },
{ name: 'Developer Tools', value: 'developer-tools' }, { name: 'Developer Tools', value: 'developer-tools' },
{ name: 'Entertainment', value: 'entertainment' }, { name: 'Entertainment', value: 'entertainment' },
{ name: 'Art & Creativity', value: 'art-creativity' } { name: 'Art & Creativity', value: 'art-creativity' },
], ],
default: null default: null,
}, },
{ {
type: 'input', type: 'input',
name: 'tags', name: 'tags',
message: 'Enter tags for your mini app (separate with spaces or commas, optional):', message:
'Enter tags for your mini app (separate with spaces or commas, optional):',
default: '', default: '',
filter: (input) => { filter: input => {
if (!input.trim()) return []; if (!input.trim()) return [];
// Split by both spaces and commas, trim whitespace, and filter out empty strings // Split by both spaces and commas, trim whitespace, and filter out empty strings
return input return input
.split(/[,\s]+/) .split(/[,\s]+/)
.map(tag => tag.trim()) .map(tag => tag.trim())
.filter(tag => tag.length > 0); .filter(tag => tag.length > 0);
} },
}, },
{ {
type: 'input', type: 'input',
name: 'buttonText', name: 'buttonText',
message: 'Enter the button text for your mini app:', message: 'Enter the button text for your mini app:',
default: 'Launch Mini App', default: 'Launch Mini App',
validate: (input) => { validate: input => {
if (input.trim() === '') { if (input.trim() === '') {
return 'Button text cannot be empty'; return 'Button text cannot be empty';
} }
return true; return true;
} },
} },
]); ]);
// Merge project name from the first prompt // Merge project name from the first prompt
@ -289,7 +307,8 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
{ {
type: 'confirm', type: 'confirm',
name: 'useWallet', name: 'useWallet',
message: 'Would you like to include wallet and transaction tooling in your mini app?\n' + message:
'Would you like to include wallet and transaction tooling in your mini app?\n' +
'This includes:\n' + 'This includes:\n' +
'- EVM wallet connection\n' + '- EVM wallet connection\n' +
'- Transaction signing\n' + '- Transaction signing\n' +
@ -297,8 +316,8 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
'- Chain switching\n' + '- Chain switching\n' +
'- Solana support\n\n' + '- Solana support\n\n' +
'Include wallet and transaction features?', 'Include wallet and transaction features?',
default: true default: true,
} },
]); ]);
answers.useWallet = walletAnswer.useWallet; answers.useWallet = walletAnswer.useWallet;
@ -307,11 +326,12 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
{ {
type: 'confirm', type: 'confirm',
name: 'useTunnel', name: 'useTunnel',
message: 'Would you like to test on mobile and/or test the app with Warpcast developer tools?\n' + message:
'Would you like to test on mobile and/or test the app with Warpcast developer tools?\n' +
`⚠️ ${yellow}${italic}Both mobile testing and the Warpcast debugger require setting up a tunnel to serve your app from localhost to the broader internet.\n${reset}` + `⚠️ ${yellow}${italic}Both mobile testing and the Warpcast debugger require setting up a tunnel to serve your app from localhost to the broader internet.\n${reset}` +
'Configure a tunnel for mobile testing and/or Warpcast developer tools?', 'Configure a tunnel for mobile testing and/or Warpcast developer tools?',
default: true default: true,
} },
]); ]);
answers.useTunnel = hostingAnswer.useTunnel; answers.useTunnel = hostingAnswer.useTunnel;
@ -320,9 +340,10 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
{ {
type: 'confirm', type: 'confirm',
name: 'enableAnalytics', name: 'enableAnalytics',
message: 'Would you like to help improve Neynar products by sharing usage data from your mini app?', message:
default: true 'Would you like to help improve Neynar products by sharing usage data from your mini app?',
} default: true,
},
]); ]);
answers.enableAnalytics = analyticsAnswer.enableAnalytics; answers.enableAnalytics = analyticsAnswer.enableAnalytics;
} }
@ -337,19 +358,19 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
try { try {
console.log(`\nCloning repository from ${REPO_URL}...`); console.log(`\nCloning repository from ${REPO_URL}...`);
// Use separate commands for better cross-platform compatibility // Use separate commands for better cross-platform compatibility
execSync(`git clone ${REPO_URL} "${projectPath}"`, { execSync(`git clone ${REPO_URL} "${projectPath}"`, {
stdio: 'inherit', stdio: 'inherit',
shell: process.platform === 'win32' shell: process.platform === 'win32',
}); });
execSync('git fetch origin main', { execSync('git fetch origin main', {
cwd: projectPath, cwd: projectPath,
stdio: 'inherit', stdio: 'inherit',
shell: process.platform === 'win32' shell: process.platform === 'win32',
}); });
execSync('git reset --hard origin/main', { execSync('git reset --hard origin/main', {
cwd: projectPath, cwd: projectPath,
stdio: 'inherit', stdio: 'inherit',
shell: process.platform === 'win32' shell: process.platform === 'win32',
}); });
} catch (error) { } catch (error) {
console.error('\n❌ Error: Failed to create project directory.'); console.error('\n❌ Error: Failed to create project directory.');
@ -386,47 +407,52 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
// Add dependencies // Add dependencies
packageJson.dependencies = { packageJson.dependencies = {
"@farcaster/auth-client": ">=0.3.0 <1.0.0", '@farcaster/auth-client': '>=0.3.0 <1.0.0',
"@farcaster/auth-kit": ">=0.6.0 <1.0.0", '@farcaster/auth-kit': '>=0.6.0 <1.0.0',
"@farcaster/frame-core": ">=0.0.29 <1.0.0", '@farcaster/frame-core': '>=0.0.29 <1.0.0',
"@farcaster/frame-node": ">=0.0.18 <1.0.0", '@farcaster/frame-node': '>=0.0.18 <1.0.0',
"@farcaster/frame-sdk": ">=0.0.31 <1.0.0", '@farcaster/frame-sdk': '>=0.0.31 <1.0.0',
"@farcaster/frame-wagmi-connector": ">=0.0.19 <1.0.0", '@farcaster/frame-wagmi-connector': '>=0.0.19 <1.0.0',
"@farcaster/mini-app-solana": ">=0.0.17 <1.0.0", '@farcaster/mini-app-solana': '>=0.0.17 <1.0.0',
"@neynar/react": "^1.2.5", '@neynar/react': '^1.2.5',
"@radix-ui/react-label": "^2.1.1", '@radix-ui/react-label': '^2.1.1',
"@solana/wallet-adapter-react": "^0.15.38", '@solana/wallet-adapter-react': '^0.15.38',
"@tanstack/react-query": "^5.61.0", '@tanstack/react-query': '^5.61.0',
"@upstash/redis": "^1.34.3", '@upstash/redis': '^1.34.3',
"class-variance-authority": "^0.7.1", 'class-variance-authority': '^0.7.1',
"clsx": "^2.1.1", clsx: '^2.1.1',
"dotenv": "^16.4.7", dotenv: '^16.4.7',
"lucide-react": "^0.469.0", 'lucide-react': '^0.469.0',
"mipd": "^0.0.7", mipd: '^0.0.7',
"next": "^15", next: '^15',
"next-auth": "^4.24.11", 'next-auth': '^4.24.11',
"react": "^19", react: '^19',
"react-dom": "^19", 'react-dom': '^19',
"tailwind-merge": "^2.6.0", 'tailwind-merge': '^2.6.0',
"tailwindcss-animate": "^1.0.7", 'tailwindcss-animate': '^1.0.7',
"viem": "^2.23.6", viem: '^2.23.6',
"wagmi": "^2.14.12", wagmi: '^2.14.12',
"zod": "^3.24.2" zod: '^3.24.2',
}; };
packageJson.devDependencies = { packageJson.devDependencies = {
"@types/node": "^20", '@types/node': '^20',
"@types/react": "^19", '@types/react': '^19',
"@types/react-dom": "^19", '@types/react-dom': '^19',
"@vercel/sdk": "^1.9.0", '@typescript-eslint/eslint-plugin': '^8.0.0',
"crypto": "^1.0.1", '@typescript-eslint/parser': '^8.0.0',
"eslint": "^8", '@vercel/sdk': '^1.9.0',
"eslint-config-next": "15.0.3", crypto: '^1.0.1',
"localtunnel": "^2.0.2", eslint: '^8.57.0',
"pino-pretty": "^13.0.0", 'eslint-config-next': '15.0.3',
"postcss": "^8", 'eslint-config-prettier': '^9.1.0',
"tailwindcss": "^3.4.1", 'eslint-plugin-prettier': '^5.2.1',
"typescript": "^5" localtunnel: '^2.0.2',
'pino-pretty': '^13.0.0',
postcss: '^8',
prettier: '^3.3.3',
tailwindcss: '^3.4.1',
typescript: '^5',
}; };
// Add Neynar SDK if selected // Add Neynar SDK if selected
@ -434,6 +460,15 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
packageJson.dependencies['@neynar/nodejs-sdk'] = '^2.19.0'; packageJson.dependencies['@neynar/nodejs-sdk'] = '^2.19.0';
} }
// Update scripts with formatting and linting
packageJson.scripts = {
...packageJson.scripts,
'lint:fix': 'next lint --fix',
format: 'prettier --write .',
'format:check': 'prettier --check .',
'type-check': 'tsc --noEmit',
};
fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2)); fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
// Handle .env file // Handle .env file
@ -452,35 +487,43 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
const constantsPath = path.join(projectPath, 'src', 'lib', 'constants.ts'); const constantsPath = path.join(projectPath, 'src', 'lib', 'constants.ts');
if (fs.existsSync(constantsPath)) { if (fs.existsSync(constantsPath)) {
let constantsContent = fs.readFileSync(constantsPath, 'utf8'); let constantsContent = fs.readFileSync(constantsPath, 'utf8');
// Helper function to escape single quotes in strings // Helper function to escape single quotes in strings
const escapeString = (str) => str.replace(/'/g, "\\'"); const escapeString = str => str.replace(/'/g, "\\'");
// Helper function to safely replace constants with validation // Helper function to safely replace constants with validation
const safeReplace = (content, pattern, replacement, constantName) => { const safeReplace = (content, pattern, replacement, constantName) => {
const match = content.match(pattern); const match = content.match(pattern);
if (!match) { if (!match) {
console.log(`⚠️ Warning: Could not update ${constantName} in constants.ts. Pattern not found.`); console.log(
`⚠️ Warning: Could not update ${constantName} in constants.ts. Pattern not found.`
);
console.log(`Pattern: ${pattern}`); console.log(`Pattern: ${pattern}`);
console.log(`Expected to match in: ${content.split('\n').find(line => line.includes(constantName)) || 'Not found'}`); console.log(
`Expected to match in: ${content.split('\n').find(line => line.includes(constantName)) || 'Not found'}`
);
} else { } else {
const newContent = content.replace(pattern, replacement); const newContent = content.replace(pattern, replacement);
return newContent; return newContent;
} }
return content; return content;
}; };
// Regex patterns that match whole lines with export const // Regex patterns that match whole lines with export const
const patterns = { const patterns = {
APP_NAME: /^export const APP_NAME\s*=\s*['"`][^'"`]*['"`];$/m, APP_NAME: /^export const APP_NAME\s*=\s*['"`][^'"`]*['"`];$/m,
APP_DESCRIPTION: /^export const APP_DESCRIPTION\s*=\s*['"`][^'"`]*['"`];$/m, APP_DESCRIPTION:
APP_PRIMARY_CATEGORY: /^export const APP_PRIMARY_CATEGORY\s*=\s*['"`][^'"`]*['"`];$/m, /^export const APP_DESCRIPTION\s*=\s*['"`][^'"`]*['"`];$/m,
APP_PRIMARY_CATEGORY:
/^export const APP_PRIMARY_CATEGORY\s*=\s*['"`][^'"`]*['"`];$/m,
APP_TAGS: /^export const APP_TAGS\s*=\s*\[[^\]]*\];$/m, APP_TAGS: /^export const APP_TAGS\s*=\s*\[[^\]]*\];$/m,
APP_BUTTON_TEXT: /^export const APP_BUTTON_TEXT\s*=\s*['"`][^'"`]*['"`];$/m, APP_BUTTON_TEXT:
/^export const APP_BUTTON_TEXT\s*=\s*['"`][^'"`]*['"`];$/m,
USE_WALLET: /^export const USE_WALLET\s*=\s*(true|false);$/m, USE_WALLET: /^export const USE_WALLET\s*=\s*(true|false);$/m,
ANALYTICS_ENABLED: /^export const ANALYTICS_ENABLED\s*=\s*(true|false);$/m ANALYTICS_ENABLED:
/^export const ANALYTICS_ENABLED\s*=\s*(true|false);$/m,
}; };
// Update APP_NAME // Update APP_NAME
constantsContent = safeReplace( constantsContent = safeReplace(
constantsContent, constantsContent,
@ -488,7 +531,7 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
`export const APP_NAME = '${escapeString(answers.projectName)}';`, `export const APP_NAME = '${escapeString(answers.projectName)}';`,
'APP_NAME' 'APP_NAME'
); );
// Update APP_DESCRIPTION // Update APP_DESCRIPTION
constantsContent = safeReplace( constantsContent = safeReplace(
constantsContent, constantsContent,
@ -496,7 +539,7 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
`export const APP_DESCRIPTION = '${escapeString(answers.description)}';`, `export const APP_DESCRIPTION = '${escapeString(answers.description)}';`,
'APP_DESCRIPTION' 'APP_DESCRIPTION'
); );
// Update APP_PRIMARY_CATEGORY (always update, null becomes empty string) // Update APP_PRIMARY_CATEGORY (always update, null becomes empty string)
constantsContent = safeReplace( constantsContent = safeReplace(
constantsContent, constantsContent,
@ -504,18 +547,19 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
`export const APP_PRIMARY_CATEGORY = '${escapeString(answers.primaryCategory || '')}';`, `export const APP_PRIMARY_CATEGORY = '${escapeString(answers.primaryCategory || '')}';`,
'APP_PRIMARY_CATEGORY' 'APP_PRIMARY_CATEGORY'
); );
// Update APP_TAGS // Update APP_TAGS
const tagsString = answers.tags.length > 0 const tagsString =
? `['${answers.tags.map(tag => escapeString(tag)).join("', '")}']` answers.tags.length > 0
: "['neynar', 'starter-kit', 'demo']"; ? `['${answers.tags.map(tag => escapeString(tag)).join("', '")}']`
: "['neynar', 'starter-kit', 'demo']";
constantsContent = safeReplace( constantsContent = safeReplace(
constantsContent, constantsContent,
patterns.APP_TAGS, patterns.APP_TAGS,
`export const APP_TAGS = ${tagsString};`, `export const APP_TAGS = ${tagsString};`,
'APP_TAGS' 'APP_TAGS'
); );
// Update APP_BUTTON_TEXT (always update, use answers value) // Update APP_BUTTON_TEXT (always update, use answers value)
constantsContent = safeReplace( constantsContent = safeReplace(
constantsContent, constantsContent,
@ -523,7 +567,7 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
`export const APP_BUTTON_TEXT = '${escapeString(answers.buttonText || '')}';`, `export const APP_BUTTON_TEXT = '${escapeString(answers.buttonText || '')}';`,
'APP_BUTTON_TEXT' 'APP_BUTTON_TEXT'
); );
// Update USE_WALLET // Update USE_WALLET
constantsContent = safeReplace( constantsContent = safeReplace(
constantsContent, constantsContent,
@ -531,7 +575,7 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
`export const USE_WALLET = ${answers.useWallet};`, `export const USE_WALLET = ${answers.useWallet};`,
'USE_WALLET' 'USE_WALLET'
); );
// Update ANALYTICS_ENABLED // Update ANALYTICS_ENABLED
constantsContent = safeReplace( constantsContent = safeReplace(
constantsContent, constantsContent,
@ -539,24 +583,31 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
`export const ANALYTICS_ENABLED = ${answers.enableAnalytics};`, `export const ANALYTICS_ENABLED = ${answers.enableAnalytics};`,
'ANALYTICS_ENABLED' 'ANALYTICS_ENABLED'
); );
fs.writeFileSync(constantsPath, constantsContent); fs.writeFileSync(constantsPath, constantsContent);
} else { } else {
console.log('⚠️ constants.ts not found, skipping constants update'); console.log('⚠️ constants.ts not found, skipping constants update');
} }
fs.appendFileSync(envPath, `\nNEXTAUTH_SECRET="${crypto.randomBytes(32).toString('hex')}"`); fs.appendFileSync(
envPath,
`\nNEXTAUTH_SECRET="${crypto.randomBytes(32).toString('hex')}"`
);
if (useNeynar && neynarApiKey && neynarClientId) { if (useNeynar && neynarApiKey && neynarClientId) {
fs.appendFileSync(envPath, `\nNEYNAR_API_KEY="${neynarApiKey}"`); fs.appendFileSync(envPath, `\nNEYNAR_API_KEY="${neynarApiKey}"`);
fs.appendFileSync(envPath, `\nNEYNAR_CLIENT_ID="${neynarClientId}"`); fs.appendFileSync(envPath, `\nNEYNAR_CLIENT_ID="${neynarClientId}"`);
} else if (useNeynar) { } else if (useNeynar) {
console.log('\n⚠ Could not find a Neynar client ID and/or API key. Please configure Neynar manually in .env.local with NEYNAR_API_KEY and NEYNAR_CLIENT_ID'); console.log(
'\n⚠ Could not find a Neynar client ID and/or API key. Please configure Neynar manually in .env.local with NEYNAR_API_KEY and NEYNAR_CLIENT_ID'
);
} }
fs.appendFileSync(envPath, `\nUSE_TUNNEL="${answers.useTunnel}"`); fs.appendFileSync(envPath, `\nUSE_TUNNEL="${answers.useTunnel}"`);
fs.unlinkSync(envExamplePath); fs.unlinkSync(envExamplePath);
} else { } else {
console.log('\n.env.example does not exist, skipping copy and remove operations'); console.log(
'\n.env.example does not exist, skipping copy and remove operations'
);
} }
// Update README // Update README
@ -564,7 +615,9 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
const readmePath = path.join(projectPath, 'README.md'); const readmePath = path.join(projectPath, 'README.md');
const prependText = `<!-- generated by @neynar/create-farcaster-mini-app version ${SCRIPT_VERSION} -->\n\n`; const prependText = `<!-- generated by @neynar/create-farcaster-mini-app version ${SCRIPT_VERSION} -->\n\n`;
if (fs.existsSync(readmePath)) { if (fs.existsSync(readmePath)) {
const originalReadmeContent = fs.readFileSync(readmePath, { encoding: 'utf8' }); const originalReadmeContent = fs.readFileSync(readmePath, {
encoding: 'utf8',
});
const updatedReadmeContent = prependText + originalReadmeContent; const updatedReadmeContent = prependText + originalReadmeContent;
fs.writeFileSync(readmePath, updatedReadmeContent); fs.writeFileSync(readmePath, updatedReadmeContent);
} else { } else {
@ -574,15 +627,15 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
// Install dependencies // Install dependencies
console.log('\nInstalling dependencies...'); console.log('\nInstalling dependencies...');
execSync('npm cache clean --force', { execSync('npm cache clean --force', {
cwd: projectPath, cwd: projectPath,
stdio: 'inherit', stdio: 'inherit',
shell: process.platform === 'win32' shell: process.platform === 'win32',
}); });
execSync('npm install', { execSync('npm install', {
cwd: projectPath, cwd: projectPath,
stdio: 'inherit', stdio: 'inherit',
shell: process.platform === 'win32' shell: process.platform === 'win32',
}); });
// Remove the bin directory // Remove the bin directory
@ -596,12 +649,15 @@ export async function init(projectName = null, autoAcceptDefaults = false) {
console.log('\nInitializing git repository...'); console.log('\nInitializing git repository...');
execSync('git init', { cwd: projectPath }); execSync('git init', { cwd: projectPath });
execSync('git add .', { cwd: projectPath }); execSync('git add .', { cwd: projectPath });
execSync('git commit -m "initial commit from @neynar/create-farcaster-mini-app"', { cwd: projectPath }); execSync(
'git commit -m "initial commit from @neynar/create-farcaster-mini-app"',
{ cwd: projectPath }
);
// Calculate border length based on message length // Calculate border length based on message length
const message = `✨🪐 Successfully created mini app ${finalProjectName} with git and dependencies installed! 🪐✨`; const message = `✨🪐 Successfully created mini app ${finalProjectName} with git and dependencies installed! 🪐✨`;
const borderLength = message.length; const borderLength = message.length;
const borderStars = '✨'.repeat((borderLength / 2) + 1); const borderStars = '✨'.repeat(borderLength / 2 + 1);
console.log(`\n${borderStars}`); console.log(`\n${borderStars}`);
console.log(`${message}`); console.log(`${message}`);

View File

@ -18,4 +18,4 @@
"hooks": "~/hooks" "hooks": "~/hooks"
}, },
"iconLibrary": "lucide" "iconLibrary": "lucide"
} }

2
index.d.ts vendored
View File

@ -2,4 +2,4 @@
* Initialize a new Farcaster mini app project * Initialize a new Farcaster mini app project
* @returns Promise<void> * @returns Promise<void>
*/ */
export function init(): Promise<void>; export function init(): Promise<void>;

View File

@ -1,4 +1,4 @@
import type { NextConfig } from "next"; import type { NextConfig } from 'next';
const nextConfig: NextConfig = { const nextConfig: NextConfig = {
/* config options here */ /* config options here */

4302
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -35,6 +35,14 @@
"build:raw": "next build", "build:raw": "next build",
"start": "next start", "start": "next start",
"lint": "next lint", "lint": "next lint",
"lint:fix": "next lint --fix",
"lint:check": "next lint --max-warnings 0",
"format": "prettier --write .",
"format:check": "prettier --check .",
"format:fix": "prettier --write . && eslint --fix .",
"type-check": "tsc --noEmit",
"check": "npm run type-check && npm run lint:check && npm run format:check",
"prepare": "npm run check",
"deploy:vercel": "node scripts/deploy.js", "deploy:vercel": "node scripts/deploy.js",
"deploy:raw": "vercel --prod", "deploy:raw": "vercel --prod",
"cleanup": "node scripts/cleanup.js" "cleanup": "node scripts/cleanup.js"
@ -50,6 +58,13 @@
"devDependencies": { "devDependencies": {
"@neynar/nodejs-sdk": "^2.19.0", "@neynar/nodejs-sdk": "^2.19.0",
"@types/node": "^22.13.10", "@types/node": "^22.13.10",
"@typescript-eslint/eslint-plugin": "^8.0.0",
"@typescript-eslint/parser": "^8.0.0",
"eslint": "^8.57.0",
"eslint-config-next": "^15.0.0",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-prettier": "^5.2.1",
"prettier": "^3.3.3",
"typescript": "^5.6.3" "typescript": "^5.6.3"
} }
} }

View File

@ -26,9 +26,9 @@ async function lookupFidByCustodyAddress(custodyAddress, apiKey) {
`https://api.neynar.com/v2/farcaster/user/bulk-by-address?addresses=${lowerCasedCustodyAddress}&address_types=custody_address`, `https://api.neynar.com/v2/farcaster/user/bulk-by-address?addresses=${lowerCasedCustodyAddress}&address_types=custody_address`,
{ {
headers: { headers: {
'accept': 'application/json', accept: 'application/json',
'x-api-key': 'FARCASTER_V2_FRAMES_DEMO' 'x-api-key': 'FARCASTER_V2_FRAMES_DEMO',
} },
} }
); );
@ -37,7 +37,10 @@ async function lookupFidByCustodyAddress(custodyAddress, apiKey) {
} }
const data = await response.json(); const data = await response.json();
if (!data[lowerCasedCustodyAddress]?.length || !data[lowerCasedCustodyAddress][0].custody_address) { if (
!data[lowerCasedCustodyAddress]?.length ||
!data[lowerCasedCustodyAddress][0].custody_address
) {
throw new Error('No FID found for this custody address'); throw new Error('No FID found for this custody address');
} }
@ -51,19 +54,22 @@ async function loadEnvLocal() {
{ {
type: 'confirm', type: 'confirm',
name: 'loadLocal', name: 'loadLocal',
message: 'Found .env.local, likely created by the install script - would you like to load its values?', message:
default: false 'Found .env.local, likely created by the install script - would you like to load its values?',
} default: false,
},
]); ]);
if (loadLocal) { if (loadLocal) {
console.log('Loading values from .env.local...'); console.log('Loading values from .env.local...');
const localEnv = dotenv.parse(fs.readFileSync('.env.local')); const localEnv = dotenv.parse(fs.readFileSync('.env.local'));
// Copy all values except SEED_PHRASE to .env // Copy all values except SEED_PHRASE to .env
const envContent = fs.existsSync('.env') ? fs.readFileSync('.env', 'utf8') + '\n' : ''; const envContent = fs.existsSync('.env')
? fs.readFileSync('.env', 'utf8') + '\n'
: '';
let newEnvContent = envContent; let newEnvContent = envContent;
for (const [key, value] of Object.entries(localEnv)) { for (const [key, value] of Object.entries(localEnv)) {
if (key !== 'SEED_PHRASE') { if (key !== 'SEED_PHRASE') {
// Update process.env // Update process.env
@ -74,7 +80,7 @@ async function loadEnvLocal() {
} }
} }
} }
// Write updated content to .env // Write updated content to .env
fs.writeFileSync('.env', newEnvContent); fs.writeFileSync('.env', newEnvContent);
console.log('✅ Values from .env.local have been written to .env'); console.log('✅ Values from .env.local have been written to .env');
@ -102,9 +108,13 @@ const projectRoot = path.join(__dirname, '..');
async function validateDomain(domain) { async function validateDomain(domain) {
// Remove http:// or https:// if present // Remove http:// or https:// if present
const cleanDomain = domain.replace(/^https?:\/\//, ''); const cleanDomain = domain.replace(/^https?:\/\//, '');
// Basic domain validation // Basic domain validation
if (!cleanDomain.match(/^[a-zA-Z0-9][a-zA-Z0-9-]{1,61}[a-zA-Z0-9](?:\.[a-zA-Z]{2,})+$/)) { if (
!cleanDomain.match(
/^[a-zA-Z0-9][a-zA-Z0-9-]{1,61}[a-zA-Z0-9](?:\.[a-zA-Z]{2,})+$/
)
) {
throw new Error('Invalid domain format'); throw new Error('Invalid domain format');
} }
@ -120,8 +130,8 @@ async function queryNeynarApp(apiKey) {
`https://api.neynar.com/portal/app_by_api_key`, `https://api.neynar.com/portal/app_by_api_key`,
{ {
headers: { headers: {
'x-api-key': apiKey 'x-api-key': apiKey,
} },
} }
); );
const data = await response.json(); const data = await response.json();
@ -142,24 +152,36 @@ async function validateSeedPhrase(seedPhrase) {
} }
} }
async function generateFarcasterMetadata(domain, fid, accountAddress, seedPhrase, webhookUrl) { async function generateFarcasterMetadata(
domain,
fid,
accountAddress,
seedPhrase,
webhookUrl
) {
const header = { const header = {
type: 'custody', type: 'custody',
key: accountAddress, key: accountAddress,
fid, fid,
}; };
const encodedHeader = Buffer.from(JSON.stringify(header), 'utf-8').toString('base64'); const encodedHeader = Buffer.from(JSON.stringify(header), 'utf-8').toString(
'base64'
);
const payload = { const payload = {
domain domain,
}; };
const encodedPayload = Buffer.from(JSON.stringify(payload), 'utf-8').toString('base64url'); const encodedPayload = Buffer.from(JSON.stringify(payload), 'utf-8').toString(
'base64url'
);
const account = mnemonicToAccount(seedPhrase); const account = mnemonicToAccount(seedPhrase);
const signature = await account.signMessage({ const signature = await account.signMessage({
message: `${encodedHeader}.${encodedPayload}` message: `${encodedHeader}.${encodedPayload}`,
}); });
const encodedSignature = Buffer.from(signature, 'utf-8').toString('base64url'); const encodedSignature = Buffer.from(signature, 'utf-8').toString(
'base64url'
);
const tags = process.env.NEXT_PUBLIC_MINI_APP_TAGS?.split(','); const tags = process.env.NEXT_PUBLIC_MINI_APP_TAGS?.split(',');
@ -167,17 +189,17 @@ async function generateFarcasterMetadata(domain, fid, accountAddress, seedPhrase
accountAssociation: { accountAssociation: {
header: encodedHeader, header: encodedHeader,
payload: encodedPayload, payload: encodedPayload,
signature: encodedSignature signature: encodedSignature,
}, },
frame: { frame: {
version: "1", version: '1',
name: process.env.NEXT_PUBLIC_MINI_APP_NAME, name: process.env.NEXT_PUBLIC_MINI_APP_NAME,
iconUrl: `https://${domain}/icon.png`, iconUrl: `https://${domain}/icon.png`,
homeUrl: `https://${domain}`, homeUrl: `https://${domain}`,
imageUrl: `https://${domain}/api/opengraph-image`, imageUrl: `https://${domain}/api/opengraph-image`,
buttonTitle: process.env.NEXT_PUBLIC_MINI_APP_BUTTON_TEXT, buttonTitle: process.env.NEXT_PUBLIC_MINI_APP_BUTTON_TEXT,
splashImageUrl: `https://${domain}/splash.png`, splashImageUrl: `https://${domain}/splash.png`,
splashBackgroundColor: "#f7f7f7", splashBackgroundColor: '#f7f7f7',
webhookUrl, webhookUrl,
description: process.env.NEXT_PUBLIC_MINI_APP_DESCRIPTION, description: process.env.NEXT_PUBLIC_MINI_APP_DESCRIPTION,
primaryCategory: process.env.NEXT_PUBLIC_MINI_APP_PRIMARY_CATEGORY, primaryCategory: process.env.NEXT_PUBLIC_MINI_APP_PRIMARY_CATEGORY,
@ -190,7 +212,7 @@ async function main() {
try { try {
console.log('\n📝 Checking environment variables...'); console.log('\n📝 Checking environment variables...');
console.log('Loading values from .env...'); console.log('Loading values from .env...');
// Load .env.local if user wants to // Load .env.local if user wants to
await loadEnvLocal(); await loadEnvLocal();
@ -199,16 +221,17 @@ async function main() {
{ {
type: 'input', type: 'input',
name: 'domain', name: 'domain',
message: 'Enter the domain where your mini app will be deployed (e.g., example.com):', message:
validate: async (input) => { 'Enter the domain where your mini app will be deployed (e.g., example.com):',
validate: async input => {
try { try {
await validateDomain(input); await validateDomain(input);
return true; return true;
} catch (error) { } catch (error) {
return error.message; return error.message;
} }
} },
} },
]); ]);
// Get frame name from user // Get frame name from user
@ -218,13 +241,13 @@ async function main() {
name: 'frameName', name: 'frameName',
message: 'Enter the name for your mini app (e.g., My Cool Mini App):', message: 'Enter the name for your mini app (e.g., My Cool Mini App):',
default: process.env.NEXT_PUBLIC_MINI_APP_NAME, default: process.env.NEXT_PUBLIC_MINI_APP_NAME,
validate: (input) => { validate: input => {
if (input.trim() === '') { if (input.trim() === '') {
return 'Mini app name cannot be empty'; return 'Mini app name cannot be empty';
} }
return true; return true;
} },
} },
]); ]);
// Get button text from user // Get button text from user
@ -233,14 +256,15 @@ async function main() {
type: 'input', type: 'input',
name: 'buttonText', name: 'buttonText',
message: 'Enter the text for your mini app button:', message: 'Enter the text for your mini app button:',
default: process.env.NEXT_PUBLIC_MINI_APP_BUTTON_TEXT || 'Launch Mini App', default:
validate: (input) => { process.env.NEXT_PUBLIC_MINI_APP_BUTTON_TEXT || 'Launch Mini App',
validate: input => {
if (input.trim() === '') { if (input.trim() === '') {
return 'Button text cannot be empty'; return 'Button text cannot be empty';
} }
return true; return true;
} },
} },
]); ]);
// Get Neynar configuration // Get Neynar configuration
@ -254,9 +278,10 @@ async function main() {
{ {
type: 'password', type: 'password',
name: 'neynarApiKey', name: 'neynarApiKey',
message: 'Enter your Neynar API key (optional - leave blank to skip):', message:
default: null 'Enter your Neynar API key (optional - leave blank to skip):',
} default: null,
},
]); ]);
neynarApiKey = inputNeynarApiKey; neynarApiKey = inputNeynarApiKey;
} else { } else {
@ -284,14 +309,16 @@ async function main() {
} }
// If we get here, the API key was invalid // If we get here, the API key was invalid
console.log('\n⚠ Could not find Neynar app information. The API key may be incorrect.'); console.log(
'\n⚠ Could not find Neynar app information. The API key may be incorrect.'
);
const { retry } = await inquirer.prompt([ const { retry } = await inquirer.prompt([
{ {
type: 'confirm', type: 'confirm',
name: 'retry', name: 'retry',
message: 'Would you like to try a different API key?', message: 'Would you like to try a different API key?',
default: true default: true,
} },
]); ]);
// Reset for retry // Reset for retry
@ -311,18 +338,19 @@ async function main() {
{ {
type: 'password', type: 'password',
name: 'seedPhrase', name: 'seedPhrase',
message: 'Your farcaster custody account seed phrase is required to create a signature proving this app was created by you.\n' + message:
`⚠️ ${yellow}${italic}seed phrase is only used to sign the mini app manifest, then discarded${reset} ⚠️\n` + 'Your farcaster custody account seed phrase is required to create a signature proving this app was created by you.\n' +
'Seed phrase:', `⚠️ ${yellow}${italic}seed phrase is only used to sign the mini app manifest, then discarded${reset} ⚠️\n` +
validate: async (input) => { 'Seed phrase:',
validate: async input => {
try { try {
await validateSeedPhrase(input); await validateSeedPhrase(input);
return true; return true;
} catch (error) { } catch (error) {
return error.message; return error.message;
} }
} },
} },
]); ]);
seedPhrase = inputSeedPhrase; seedPhrase = inputSeedPhrase;
} else { } else {
@ -333,22 +361,36 @@ async function main() {
const accountAddress = await validateSeedPhrase(seedPhrase); const accountAddress = await validateSeedPhrase(seedPhrase);
console.log('✅ Generated account address from seed phrase'); console.log('✅ Generated account address from seed phrase');
const fid = await lookupFidByCustodyAddress(accountAddress, neynarApiKey ?? 'FARCASTER_V2_FRAMES_DEMO'); const fid = await lookupFidByCustodyAddress(
accountAddress,
neynarApiKey ?? 'FARCASTER_V2_FRAMES_DEMO'
);
// Generate and sign manifest // Generate and sign manifest
console.log('\n🔨 Generating mini app manifest...'); console.log('\n🔨 Generating mini app manifest...');
// Determine webhook URL based on environment variables
const webhookUrl = neynarApiKey && neynarClientId
? `https://api.neynar.com/f/app/${neynarClientId}/event`
: `${domain}/api/webhook`;
const metadata = await generateFarcasterMetadata(domain, fid, accountAddress, seedPhrase, webhookUrl); // Determine webhook URL based on environment variables
console.log('\n✅ Mini app manifest generated' + (seedPhrase ? ' and signed' : '')); const webhookUrl =
neynarApiKey && neynarClientId
? `https://api.neynar.com/f/app/${neynarClientId}/event`
: `${domain}/api/webhook`;
const metadata = await generateFarcasterMetadata(
domain,
fid,
accountAddress,
seedPhrase,
webhookUrl
);
console.log(
'\n✅ Mini app manifest generated' + (seedPhrase ? ' and signed' : '')
);
// Read existing .env file or create new one // Read existing .env file or create new one
const envPath = path.join(projectRoot, '.env'); const envPath = path.join(projectRoot, '.env');
let envContent = fs.existsSync(envPath) ? fs.readFileSync(envPath, 'utf8') : ''; let envContent = fs.existsSync(envPath)
? fs.readFileSync(envPath, 'utf8')
: '';
// Add or update environment variables // Add or update environment variables
const newEnvVars = [ const newEnvVars = [
@ -366,10 +408,10 @@ async function main() {
`NEXT_PUBLIC_ANALYTICS_ENABLED="${process.env.NEXT_PUBLIC_ANALYTICS_ENABLED || 'false'}"`, `NEXT_PUBLIC_ANALYTICS_ENABLED="${process.env.NEXT_PUBLIC_ANALYTICS_ENABLED || 'false'}"`,
// Neynar configuration (if it exists in current env) // Neynar configuration (if it exists in current env)
...(process.env.NEYNAR_API_KEY ? ...(process.env.NEYNAR_API_KEY
[`NEYNAR_API_KEY="${process.env.NEYNAR_API_KEY}"`] : []), ? [`NEYNAR_API_KEY="${process.env.NEYNAR_API_KEY}"`]
...(neynarClientId ? : []),
[`NEYNAR_CLIENT_ID="${neynarClientId}"`] : []), ...(neynarClientId ? [`NEYNAR_CLIENT_ID="${neynarClientId}"`] : []),
// FID (if it exists in current env) // FID (if it exists in current env)
...(process.env.FID ? [`FID="${process.env.FID}"`] : []), ...(process.env.FID ? [`FID="${process.env.FID}"`] : []),
@ -406,16 +448,21 @@ async function main() {
// Run next build // Run next build
console.log('\nBuilding Next.js application...'); console.log('\nBuilding Next.js application...');
const nextBin = path.normalize(path.join(projectRoot, 'node_modules', '.bin', 'next')); const nextBin = path.normalize(
execSync(`"${nextBin}" build`, { path.join(projectRoot, 'node_modules', '.bin', 'next')
cwd: projectRoot, );
execSync(`"${nextBin}" build`, {
cwd: projectRoot,
stdio: 'inherit', stdio: 'inherit',
shell: process.platform === 'win32' shell: process.platform === 'win32',
}); });
console.log('\n✨ Build complete! Your mini app is ready for deployment. 🪐'); console.log(
console.log('📝 Make sure to configure the environment variables from .env in your hosting provider'); '\n✨ Build complete! Your mini app is ready for deployment. 🪐'
);
console.log(
'📝 Make sure to configure the environment variables from .env in your hosting provider'
);
} catch (error) { } catch (error) {
console.error('\n❌ Error:', error.message); console.error('\n❌ Error:', error.message);
process.exit(1); process.exit(1);

View File

@ -21,13 +21,13 @@ args.forEach((arg, index) => {
try { try {
console.log(`Checking for processes on port ${port}...`); console.log(`Checking for processes on port ${port}...`);
// Find processes using the port // Find processes using the port
const pids = execSync(`lsof -ti :${port}`, { encoding: 'utf8' }).trim(); const pids = execSync(`lsof -ti :${port}`, { encoding: 'utf8' }).trim();
if (pids) { if (pids) {
console.log(`Found processes: ${pids.replace(/\n/g, ', ')}`); console.log(`Found processes: ${pids.replace(/\n/g, ', ')}`);
// Kill the processes // Kill the processes
execSync(`kill -9 ${pids.replace(/\n/g, ' ')}`); execSync(`kill -9 ${pids.replace(/\n/g, ' ')}`);
console.log(`✓ Processes on port ${port} have been terminated`); console.log(`✓ Processes on port ${port} have been terminated`);
@ -42,4 +42,4 @@ try {
console.error(`Error: ${error.message}`); console.error(`Error: ${error.message}`);
process.exit(1); process.exit(1);
} }
} }

View File

@ -34,9 +34,9 @@ async function lookupFidByCustodyAddress(custodyAddress, apiKey) {
`https://api.neynar.com/v2/farcaster/user/bulk-by-address?addresses=${lowerCasedCustodyAddress}&address_types=custody_address`, `https://api.neynar.com/v2/farcaster/user/bulk-by-address?addresses=${lowerCasedCustodyAddress}&address_types=custody_address`,
{ {
headers: { headers: {
'accept': 'application/json', accept: 'application/json',
'x-api-key': apiKey 'x-api-key': apiKey,
} },
} }
); );
@ -45,32 +45,47 @@ async function lookupFidByCustodyAddress(custodyAddress, apiKey) {
} }
const data = await response.json(); const data = await response.json();
if (!data[lowerCasedCustodyAddress]?.length || !data[lowerCasedCustodyAddress][0].custody_address) { if (
!data[lowerCasedCustodyAddress]?.length ||
!data[lowerCasedCustodyAddress][0].custody_address
) {
throw new Error('No FID found for this custody address'); throw new Error('No FID found for this custody address');
} }
return data[lowerCasedCustodyAddress][0].fid; return data[lowerCasedCustodyAddress][0].fid;
} }
async function generateFarcasterMetadata(domain, fid, accountAddress, seedPhrase, webhookUrl) { async function generateFarcasterMetadata(
domain,
fid,
accountAddress,
seedPhrase,
webhookUrl
) {
const trimmedDomain = domain.trim(); const trimmedDomain = domain.trim();
const header = { const header = {
type: 'custody', type: 'custody',
key: accountAddress, key: accountAddress,
fid, fid,
}; };
const encodedHeader = Buffer.from(JSON.stringify(header), 'utf-8').toString('base64'); const encodedHeader = Buffer.from(JSON.stringify(header), 'utf-8').toString(
'base64'
);
const payload = { const payload = {
domain: trimmedDomain domain: trimmedDomain,
}; };
const encodedPayload = Buffer.from(JSON.stringify(payload), 'utf-8').toString('base64url'); const encodedPayload = Buffer.from(JSON.stringify(payload), 'utf-8').toString(
'base64url'
);
const account = mnemonicToAccount(seedPhrase); const account = mnemonicToAccount(seedPhrase);
const signature = await account.signMessage({ const signature = await account.signMessage({
message: `${encodedHeader}.${encodedPayload}` message: `${encodedHeader}.${encodedPayload}`,
}); });
const encodedSignature = Buffer.from(signature, 'utf-8').toString('base64url'); const encodedSignature = Buffer.from(signature, 'utf-8').toString(
'base64url'
);
const tags = process.env.NEXT_PUBLIC_MINI_APP_TAGS?.split(','); const tags = process.env.NEXT_PUBLIC_MINI_APP_TAGS?.split(',');
@ -78,17 +93,17 @@ async function generateFarcasterMetadata(domain, fid, accountAddress, seedPhrase
accountAssociation: { accountAssociation: {
header: encodedHeader, header: encodedHeader,
payload: encodedPayload, payload: encodedPayload,
signature: encodedSignature signature: encodedSignature,
}, },
frame: { frame: {
version: "1", version: '1',
name: process.env.NEXT_PUBLIC_MINI_APP_NAME, name: process.env.NEXT_PUBLIC_MINI_APP_NAME,
iconUrl: `https://${trimmedDomain}/icon.png`, iconUrl: `https://${trimmedDomain}/icon.png`,
homeUrl: `https://${trimmedDomain}`, homeUrl: `https://${trimmedDomain}`,
imageUrl: `https://${trimmedDomain}/api/opengraph-image`, imageUrl: `https://${trimmedDomain}/api/opengraph-image`,
buttonTitle: process.env.NEXT_PUBLIC_MINI_APP_BUTTON_TEXT, buttonTitle: process.env.NEXT_PUBLIC_MINI_APP_BUTTON_TEXT,
splashImageUrl: `https://${trimmedDomain}/splash.png`, splashImageUrl: `https://${trimmedDomain}/splash.png`,
splashBackgroundColor: "#f7f7f7", splashBackgroundColor: '#f7f7f7',
webhookUrl: webhookUrl?.trim(), webhookUrl: webhookUrl?.trim(),
description: process.env.NEXT_PUBLIC_MINI_APP_DESCRIPTION, description: process.env.NEXT_PUBLIC_MINI_APP_DESCRIPTION,
primaryCategory: process.env.NEXT_PUBLIC_MINI_APP_PRIMARY_CATEGORY, primaryCategory: process.env.NEXT_PUBLIC_MINI_APP_PRIMARY_CATEGORY,
@ -104,15 +119,16 @@ async function loadEnvLocal() {
{ {
type: 'confirm', type: 'confirm',
name: 'loadLocal', name: 'loadLocal',
message: 'Found .env.local - would you like to load its values in addition to .env values? (except for SEED_PHRASE, values will be written to .env)', message:
default: true 'Found .env.local - would you like to load its values in addition to .env values? (except for SEED_PHRASE, values will be written to .env)',
} default: true,
},
]); ]);
if (loadLocal) { if (loadLocal) {
console.log('Loading values from .env.local...'); console.log('Loading values from .env.local...');
const localEnv = dotenv.parse(fs.readFileSync('.env.local')); const localEnv = dotenv.parse(fs.readFileSync('.env.local'));
const allowedVars = [ const allowedVars = [
'SEED_PHRASE', 'SEED_PHRASE',
'NEXT_PUBLIC_MINI_APP_NAME', 'NEXT_PUBLIC_MINI_APP_NAME',
@ -122,12 +138,14 @@ async function loadEnvLocal() {
'NEXT_PUBLIC_MINI_APP_BUTTON_TEXT', 'NEXT_PUBLIC_MINI_APP_BUTTON_TEXT',
'NEXT_PUBLIC_ANALYTICS_ENABLED', 'NEXT_PUBLIC_ANALYTICS_ENABLED',
'NEYNAR_API_KEY', 'NEYNAR_API_KEY',
'NEYNAR_CLIENT_ID' 'NEYNAR_CLIENT_ID',
]; ];
const envContent = fs.existsSync('.env') ? fs.readFileSync('.env', 'utf8') + '\n' : ''; const envContent = fs.existsSync('.env')
? fs.readFileSync('.env', 'utf8') + '\n'
: '';
let newEnvContent = envContent; let newEnvContent = envContent;
for (const [key, value] of Object.entries(localEnv)) { for (const [key, value] of Object.entries(localEnv)) {
if (allowedVars.includes(key)) { if (allowedVars.includes(key)) {
process.env[key] = value; process.env[key] = value;
@ -136,7 +154,7 @@ async function loadEnvLocal() {
} }
} }
} }
fs.writeFileSync('.env', newEnvContent); fs.writeFileSync('.env', newEnvContent);
console.log('✅ Values from .env.local have been written to .env'); console.log('✅ Values from .env.local have been written to .env');
} }
@ -149,7 +167,7 @@ async function loadEnvLocal() {
async function checkRequiredEnvVars() { async function checkRequiredEnvVars() {
console.log('\n📝 Checking environment variables...'); console.log('\n📝 Checking environment variables...');
console.log('Loading values from .env...'); console.log('Loading values from .env...');
await loadEnvLocal(); await loadEnvLocal();
const requiredVars = [ const requiredVars = [
@ -157,20 +175,23 @@ async function checkRequiredEnvVars() {
name: 'NEXT_PUBLIC_MINI_APP_NAME', name: 'NEXT_PUBLIC_MINI_APP_NAME',
message: 'Enter the name for your frame (e.g., My Cool Mini App):', message: 'Enter the name for your frame (e.g., My Cool Mini App):',
default: process.env.NEXT_PUBLIC_MINI_APP_NAME, default: process.env.NEXT_PUBLIC_MINI_APP_NAME,
validate: input => input.trim() !== '' || 'Mini app name cannot be empty' validate: input => input.trim() !== '' || 'Mini app name cannot be empty',
}, },
{ {
name: 'NEXT_PUBLIC_MINI_APP_BUTTON_TEXT', name: 'NEXT_PUBLIC_MINI_APP_BUTTON_TEXT',
message: 'Enter the text for your frame button:', message: 'Enter the text for your frame button:',
default: process.env.NEXT_PUBLIC_MINI_APP_BUTTON_TEXT ?? 'Launch Mini App', default:
validate: input => input.trim() !== '' || 'Button text cannot be empty' process.env.NEXT_PUBLIC_MINI_APP_BUTTON_TEXT ?? 'Launch Mini App',
} validate: input => input.trim() !== '' || 'Button text cannot be empty',
},
]; ];
const missingVars = requiredVars.filter(varConfig => !process.env[varConfig.name]); const missingVars = requiredVars.filter(
varConfig => !process.env[varConfig.name]
);
if (missingVars.length > 0) { if (missingVars.length > 0) {
console.log('\n⚠ Some required information is missing. Let\'s set it up:'); console.log("\n⚠ Some required information is missing. Let's set it up:");
for (const varConfig of missingVars) { for (const varConfig of missingVars) {
const { value } = await inquirer.prompt([ const { value } = await inquirer.prompt([
{ {
@ -178,17 +199,22 @@ async function checkRequiredEnvVars() {
name: 'value', name: 'value',
message: varConfig.message, message: varConfig.message,
default: varConfig.default, default: varConfig.default,
validate: varConfig.validate validate: varConfig.validate,
} },
]); ]);
process.env[varConfig.name] = value; process.env[varConfig.name] = value;
const envContent = fs.existsSync('.env') ? fs.readFileSync('.env', 'utf8') : ''; const envContent = fs.existsSync('.env')
? fs.readFileSync('.env', 'utf8')
: '';
if (!envContent.includes(`${varConfig.name}=`)) { if (!envContent.includes(`${varConfig.name}=`)) {
const newLine = envContent ? '\n' : ''; const newLine = envContent ? '\n' : '';
fs.appendFileSync('.env', `${newLine}${varConfig.name}="${value.trim()}"`); fs.appendFileSync(
'.env',
`${newLine}${varConfig.name}="${value.trim()}"`
);
} }
} }
} }
@ -201,21 +227,23 @@ async function checkRequiredEnvVars() {
{ {
type: 'password', type: 'password',
name: 'seedPhrase', name: 'seedPhrase',
message: 'Enter your Farcaster custody account seed phrase to sign the mini app manifest\n(optional -- leave blank to create an unsigned mini app)\n\nSeed phrase:', message:
default: null 'Enter your Farcaster custody account seed phrase to sign the mini app manifest\n(optional -- leave blank to create an unsigned mini app)\n\nSeed phrase:',
} default: null,
},
]); ]);
if (seedPhrase) { if (seedPhrase) {
process.env.SEED_PHRASE = seedPhrase; process.env.SEED_PHRASE = seedPhrase;
const { storeSeedPhrase } = await inquirer.prompt([ const { storeSeedPhrase } = await inquirer.prompt([
{ {
type: 'confirm', type: 'confirm',
name: 'storeSeedPhrase', name: 'storeSeedPhrase',
message: 'Would you like to store this seed phrase in .env.local for future use?', message:
default: false 'Would you like to store this seed phrase in .env.local for future use?',
} default: false,
},
]); ]);
if (storeSeedPhrase) { if (storeSeedPhrase) {
@ -230,9 +258,9 @@ async function checkRequiredEnvVars() {
async function getGitRemote() { async function getGitRemote() {
try { try {
const remoteUrl = execSync('git remote get-url origin', { const remoteUrl = execSync('git remote get-url origin', {
cwd: projectRoot, cwd: projectRoot,
encoding: 'utf8' encoding: 'utf8',
}).trim(); }).trim();
return remoteUrl; return remoteUrl;
} catch (error) { } catch (error) {
@ -242,9 +270,9 @@ async function getGitRemote() {
async function checkVercelCLI() { async function checkVercelCLI() {
try { try {
execSync('vercel --version', { execSync('vercel --version', {
stdio: 'ignore', stdio: 'ignore',
shell: process.platform === 'win32' shell: process.platform === 'win32',
}); });
return true; return true;
} catch (error) { } catch (error) {
@ -254,9 +282,9 @@ async function checkVercelCLI() {
async function installVercelCLI() { async function installVercelCLI() {
console.log('Installing Vercel CLI...'); console.log('Installing Vercel CLI...');
execSync('npm install -g vercel', { execSync('npm install -g vercel', {
stdio: 'inherit', stdio: 'inherit',
shell: process.platform === 'win32' shell: process.platform === 'win32',
}); });
} }
@ -271,25 +299,27 @@ async function getVercelToken() {
} catch (error) { } catch (error) {
console.warn('Could not read Vercel token from config file'); console.warn('Could not read Vercel token from config file');
} }
// Try environment variable // Try environment variable
if (process.env.VERCEL_TOKEN) { if (process.env.VERCEL_TOKEN) {
return process.env.VERCEL_TOKEN; return process.env.VERCEL_TOKEN;
} }
// Try to extract from vercel whoami // Try to extract from vercel whoami
try { try {
const whoamiOutput = execSync('vercel whoami', { const whoamiOutput = execSync('vercel whoami', {
encoding: 'utf8', encoding: 'utf8',
stdio: 'pipe' stdio: 'pipe',
}); });
// If we can get whoami, we're logged in, but we need the actual token // If we can get whoami, we're logged in, but we need the actual token
// The token isn't directly exposed, so we'll need to use CLI for some operations // The token isn't directly exposed, so we'll need to use CLI for some operations
console.log('✅ Verified Vercel CLI authentication'); console.log('✅ Verified Vercel CLI authentication');
return null; // We'll fall back to CLI operations return null; // We'll fall back to CLI operations
} catch (error) { } catch (error) {
throw new Error('Not logged in to Vercel CLI. Please run this script again to login.'); throw new Error(
'Not logged in to Vercel CLI. Please run this script again to login.'
);
} }
} }
@ -303,21 +333,25 @@ async function loginToVercel() {
console.log('2. Authorize GitHub access'); console.log('2. Authorize GitHub access');
console.log('3. Complete the Vercel account setup in your browser'); console.log('3. Complete the Vercel account setup in your browser');
console.log('4. Return here once your Vercel account is created\n'); console.log('4. Return here once your Vercel account is created\n');
console.log('\nNote: you may need to cancel this script with ctrl+c and run it again if creating a new vercel account'); console.log(
'\nNote: you may need to cancel this script with ctrl+c and run it again if creating a new vercel account'
);
const child = spawn('vercel', ['login'], { const child = spawn('vercel', ['login'], {
stdio: 'inherit' stdio: 'inherit',
}); });
await new Promise((resolve, reject) => { await new Promise((resolve, reject) => {
child.on('close', (code) => { child.on('close', code => {
resolve(); resolve();
}); });
}); });
console.log('\n📱 Waiting for login to complete...'); console.log('\n📱 Waiting for login to complete...');
console.log('If you\'re creating a new account, please complete the Vercel account setup in your browser first.'); console.log(
"If you're creating a new account, please complete the Vercel account setup in your browser first."
);
for (let i = 0; i < 150; i++) { for (let i = 0; i < 150; i++) {
try { try {
execSync('vercel whoami', { stdio: 'ignore' }); execSync('vercel whoami', { stdio: 'ignore' });
@ -349,11 +383,11 @@ async function setVercelEnvVarSDK(vercelClient, projectId, key, value) {
// Get existing environment variables // Get existing environment variables
const existingVars = await vercelClient.projects.getEnvironmentVariables({ const existingVars = await vercelClient.projects.getEnvironmentVariables({
idOrName: projectId idOrName: projectId,
}); });
const existingVar = existingVars.envs?.find(env => const existingVar = existingVars.envs?.find(
env.key === key && env.target?.includes('production') env => env.key === key && env.target?.includes('production')
); );
if (existingVar) { if (existingVar) {
@ -363,8 +397,8 @@ async function setVercelEnvVarSDK(vercelClient, projectId, key, value) {
id: existingVar.id, id: existingVar.id,
requestBody: { requestBody: {
value: processedValue, value: processedValue,
target: ['production'] target: ['production'],
} },
}); });
console.log(`✅ Updated environment variable: ${key}`); console.log(`✅ Updated environment variable: ${key}`);
} else { } else {
@ -375,15 +409,18 @@ async function setVercelEnvVarSDK(vercelClient, projectId, key, value) {
key: key, key: key,
value: processedValue, value: processedValue,
type: 'encrypted', type: 'encrypted',
target: ['production'] target: ['production'],
} },
}); });
console.log(`✅ Created environment variable: ${key}`); console.log(`✅ Created environment variable: ${key}`);
} }
return true; return true;
} catch (error) { } catch (error) {
console.warn(`⚠️ Warning: Failed to set environment variable ${key}:`, error.message); console.warn(
`⚠️ Warning: Failed to set environment variable ${key}:`,
error.message
);
return false; return false;
} }
} }
@ -395,7 +432,7 @@ async function setVercelEnvVarCLI(key, value, projectRoot) {
execSync(`vercel env rm ${key} production -y`, { execSync(`vercel env rm ${key} production -y`, {
cwd: projectRoot, cwd: projectRoot,
stdio: 'ignore', stdio: 'ignore',
env: process.env env: process.env,
}); });
} catch (error) { } catch (error) {
// Ignore errors from removal // Ignore errors from removal
@ -424,7 +461,7 @@ async function setVercelEnvVarCLI(key, value, projectRoot) {
cwd: projectRoot, cwd: projectRoot,
stdio: 'pipe', // Changed from 'inherit' to avoid interactive prompts stdio: 'pipe', // Changed from 'inherit' to avoid interactive prompts
shell: true, shell: true,
env: process.env env: process.env,
}); });
fs.unlinkSync(tempFilePath); fs.unlinkSync(tempFilePath);
@ -435,72 +472,95 @@ async function setVercelEnvVarCLI(key, value, projectRoot) {
if (fs.existsSync(tempFilePath)) { if (fs.existsSync(tempFilePath)) {
fs.unlinkSync(tempFilePath); fs.unlinkSync(tempFilePath);
} }
console.warn(`⚠️ Warning: Failed to set environment variable ${key}:`, error.message); console.warn(
`⚠️ Warning: Failed to set environment variable ${key}:`,
error.message
);
return false; return false;
} }
} }
async function setEnvironmentVariables(vercelClient, projectId, envVars, projectRoot) { async function setEnvironmentVariables(
vercelClient,
projectId,
envVars,
projectRoot
) {
console.log('\n📝 Setting up environment variables...'); console.log('\n📝 Setting up environment variables...');
const results = []; const results = [];
for (const [key, value] of Object.entries(envVars)) { for (const [key, value] of Object.entries(envVars)) {
if (!value) continue; if (!value) continue;
let success = false; let success = false;
// Try SDK approach first if we have a Vercel client // Try SDK approach first if we have a Vercel client
if (vercelClient && projectId) { if (vercelClient && projectId) {
success = await setVercelEnvVarSDK(vercelClient, projectId, key, value); success = await setVercelEnvVarSDK(vercelClient, projectId, key, value);
} }
// Fallback to CLI approach // Fallback to CLI approach
if (!success) { if (!success) {
success = await setVercelEnvVarCLI(key, value, projectRoot); success = await setVercelEnvVarCLI(key, value, projectRoot);
} }
results.push({ key, success }); results.push({ key, success });
} }
// Report results // Report results
const failed = results.filter(r => !r.success); const failed = results.filter(r => !r.success);
if (failed.length > 0) { if (failed.length > 0) {
console.warn(`\n⚠️ Failed to set ${failed.length} environment variables:`); console.warn(`\n⚠️ Failed to set ${failed.length} environment variables:`);
failed.forEach(r => console.warn(` - ${r.key}`)); failed.forEach(r => console.warn(` - ${r.key}`));
console.warn('\nYou may need to set these manually in the Vercel dashboard.'); console.warn(
'\nYou may need to set these manually in the Vercel dashboard.'
);
} }
return results; return results;
} }
async function deployToVercel(useGitHub = false) { async function deployToVercel(useGitHub = false) {
try { try {
console.log('\n🚀 Deploying to Vercel...'); console.log('\n🚀 Deploying to Vercel...');
// Ensure vercel.json exists // Ensure vercel.json exists
const vercelConfigPath = path.join(projectRoot, 'vercel.json'); const vercelConfigPath = path.join(projectRoot, 'vercel.json');
if (!fs.existsSync(vercelConfigPath)) { if (!fs.existsSync(vercelConfigPath)) {
console.log('📝 Creating vercel.json configuration...'); console.log('📝 Creating vercel.json configuration...');
fs.writeFileSync(vercelConfigPath, JSON.stringify({ fs.writeFileSync(
buildCommand: "next build", vercelConfigPath,
framework: "nextjs" JSON.stringify(
}, null, 2)); {
buildCommand: 'next build',
framework: 'nextjs',
},
null,
2
)
);
} }
// Set up Vercel project // Set up Vercel project
console.log('\n📦 Setting up Vercel project...'); console.log('\n📦 Setting up Vercel project...');
console.log('An initial deployment is required to get an assigned domain that can be used in the mini app manifest\n'); console.log(
console.log('\n⚠ Note: choosing a longer, more unique project name will help avoid conflicts with other existing domains\n'); 'An initial deployment is required to get an assigned domain that can be used in the mini app manifest\n'
);
execSync('vercel', { console.log(
'\n⚠ Note: choosing a longer, more unique project name will help avoid conflicts with other existing domains\n'
);
execSync('vercel', {
cwd: projectRoot, cwd: projectRoot,
stdio: 'inherit', stdio: 'inherit',
shell: process.platform === 'win32' shell: process.platform === 'win32',
}); });
// Load project info // Load project info
const projectJson = JSON.parse(fs.readFileSync('.vercel/project.json', 'utf8')); const projectJson = JSON.parse(
fs.readFileSync('.vercel/project.json', 'utf8')
);
const projectId = projectJson.projectId; const projectId = projectJson.projectId;
// Get Vercel token and initialize SDK client // Get Vercel token and initialize SDK client
@ -509,12 +569,14 @@ async function deployToVercel(useGitHub = false) {
const token = await getVercelToken(); const token = await getVercelToken();
if (token) { if (token) {
vercelClient = new Vercel({ vercelClient = new Vercel({
bearerToken: token bearerToken: token,
}); });
console.log('✅ Initialized Vercel SDK client'); console.log('✅ Initialized Vercel SDK client');
} }
} catch (error) { } catch (error) {
console.warn('⚠️ Could not initialize Vercel SDK, falling back to CLI operations'); console.warn(
'⚠️ Could not initialize Vercel SDK, falling back to CLI operations'
);
} }
// Get project details // Get project details
@ -525,22 +587,27 @@ async function deployToVercel(useGitHub = false) {
if (vercelClient) { if (vercelClient) {
try { try {
const project = await vercelClient.projects.get({ const project = await vercelClient.projects.get({
idOrName: projectId idOrName: projectId,
}); });
projectName = project.name; projectName = project.name;
domain = `${projectName}.vercel.app`; domain = `${projectName}.vercel.app`;
console.log('🌐 Using project name for domain:', domain); console.log('🌐 Using project name for domain:', domain);
} catch (error) { } catch (error) {
console.warn('⚠️ Could not get project details via SDK, using CLI fallback'); console.warn(
'⚠️ Could not get project details via SDK, using CLI fallback'
);
} }
} }
// Fallback to CLI method if SDK failed // Fallback to CLI method if SDK failed
if (!domain) { if (!domain) {
const inspectOutput = execSync(`vercel project inspect ${projectId} 2>&1`, { const inspectOutput = execSync(
cwd: projectRoot, `vercel project inspect ${projectId} 2>&1`,
encoding: 'utf8' {
}); cwd: projectRoot,
encoding: 'utf8',
}
);
const nameMatch = inspectOutput.match(/Name\s+([^\n]+)/); const nameMatch = inspectOutput.match(/Name\s+([^\n]+)/);
if (nameMatch) { if (nameMatch) {
@ -554,7 +621,9 @@ async function deployToVercel(useGitHub = false) {
domain = `${projectName}.vercel.app`; domain = `${projectName}.vercel.app`;
console.log('🌐 Using project name for domain:', domain); console.log('🌐 Using project name for domain:', domain);
} else { } else {
throw new Error('Could not determine project name from inspection output'); throw new Error(
'Could not determine project name from inspection output'
);
} }
} }
} }
@ -565,110 +634,146 @@ async function deployToVercel(useGitHub = false) {
if (process.env.SEED_PHRASE) { if (process.env.SEED_PHRASE) {
console.log('\n🔨 Generating mini app metadata...'); console.log('\n🔨 Generating mini app metadata...');
const accountAddress = await validateSeedPhrase(process.env.SEED_PHRASE); const accountAddress = await validateSeedPhrase(process.env.SEED_PHRASE);
fid = await lookupFidByCustodyAddress(accountAddress, process.env.NEYNAR_API_KEY ?? 'FARCASTER_V2_FRAMES_DEMO'); fid = await lookupFidByCustodyAddress(
accountAddress,
const webhookUrl = process.env.NEYNAR_API_KEY && process.env.NEYNAR_CLIENT_ID process.env.NEYNAR_API_KEY ?? 'FARCASTER_V2_FRAMES_DEMO'
? `https://api.neynar.com/f/app/${process.env.NEYNAR_CLIENT_ID}/event` );
: `https://${domain}/api/webhook`;
miniAppMetadata = await generateFarcasterMetadata(domain, fid, accountAddress, process.env.SEED_PHRASE, webhookUrl); const webhookUrl =
process.env.NEYNAR_API_KEY && process.env.NEYNAR_CLIENT_ID
? `https://api.neynar.com/f/app/${process.env.NEYNAR_CLIENT_ID}/event`
: `https://${domain}/api/webhook`;
miniAppMetadata = await generateFarcasterMetadata(
domain,
fid,
accountAddress,
process.env.SEED_PHRASE,
webhookUrl
);
console.log('✅ Mini app metadata generated and signed'); console.log('✅ Mini app metadata generated and signed');
} }
// Prepare environment variables // Prepare environment variables
const nextAuthSecret = process.env.NEXTAUTH_SECRET || crypto.randomBytes(32).toString('hex'); const nextAuthSecret =
process.env.NEXTAUTH_SECRET || crypto.randomBytes(32).toString('hex');
const vercelEnv = { const vercelEnv = {
NEXTAUTH_SECRET: nextAuthSecret, NEXTAUTH_SECRET: nextAuthSecret,
AUTH_SECRET: nextAuthSecret, AUTH_SECRET: nextAuthSecret,
NEXTAUTH_URL: `https://${domain}`, NEXTAUTH_URL: `https://${domain}`,
NEXT_PUBLIC_URL: `https://${domain}`, NEXT_PUBLIC_URL: `https://${domain}`,
...(process.env.NEYNAR_API_KEY && { NEYNAR_API_KEY: process.env.NEYNAR_API_KEY }), ...(process.env.NEYNAR_API_KEY && {
...(process.env.NEYNAR_CLIENT_ID && { NEYNAR_CLIENT_ID: process.env.NEYNAR_CLIENT_ID }), NEYNAR_API_KEY: process.env.NEYNAR_API_KEY,
}),
...(process.env.NEYNAR_CLIENT_ID && {
NEYNAR_CLIENT_ID: process.env.NEYNAR_CLIENT_ID,
}),
...(miniAppMetadata && { MINI_APP_METADATA: miniAppMetadata }), ...(miniAppMetadata && { MINI_APP_METADATA: miniAppMetadata }),
...Object.fromEntries( ...Object.fromEntries(
Object.entries(process.env) Object.entries(process.env).filter(([key]) =>
.filter(([key]) => key.startsWith('NEXT_PUBLIC_')) key.startsWith('NEXT_PUBLIC_')
) )
),
}; };
// Set environment variables // Set environment variables
await setEnvironmentVariables(vercelClient, projectId, vercelEnv, projectRoot); await setEnvironmentVariables(
vercelClient,
projectId,
vercelEnv,
projectRoot
);
// Deploy the project // Deploy the project
if (useGitHub) { if (useGitHub) {
console.log('\nSetting up GitHub integration...'); console.log('\nSetting up GitHub integration...');
execSync('vercel link', { execSync('vercel link', {
cwd: projectRoot, cwd: projectRoot,
stdio: 'inherit', stdio: 'inherit',
env: process.env env: process.env,
}); });
console.log('\n📦 Deploying with GitHub integration...'); console.log('\n📦 Deploying with GitHub integration...');
} else { } else {
console.log('\n📦 Deploying local code directly...'); console.log('\n📦 Deploying local code directly...');
} }
execSync('vercel deploy --prod', { execSync('vercel deploy --prod', {
cwd: projectRoot, cwd: projectRoot,
stdio: 'inherit', stdio: 'inherit',
env: process.env env: process.env,
}); });
// Verify actual domain after deployment // Verify actual domain after deployment
console.log('\n🔍 Verifying deployment domain...'); console.log('\n🔍 Verifying deployment domain...');
let actualDomain = domain; let actualDomain = domain;
if (vercelClient) { if (vercelClient) {
try { try {
const deployments = await vercelClient.deployments.list({ const deployments = await vercelClient.deployments.list({
projectId: projectId, projectId: projectId,
limit: 1 limit: 1,
}); });
if (deployments.deployments?.[0]?.url) { if (deployments.deployments?.[0]?.url) {
actualDomain = deployments.deployments[0].url; actualDomain = deployments.deployments[0].url;
console.log('🌐 Verified actual domain:', actualDomain); console.log('🌐 Verified actual domain:', actualDomain);
} }
} catch (error) { } catch (error) {
console.warn('⚠️ Could not verify domain via SDK, using assumed domain'); console.warn(
'⚠️ Could not verify domain via SDK, using assumed domain'
);
} }
} }
// Update environment variables if domain changed // Update environment variables if domain changed
if (actualDomain !== domain) { if (actualDomain !== domain) {
console.log('🔄 Updating environment variables with correct domain...'); console.log('🔄 Updating environment variables with correct domain...');
const webhookUrl = process.env.NEYNAR_API_KEY && process.env.NEYNAR_CLIENT_ID const webhookUrl =
? `https://api.neynar.com/f/app/${process.env.NEYNAR_CLIENT_ID}/event` process.env.NEYNAR_API_KEY && process.env.NEYNAR_CLIENT_ID
: `https://${actualDomain}/api/webhook`; ? `https://api.neynar.com/f/app/${process.env.NEYNAR_CLIENT_ID}/event`
: `https://${actualDomain}/api/webhook`;
const updatedEnv = { const updatedEnv = {
NEXTAUTH_URL: `https://${actualDomain}`, NEXTAUTH_URL: `https://${actualDomain}`,
NEXT_PUBLIC_URL: `https://${actualDomain}` NEXT_PUBLIC_URL: `https://${actualDomain}`,
}; };
if (miniAppMetadata) { if (miniAppMetadata) {
const updatedMetadata = await generateFarcasterMetadata(actualDomain, fid, await validateSeedPhrase(process.env.SEED_PHRASE), process.env.SEED_PHRASE, webhookUrl); const updatedMetadata = await generateFarcasterMetadata(
actualDomain,
fid,
await validateSeedPhrase(process.env.SEED_PHRASE),
process.env.SEED_PHRASE,
webhookUrl
);
updatedEnv.MINI_APP_METADATA = updatedMetadata; updatedEnv.MINI_APP_METADATA = updatedMetadata;
} }
await setEnvironmentVariables(vercelClient, projectId, updatedEnv, projectRoot); await setEnvironmentVariables(
vercelClient,
projectId,
updatedEnv,
projectRoot
);
console.log('\n📦 Redeploying with correct domain...'); console.log('\n📦 Redeploying with correct domain...');
execSync('vercel deploy --prod', { execSync('vercel deploy --prod', {
cwd: projectRoot, cwd: projectRoot,
stdio: 'inherit', stdio: 'inherit',
env: process.env env: process.env,
}); });
domain = actualDomain; domain = actualDomain;
} }
console.log('\n✨ Deployment complete! Your mini app is now live at:'); console.log('\n✨ Deployment complete! Your mini app is now live at:');
console.log(`🌐 https://${domain}`); console.log(`🌐 https://${domain}`);
console.log('\n📝 You can manage your project at https://vercel.com/dashboard'); console.log(
'\n📝 You can manage your project at https://vercel.com/dashboard'
);
} catch (error) { } catch (error) {
console.error('\n❌ Deployment failed:', error.message); console.error('\n❌ Deployment failed:', error.message);
process.exit(1); process.exit(1);
@ -678,7 +783,9 @@ async function deployToVercel(useGitHub = false) {
async function main() { async function main() {
try { try {
console.log('🚀 Vercel Mini App Deployment (SDK Edition)'); console.log('🚀 Vercel Mini App Deployment (SDK Edition)');
console.log('This script will deploy your mini app to Vercel using the Vercel SDK.'); console.log(
'This script will deploy your mini app to Vercel using the Vercel SDK.'
);
console.log('\nThe script will:'); console.log('\nThe script will:');
console.log('1. Check for required environment variables'); console.log('1. Check for required environment variables');
console.log('2. Set up a Vercel project (new or existing)'); console.log('2. Set up a Vercel project (new or existing)');
@ -690,9 +797,9 @@ async function main() {
await import('@vercel/sdk'); await import('@vercel/sdk');
} catch (error) { } catch (error) {
console.log('📦 Installing @vercel/sdk...'); console.log('📦 Installing @vercel/sdk...');
execSync('npm install @vercel/sdk', { execSync('npm install @vercel/sdk', {
cwd: projectRoot, cwd: projectRoot,
stdio: 'inherit' stdio: 'inherit',
}); });
console.log('✅ @vercel/sdk installed successfully'); console.log('✅ @vercel/sdk installed successfully');
} }
@ -709,8 +816,8 @@ async function main() {
type: 'confirm', type: 'confirm',
name: 'useGitHubDeploy', name: 'useGitHubDeploy',
message: 'Would you like to deploy from the GitHub repository?', message: 'Would you like to deploy from the GitHub repository?',
default: true default: true,
} },
]); ]);
useGitHub = useGitHubDeploy; useGitHub = useGitHubDeploy;
} else { } else {
@ -722,10 +829,10 @@ async function main() {
message: 'What would you like to do?', message: 'What would you like to do?',
choices: [ choices: [
{ name: 'Deploy local code directly', value: 'deploy' }, { name: 'Deploy local code directly', value: 'deploy' },
{ name: 'Set up GitHub repository first', value: 'setup' } { name: 'Set up GitHub repository first', value: 'setup' },
], ],
default: 'deploy' default: 'deploy',
} },
]); ]);
if (action === 'setup') { if (action === 'setup') {
@ -739,22 +846,21 @@ async function main() {
} }
} }
if (!await checkVercelCLI()) { if (!(await checkVercelCLI())) {
console.log('Vercel CLI not found. Installing...'); console.log('Vercel CLI not found. Installing...');
await installVercelCLI(); await installVercelCLI();
} }
if (!await loginToVercel()) { if (!(await loginToVercel())) {
console.error('\n❌ Failed to log in to Vercel. Please try again.'); console.error('\n❌ Failed to log in to Vercel. Please try again.');
process.exit(1); process.exit(1);
} }
await deployToVercel(useGitHub); await deployToVercel(useGitHub);
} catch (error) { } catch (error) {
console.error('\n❌ Error:', error.message); console.error('\n❌ Error:', error.message);
process.exit(1); process.exit(1);
} }
} }
main(); main();

View File

@ -33,18 +33,18 @@ args.forEach((arg, index) => {
}); });
async function checkPort(port) { async function checkPort(port) {
return new Promise((resolve) => { return new Promise(resolve => {
const server = createServer(); const server = createServer();
server.once('error', () => { server.once('error', () => {
resolve(true); // Port is in use resolve(true); // Port is in use
}); });
server.once('listening', () => { server.once('listening', () => {
server.close(); server.close();
resolve(false); // Port is free resolve(false); // Port is free
}); });
server.listen(port); server.listen(port);
}); });
} }
@ -54,29 +54,32 @@ async function killProcessOnPort(port) {
if (process.platform === 'win32') { if (process.platform === 'win32') {
// Windows: Use netstat to find the process // Windows: Use netstat to find the process
const netstat = spawn('netstat', ['-ano', '|', 'findstr', `:${port}`]); const netstat = spawn('netstat', ['-ano', '|', 'findstr', `:${port}`]);
netstat.stdout.on('data', (data) => { netstat.stdout.on('data', data => {
const match = data.toString().match(/\s+(\d+)$/); const match = data.toString().match(/\s+(\d+)$/);
if (match) { if (match) {
const pid = match[1]; const pid = match[1];
spawn('taskkill', ['/F', '/PID', pid]); spawn('taskkill', ['/F', '/PID', pid]);
} }
}); });
await new Promise((resolve) => netstat.on('close', resolve)); await new Promise(resolve => netstat.on('close', resolve));
} else { } else {
// Unix-like systems: Use lsof // Unix-like systems: Use lsof
const lsof = spawn('lsof', ['-ti', `:${port}`]); const lsof = spawn('lsof', ['-ti', `:${port}`]);
lsof.stdout.on('data', (data) => { lsof.stdout.on('data', data => {
data.toString().split('\n').forEach(pid => { data
if (pid) { .toString()
try { .split('\n')
process.kill(parseInt(pid), 'SIGKILL'); .forEach(pid => {
} catch (e) { if (pid) {
if (e.code !== 'ESRCH') throw e; try {
process.kill(parseInt(pid), 'SIGKILL');
} catch (e) {
if (e.code !== 'ESRCH') throw e;
}
} }
} });
});
}); });
await new Promise((resolve) => lsof.on('close', resolve)); await new Promise(resolve => lsof.on('close', resolve));
} }
} catch (e) { } catch (e) {
// Ignore errors if no process found // Ignore errors if no process found
@ -87,13 +90,15 @@ async function startDev() {
// Check if the specified port is already in use // Check if the specified port is already in use
const isPortInUse = await checkPort(port); const isPortInUse = await checkPort(port);
if (isPortInUse) { if (isPortInUse) {
console.error(`Port ${port} is already in use. To find and kill the process using this port:\n\n` + console.error(
(process.platform === 'win32' `Port ${port} is already in use. To find and kill the process using this port:\n\n` +
? `1. Run: netstat -ano | findstr :${port}\n` + (process.platform === 'win32'
'2. Note the PID (Process ID) from the output\n' + ? `1. Run: netstat -ano | findstr :${port}\n` +
'3. Run: taskkill /PID <PID> /F\n' '2. Note the PID (Process ID) from the output\n' +
: `On macOS/Linux, run:\nnpm run cleanup\n`) + '3. Run: taskkill /PID <PID> /F\n'
'\nThen try running this command again.'); : `On macOS/Linux, run:\nnpm run cleanup\n`) +
'\nThen try running this command again.'
);
process.exit(1); process.exit(1);
} }
@ -105,7 +110,9 @@ async function startDev() {
tunnel = await localtunnel({ port: port }); tunnel = await localtunnel({ port: port });
let ip; let ip;
try { try {
ip = await fetch('https://ipv4.icanhazip.com').then(res => res.text()).then(ip => ip.trim()); ip = await fetch('https://ipv4.icanhazip.com')
.then(res => res.text())
.then(ip => ip.trim());
} catch (error) { } catch (error) {
console.error('Error getting IP address:', error); console.error('Error getting IP address:', error);
} }
@ -143,15 +150,21 @@ async function startDev() {
4. Click "Preview" to test your mini app (note that it may take ~5 seconds to load the first time) 4. Click "Preview" to test your mini app (note that it may take ~5 seconds to load the first time)
`); `);
} }
// Start next dev with appropriate configuration // Start next dev with appropriate configuration
const nextBin = path.normalize(path.join(projectRoot, 'node_modules', '.bin', 'next')); const nextBin = path.normalize(
path.join(projectRoot, 'node_modules', '.bin', 'next')
);
nextDev = spawn(nextBin, ['dev', '-p', port.toString()], { nextDev = spawn(nextBin, ['dev', '-p', port.toString()], {
stdio: 'inherit', stdio: 'inherit',
env: { ...process.env, NEXT_PUBLIC_URL: miniAppUrl, NEXTAUTH_URL: miniAppUrl }, env: {
...process.env,
NEXT_PUBLIC_URL: miniAppUrl,
NEXTAUTH_URL: miniAppUrl,
},
cwd: projectRoot, cwd: projectRoot,
shell: process.platform === 'win32' // Add shell option for Windows shell: process.platform === 'win32', // Add shell option for Windows
}); });
// Handle cleanup // Handle cleanup
@ -181,7 +194,7 @@ async function startDev() {
console.log('Note: Next.js process already terminated'); console.log('Note: Next.js process already terminated');
} }
} }
if (tunnel) { if (tunnel) {
try { try {
await tunnel.close(); await tunnel.close();
@ -209,4 +222,4 @@ async function startDev() {
} }
} }
startDev().catch(console.error); startDev().catch(console.error);

View File

@ -1,6 +1,6 @@
import NextAuth from "next-auth" import NextAuth from 'next-auth';
import { authOptions } from "~/auth" import { authOptions } from '~/auth';
const handler = NextAuth(authOptions) const handler = NextAuth(authOptions);
export { handler as GET, handler as POST } export { handler as GET, handler as POST };

View File

@ -4,10 +4,13 @@ export async function GET(request: Request) {
const apiKey = process.env.NEYNAR_API_KEY; const apiKey = process.env.NEYNAR_API_KEY;
const { searchParams } = new URL(request.url); const { searchParams } = new URL(request.url);
const fid = searchParams.get('fid'); const fid = searchParams.get('fid');
if (!apiKey) { if (!apiKey) {
return NextResponse.json( return NextResponse.json(
{ error: 'Neynar API key is not configured. Please add NEYNAR_API_KEY to your environment variables.' }, {
error:
'Neynar API key is not configured. Please add NEYNAR_API_KEY to your environment variables.',
},
{ status: 500 } { status: 500 }
); );
} }
@ -24,7 +27,7 @@ export async function GET(request: Request) {
`https://api.neynar.com/v2/farcaster/user/best_friends?fid=${fid}&limit=3`, `https://api.neynar.com/v2/farcaster/user/best_friends?fid=${fid}&limit=3`,
{ {
headers: { headers: {
"x-api-key": apiKey, 'x-api-key': apiKey,
}, },
} }
); );
@ -33,14 +36,19 @@ export async function GET(request: Request) {
throw new Error(`Neynar API error: ${response.statusText}`); throw new Error(`Neynar API error: ${response.statusText}`);
} }
const { users } = await response.json() as { users: { user: { fid: number; username: string } }[] }; const { users } = (await response.json()) as {
users: { user: { fid: number; username: string } }[];
};
return NextResponse.json({ bestFriends: users }); return NextResponse.json({ bestFriends: users });
} catch (error) { } catch (error) {
console.error('Failed to fetch best friends:', error); console.error('Failed to fetch best friends:', error);
return NextResponse.json( return NextResponse.json(
{ error: 'Failed to fetch best friends. Please check your Neynar API key and try again.' }, {
error:
'Failed to fetch best friends. Please check your Neynar API key and try again.',
},
{ status: 500 } { status: 500 }
); );
} }
} }

View File

@ -1,6 +1,6 @@
import { ImageResponse } from "next/og"; import { ImageResponse } from 'next/og';
import { NextRequest } from "next/server"; import { NextRequest } from 'next/server';
import { getNeynarUser } from "~/lib/neynar"; import { getNeynarUser } from '~/lib/neynar';
export const dynamic = 'force-dynamic'; export const dynamic = 'force-dynamic';
@ -15,10 +15,18 @@ export async function GET(request: NextRequest) {
<div tw="flex h-full w-full flex-col justify-center items-center relative bg-primary"> <div tw="flex h-full w-full flex-col justify-center items-center relative bg-primary">
{user?.pfp_url && ( {user?.pfp_url && (
<div tw="flex w-96 h-96 rounded-full overflow-hidden mb-8 border-8 border-white"> <div tw="flex w-96 h-96 rounded-full overflow-hidden mb-8 border-8 border-white">
<img src={user.pfp_url} alt="Profile" tw="w-full h-full object-cover" /> <img
src={user.pfp_url}
alt="Profile"
tw="w-full h-full object-cover"
/>
</div> </div>
)} )}
<h1 tw="text-8xl text-white">{user?.display_name ? `Hello from ${user.display_name ?? user.username}!` : 'Hello!'}</h1> <h1 tw="text-8xl text-white">
{user?.display_name
? `Hello from ${user.display_name ?? user.username}!`
: 'Hello!'}
</h1>
<p tw="text-5xl mt-4 text-white opacity-80">Powered by Neynar 🪐</p> <p tw="text-5xl mt-4 text-white opacity-80">Powered by Neynar 🪐</p>
</div> </div>
), ),
@ -27,4 +35,4 @@ export async function GET(request: NextRequest) {
height: 800, height: 800,
} }
); );
} }

View File

@ -1,9 +1,9 @@
import { notificationDetailsSchema } from "@farcaster/frame-sdk"; import { notificationDetailsSchema } from '@farcaster/frame-sdk';
import { NextRequest } from "next/server"; import { NextRequest } from 'next/server';
import { z } from "zod"; import { z } from 'zod';
import { setUserNotificationDetails } from "~/lib/kv"; import { setUserNotificationDetails } from '~/lib/kv';
import { sendMiniAppNotification } from "~/lib/notifs"; import { sendMiniAppNotification } from '~/lib/notifs';
import { sendNeynarMiniAppNotification } from "~/lib/neynar"; import { sendNeynarMiniAppNotification } from '~/lib/neynar';
const requestSchema = z.object({ const requestSchema = z.object({
fid: z.number(), fid: z.number(),
@ -13,7 +13,8 @@ const requestSchema = z.object({
export async function POST(request: NextRequest) { export async function POST(request: NextRequest) {
// If Neynar is enabled, we don't need to store notification details // If Neynar is enabled, we don't need to store notification details
// as they will be managed by Neynar's system // as they will be managed by Neynar's system
const neynarEnabled = process.env.NEYNAR_API_KEY && process.env.NEYNAR_CLIENT_ID; const neynarEnabled =
process.env.NEYNAR_API_KEY && process.env.NEYNAR_CLIENT_ID;
const requestJson = await request.json(); const requestJson = await request.json();
const requestBody = requestSchema.safeParse(requestJson); const requestBody = requestSchema.safeParse(requestJson);
@ -34,21 +35,23 @@ export async function POST(request: NextRequest) {
} }
// Use appropriate notification function based on Neynar status // Use appropriate notification function based on Neynar status
const sendNotification = neynarEnabled ? sendNeynarMiniAppNotification : sendMiniAppNotification; const sendNotification = neynarEnabled
? sendNeynarMiniAppNotification
: sendMiniAppNotification;
const sendResult = await sendNotification({ const sendResult = await sendNotification({
fid: Number(requestBody.data.fid), fid: Number(requestBody.data.fid),
title: "Test notification", title: 'Test notification',
body: "Sent at " + new Date().toISOString(), body: 'Sent at ' + new Date().toISOString(),
}); });
if (sendResult.state === "error") { if (sendResult.state === 'error') {
return Response.json( return Response.json(
{ success: false, error: sendResult.error }, { success: false, error: sendResult.error },
{ status: 500 } { status: 500 }
); );
} else if (sendResult.state === "rate_limit") { } else if (sendResult.state === 'rate_limit') {
return Response.json( return Response.json(
{ success: false, error: "Rate limited" }, { success: false, error: 'Rate limited' },
{ status: 429 } { status: 429 }
); );
} }

View File

@ -5,10 +5,13 @@ export async function GET(request: Request) {
const apiKey = process.env.NEYNAR_API_KEY; const apiKey = process.env.NEYNAR_API_KEY;
const { searchParams } = new URL(request.url); const { searchParams } = new URL(request.url);
const fids = searchParams.get('fids'); const fids = searchParams.get('fids');
if (!apiKey) { if (!apiKey) {
return NextResponse.json( return NextResponse.json(
{ error: 'Neynar API key is not configured. Please add NEYNAR_API_KEY to your environment variables.' }, {
error:
'Neynar API key is not configured. Please add NEYNAR_API_KEY to your environment variables.',
},
{ status: 500 } { status: 500 }
); );
} }
@ -23,7 +26,7 @@ export async function GET(request: Request) {
try { try {
const neynar = new NeynarAPIClient({ apiKey }); const neynar = new NeynarAPIClient({ apiKey });
const fidsArray = fids.split(',').map(fid => parseInt(fid.trim())); const fidsArray = fids.split(',').map(fid => parseInt(fid.trim()));
const { users } = await neynar.fetchBulkUsers({ const { users } = await neynar.fetchBulkUsers({
fids: fidsArray, fids: fidsArray,
}); });
@ -32,7 +35,10 @@ export async function GET(request: Request) {
} catch (error) { } catch (error) {
console.error('Failed to fetch users:', error); console.error('Failed to fetch users:', error);
return NextResponse.json( return NextResponse.json(
{ error: 'Failed to fetch users. Please check your Neynar API key and try again.' }, {
error:
'Failed to fetch users. Please check your Neynar API key and try again.',
},
{ status: 500 } { status: 500 }
); );
} }

View File

@ -2,19 +2,20 @@ import {
ParseWebhookEvent, ParseWebhookEvent,
parseWebhookEvent, parseWebhookEvent,
verifyAppKeyWithNeynar, verifyAppKeyWithNeynar,
} from "@farcaster/frame-node"; } from '@farcaster/frame-node';
import { NextRequest } from "next/server"; import { NextRequest } from 'next/server';
import { APP_NAME } from "~/lib/constants"; import { APP_NAME } from '~/lib/constants';
import { import {
deleteUserNotificationDetails, deleteUserNotificationDetails,
setUserNotificationDetails, setUserNotificationDetails,
} from "~/lib/kv"; } from '~/lib/kv';
import { sendMiniAppNotification } from "~/lib/notifs"; import { sendMiniAppNotification } from '~/lib/notifs';
export async function POST(request: NextRequest) { export async function POST(request: NextRequest) {
// If Neynar is enabled, we don't need to handle webhooks here // If Neynar is enabled, we don't need to handle webhooks here
// as they will be handled by Neynar's webhook endpoint // as they will be handled by Neynar's webhook endpoint
const neynarEnabled = process.env.NEYNAR_API_KEY && process.env.NEYNAR_CLIENT_ID; const neynarEnabled =
process.env.NEYNAR_API_KEY && process.env.NEYNAR_CLIENT_ID;
if (neynarEnabled) { if (neynarEnabled) {
return Response.json({ success: true }); return Response.json({ success: true });
} }
@ -28,20 +29,20 @@ export async function POST(request: NextRequest) {
const error = e as ParseWebhookEvent.ErrorType; const error = e as ParseWebhookEvent.ErrorType;
switch (error.name) { switch (error.name) {
case "VerifyJsonFarcasterSignature.InvalidDataError": case 'VerifyJsonFarcasterSignature.InvalidDataError':
case "VerifyJsonFarcasterSignature.InvalidEventDataError": case 'VerifyJsonFarcasterSignature.InvalidEventDataError':
// The request data is invalid // The request data is invalid
return Response.json( return Response.json(
{ success: false, error: error.message }, { success: false, error: error.message },
{ status: 400 } { status: 400 }
); );
case "VerifyJsonFarcasterSignature.InvalidAppKeyError": case 'VerifyJsonFarcasterSignature.InvalidAppKeyError':
// The app key is invalid // The app key is invalid
return Response.json( return Response.json(
{ success: false, error: error.message }, { success: false, error: error.message },
{ status: 401 } { status: 401 }
); );
case "VerifyJsonFarcasterSignature.VerifyAppKeyError": case 'VerifyJsonFarcasterSignature.VerifyAppKeyError':
// Internal error verifying the app key (caller may want to try again) // Internal error verifying the app key (caller may want to try again)
return Response.json( return Response.json(
{ success: false, error: error.message }, { success: false, error: error.message },
@ -56,33 +57,33 @@ export async function POST(request: NextRequest) {
// Only handle notifications if Neynar is not enabled // Only handle notifications if Neynar is not enabled
// When Neynar is enabled, notifications are handled through their webhook // When Neynar is enabled, notifications are handled through their webhook
switch (event.event) { switch (event.event) {
case "frame_added": case 'frame_added':
if (event.notificationDetails) { if (event.notificationDetails) {
await setUserNotificationDetails(fid, event.notificationDetails); await setUserNotificationDetails(fid, event.notificationDetails);
await sendMiniAppNotification({ await sendMiniAppNotification({
fid, fid,
title: `Welcome to ${APP_NAME}`, title: `Welcome to ${APP_NAME}`,
body: "Mini app is now added to your client", body: 'Mini app is now added to your client',
}); });
} else { } else {
await deleteUserNotificationDetails(fid); await deleteUserNotificationDetails(fid);
} }
break; break;
case "frame_removed": case 'frame_removed':
await deleteUserNotificationDetails(fid); await deleteUserNotificationDetails(fid);
break; break;
case "notifications_enabled": case 'notifications_enabled':
await setUserNotificationDetails(fid, event.notificationDetails); await setUserNotificationDetails(fid, event.notificationDetails);
await sendMiniAppNotification({ await sendMiniAppNotification({
fid, fid,
title: `Welcome to ${APP_NAME}`, title: `Welcome to ${APP_NAME}`,
body: "Notifications are now enabled", body: 'Notifications are now enabled',
}); });
break; break;
case "notifications_disabled": case 'notifications_disabled':
await deleteUserNotificationDetails(fid); await deleteUserNotificationDetails(fid);
break; break;
} }

View File

@ -1,10 +1,10 @@
"use client"; 'use client';
import dynamic from "next/dynamic"; import dynamic from 'next/dynamic';
import { APP_NAME } from "~/lib/constants"; import { APP_NAME } from '~/lib/constants';
// note: dynamic import is required for components that use the Frame SDK // note: dynamic import is required for components that use the Frame SDK
const AppComponent = dynamic(() => import("~/components/App"), { const AppComponent = dynamic(() => import('~/components/App'), {
ssr: false, ssr: false,
}); });

View File

@ -62,11 +62,11 @@ body {
.container { .container {
@apply mx-auto max-w-md px-4; @apply mx-auto max-w-md px-4;
} }
.container-wide { .container-wide {
@apply mx-auto max-w-lg px-4; @apply mx-auto max-w-lg px-4;
} }
.container-narrow { .container-narrow {
@apply mx-auto max-w-sm px-4; @apply mx-auto max-w-sm px-4;
} }
@ -75,7 +75,7 @@ body {
.card { .card {
@apply bg-white dark:bg-gray-800 rounded-lg border border-gray-200 dark:border-gray-700 shadow-sm; @apply bg-white dark:bg-gray-800 rounded-lg border border-gray-200 dark:border-gray-700 shadow-sm;
} }
.card-primary { .card-primary {
@apply bg-primary/10 border-primary/20; @apply bg-primary/10 border-primary/20;
} }
@ -84,15 +84,15 @@ body {
.btn { .btn {
@apply inline-flex items-center justify-center rounded-lg px-4 py-2 text-sm font-medium transition-colors focus:outline-none focus:ring-2 focus:ring-offset-2 disabled:opacity-50 disabled:pointer-events-none; @apply inline-flex items-center justify-center rounded-lg px-4 py-2 text-sm font-medium transition-colors focus:outline-none focus:ring-2 focus:ring-offset-2 disabled:opacity-50 disabled:pointer-events-none;
} }
.btn-primary { .btn-primary {
@apply bg-primary text-white hover:bg-primary-dark focus:ring-primary; @apply bg-primary text-white hover:bg-primary-dark focus:ring-primary;
} }
.btn-secondary { .btn-secondary {
@apply bg-secondary text-gray-900 hover:bg-gray-200 focus:ring-gray-500 dark:bg-secondary-dark dark:text-gray-100 dark:hover:bg-gray-600; @apply bg-secondary text-gray-900 hover:bg-gray-200 focus:ring-gray-500 dark:bg-secondary-dark dark:text-gray-100 dark:hover:bg-gray-600;
} }
.btn-outline { .btn-outline {
@apply border border-gray-300 bg-transparent hover:bg-gray-50 focus:ring-gray-500 dark:border-gray-600 dark:hover:bg-gray-800; @apply border border-gray-300 bg-transparent hover:bg-gray-50 focus:ring-gray-500 dark:border-gray-600 dark:hover:bg-gray-800;
} }
@ -106,7 +106,7 @@ body {
.spinner { .spinner {
@apply animate-spin rounded-full border-2 border-gray-300 border-t-primary; @apply animate-spin rounded-full border-2 border-gray-300 border-t-primary;
} }
.spinner-primary { .spinner-primary {
@apply animate-spin rounded-full border-2 border-white border-t-transparent; @apply animate-spin rounded-full border-2 border-white border-t-transparent;
} }

View File

@ -1,9 +1,9 @@
import type { Metadata } from "next"; import type { Metadata } from 'next';
import { getSession } from "~/auth" import { getSession } from '~/auth';
import "~/app/globals.css"; import '~/app/globals.css';
import { Providers } from "~/app/providers"; import { Providers } from '~/app/providers';
import { APP_NAME, APP_DESCRIPTION } from "~/lib/constants"; import { APP_NAME, APP_DESCRIPTION } from '~/lib/constants';
export const metadata: Metadata = { export const metadata: Metadata = {
title: APP_NAME, title: APP_NAME,
@ -14,8 +14,8 @@ export default async function RootLayout({
children, children,
}: Readonly<{ }: Readonly<{
children: React.ReactNode; children: React.ReactNode;
}>) { }>) {
const session = await getSession() const session = await getSession();
return ( return (
<html lang="en"> <html lang="en">

View File

@ -1,7 +1,7 @@
import { Metadata } from "next"; import { Metadata } from 'next';
import App from "./app"; import App from './app';
import { APP_NAME, APP_DESCRIPTION, APP_OG_IMAGE_URL } from "~/lib/constants"; import { APP_NAME, APP_DESCRIPTION, APP_OG_IMAGE_URL } from '~/lib/constants';
import { getMiniAppEmbedMetadata } from "~/lib/utils"; import { getMiniAppEmbedMetadata } from '~/lib/utils';
export const revalidate = 300; export const revalidate = 300;
@ -14,11 +14,11 @@ export async function generateMetadata(): Promise<Metadata> {
images: [APP_OG_IMAGE_URL], images: [APP_OG_IMAGE_URL],
}, },
other: { other: {
"fc:frame": JSON.stringify(getMiniAppEmbedMetadata()), 'fc:frame': JSON.stringify(getMiniAppEmbedMetadata()),
}, },
}; };
} }
export default function Home() { export default function Home() {
return (<App />); return <App />;
} }

View File

@ -1,25 +1,35 @@
"use client"; 'use client';
import dynamic from "next/dynamic"; import dynamic from 'next/dynamic';
import type { Session } from "next-auth"; import type { Session } from 'next-auth';
import { SessionProvider } from "next-auth/react"; import { SessionProvider } from 'next-auth/react';
import { MiniAppProvider } from "@neynar/react"; import { MiniAppProvider } from '@neynar/react';
import { SafeFarcasterSolanaProvider } from "~/components/providers/SafeFarcasterSolanaProvider"; import { SafeFarcasterSolanaProvider } from '~/components/providers/SafeFarcasterSolanaProvider';
import { ANALYTICS_ENABLED } from "~/lib/constants"; import { ANALYTICS_ENABLED } from '~/lib/constants';
const WagmiProvider = dynamic( const WagmiProvider = dynamic(
() => import("~/components/providers/WagmiProvider"), () => import('~/components/providers/WagmiProvider'),
{ {
ssr: false, ssr: false,
} }
); );
export function Providers({ session, children }: { session: Session | null, children: React.ReactNode }) { export function Providers({
const solanaEndpoint = process.env.SOLANA_RPC_ENDPOINT || "https://solana-rpc.publicnode.com"; session,
children,
}: {
session: Session | null;
children: React.ReactNode;
}) {
const solanaEndpoint =
process.env.SOLANA_RPC_ENDPOINT || 'https://solana-rpc.publicnode.com';
return ( return (
<SessionProvider session={session}> <SessionProvider session={session}>
<WagmiProvider> <WagmiProvider>
<MiniAppProvider analyticsEnabled={ANALYTICS_ENABLED} backButtonEnabled={true}> <MiniAppProvider
analyticsEnabled={ANALYTICS_ENABLED}
backButtonEnabled={true}
>
<SafeFarcasterSolanaProvider endpoint={solanaEndpoint}> <SafeFarcasterSolanaProvider endpoint={solanaEndpoint}>
{children} {children}
</SafeFarcasterSolanaProvider> </SafeFarcasterSolanaProvider>

View File

@ -1,7 +1,7 @@
import type { Metadata } from "next"; import type { Metadata } from 'next';
import { redirect } from "next/navigation"; import { redirect } from 'next/navigation';
import { APP_URL, APP_NAME, APP_DESCRIPTION } from "~/lib/constants"; import { APP_URL, APP_NAME, APP_DESCRIPTION } from '~/lib/constants';
import { getMiniAppEmbedMetadata } from "~/lib/utils"; import { getMiniAppEmbedMetadata } from '~/lib/utils';
export const revalidate = 300; export const revalidate = 300;
// This is an example of how to generate a dynamically generated share page based on fid: // This is an example of how to generate a dynamically generated share page based on fid:
@ -23,12 +23,12 @@ export async function generateMetadata({
images: [imageUrl], images: [imageUrl],
}, },
other: { other: {
"fc:frame": JSON.stringify(getMiniAppEmbedMetadata(imageUrl)), 'fc:frame': JSON.stringify(getMiniAppEmbedMetadata(imageUrl)),
}, },
}; };
} }
export default function SharePage() { export default function SharePage() {
// redirect to home page // redirect to home page
redirect("/"); redirect('/');
} }

View File

@ -1,8 +1,8 @@
import { AuthOptions, getServerSession } from "next-auth" import { AuthOptions, getServerSession } from 'next-auth';
import CredentialsProvider from "next-auth/providers/credentials"; import CredentialsProvider from 'next-auth/providers/credentials';
import { createAppClient, viemConnector } from "@farcaster/auth-client"; import { createAppClient, viemConnector } from '@farcaster/auth-client';
declare module "next-auth" { declare module 'next-auth' {
interface Session { interface Session {
user: { user: {
fid: number; fid: number;
@ -26,34 +26,34 @@ function getDomainFromUrl(urlString: string | undefined): string {
} }
export const authOptions: AuthOptions = { export const authOptions: AuthOptions = {
// Configure one or more authentication providers // Configure one or more authentication providers
providers: [ providers: [
CredentialsProvider({ CredentialsProvider({
name: "Sign in with Farcaster", name: 'Sign in with Farcaster',
credentials: { credentials: {
message: { message: {
label: "Message", label: 'Message',
type: "text", type: 'text',
placeholder: "0x0", placeholder: '0x0',
}, },
signature: { signature: {
label: "Signature", label: 'Signature',
type: "text", type: 'text',
placeholder: "0x0", placeholder: '0x0',
}, },
// In a production app with a server, these should be fetched from // In a production app with a server, these should be fetched from
// your Farcaster data indexer rather than have them accepted as part // your Farcaster data indexer rather than have them accepted as part
// of credentials. // of credentials.
// question: should these natively use the Neynar API? // question: should these natively use the Neynar API?
name: { name: {
label: "Name", label: 'Name',
type: "text", type: 'text',
placeholder: "0x0", placeholder: '0x0',
}, },
pfp: { pfp: {
label: "Pfp", label: 'Pfp',
type: "text", type: 'text',
placeholder: "0x0", placeholder: '0x0',
}, },
}, },
async authorize(credentials, req) { async authorize(credentials, req) {
@ -100,30 +100,30 @@ export const authOptions: AuthOptions = {
name: `next-auth.session-token`, name: `next-auth.session-token`,
options: { options: {
httpOnly: true, httpOnly: true,
sameSite: "none", sameSite: 'none',
path: "/", path: '/',
secure: true secure: true,
} },
}, },
callbackUrl: { callbackUrl: {
name: `next-auth.callback-url`, name: `next-auth.callback-url`,
options: { options: {
sameSite: "none", sameSite: 'none',
path: "/", path: '/',
secure: true secure: true,
} },
}, },
csrfToken: { csrfToken: {
name: `next-auth.csrf-token`, name: `next-auth.csrf-token`,
options: { options: {
httpOnly: true, httpOnly: true,
sameSite: "none", sameSite: 'none',
path: "/", path: '/',
secure: true secure: true,
} },
} },
} },
} };
export const getSession = async () => { export const getSession = async () => {
try { try {
@ -132,4 +132,4 @@ export const getSession = async () => {
console.error('Error getting server session:', error); console.error('Error getting server session:', error);
return null; return null;
} }
} };

View File

@ -1,19 +1,24 @@
"use client"; 'use client';
import { useEffect } from "react"; import { useEffect } from 'react';
import { useMiniApp } from "@neynar/react"; import { useMiniApp } from '@neynar/react';
import { Header } from "~/components/ui/Header"; import { Header } from '~/components/ui/Header';
import { Footer } from "~/components/ui/Footer"; import { Footer } from '~/components/ui/Footer';
import { HomeTab, ActionsTab, ContextTab, WalletTab } from "~/components/ui/tabs"; import {
import { USE_WALLET } from "~/lib/constants"; HomeTab,
import { useNeynarUser } from "../hooks/useNeynarUser"; ActionsTab,
ContextTab,
WalletTab,
} from '~/components/ui/tabs';
import { USE_WALLET } from '~/lib/constants';
import { useNeynarUser } from '../hooks/useNeynarUser';
// --- Types --- // --- Types ---
export enum Tab { export enum Tab {
Home = "home", Home = 'home',
Actions = "actions", Actions = 'actions',
Context = "context", Context = 'context',
Wallet = "wallet", Wallet = 'wallet',
} }
export interface AppProps { export interface AppProps {
@ -22,44 +27,39 @@ export interface AppProps {
/** /**
* App component serves as the main container for the mini app interface. * App component serves as the main container for the mini app interface.
* *
* This component orchestrates the overall mini app experience by: * This component orchestrates the overall mini app experience by:
* - Managing tab navigation and state * - Managing tab navigation and state
* - Handling Farcaster mini app initialization * - Handling Farcaster mini app initialization
* - Coordinating wallet and context state * - Coordinating wallet and context state
* - Providing error handling and loading states * - Providing error handling and loading states
* - Rendering the appropriate tab content based on user selection * - Rendering the appropriate tab content based on user selection
* *
* The component integrates with the Neynar SDK for Farcaster functionality * The component integrates with the Neynar SDK for Farcaster functionality
* and Wagmi for wallet management. It provides a complete mini app * and Wagmi for wallet management. It provides a complete mini app
* experience with multiple tabs for different functionality areas. * experience with multiple tabs for different functionality areas.
* *
* Features: * Features:
* - Tab-based navigation (Home, Actions, Context, Wallet) * - Tab-based navigation (Home, Actions, Context, Wallet)
* - Farcaster mini app integration * - Farcaster mini app integration
* - Wallet connection management * - Wallet connection management
* - Error handling and display * - Error handling and display
* - Loading states for async operations * - Loading states for async operations
* *
* @param props - Component props * @param props - Component props
* @param props.title - Optional title for the mini app (defaults to "Neynar Starter Kit") * @param props.title - Optional title for the mini app (defaults to "Neynar Starter Kit")
* *
* @example * @example
* ```tsx * ```tsx
* <App title="My Mini App" /> * <App title="My Mini App" />
* ``` * ```
*/ */
export default function App( export default function App(
{ title }: AppProps = { title: "Neynar Starter Kit" } { title }: AppProps = { title: 'Neynar Starter Kit' }
) { ) {
// --- Hooks --- // --- Hooks ---
const { const { isSDKLoaded, context, setInitialTab, setActiveTab, currentTab } =
isSDKLoaded, useMiniApp();
context,
setInitialTab,
setActiveTab,
currentTab,
} = useMiniApp();
// --- Neynar user hook --- // --- Neynar user hook ---
const { user: neynarUser } = useNeynarUser(context || undefined); const { user: neynarUser } = useNeynarUser(context || undefined);
@ -67,7 +67,7 @@ export default function App(
// --- Effects --- // --- Effects ---
/** /**
* Sets the initial tab to "home" when the SDK is loaded. * Sets the initial tab to "home" when the SDK is loaded.
* *
* This effect ensures that users start on the home tab when they first * This effect ensures that users start on the home tab when they first
* load the mini app. It only runs when the SDK is fully loaded to * load the mini app. It only runs when the SDK is fully loaded to
* prevent errors during initialization. * prevent errors during initialization.
@ -115,9 +115,12 @@ export default function App(
{currentTab === Tab.Wallet && <WalletTab />} {currentTab === Tab.Wallet && <WalletTab />}
{/* Footer with navigation */} {/* Footer with navigation */}
<Footer activeTab={currentTab as Tab} setActiveTab={setActiveTab} showWallet={USE_WALLET} /> <Footer
activeTab={currentTab as Tab}
setActiveTab={setActiveTab}
showWallet={USE_WALLET}
/>
</div> </div>
</div> </div>
); );
} }

View File

@ -1,9 +1,12 @@
import React, { createContext, useEffect, useState } from "react"; import React, { createContext, useEffect, useState } from 'react';
import dynamic from "next/dynamic"; import dynamic from 'next/dynamic';
import { sdk } from '@farcaster/frame-sdk'; import { sdk } from '@farcaster/frame-sdk';
const FarcasterSolanaProvider = dynamic( const FarcasterSolanaProvider = dynamic(
() => import('@farcaster/mini-app-solana').then(mod => mod.FarcasterSolanaProvider), () =>
import('@farcaster/mini-app-solana').then(
mod => mod.FarcasterSolanaProvider
),
{ ssr: false } { ssr: false }
); );
@ -12,10 +15,15 @@ type SafeFarcasterSolanaProviderProps = {
children: React.ReactNode; children: React.ReactNode;
}; };
const SolanaProviderContext = createContext<{ hasSolanaProvider: boolean }>({ hasSolanaProvider: false }); const SolanaProviderContext = createContext<{ hasSolanaProvider: boolean }>({
hasSolanaProvider: false,
});
export function SafeFarcasterSolanaProvider({ endpoint, children }: SafeFarcasterSolanaProviderProps) { export function SafeFarcasterSolanaProvider({
const isClient = typeof window !== "undefined"; endpoint,
children,
}: SafeFarcasterSolanaProviderProps) {
const isClient = typeof window !== 'undefined';
const [hasSolanaProvider, setHasSolanaProvider] = useState<boolean>(false); const [hasSolanaProvider, setHasSolanaProvider] = useState<boolean>(false);
const [checked, setChecked] = useState<boolean>(false); const [checked, setChecked] = useState<boolean>(false);
@ -48,8 +56,8 @@ export function SafeFarcasterSolanaProvider({ endpoint, children }: SafeFarcaste
const origError = console.error; const origError = console.error;
console.error = (...args) => { console.error = (...args) => {
if ( if (
typeof args[0] === "string" && typeof args[0] === 'string' &&
args[0].includes("WalletConnectionError: could not get Solana provider") args[0].includes('WalletConnectionError: could not get Solana provider')
) { ) {
if (!errorShown) { if (!errorShown) {
origError(...args); origError(...args);

View File

@ -1,12 +1,12 @@
import { createConfig, http, WagmiProvider } from "wagmi"; import { createConfig, http, WagmiProvider } from 'wagmi';
import { base, degen, mainnet, optimism, unichain, celo } from "wagmi/chains"; import { base, degen, mainnet, optimism, unichain, celo } from 'wagmi/chains';
import { QueryClient, QueryClientProvider } from "@tanstack/react-query"; import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
import { farcasterFrame } from "@farcaster/frame-wagmi-connector"; import { farcasterFrame } from '@farcaster/frame-wagmi-connector';
import { coinbaseWallet, metaMask } from 'wagmi/connectors'; import { coinbaseWallet, metaMask } from 'wagmi/connectors';
import { APP_NAME, APP_ICON_URL, APP_URL } from "~/lib/constants"; import { APP_NAME, APP_ICON_URL, APP_URL } from '~/lib/constants';
import { useEffect, useState } from "react"; import { useEffect, useState } from 'react';
import { useConnect, useAccount } from "wagmi"; import { useConnect, useAccount } from 'wagmi';
import React from "react"; import React from 'react';
// Custom hook for Coinbase Wallet detection and auto-connection // Custom hook for Coinbase Wallet detection and auto-connection
function useCoinbaseWalletAutoConnect() { function useCoinbaseWalletAutoConnect() {
@ -17,15 +17,16 @@ function useCoinbaseWalletAutoConnect() {
useEffect(() => { useEffect(() => {
// Check if we're running in Coinbase Wallet // Check if we're running in Coinbase Wallet
const checkCoinbaseWallet = () => { const checkCoinbaseWallet = () => {
const isInCoinbaseWallet = window.ethereum?.isCoinbaseWallet || const isInCoinbaseWallet =
window.ethereum?.isCoinbaseWallet ||
window.ethereum?.isCoinbaseWalletExtension || window.ethereum?.isCoinbaseWalletExtension ||
window.ethereum?.isCoinbaseWalletBrowser; window.ethereum?.isCoinbaseWalletBrowser;
setIsCoinbaseWallet(!!isInCoinbaseWallet); setIsCoinbaseWallet(!!isInCoinbaseWallet);
}; };
checkCoinbaseWallet(); checkCoinbaseWallet();
window.addEventListener('ethereum#initialized', checkCoinbaseWallet); window.addEventListener('ethereum#initialized', checkCoinbaseWallet);
return () => { return () => {
window.removeEventListener('ethereum#initialized', checkCoinbaseWallet); window.removeEventListener('ethereum#initialized', checkCoinbaseWallet);
}; };
@ -70,7 +71,11 @@ export const config = createConfig({
const queryClient = new QueryClient(); const queryClient = new QueryClient();
// Wrapper component that provides Coinbase Wallet auto-connection // Wrapper component that provides Coinbase Wallet auto-connection
function CoinbaseWalletAutoConnect({ children }: { children: React.ReactNode }) { function CoinbaseWalletAutoConnect({
children,
}: {
children: React.ReactNode;
}) {
useCoinbaseWalletAutoConnect(); useCoinbaseWalletAutoConnect();
return <>{children}</>; return <>{children}</>;
} }
@ -79,9 +84,7 @@ export default function Provider({ children }: { children: React.ReactNode }) {
return ( return (
<WagmiProvider config={config}> <WagmiProvider config={config}>
<QueryClientProvider client={queryClient}> <QueryClientProvider client={queryClient}>
<CoinbaseWalletAutoConnect> <CoinbaseWalletAutoConnect>{children}</CoinbaseWalletAutoConnect>
{children}
</CoinbaseWalletAutoConnect>
</QueryClientProvider> </QueryClientProvider>
</WagmiProvider> </WagmiProvider>
); );

View File

@ -5,43 +5,40 @@ interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
size?: 'sm' | 'md' | 'lg'; size?: 'sm' | 'md' | 'lg';
} }
export function Button({ export function Button({
children, children,
className = "", className = '',
isLoading = false, isLoading = false,
variant = 'primary', variant = 'primary',
size = 'md', size = 'md',
...props ...props
}: ButtonProps) { }: ButtonProps) {
const baseClasses = "btn"; const baseClasses = 'btn';
const variantClasses = { const variantClasses = {
primary: "btn-primary", primary: 'btn-primary',
secondary: "btn-secondary", secondary: 'btn-secondary',
outline: "btn-outline" outline: 'btn-outline',
};
const sizeClasses = {
sm: "px-3 py-1.5 text-xs",
md: "px-4 py-2 text-sm",
lg: "px-6 py-3 text-base"
}; };
const fullWidthClasses = "w-full max-w-xs mx-auto block"; const sizeClasses = {
sm: 'px-3 py-1.5 text-xs',
md: 'px-4 py-2 text-sm',
lg: 'px-6 py-3 text-base',
};
const fullWidthClasses = 'w-full max-w-xs mx-auto block';
const combinedClasses = [ const combinedClasses = [
baseClasses, baseClasses,
variantClasses[variant], variantClasses[variant],
sizeClasses[size], sizeClasses[size],
fullWidthClasses, fullWidthClasses,
className className,
].join(' '); ].join(' ');
return ( return (
<button <button className={combinedClasses} {...props}>
className={combinedClasses}
{...props}
>
{isLoading ? ( {isLoading ? (
<div className="flex items-center justify-center"> <div className="flex items-center justify-center">
<div className="spinner-primary h-5 w-5" /> <div className="spinner-primary h-5 w-5" />

View File

@ -1,5 +1,5 @@
import React from "react"; import React from 'react';
import { Tab } from "~/components/App"; import { Tab } from '~/components/App';
interface FooterProps { interface FooterProps {
activeTab: Tab; activeTab: Tab;
@ -7,13 +7,19 @@ interface FooterProps {
showWallet?: boolean; showWallet?: boolean;
} }
export const Footer: React.FC<FooterProps> = ({ activeTab, setActiveTab, showWallet = false }) => ( export const Footer: React.FC<FooterProps> = ({
activeTab,
setActiveTab,
showWallet = false,
}) => (
<div className="fixed bottom-0 left-0 right-0 mx-4 mb-4 bg-gray-100 dark:bg-gray-800 border-[3px] border-double border-primary px-2 py-2 rounded-lg z-50"> <div className="fixed bottom-0 left-0 right-0 mx-4 mb-4 bg-gray-100 dark:bg-gray-800 border-[3px] border-double border-primary px-2 py-2 rounded-lg z-50">
<div className="flex justify-around items-center h-14"> <div className="flex justify-around items-center h-14">
<button <button
onClick={() => setActiveTab(Tab.Home)} onClick={() => setActiveTab(Tab.Home)}
className={`flex flex-col items-center justify-center w-full h-full ${ className={`flex flex-col items-center justify-center w-full h-full ${
activeTab === Tab.Home ? 'text-primary dark:text-primary-light' : 'text-gray-500 dark:text-gray-400' activeTab === Tab.Home
? 'text-primary dark:text-primary-light'
: 'text-gray-500 dark:text-gray-400'
}`} }`}
> >
<span className="text-xl">🏠</span> <span className="text-xl">🏠</span>
@ -22,7 +28,9 @@ export const Footer: React.FC<FooterProps> = ({ activeTab, setActiveTab, showWal
<button <button
onClick={() => setActiveTab(Tab.Actions)} onClick={() => setActiveTab(Tab.Actions)}
className={`flex flex-col items-center justify-center w-full h-full ${ className={`flex flex-col items-center justify-center w-full h-full ${
activeTab === Tab.Actions ? 'text-primary dark:text-primary-light' : 'text-gray-500 dark:text-gray-400' activeTab === Tab.Actions
? 'text-primary dark:text-primary-light'
: 'text-gray-500 dark:text-gray-400'
}`} }`}
> >
<span className="text-xl"></span> <span className="text-xl"></span>
@ -31,7 +39,9 @@ export const Footer: React.FC<FooterProps> = ({ activeTab, setActiveTab, showWal
<button <button
onClick={() => setActiveTab(Tab.Context)} onClick={() => setActiveTab(Tab.Context)}
className={`flex flex-col items-center justify-center w-full h-full ${ className={`flex flex-col items-center justify-center w-full h-full ${
activeTab === Tab.Context ? 'text-primary dark:text-primary-light' : 'text-gray-500 dark:text-gray-400' activeTab === Tab.Context
? 'text-primary dark:text-primary-light'
: 'text-gray-500 dark:text-gray-400'
}`} }`}
> >
<span className="text-xl">📋</span> <span className="text-xl">📋</span>
@ -41,7 +51,9 @@ export const Footer: React.FC<FooterProps> = ({ activeTab, setActiveTab, showWal
<button <button
onClick={() => setActiveTab(Tab.Wallet)} onClick={() => setActiveTab(Tab.Wallet)}
className={`flex flex-col items-center justify-center w-full h-full ${ className={`flex flex-col items-center justify-center w-full h-full ${
activeTab === Tab.Wallet ? 'text-primary dark:text-primary-light' : 'text-gray-500 dark:text-gray-400' activeTab === Tab.Wallet
? 'text-primary dark:text-primary-light'
: 'text-gray-500 dark:text-gray-400'
}`} }`}
> >
<span className="text-xl">👛</span> <span className="text-xl">👛</span>

View File

@ -1,9 +1,9 @@
"use client"; 'use client';
import { useState } from "react"; import { useState } from 'react';
import { APP_NAME } from "~/lib/constants"; import { APP_NAME } from '~/lib/constants';
import sdk from "@farcaster/frame-sdk"; import sdk from '@farcaster/frame-sdk';
import { useMiniApp } from "@neynar/react"; import { useMiniApp } from '@neynar/react';
type HeaderProps = { type HeaderProps = {
neynarUser?: { neynarUser?: {
@ -18,23 +18,19 @@ export function Header({ neynarUser }: HeaderProps) {
return ( return (
<div className="relative"> <div className="relative">
<div <div className="mt-4 mb-4 mx-4 px-2 py-2 bg-gray-100 dark:bg-gray-800 rounded-lg flex items-center justify-between border-[3px] border-double border-primary">
className="mt-4 mb-4 mx-4 px-2 py-2 bg-gray-100 dark:bg-gray-800 rounded-lg flex items-center justify-between border-[3px] border-double border-primary" <div className="text-lg font-light">Welcome to {APP_NAME}!</div>
>
<div className="text-lg font-light">
Welcome to {APP_NAME}!
</div>
{context?.user && ( {context?.user && (
<div <div
className="cursor-pointer" className="cursor-pointer"
onClick={() => { onClick={() => {
setIsUserDropdownOpen(!isUserDropdownOpen); setIsUserDropdownOpen(!isUserDropdownOpen);
}} }}
> >
{context.user.pfpUrl && ( {context.user.pfpUrl && (
<img <img
src={context.user.pfpUrl} src={context.user.pfpUrl}
alt="Profile" alt="Profile"
className="w-10 h-10 rounded-full border-2 border-primary" className="w-10 h-10 rounded-full border-2 border-primary"
/> />
)} )}
@ -42,14 +38,16 @@ export function Header({ neynarUser }: HeaderProps) {
)} )}
</div> </div>
{context?.user && ( {context?.user && (
<> <>
{isUserDropdownOpen && ( {isUserDropdownOpen && (
<div className="absolute top-full right-0 z-50 w-fit mt-1 mx-4 bg-white dark:bg-gray-800 rounded-lg shadow-lg border border-gray-200 dark:border-gray-700"> <div className="absolute top-full right-0 z-50 w-fit mt-1 mx-4 bg-white dark:bg-gray-800 rounded-lg shadow-lg border border-gray-200 dark:border-gray-700">
<div className="p-3 space-y-2"> <div className="p-3 space-y-2">
<div className="text-right"> <div className="text-right">
<h3 <h3
className="font-bold text-sm hover:underline cursor-pointer inline-block" className="font-bold text-sm hover:underline cursor-pointer inline-block"
onClick={() => sdk.actions.viewProfile({ fid: context.user.fid })} onClick={() =>
sdk.actions.viewProfile({ fid: context.user.fid })
}
> >
{context.user.displayName || context.user.username} {context.user.displayName || context.user.username}
</h3> </h3>

View File

@ -3,7 +3,7 @@
import { useCallback, useState, useEffect } from 'react'; import { useCallback, useState, useEffect } from 'react';
import { Button } from './Button'; import { Button } from './Button';
import { useMiniApp } from '@neynar/react'; import { useMiniApp } from '@neynar/react';
import { type ComposeCast } from "@farcaster/frame-sdk"; import { type ComposeCast } from '@farcaster/frame-sdk';
interface EmbedConfig { interface EmbedConfig {
path?: string; path?: string;
@ -23,9 +23,16 @@ interface ShareButtonProps {
isLoading?: boolean; isLoading?: boolean;
} }
export function ShareButton({ buttonText, cast, className = '', isLoading = false }: ShareButtonProps) { export function ShareButton({
buttonText,
cast,
className = '',
isLoading = false,
}: ShareButtonProps) {
const [isProcessing, setIsProcessing] = useState(false); const [isProcessing, setIsProcessing] = useState(false);
const [bestFriends, setBestFriends] = useState<{ fid: number; username: string; }[] | null>(null); const [bestFriends, setBestFriends] = useState<
{ fid: number; username: string }[] | null
>(null);
const [isLoadingBestFriends, setIsLoadingBestFriends] = useState(false); const [isLoadingBestFriends, setIsLoadingBestFriends] = useState(false);
const { context, actions } = useMiniApp(); const { context, actions } = useMiniApp();
@ -51,7 +58,7 @@ export function ShareButton({ buttonText, cast, className = '', isLoading = fals
if (cast.bestFriends) { if (cast.bestFriends) {
if (bestFriends) { if (bestFriends) {
// Replace @N with usernames, or remove if no matching friend // Replace @N with usernames, or remove if no matching friend
finalText = finalText.replace(/@\d+/g, (match) => { finalText = finalText.replace(/@\d+/g, match => {
const friendIndex = parseInt(match.slice(1)) - 1; const friendIndex = parseInt(match.slice(1)) - 1;
const friend = bestFriends[friendIndex]; const friend = bestFriends[friendIndex];
if (friend) { if (friend) {
@ -67,16 +74,20 @@ export function ShareButton({ buttonText, cast, className = '', isLoading = fals
// Process embeds // Process embeds
const processedEmbeds = await Promise.all( const processedEmbeds = await Promise.all(
(cast.embeds || []).map(async (embed) => { (cast.embeds || []).map(async embed => {
if (typeof embed === 'string') { if (typeof embed === 'string') {
return embed; return embed;
} }
if (embed.path) { if (embed.path) {
const baseUrl = process.env.NEXT_PUBLIC_URL || window.location.origin; const baseUrl =
process.env.NEXT_PUBLIC_URL || window.location.origin;
const url = new URL(`${baseUrl}${embed.path}`); const url = new URL(`${baseUrl}${embed.path}`);
// Add UTM parameters // Add UTM parameters
url.searchParams.set('utm_source', `share-cast-${context?.user?.fid || 'unknown'}`); url.searchParams.set(
'utm_source',
`share-cast-${context?.user?.fid || 'unknown'}`
);
// If custom image generator is provided, use it // If custom image generator is provided, use it
if (embed.imageUrl) { if (embed.imageUrl) {

View File

@ -1,22 +1,22 @@
import * as React from "react" import * as React from 'react';
import { cn } from "~/lib/utils" import { cn } from '~/lib/utils';
const Input = React.forwardRef<HTMLInputElement, React.ComponentProps<"input">>( const Input = React.forwardRef<HTMLInputElement, React.ComponentProps<'input'>>(
({ className, type, ...props }, ref) => { ({ className, type, ...props }, ref) => {
return ( return (
<input <input
type={type} type={type}
className={cn( className={cn(
"flex h-10 w-full rounded-md border border-neutral-200 bg-white px-3 py-2 text-base ring-offset-white file:border-0 file:bg-transparent file:text-sm file:font-medium file:text-neutral-950 placeholder:text-neutral-500 focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-neutral-950 focus-visible:ring-offset-2 disabled:cursor-not-allowed disabled:opacity-50 md:text-sm dark:border-neutral-800 dark:bg-neutral-950 dark:ring-offset-neutral-950 dark:file:text-neutral-50 dark:placeholder:text-neutral-400 dark:focus-visible:ring-neutral-300", 'flex h-10 w-full rounded-md border border-neutral-200 bg-white px-3 py-2 text-base ring-offset-white file:border-0 file:bg-transparent file:text-sm file:font-medium file:text-neutral-950 placeholder:text-neutral-500 focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-neutral-950 focus-visible:ring-offset-2 disabled:cursor-not-allowed disabled:opacity-50 md:text-sm dark:border-neutral-800 dark:bg-neutral-950 dark:ring-offset-neutral-950 dark:file:text-neutral-50 dark:placeholder:text-neutral-400 dark:focus-visible:ring-neutral-300',
className className
)} )}
ref={ref} ref={ref}
{...props} {...props}
/> />
) );
} }
) );
Input.displayName = "Input" Input.displayName = 'Input';
export { Input } export { Input };

View File

@ -1,14 +1,14 @@
"use client" 'use client';
import * as React from "react" import * as React from 'react';
import * as LabelPrimitive from "@radix-ui/react-label" import * as LabelPrimitive from '@radix-ui/react-label';
import { cva, type VariantProps } from "class-variance-authority" import { cva, type VariantProps } from 'class-variance-authority';
import { cn } from "~/lib/utils" import { cn } from '~/lib/utils';
const labelVariants = cva( const labelVariants = cva(
"text-sm font-medium leading-none peer-disabled:cursor-not-allowed peer-disabled:opacity-70" 'text-sm font-medium leading-none peer-disabled:cursor-not-allowed peer-disabled:opacity-70'
) );
const Label = React.forwardRef< const Label = React.forwardRef<
React.ElementRef<typeof LabelPrimitive.Root>, React.ElementRef<typeof LabelPrimitive.Root>,
@ -20,7 +20,7 @@ const Label = React.forwardRef<
className={cn(labelVariants(), className)} className={cn(labelVariants(), className)}
{...props} {...props}
/> />
)) ));
Label.displayName = LabelPrimitive.Root.displayName Label.displayName = LabelPrimitive.Root.displayName;
export { Label } export { Label };

View File

@ -1,15 +1,15 @@
"use client"; 'use client';
import { useCallback, useState } from "react"; import { useCallback, useState } from 'react';
import { useMiniApp } from "@neynar/react"; import { useMiniApp } from '@neynar/react';
import { ShareButton } from "../Share"; import { ShareButton } from '../Share';
import { Button } from "../Button"; import { Button } from '../Button';
import { SignIn } from "../wallet/SignIn"; import { SignIn } from '../wallet/SignIn';
import { type Haptics } from "@farcaster/frame-sdk"; import { type Haptics } from '@farcaster/frame-sdk';
/** /**
* ActionsTab component handles mini app actions like sharing, notifications, and haptic feedback. * ActionsTab component handles mini app actions like sharing, notifications, and haptic feedback.
* *
* This component provides the main interaction interface for users to: * This component provides the main interaction interface for users to:
* - Share the mini app with others * - Share the mini app with others
* - Sign in with Farcaster * - Sign in with Farcaster
@ -17,10 +17,10 @@ import { type Haptics } from "@farcaster/frame-sdk";
* - Trigger haptic feedback * - Trigger haptic feedback
* - Add the mini app to their client * - Add the mini app to their client
* - Copy share URLs * - Copy share URLs
* *
* The component uses the useMiniApp hook to access Farcaster context and actions. * The component uses the useMiniApp hook to access Farcaster context and actions.
* All state is managed locally within this component. * All state is managed locally within this component.
* *
* @example * @example
* ```tsx * ```tsx
* <ActionsTab /> * <ActionsTab />
@ -28,63 +28,65 @@ import { type Haptics } from "@farcaster/frame-sdk";
*/ */
export function ActionsTab() { export function ActionsTab() {
// --- Hooks --- // --- Hooks ---
const { const { actions, added, notificationDetails, haptics, context } =
actions, useMiniApp();
added,
notificationDetails,
haptics,
context,
} = useMiniApp();
// --- State --- // --- State ---
const [notificationState, setNotificationState] = useState({ const [notificationState, setNotificationState] = useState({
sendStatus: "", sendStatus: '',
shareUrlCopied: false, shareUrlCopied: false,
}); });
const [selectedHapticIntensity, setSelectedHapticIntensity] = useState<Haptics.ImpactOccurredType>('medium'); const [selectedHapticIntensity, setSelectedHapticIntensity] =
useState<Haptics.ImpactOccurredType>('medium');
// --- Handlers --- // --- Handlers ---
/** /**
* Sends a notification to the current user's Farcaster account. * Sends a notification to the current user's Farcaster account.
* *
* This function makes a POST request to the /api/send-notification endpoint * This function makes a POST request to the /api/send-notification endpoint
* with the user's FID and notification details. It handles different response * with the user's FID and notification details. It handles different response
* statuses including success (200), rate limiting (429), and errors. * statuses including success (200), rate limiting (429), and errors.
* *
* @returns Promise that resolves when the notification is sent or fails * @returns Promise that resolves when the notification is sent or fails
*/ */
const sendFarcasterNotification = useCallback(async () => { const sendFarcasterNotification = useCallback(async () => {
setNotificationState((prev) => ({ ...prev, sendStatus: "" })); setNotificationState(prev => ({ ...prev, sendStatus: '' }));
if (!notificationDetails || !context) { if (!notificationDetails || !context) {
return; return;
} }
try { try {
const response = await fetch("/api/send-notification", { const response = await fetch('/api/send-notification', {
method: "POST", method: 'POST',
mode: "same-origin", mode: 'same-origin',
headers: { "Content-Type": "application/json" }, headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ body: JSON.stringify({
fid: context.user.fid, fid: context.user.fid,
notificationDetails, notificationDetails,
}), }),
}); });
if (response.status === 200) { if (response.status === 200) {
setNotificationState((prev) => ({ ...prev, sendStatus: "Success" })); setNotificationState(prev => ({ ...prev, sendStatus: 'Success' }));
return; return;
} else if (response.status === 429) { } else if (response.status === 429) {
setNotificationState((prev) => ({ ...prev, sendStatus: "Rate limited" })); setNotificationState(prev => ({ ...prev, sendStatus: 'Rate limited' }));
return; return;
} }
const responseText = await response.text(); const responseText = await response.text();
setNotificationState((prev) => ({ ...prev, sendStatus: `Error: ${responseText}` })); setNotificationState(prev => ({
...prev,
sendStatus: `Error: ${responseText}`,
}));
} catch (error) { } catch (error) {
setNotificationState((prev) => ({ ...prev, sendStatus: `Error: ${error}` })); setNotificationState(prev => ({
...prev,
sendStatus: `Error: ${error}`,
}));
} }
}, [context, notificationDetails]); }, [context, notificationDetails]);
/** /**
* Copies the share URL for the current user to the clipboard. * Copies the share URL for the current user to the clipboard.
* *
* This function generates a share URL using the user's FID and copies it * This function generates a share URL using the user's FID and copies it
* to the clipboard. It shows a temporary "Copied!" message for 2 seconds. * to the clipboard. It shows a temporary "Copied!" message for 2 seconds.
*/ */
@ -92,14 +94,18 @@ export function ActionsTab() {
if (context?.user?.fid) { if (context?.user?.fid) {
const userShareUrl = `${process.env.NEXT_PUBLIC_URL}/share/${context.user.fid}`; const userShareUrl = `${process.env.NEXT_PUBLIC_URL}/share/${context.user.fid}`;
await navigator.clipboard.writeText(userShareUrl); await navigator.clipboard.writeText(userShareUrl);
setNotificationState((prev) => ({ ...prev, shareUrlCopied: true })); setNotificationState(prev => ({ ...prev, shareUrlCopied: true }));
setTimeout(() => setNotificationState((prev) => ({ ...prev, shareUrlCopied: false })), 2000); setTimeout(
() =>
setNotificationState(prev => ({ ...prev, shareUrlCopied: false })),
2000
);
} }
}, [context?.user?.fid]); }, [context?.user?.fid]);
/** /**
* Triggers haptic feedback with the selected intensity. * Triggers haptic feedback with the selected intensity.
* *
* This function calls the haptics.impactOccurred method with the current * This function calls the haptics.impactOccurred method with the current
* selectedHapticIntensity setting. It handles errors gracefully by logging them. * selectedHapticIntensity setting. It handles errors gracefully by logging them.
*/ */
@ -115,12 +121,14 @@ export function ActionsTab() {
return ( return (
<div className="space-y-3 px-6 w-full max-w-md mx-auto"> <div className="space-y-3 px-6 w-full max-w-md mx-auto">
{/* Share functionality */} {/* Share functionality */}
<ShareButton <ShareButton
buttonText="Share Mini App" buttonText="Share Mini App"
cast={{ cast={{
text: "Check out this awesome frame @1 @2 @3! 🚀🪐", text: 'Check out this awesome frame @1 @2 @3! 🚀🪐',
bestFriends: true, bestFriends: true,
embeds: [`${process.env.NEXT_PUBLIC_URL}/share/${context?.user?.fid || ''}`] embeds: [
`${process.env.NEXT_PUBLIC_URL}/share/${context?.user?.fid || ''}`,
],
}} }}
className="w-full" className="w-full"
/> />
@ -129,7 +137,14 @@ export function ActionsTab() {
<SignIn /> <SignIn />
{/* Mini app actions */} {/* Mini app actions */}
<Button onClick={() => actions.openUrl("https://www.youtube.com/watch?v=dQw4w9WgXcQ")} className="w-full">Open Link</Button> <Button
onClick={() =>
actions.openUrl('https://www.youtube.com/watch?v=dQw4w9WgXcQ')
}
className="w-full"
>
Open Link
</Button>
<Button onClick={actions.addMiniApp} disabled={added} className="w-full"> <Button onClick={actions.addMiniApp} disabled={added} className="w-full">
Add Mini App to Client Add Mini App to Client
@ -141,17 +156,21 @@ export function ActionsTab() {
Send notification result: {notificationState.sendStatus} Send notification result: {notificationState.sendStatus}
</div> </div>
)} )}
<Button onClick={sendFarcasterNotification} disabled={!notificationDetails} className="w-full"> <Button
onClick={sendFarcasterNotification}
disabled={!notificationDetails}
className="w-full"
>
Send notification Send notification
</Button> </Button>
{/* Share URL copying */} {/* Share URL copying */}
<Button <Button
onClick={copyUserShareUrl} onClick={copyUserShareUrl}
disabled={!context?.user?.fid} disabled={!context?.user?.fid}
className="w-full" className="w-full"
> >
{notificationState.shareUrlCopied ? "Copied!" : "Copy share URL"} {notificationState.shareUrlCopied ? 'Copied!' : 'Copy share URL'}
</Button> </Button>
{/* Haptic feedback controls */} {/* Haptic feedback controls */}
@ -161,7 +180,11 @@ export function ActionsTab() {
</label> </label>
<select <select
value={selectedHapticIntensity} value={selectedHapticIntensity}
onChange={(e) => setSelectedHapticIntensity(e.target.value as Haptics.ImpactOccurredType)} onChange={e =>
setSelectedHapticIntensity(
e.target.value as Haptics.ImpactOccurredType
)
}
className="w-full px-3 py-2 border border-gray-300 dark:border-gray-600 rounded-md bg-white dark:bg-gray-800 text-gray-900 dark:text-gray-100 focus:outline-none focus:ring-2 focus:ring-primary" className="w-full px-3 py-2 border border-gray-300 dark:border-gray-600 rounded-md bg-white dark:bg-gray-800 text-gray-900 dark:text-gray-100 focus:outline-none focus:ring-2 focus:ring-primary"
> >
<option value={'light'}>Light</option> <option value={'light'}>Light</option>
@ -170,13 +193,10 @@ export function ActionsTab() {
<option value={'soft'}>Soft</option> <option value={'soft'}>Soft</option>
<option value={'rigid'}>Rigid</option> <option value={'rigid'}>Rigid</option>
</select> </select>
<Button <Button onClick={triggerHapticFeedback} className="w-full">
onClick={triggerHapticFeedback}
className="w-full"
>
Trigger Haptic Feedback Trigger Haptic Feedback
</Button> </Button>
</div> </div>
</div> </div>
); );
} }

View File

@ -1,19 +1,19 @@
"use client"; 'use client';
import { useMiniApp } from "@neynar/react"; import { useMiniApp } from '@neynar/react';
/** /**
* ContextTab component displays the current mini app context in JSON format. * ContextTab component displays the current mini app context in JSON format.
* *
* This component provides a developer-friendly view of the Farcaster mini app context, * This component provides a developer-friendly view of the Farcaster mini app context,
* including user information, client details, and other contextual data. It's useful * including user information, client details, and other contextual data. It's useful
* for debugging and understanding what data is available to the mini app. * for debugging and understanding what data is available to the mini app.
* *
* The context includes: * The context includes:
* - User information (FID, username, display name, profile picture) * - User information (FID, username, display name, profile picture)
* - Client information (safe area insets, platform details) * - Client information (safe area insets, platform details)
* - Mini app configuration and state * - Mini app configuration and state
* *
* @example * @example
* ```tsx * ```tsx
* <ContextTab /> * <ContextTab />
@ -21,7 +21,7 @@ import { useMiniApp } from "@neynar/react";
*/ */
export function ContextTab() { export function ContextTab() {
const { context } = useMiniApp(); const { context } = useMiniApp();
return ( return (
<div className="mx-6"> <div className="mx-6">
<h2 className="text-lg font-semibold mb-2">Context</h2> <h2 className="text-lg font-semibold mb-2">Context</h2>
@ -32,4 +32,4 @@ export function ContextTab() {
</div> </div>
</div> </div>
); );
} }

View File

@ -1,12 +1,12 @@
"use client"; 'use client';
/** /**
* HomeTab component displays the main landing content for the mini app. * HomeTab component displays the main landing content for the mini app.
* *
* This is the default tab that users see when they first open the mini app. * This is the default tab that users see when they first open the mini app.
* It provides a simple welcome message and placeholder content that can be * It provides a simple welcome message and placeholder content that can be
* customized for specific use cases. * customized for specific use cases.
* *
* @example * @example
* ```tsx * ```tsx
* <HomeTab /> * <HomeTab />
@ -21,4 +21,4 @@ export function HomeTab() {
</div> </div>
</div> </div>
); );
} }

View File

@ -1,22 +1,32 @@
"use client"; 'use client';
import { useCallback, useMemo, useState, useEffect } from "react"; import { useCallback, useMemo, useState, useEffect } from 'react';
import { useAccount, useSendTransaction, useSignTypedData, useWaitForTransactionReceipt, useDisconnect, useConnect, useSwitchChain, useChainId, type Connector } from "wagmi"; import {
useAccount,
useSendTransaction,
useSignTypedData,
useWaitForTransactionReceipt,
useDisconnect,
useConnect,
useSwitchChain,
useChainId,
type Connector,
} from 'wagmi';
import { useWallet as useSolanaWallet } from '@solana/wallet-adapter-react'; import { useWallet as useSolanaWallet } from '@solana/wallet-adapter-react';
import { base, degen, mainnet, optimism, unichain } from "wagmi/chains"; import { base, degen, mainnet, optimism, unichain } from 'wagmi/chains';
import { Button } from "../Button"; import { Button } from '../Button';
import { truncateAddress } from "../../../lib/truncateAddress"; import { truncateAddress } from '../../../lib/truncateAddress';
import { renderError } from "../../../lib/errorUtils"; import { renderError } from '../../../lib/errorUtils';
import { SignEvmMessage } from "../wallet/SignEvmMessage"; import { SignEvmMessage } from '../wallet/SignEvmMessage';
import { SendEth } from "../wallet/SendEth"; import { SendEth } from '../wallet/SendEth';
import { SignSolanaMessage } from "../wallet/SignSolanaMessage"; import { SignSolanaMessage } from '../wallet/SignSolanaMessage';
import { SendSolana } from "../wallet/SendSolana"; import { SendSolana } from '../wallet/SendSolana';
import { USE_WALLET, APP_NAME } from "../../../lib/constants"; import { USE_WALLET, APP_NAME } from '../../../lib/constants';
import { useMiniApp } from "@neynar/react"; import { useMiniApp } from '@neynar/react';
/** /**
* WalletTab component manages wallet-related UI for both EVM and Solana chains. * WalletTab component manages wallet-related UI for both EVM and Solana chains.
* *
* This component provides a comprehensive wallet interface that supports: * This component provides a comprehensive wallet interface that supports:
* - EVM wallet connections (Farcaster Frame, Coinbase Wallet, MetaMask) * - EVM wallet connections (Farcaster Frame, Coinbase Wallet, MetaMask)
* - Solana wallet integration * - Solana wallet integration
@ -24,10 +34,10 @@ import { useMiniApp } from "@neynar/react";
* - Transaction sending for both chains * - Transaction sending for both chains
* - Chain switching for EVM chains * - Chain switching for EVM chains
* - Auto-connection in Farcaster clients * - Auto-connection in Farcaster clients
* *
* The component automatically detects when running in a Farcaster client * The component automatically detects when running in a Farcaster client
* and attempts to auto-connect using the Farcaster Frame connector. * and attempts to auto-connect using the Farcaster Frame connector.
* *
* @example * @example
* ```tsx * ```tsx
* <WalletTab /> * <WalletTab />
@ -47,7 +57,8 @@ function WalletStatus({ address, chainId }: WalletStatusProps) {
<> <>
{address && ( {address && (
<div className="text-xs w-full"> <div className="text-xs w-full">
Address: <pre className="inline w-full">{truncateAddress(address)}</pre> Address:{' '}
<pre className="inline w-full">{truncateAddress(address)}</pre>
</div> </div>
)} )}
{chainId && ( {chainId && (
@ -90,13 +101,19 @@ function ConnectionControls({
if (context) { if (context) {
return ( return (
<div className="space-y-2 w-full"> <div className="space-y-2 w-full">
<Button onClick={() => connect({ connector: connectors[0] })} className="w-full"> <Button
onClick={() => connect({ connector: connectors[0] })}
className="w-full"
>
Connect (Auto) Connect (Auto)
</Button> </Button>
<Button <Button
onClick={() => { onClick={() => {
console.log("Manual Farcaster connection attempt"); console.log('Manual Farcaster connection attempt');
console.log("Connectors:", connectors.map((c, i) => `${i}: ${c.name}`)); console.log(
'Connectors:',
connectors.map((c, i) => `${i}: ${c.name}`)
);
connect({ connector: connectors[0] }); connect({ connector: connectors[0] });
}} }}
className="w-full" className="w-full"
@ -108,10 +125,16 @@ function ConnectionControls({
} }
return ( return (
<div className="space-y-3 w-full"> <div className="space-y-3 w-full">
<Button onClick={() => connect({ connector: connectors[1] })} className="w-full"> <Button
onClick={() => connect({ connector: connectors[1] })}
className="w-full"
>
Connect Coinbase Wallet Connect Coinbase Wallet
</Button> </Button>
<Button onClick={() => connect({ connector: connectors[2] })} className="w-full"> <Button
onClick={() => connect({ connector: connectors[2] })}
className="w-full"
>
Connect MetaMask Connect MetaMask
</Button> </Button>
</div> </div>
@ -120,8 +143,10 @@ function ConnectionControls({
export function WalletTab() { export function WalletTab() {
// --- State --- // --- State ---
const [evmContractTransactionHash, setEvmContractTransactionHash] = useState<string | null>(null); const [evmContractTransactionHash, setEvmContractTransactionHash] = useState<
string | null
>(null);
// --- Hooks --- // --- Hooks ---
const { context } = useMiniApp(); const { context } = useMiniApp();
const { address, isConnected } = useAccount(); const { address, isConnected } = useAccount();
@ -137,10 +162,12 @@ export function WalletTab() {
isPending: isEvmTransactionPending, isPending: isEvmTransactionPending,
} = useSendTransaction(); } = useSendTransaction();
const { isLoading: isEvmTransactionConfirming, isSuccess: isEvmTransactionConfirmed } = const {
useWaitForTransactionReceipt({ isLoading: isEvmTransactionConfirming,
hash: evmContractTransactionHash as `0x${string}`, isSuccess: isEvmTransactionConfirmed,
}); } = useWaitForTransactionReceipt({
hash: evmContractTransactionHash as `0x${string}`,
});
const { const {
signTypedData, signTypedData,
@ -162,38 +189,47 @@ export function WalletTab() {
// --- Effects --- // --- Effects ---
/** /**
* Auto-connect when Farcaster context is available. * Auto-connect when Farcaster context is available.
* *
* This effect detects when the app is running in a Farcaster client * This effect detects when the app is running in a Farcaster client
* and automatically attempts to connect using the Farcaster Frame connector. * and automatically attempts to connect using the Farcaster Frame connector.
* It includes comprehensive logging for debugging connection issues. * It includes comprehensive logging for debugging connection issues.
*/ */
useEffect(() => { useEffect(() => {
// Check if we're in a Farcaster client environment // Check if we're in a Farcaster client environment
const isInFarcasterClient = typeof window !== 'undefined' && const isInFarcasterClient =
(window.location.href.includes('warpcast.com') || typeof window !== 'undefined' &&
window.location.href.includes('farcaster') || (window.location.href.includes('warpcast.com') ||
window.ethereum?.isFarcaster || window.location.href.includes('farcaster') ||
context?.client); window.ethereum?.isFarcaster ||
context?.client);
if (context?.user?.fid && !isConnected && connectors.length > 0 && isInFarcasterClient) {
console.log("Attempting auto-connection with Farcaster context..."); if (
console.log("- User FID:", context.user.fid); context?.user?.fid &&
console.log("- Available connectors:", connectors.map((c, i) => `${i}: ${c.name}`)); !isConnected &&
console.log("- Using connector:", connectors[0].name); connectors.length > 0 &&
console.log("- In Farcaster client:", isInFarcasterClient); isInFarcasterClient
) {
console.log('Attempting auto-connection with Farcaster context...');
console.log('- User FID:', context.user.fid);
console.log(
'- Available connectors:',
connectors.map((c, i) => `${i}: ${c.name}`)
);
console.log('- Using connector:', connectors[0].name);
console.log('- In Farcaster client:', isInFarcasterClient);
// Use the first connector (farcasterFrame) for auto-connection // Use the first connector (farcasterFrame) for auto-connection
try { try {
connect({ connector: connectors[0] }); connect({ connector: connectors[0] });
} catch (error) { } catch (error) {
console.error("Auto-connection failed:", error); console.error('Auto-connection failed:', error);
} }
} else { } else {
console.log("Auto-connection conditions not met:"); console.log('Auto-connection conditions not met:');
console.log("- Has context:", !!context?.user?.fid); console.log('- Has context:', !!context?.user?.fid);
console.log("- Is connected:", isConnected); console.log('- Is connected:', isConnected);
console.log("- Has connectors:", connectors.length > 0); console.log('- Has connectors:', connectors.length > 0);
console.log("- In Farcaster client:", isInFarcasterClient); console.log('- In Farcaster client:', isInFarcasterClient);
} }
}, [context?.user?.fid, isConnected, connectors, connect, context?.client]); }, [context?.user?.fid, isConnected, connectors, connect, context?.client]);
@ -227,7 +263,7 @@ export function WalletTab() {
/** /**
* Sends a transaction to call the yoink() function on the Yoink contract. * Sends a transaction to call the yoink() function on the Yoink contract.
* *
* This function sends a transaction to a specific contract address with * This function sends a transaction to a specific contract address with
* the encoded function call data for the yoink() function. * the encoded function call data for the yoink() function.
*/ */
@ -235,11 +271,11 @@ export function WalletTab() {
sendTransaction( sendTransaction(
{ {
// call yoink() on Yoink contract // call yoink() on Yoink contract
to: "0x4bBFD120d9f352A0BEd7a014bd67913a2007a878", to: '0x4bBFD120d9f352A0BEd7a014bd67913a2007a878',
data: "0x9846cd9efc000023c0", data: '0x9846cd9efc000023c0',
}, },
{ {
onSuccess: (hash) => { onSuccess: hash => {
setEvmContractTransactionHash(hash); setEvmContractTransactionHash(hash);
}, },
} }
@ -248,7 +284,7 @@ export function WalletTab() {
/** /**
* Signs typed data using EIP-712 standard. * Signs typed data using EIP-712 standard.
* *
* This function creates a typed data structure with the app name, version, * This function creates a typed data structure with the app name, version,
* and chain ID, then requests the user to sign it. * and chain ID, then requests the user to sign it.
*/ */
@ -256,16 +292,16 @@ export function WalletTab() {
signTypedData({ signTypedData({
domain: { domain: {
name: APP_NAME, name: APP_NAME,
version: "1", version: '1',
chainId, chainId,
}, },
types: { types: {
Message: [{ name: "content", type: "string" }], Message: [{ name: 'content', type: 'string' }],
}, },
message: { message: {
content: `Hello from ${APP_NAME}!`, content: `Hello from ${APP_NAME}!`,
}, },
primaryType: "Message", primaryType: 'Message',
}); });
}, [chainId, signTypedData]); }, [chainId, signTypedData]);
@ -308,12 +344,12 @@ export function WalletTab() {
<div className="text-xs w-full"> <div className="text-xs w-full">
<div>Hash: {truncateAddress(evmContractTransactionHash)}</div> <div>Hash: {truncateAddress(evmContractTransactionHash)}</div>
<div> <div>
Status:{" "} Status:{' '}
{isEvmTransactionConfirming {isEvmTransactionConfirming
? "Confirming..." ? 'Confirming...'
: isEvmTransactionConfirmed : isEvmTransactionConfirmed
? "Confirmed!" ? 'Confirmed!'
: "Pending"} : 'Pending'}
</div> </div>
</div> </div>
)} )}
@ -347,4 +383,4 @@ export function WalletTab() {
)} )}
</div> </div>
); );
} }

View File

@ -1,4 +1,4 @@
export { HomeTab } from './HomeTab'; export { HomeTab } from './HomeTab';
export { ActionsTab } from './ActionsTab'; export { ActionsTab } from './ActionsTab';
export { ContextTab } from './ContextTab'; export { ContextTab } from './ContextTab';
export { WalletTab } from './WalletTab'; export { WalletTab } from './WalletTab';

View File

@ -1,25 +1,29 @@
"use client"; 'use client';
import { useCallback, useMemo } from "react"; import { useCallback, useMemo } from 'react';
import { useAccount, useSendTransaction, useWaitForTransactionReceipt } from "wagmi"; import {
import { base } from "wagmi/chains"; useAccount,
import { Button } from "../Button"; useSendTransaction,
import { truncateAddress } from "../../../lib/truncateAddress"; useWaitForTransactionReceipt,
import { renderError } from "../../../lib/errorUtils"; } from 'wagmi';
import { base } from 'wagmi/chains';
import { Button } from '../Button';
import { truncateAddress } from '../../../lib/truncateAddress';
import { renderError } from '../../../lib/errorUtils';
/** /**
* SendEth component handles sending ETH transactions to protocol guild addresses. * SendEth component handles sending ETH transactions to protocol guild addresses.
* *
* This component provides a simple interface for users to send small amounts * This component provides a simple interface for users to send small amounts
* of ETH to protocol guild addresses. It automatically selects the appropriate * of ETH to protocol guild addresses. It automatically selects the appropriate
* recipient address based on the current chain and displays transaction status. * recipient address based on the current chain and displays transaction status.
* *
* Features: * Features:
* - Chain-specific recipient addresses * - Chain-specific recipient addresses
* - Transaction status tracking * - Transaction status tracking
* - Error handling and display * - Error handling and display
* - Transaction hash display * - Transaction hash display
* *
* @example * @example
* ```tsx * ```tsx
* <SendEth /> * <SendEth />
@ -36,32 +40,34 @@ export function SendEth() {
isPending: isEthTransactionPending, isPending: isEthTransactionPending,
} = useSendTransaction(); } = useSendTransaction();
const { isLoading: isEthTransactionConfirming, isSuccess: isEthTransactionConfirmed } = const {
useWaitForTransactionReceipt({ isLoading: isEthTransactionConfirming,
hash: ethTransactionHash, isSuccess: isEthTransactionConfirmed,
}); } = useWaitForTransactionReceipt({
hash: ethTransactionHash,
});
// --- Computed Values --- // --- Computed Values ---
/** /**
* Determines the recipient address based on the current chain. * Determines the recipient address based on the current chain.
* *
* Uses different protocol guild addresses for different chains: * Uses different protocol guild addresses for different chains:
* - Base: 0x32e3C7fD24e175701A35c224f2238d18439C7dBC * - Base: 0x32e3C7fD24e175701A35c224f2238d18439C7dBC
* - Other chains: 0xB3d8d7887693a9852734b4D25e9C0Bb35Ba8a830 * - Other chains: 0xB3d8d7887693a9852734b4D25e9C0Bb35Ba8a830
* *
* @returns string - The recipient address for the current chain * @returns string - The recipient address for the current chain
*/ */
const protocolGuildRecipientAddress = useMemo(() => { const protocolGuildRecipientAddress = useMemo(() => {
// Protocol guild address // Protocol guild address
return chainId === base.id return chainId === base.id
? "0x32e3C7fD24e175701A35c224f2238d18439C7dBC" ? '0x32e3C7fD24e175701A35c224f2238d18439C7dBC'
: "0xB3d8d7887693a9852734b4D25e9C0Bb35Ba8a830"; : '0xB3d8d7887693a9852734b4D25e9C0Bb35Ba8a830';
}, [chainId]); }, [chainId]);
// --- Handlers --- // --- Handlers ---
/** /**
* Handles sending the ETH transaction. * Handles sending the ETH transaction.
* *
* This function sends a small amount of ETH (1 wei) to the protocol guild * This function sends a small amount of ETH (1 wei) to the protocol guild
* address for the current chain. The transaction is sent using the wagmi * address for the current chain. The transaction is sent using the wagmi
* sendTransaction hook. * sendTransaction hook.
@ -88,15 +94,15 @@ export function SendEth() {
<div className="mt-2 text-xs"> <div className="mt-2 text-xs">
<div>Hash: {truncateAddress(ethTransactionHash)}</div> <div>Hash: {truncateAddress(ethTransactionHash)}</div>
<div> <div>
Status:{" "} Status:{' '}
{isEthTransactionConfirming {isEthTransactionConfirming
? "Confirming..." ? 'Confirming...'
: isEthTransactionConfirmed : isEthTransactionConfirmed
? "Confirmed!" ? 'Confirmed!'
: "Pending"} : 'Pending'}
</div> </div>
</div> </div>
)} )}
</> </>
); );
} }

View File

@ -1,29 +1,32 @@
"use client"; 'use client';
import { useCallback, useState } from "react"; import { useCallback, useState } from 'react';
import { useConnection as useSolanaConnection, useWallet as useSolanaWallet } from '@solana/wallet-adapter-react'; import {
useConnection as useSolanaConnection,
useWallet as useSolanaWallet,
} from '@solana/wallet-adapter-react';
import { PublicKey, SystemProgram, Transaction } from '@solana/web3.js'; import { PublicKey, SystemProgram, Transaction } from '@solana/web3.js';
import { Button } from "../Button"; import { Button } from '../Button';
import { truncateAddress } from "../../../lib/truncateAddress"; import { truncateAddress } from '../../../lib/truncateAddress';
import { renderError } from "../../../lib/errorUtils"; import { renderError } from '../../../lib/errorUtils';
/** /**
* SendSolana component handles sending SOL transactions on Solana. * SendSolana component handles sending SOL transactions on Solana.
* *
* This component provides a simple interface for users to send SOL transactions * This component provides a simple interface for users to send SOL transactions
* using their connected Solana wallet. It includes transaction status tracking * using their connected Solana wallet. It includes transaction status tracking
* and error handling. * and error handling.
* *
* Features: * Features:
* - SOL transaction sending * - SOL transaction sending
* - Transaction status tracking * - Transaction status tracking
* - Error handling and display * - Error handling and display
* - Loading state management * - Loading state management
* *
* Note: This component is a placeholder implementation. In a real application, * Note: This component is a placeholder implementation. In a real application,
* you would integrate with a Solana wallet adapter and transaction library * you would integrate with a Solana wallet adapter and transaction library
* like @solana/web3.js to handle actual transactions. * like @solana/web3.js to handle actual transactions.
* *
* @example * @example
* ```tsx * ```tsx
* <SendSolana /> * <SendSolana />
@ -42,7 +45,8 @@ export function SendSolana() {
// This should be replaced but including it from the original demo // This should be replaced but including it from the original demo
// https://github.com/farcasterxyz/frames-v2-demo/blob/main/src/components/Demo.tsx#L718 // https://github.com/farcasterxyz/frames-v2-demo/blob/main/src/components/Demo.tsx#L718
const ashoatsPhantomSolanaWallet = 'Ao3gLNZAsbrmnusWVqQCPMrcqNi6jdYgu8T6NCoXXQu1'; const ashoatsPhantomSolanaWallet =
'Ao3gLNZAsbrmnusWVqQCPMrcqNi6jdYgu8T6NCoXXQu1';
/** /**
* Handles sending the Solana transaction * Handles sending the Solana transaction
@ -67,12 +71,13 @@ export function SendSolana() {
fromPubkey: new PublicKey(fromPubkeyStr), fromPubkey: new PublicKey(fromPubkeyStr),
toPubkey: new PublicKey(toPubkeyStr), toPubkey: new PublicKey(toPubkeyStr),
lamports: 0n, lamports: 0n,
}), })
); );
transaction.recentBlockhash = blockhash; transaction.recentBlockhash = blockhash;
transaction.feePayer = new PublicKey(fromPubkeyStr); transaction.feePayer = new PublicKey(fromPubkeyStr);
const simulation = await solanaConnection.simulateTransaction(transaction); const simulation =
await solanaConnection.simulateTransaction(transaction);
if (simulation.value.err) { if (simulation.value.err) {
// Gather logs and error details for debugging // Gather logs and error details for debugging
const logs = simulation.value.logs?.join('\n') ?? 'No logs'; const logs = simulation.value.logs?.join('\n') ?? 'No logs';
@ -100,7 +105,8 @@ export function SendSolana() {
> >
Send Transaction (sol) Send Transaction (sol)
</Button> </Button>
{solanaTransactionState.status === 'error' && renderError(solanaTransactionState.error)} {solanaTransactionState.status === 'error' &&
renderError(solanaTransactionState.error)}
{solanaTransactionState.status === 'success' && ( {solanaTransactionState.status === 'success' && (
<div className="mt-2 text-xs"> <div className="mt-2 text-xs">
<div>Hash: {truncateAddress(solanaTransactionState.signature)}</div> <div>Hash: {truncateAddress(solanaTransactionState.signature)}</div>
@ -108,4 +114,4 @@ export function SendSolana() {
)} )}
</> </>
); );
} }

View File

@ -1,26 +1,26 @@
"use client"; 'use client';
import { useCallback } from "react"; import { useCallback } from 'react';
import { useAccount, useConnect, useSignMessage } from "wagmi"; import { useAccount, useConnect, useSignMessage } from 'wagmi';
import { base } from "wagmi/chains"; import { base } from 'wagmi/chains';
import { Button } from "../Button"; import { Button } from '../Button';
import { config } from "../../providers/WagmiProvider"; import { config } from '../../providers/WagmiProvider';
import { APP_NAME } from "../../../lib/constants"; import { APP_NAME } from '../../../lib/constants';
import { renderError } from "../../../lib/errorUtils"; import { renderError } from '../../../lib/errorUtils';
/** /**
* SignEvmMessage component handles signing messages on EVM-compatible chains. * SignEvmMessage component handles signing messages on EVM-compatible chains.
* *
* This component provides a simple interface for users to sign messages using * This component provides a simple interface for users to sign messages using
* their connected EVM wallet. It automatically handles wallet connection if * their connected EVM wallet. It automatically handles wallet connection if
* the user is not already connected, and displays the signature result. * the user is not already connected, and displays the signature result.
* *
* Features: * Features:
* - Automatic wallet connection if needed * - Automatic wallet connection if needed
* - Message signing with app name * - Message signing with app name
* - Error handling and display * - Error handling and display
* - Signature result display * - Signature result display
* *
* @example * @example
* ```tsx * ```tsx
* <SignEvmMessage /> * <SignEvmMessage />
@ -41,12 +41,12 @@ export function SignEvmMessage() {
// --- Handlers --- // --- Handlers ---
/** /**
* Handles the message signing process. * Handles the message signing process.
* *
* This function first ensures the user is connected to an EVM wallet, * This function first ensures the user is connected to an EVM wallet,
* then requests them to sign a message containing the app name. * then requests them to sign a message containing the app name.
* If the user is not connected, it automatically connects using the * If the user is not connected, it automatically connects using the
* Farcaster Frame connector. * Farcaster Frame connector.
* *
* @returns Promise<void> * @returns Promise<void>
*/ */
const signEvmMessage = useCallback(async () => { const signEvmMessage = useCallback(async () => {
@ -78,4 +78,4 @@ export function SignEvmMessage() {
)} )}
</> </>
); );
} }

View File

@ -1,24 +1,24 @@
"use client"; 'use client';
import { useCallback, useState } from "react"; import { useCallback, useState } from 'react';
import { signIn, signOut, getCsrfToken } from "next-auth/react"; import { signIn, signOut, getCsrfToken } from 'next-auth/react';
import sdk, { SignIn as SignInCore } from "@farcaster/frame-sdk"; import sdk, { SignIn as SignInCore } from '@farcaster/frame-sdk';
import { useSession } from "next-auth/react"; import { useSession } from 'next-auth/react';
import { Button } from "../Button"; import { Button } from '../Button';
/** /**
* SignIn component handles Farcaster authentication using Sign-In with Farcaster (SIWF). * SignIn component handles Farcaster authentication using Sign-In with Farcaster (SIWF).
* *
* This component provides a complete authentication flow for Farcaster users: * This component provides a complete authentication flow for Farcaster users:
* - Generates nonces for secure authentication * - Generates nonces for secure authentication
* - Handles the SIWF flow using the Farcaster SDK * - Handles the SIWF flow using the Farcaster SDK
* - Manages NextAuth session state * - Manages NextAuth session state
* - Provides sign-out functionality * - Provides sign-out functionality
* - Displays authentication status and results * - Displays authentication status and results
* *
* The component integrates with both the Farcaster Frame SDK and NextAuth * The component integrates with both the Farcaster Frame SDK and NextAuth
* to provide seamless authentication within mini apps. * to provide seamless authentication within mini apps.
* *
* @example * @example
* ```tsx * ```tsx
* <SignIn /> * <SignIn />
@ -45,69 +45,69 @@ export function SignIn() {
// --- Handlers --- // --- Handlers ---
/** /**
* Generates a nonce for the sign-in process. * Generates a nonce for the sign-in process.
* *
* This function retrieves a CSRF token from NextAuth to use as a nonce * This function retrieves a CSRF token from NextAuth to use as a nonce
* for the SIWF authentication flow. The nonce ensures the authentication * for the SIWF authentication flow. The nonce ensures the authentication
* request is fresh and prevents replay attacks. * request is fresh and prevents replay attacks.
* *
* @returns Promise<string> - The generated nonce token * @returns Promise<string> - The generated nonce token
* @throws Error if unable to generate nonce * @throws Error if unable to generate nonce
*/ */
const getNonce = useCallback(async () => { const getNonce = useCallback(async () => {
const nonce = await getCsrfToken(); const nonce = await getCsrfToken();
if (!nonce) throw new Error("Unable to generate nonce"); if (!nonce) throw new Error('Unable to generate nonce');
return nonce; return nonce;
}, []); }, []);
/** /**
* Handles the sign-in process using Farcaster SDK. * Handles the sign-in process using Farcaster SDK.
* *
* This function orchestrates the complete SIWF flow: * This function orchestrates the complete SIWF flow:
* 1. Generates a nonce for security * 1. Generates a nonce for security
* 2. Calls the Farcaster SDK to initiate sign-in * 2. Calls the Farcaster SDK to initiate sign-in
* 3. Submits the result to NextAuth for session management * 3. Submits the result to NextAuth for session management
* 4. Handles various error conditions including user rejection * 4. Handles various error conditions including user rejection
* *
* @returns Promise<void> * @returns Promise<void>
*/ */
const handleSignIn = useCallback(async () => { const handleSignIn = useCallback(async () => {
try { try {
setAuthState((prev) => ({ ...prev, signingIn: true })); setAuthState(prev => ({ ...prev, signingIn: true }));
setSignInFailure(undefined); setSignInFailure(undefined);
const nonce = await getNonce(); const nonce = await getNonce();
const result = await sdk.actions.signIn({ nonce }); const result = await sdk.actions.signIn({ nonce });
setSignInResult(result); setSignInResult(result);
await signIn("credentials", { await signIn('credentials', {
message: result.message, message: result.message,
signature: result.signature, signature: result.signature,
redirect: false, redirect: false,
}); });
} catch (e) { } catch (e) {
if (e instanceof SignInCore.RejectedByUser) { if (e instanceof SignInCore.RejectedByUser) {
setSignInFailure("Rejected by user"); setSignInFailure('Rejected by user');
return; return;
} }
setSignInFailure("Unknown error"); setSignInFailure('Unknown error');
} finally { } finally {
setAuthState((prev) => ({ ...prev, signingIn: false })); setAuthState(prev => ({ ...prev, signingIn: false }));
} }
}, [getNonce]); }, [getNonce]);
/** /**
* Handles the sign-out process. * Handles the sign-out process.
* *
* This function clears the NextAuth session and resets the local * This function clears the NextAuth session and resets the local
* sign-in result state to complete the sign-out flow. * sign-in result state to complete the sign-out flow.
* *
* @returns Promise<void> * @returns Promise<void>
*/ */
const handleSignOut = useCallback(async () => { const handleSignOut = useCallback(async () => {
try { try {
setAuthState((prev) => ({ ...prev, signingOut: true })); setAuthState(prev => ({ ...prev, signingOut: true }));
await signOut({ redirect: false }); await signOut({ redirect: false });
setSignInResult(undefined); setSignInResult(undefined);
} finally { } finally {
setAuthState((prev) => ({ ...prev, signingOut: false })); setAuthState(prev => ({ ...prev, signingOut: false }));
} }
}, []); }, []);
@ -115,12 +115,12 @@ export function SignIn() {
return ( return (
<> <>
{/* Authentication Buttons */} {/* Authentication Buttons */}
{status !== "authenticated" && ( {status !== 'authenticated' && (
<Button onClick={handleSignIn} disabled={authState.signingIn}> <Button onClick={handleSignIn} disabled={authState.signingIn}>
Sign In with Farcaster Sign In with Farcaster
</Button> </Button>
)} )}
{status === "authenticated" && ( {status === 'authenticated' && (
<Button onClick={handleSignOut} disabled={authState.signingOut}> <Button onClick={handleSignOut} disabled={authState.signingOut}>
Sign out Sign out
</Button> </Button>
@ -155,4 +155,4 @@ export function SignIn() {
)} )}
</> </>
); );
} }

View File

@ -1,8 +1,8 @@
"use client"; 'use client';
import { useCallback, useState } from "react"; import { useCallback, useState } from 'react';
import { Button } from "../Button"; import { Button } from '../Button';
import { renderError } from "../../../lib/errorUtils"; import { renderError } from '../../../lib/errorUtils';
interface SignSolanaMessageProps { interface SignSolanaMessageProps {
signMessage?: (message: Uint8Array) => Promise<Uint8Array>; signMessage?: (message: Uint8Array) => Promise<Uint8Array>;
@ -10,20 +10,20 @@ interface SignSolanaMessageProps {
/** /**
* SignSolanaMessage component handles signing messages on Solana. * SignSolanaMessage component handles signing messages on Solana.
* *
* This component provides a simple interface for users to sign messages using * This component provides a simple interface for users to sign messages using
* their connected Solana wallet. It accepts a signMessage function as a prop * their connected Solana wallet. It accepts a signMessage function as a prop
* and handles the complete signing flow including error handling. * and handles the complete signing flow including error handling.
* *
* Features: * Features:
* - Message signing with Solana wallet * - Message signing with Solana wallet
* - Error handling and display * - Error handling and display
* - Signature result display (base64 encoded) * - Signature result display (base64 encoded)
* - Loading state management * - Loading state management
* *
* @param props - Component props * @param props - Component props
* @param props.signMessage - Function to sign messages with Solana wallet * @param props.signMessage - Function to sign messages with Solana wallet
* *
* @example * @example
* ```tsx * ```tsx
* <SignSolanaMessage signMessage={solanaWallet.signMessage} /> * <SignSolanaMessage signMessage={solanaWallet.signMessage} />
@ -38,11 +38,11 @@ export function SignSolanaMessage({ signMessage }: SignSolanaMessageProps) {
// --- Handlers --- // --- Handlers ---
/** /**
* Handles the Solana message signing process. * Handles the Solana message signing process.
* *
* This function encodes a message as UTF-8 bytes, signs it using the provided * This function encodes a message as UTF-8 bytes, signs it using the provided
* signMessage function, and displays the base64-encoded signature result. * signMessage function, and displays the base64-encoded signature result.
* It includes comprehensive error handling and loading state management. * It includes comprehensive error handling and loading state management.
* *
* @returns Promise<void> * @returns Promise<void>
*/ */
const handleSignMessage = useCallback(async () => { const handleSignMessage = useCallback(async () => {
@ -51,7 +51,7 @@ export function SignSolanaMessage({ signMessage }: SignSolanaMessageProps) {
if (!signMessage) { if (!signMessage) {
throw new Error('no Solana signMessage'); throw new Error('no Solana signMessage');
} }
const input = new TextEncoder().encode("Hello from Solana!"); const input = new TextEncoder().encode('Hello from Solana!');
const signatureBytes = await signMessage(input); const signatureBytes = await signMessage(input);
const signature = btoa(String.fromCharCode(...signatureBytes)); const signature = btoa(String.fromCharCode(...signatureBytes));
setSignature(signature); setSignature(signature);
@ -84,4 +84,4 @@ export function SignSolanaMessage({ signMessage }: SignSolanaMessageProps) {
)} )}
</> </>
); );
} }

View File

@ -2,4 +2,4 @@ export { SignIn } from './SignIn';
export { SignEvmMessage } from './SignEvmMessage'; export { SignEvmMessage } from './SignEvmMessage';
export { SendEth } from './SendEth'; export { SendEth } from './SendEth';
export { SignSolanaMessage } from './SignSolanaMessage'; export { SignSolanaMessage } from './SignSolanaMessage';
export { SendSolana } from './SendSolana'; export { SendSolana } from './SendSolana';

View File

@ -1,4 +1,4 @@
import { useEffect, useState } from "react"; import { useEffect, useState } from 'react';
export interface NeynarUser { export interface NeynarUser {
fid: number; fid: number;
@ -19,20 +19,21 @@ export function useNeynarUser(context?: { user?: { fid?: number } }) {
setLoading(true); setLoading(true);
setError(null); setError(null);
fetch(`/api/users?fids=${context.user.fid}`) fetch(`/api/users?fids=${context.user.fid}`)
.then((response) => { .then(response => {
if (!response.ok) throw new Error(`HTTP error! status: ${response.status}`); if (!response.ok)
throw new Error(`HTTP error! status: ${response.status}`);
return response.json(); return response.json();
}) })
.then((data) => { .then(data => {
if (data.users?.[0]) { if (data.users?.[0]) {
setUser(data.users[0]); setUser(data.users[0]);
} else { } else {
setUser(null); setUser(null);
} }
}) })
.catch((err) => setError(err.message)) .catch(err => setError(err.message))
.finally(() => setLoading(false)); .finally(() => setLoading(false));
}, [context?.user?.fid]); }, [context?.user?.fid]);
return { user, loading, error }; return { user, loading, error };
} }

View File

@ -1,10 +1,10 @@
/** /**
* Application constants and configuration values. * Application constants and configuration values.
* *
* This file contains all the configuration constants used throughout the mini app. * This file contains all the configuration constants used throughout the mini app.
* These values are either sourced from environment variables or hardcoded and provide * These values are either sourced from environment variables or hardcoded and provide
* configuration for the app's appearance, behavior, and integration settings. * configuration for the app's appearance, behavior, and integration settings.
* *
* NOTE: This file is automatically updated by the init script. * NOTE: This file is automatically updated by the init script.
* Manual changes may be overwritten during project initialization. * Manual changes may be overwritten during project initialization.
*/ */
@ -63,7 +63,7 @@ export const APP_SPLASH_URL = `${APP_URL}/splash.png`;
* Background color for the splash screen. * Background color for the splash screen.
* Used as fallback when splash image is loading. * Used as fallback when splash image is loading.
*/ */
export const APP_SPLASH_BACKGROUND_COLOR = "#f7f7f7"; export const APP_SPLASH_BACKGROUND_COLOR = '#f7f7f7';
// --- UI Configuration --- // --- UI Configuration ---
/** /**
@ -75,18 +75,19 @@ export const APP_BUTTON_TEXT = 'Launch NSK';
// --- Integration Configuration --- // --- Integration Configuration ---
/** /**
* Webhook URL for receiving events from Neynar. * Webhook URL for receiving events from Neynar.
* *
* If Neynar API key and client ID are configured, uses the official * If Neynar API key and client ID are configured, uses the official
* Neynar webhook endpoint. Otherwise, falls back to a local webhook * Neynar webhook endpoint. Otherwise, falls back to a local webhook
* endpoint for development and testing. * endpoint for development and testing.
*/ */
export const APP_WEBHOOK_URL = process.env.NEYNAR_API_KEY && process.env.NEYNAR_CLIENT_ID export const APP_WEBHOOK_URL =
process.env.NEYNAR_API_KEY && process.env.NEYNAR_CLIENT_ID
? `https://api.neynar.com/f/app/${process.env.NEYNAR_CLIENT_ID}/event` ? `https://api.neynar.com/f/app/${process.env.NEYNAR_CLIENT_ID}/event`
: `${APP_URL}/api/webhook`; : `${APP_URL}/api/webhook`;
/** /**
* Flag to enable/disable wallet functionality. * Flag to enable/disable wallet functionality.
* *
* When true, wallet-related components and features are rendered. * When true, wallet-related components and features are rendered.
* When false, wallet functionality is completely hidden from the UI. * When false, wallet functionality is completely hidden from the UI.
* Useful for mini apps that don't require wallet integration. * Useful for mini apps that don't require wallet integration.
@ -95,7 +96,7 @@ export const USE_WALLET = true;
/** /**
* Flag to enable/disable analytics tracking. * Flag to enable/disable analytics tracking.
* *
* When true, usage analytics are collected and sent to Neynar. * When true, usage analytics are collected and sent to Neynar.
* When false, analytics collection is disabled. * When false, analytics collection is disabled.
* Useful for privacy-conscious users or development environments. * Useful for privacy-conscious users or development environments.

View File

@ -1,9 +1,9 @@
import { type ReactElement } from "react"; import { type ReactElement } from 'react';
import { BaseError, UserRejectedRequestError } from "viem"; import { BaseError, UserRejectedRequestError } from 'viem';
/** /**
* Renders an error object in a user-friendly format. * Renders an error object in a user-friendly format.
* *
* This utility function takes an error object and renders it as a React element * This utility function takes an error object and renders it as a React element
* with consistent styling. It handles different types of errors including: * with consistent styling. It handles different types of errors including:
* - Error objects with message properties * - Error objects with message properties
@ -11,14 +11,14 @@ import { BaseError, UserRejectedRequestError } from "viem";
* - String errors * - String errors
* - Unknown error types * - Unknown error types
* - User rejection errors (special handling for wallet rejections) * - User rejection errors (special handling for wallet rejections)
* *
* The rendered error is displayed in a gray container with monospace font * The rendered error is displayed in a gray container with monospace font
* for better readability of technical error details. User rejections are * for better readability of technical error details. User rejections are
* displayed with a simpler, more user-friendly message. * displayed with a simpler, more user-friendly message.
* *
* @param error - The error object to render * @param error - The error object to render
* @returns ReactElement - A styled error display component, or null if no error * @returns ReactElement - A styled error display component, or null if no error
* *
* @example * @example
* ```tsx * ```tsx
* {isError && renderError(error)} * {isError && renderError(error)}
@ -27,11 +27,11 @@ import { BaseError, UserRejectedRequestError } from "viem";
export function renderError(error: unknown): ReactElement | null { export function renderError(error: unknown): ReactElement | null {
// Handle null/undefined errors // Handle null/undefined errors
if (!error) return null; if (!error) return null;
// Special handling for user rejections in wallet operations // Special handling for user rejections in wallet operations
if (error instanceof BaseError) { if (error instanceof BaseError) {
const isUserRejection = error.walk( const isUserRejection = error.walk(
(e) => e instanceof UserRejectedRequestError e => e instanceof UserRejectedRequestError
); );
if (isUserRejection) { if (isUserRejection) {
@ -43,10 +43,10 @@ export function renderError(error: unknown): ReactElement | null {
); );
} }
} }
// Extract error message from different error types // Extract error message from different error types
let errorMessage: string; let errorMessage: string;
if (error instanceof Error) { if (error instanceof Error) {
errorMessage = error.message; errorMessage = error.message;
} else if (typeof error === 'object' && error !== null && 'error' in error) { } else if (typeof error === 'object' && error !== null && 'error' in error) {
@ -63,4 +63,4 @@ export function renderError(error: unknown): ReactElement | null {
<div className="whitespace-pre-wrap break-words">{errorMessage}</div> <div className="whitespace-pre-wrap break-words">{errorMessage}</div>
</div> </div>
); );
} }

View File

@ -1,16 +1,18 @@
import { FrameNotificationDetails } from "@farcaster/frame-sdk"; import { FrameNotificationDetails } from '@farcaster/frame-sdk';
import { Redis } from "@upstash/redis"; import { Redis } from '@upstash/redis';
import { APP_NAME } from "./constants"; import { APP_NAME } from './constants';
// In-memory fallback storage // In-memory fallback storage
const localStore = new Map<string, FrameNotificationDetails>(); const localStore = new Map<string, FrameNotificationDetails>();
// Use Redis if KV env vars are present, otherwise use in-memory // Use Redis if KV env vars are present, otherwise use in-memory
const useRedis = process.env.KV_REST_API_URL && process.env.KV_REST_API_TOKEN; const useRedis = process.env.KV_REST_API_URL && process.env.KV_REST_API_TOKEN;
const redis = useRedis ? new Redis({ const redis = useRedis
url: process.env.KV_REST_API_URL!, ? new Redis({
token: process.env.KV_REST_API_TOKEN!, url: process.env.KV_REST_API_URL!,
}) : null; token: process.env.KV_REST_API_TOKEN!,
})
: null;
function getUserNotificationDetailsKey(fid: number): string { function getUserNotificationDetailsKey(fid: number): string {
return `${APP_NAME}:user:${fid}`; return `${APP_NAME}:user:${fid}`;

View File

@ -1,11 +1,15 @@
import { NeynarAPIClient, Configuration, WebhookUserCreated } from '@neynar/nodejs-sdk'; import {
NeynarAPIClient,
Configuration,
WebhookUserCreated,
} from '@neynar/nodejs-sdk';
import { APP_URL } from './constants'; import { APP_URL } from './constants';
let neynarClient: NeynarAPIClient | null = null; let neynarClient: NeynarAPIClient | null = null;
// Example usage: // Example usage:
// const client = getNeynarClient(); // const client = getNeynarClient();
// const user = await client.lookupUserByFid(fid); // const user = await client.lookupUserByFid(fid);
export function getNeynarClient() { export function getNeynarClient() {
if (!neynarClient) { if (!neynarClient) {
const apiKey = process.env.NEYNAR_API_KEY; const apiKey = process.env.NEYNAR_API_KEY;
@ -33,12 +37,12 @@ export async function getNeynarUser(fid: number): Promise<User | null> {
type SendMiniAppNotificationResult = type SendMiniAppNotificationResult =
| { | {
state: "error"; state: 'error';
error: unknown; error: unknown;
} }
| { state: "no_token" } | { state: 'no_token' }
| { state: "rate_limit" } | { state: 'rate_limit' }
| { state: "success" }; | { state: 'success' };
export async function sendNeynarMiniAppNotification({ export async function sendNeynarMiniAppNotification({
fid, fid,
@ -58,19 +62,19 @@ export async function sendNeynarMiniAppNotification({
target_url: APP_URL, target_url: APP_URL,
}; };
const result = await client.publishFrameNotifications({ const result = await client.publishFrameNotifications({
targetFids, targetFids,
notification notification,
}); });
if (result.notification_deliveries.length > 0) { if (result.notification_deliveries.length > 0) {
return { state: "success" }; return { state: 'success' };
} else if (result.notification_deliveries.length === 0) { } else if (result.notification_deliveries.length === 0) {
return { state: "no_token" }; return { state: 'no_token' };
} else { } else {
return { state: "error", error: result || "Unknown error" }; return { state: 'error', error: result || 'Unknown error' };
} }
} catch (error) { } catch (error) {
return { state: "error", error }; return { state: 'error', error };
} }
} }

View File

@ -1,18 +1,18 @@
import { import {
SendNotificationRequest, SendNotificationRequest,
sendNotificationResponseSchema, sendNotificationResponseSchema,
} from "@farcaster/frame-sdk"; } from '@farcaster/frame-sdk';
import { getUserNotificationDetails } from "~/lib/kv"; import { getUserNotificationDetails } from '~/lib/kv';
import { APP_URL } from "./constants"; import { APP_URL } from './constants';
type SendMiniAppNotificationResult = type SendMiniAppNotificationResult =
| { | {
state: "error"; state: 'error';
error: unknown; error: unknown;
} }
| { state: "no_token" } | { state: 'no_token' }
| { state: "rate_limit" } | { state: 'rate_limit' }
| { state: "success" }; | { state: 'success' };
export async function sendMiniAppNotification({ export async function sendMiniAppNotification({
fid, fid,
@ -25,13 +25,13 @@ export async function sendMiniAppNotification({
}): Promise<SendMiniAppNotificationResult> { }): Promise<SendMiniAppNotificationResult> {
const notificationDetails = await getUserNotificationDetails(fid); const notificationDetails = await getUserNotificationDetails(fid);
if (!notificationDetails) { if (!notificationDetails) {
return { state: "no_token" }; return { state: 'no_token' };
} }
const response = await fetch(notificationDetails.url, { const response = await fetch(notificationDetails.url, {
method: "POST", method: 'POST',
headers: { headers: {
"Content-Type": "application/json", 'Content-Type': 'application/json',
}, },
body: JSON.stringify({ body: JSON.stringify({
notificationId: crypto.randomUUID(), notificationId: crypto.randomUUID(),
@ -48,17 +48,17 @@ export async function sendMiniAppNotification({
const responseBody = sendNotificationResponseSchema.safeParse(responseJson); const responseBody = sendNotificationResponseSchema.safeParse(responseJson);
if (responseBody.success === false) { if (responseBody.success === false) {
// Malformed response // Malformed response
return { state: "error", error: responseBody.error.errors }; return { state: 'error', error: responseBody.error.errors };
} }
if (responseBody.data.result.rateLimitedTokens.length) { if (responseBody.data.result.rateLimitedTokens.length) {
// Rate limited // Rate limited
return { state: "rate_limit" }; return { state: 'rate_limit' };
} }
return { state: "success" }; return { state: 'success' };
} else { } else {
// Error response // Error response
return { state: "error", error: responseJson }; return { state: 'error', error: responseJson };
} }
} }

View File

@ -1,4 +1,4 @@
export const truncateAddress = (address: string) => { export const truncateAddress = (address: string) => {
if (!address) return ""; if (!address) return '';
return `${address.slice(0, 14)}...${address.slice(-12)}`; return `${address.slice(0, 14)}...${address.slice(-12)}`;
}; };

View File

@ -1,7 +1,18 @@
import { type ClassValue, clsx } from 'clsx'; import { type ClassValue, clsx } from 'clsx';
import { twMerge } from 'tailwind-merge'; import { twMerge } from 'tailwind-merge';
import { mnemonicToAccount } from 'viem/accounts'; import { mnemonicToAccount } from 'viem/accounts';
import { APP_BUTTON_TEXT, APP_DESCRIPTION, APP_ICON_URL, APP_NAME, APP_OG_IMAGE_URL, APP_PRIMARY_CATEGORY, APP_SPLASH_BACKGROUND_COLOR, APP_TAGS, APP_URL, APP_WEBHOOK_URL } from './constants'; import {
APP_BUTTON_TEXT,
APP_DESCRIPTION,
APP_ICON_URL,
APP_NAME,
APP_OG_IMAGE_URL,
APP_PRIMARY_CATEGORY,
APP_SPLASH_BACKGROUND_COLOR,
APP_TAGS,
APP_URL,
APP_WEBHOOK_URL,
} from './constants';
import { APP_SPLASH_URL } from './constants'; import { APP_SPLASH_URL } from './constants';
interface MiniAppMetadata { interface MiniAppMetadata {
@ -17,7 +28,7 @@ interface MiniAppMetadata {
description?: string; description?: string;
primaryCategory?: string; primaryCategory?: string;
tags?: string[]; tags?: string[];
}; }
interface MiniAppManifest { interface MiniAppManifest {
accountAssociation?: { accountAssociation?: {
@ -35,7 +46,7 @@ export function cn(...inputs: ClassValue[]) {
export function getSecretEnvVars() { export function getSecretEnvVars() {
const seedPhrase = process.env.SEED_PHRASE; const seedPhrase = process.env.SEED_PHRASE;
const fid = process.env.FID; const fid = process.env.FID;
if (!seedPhrase || !fid) { if (!seedPhrase || !fid) {
return null; return null;
} }
@ -45,12 +56,12 @@ export function getSecretEnvVars() {
export function getMiniAppEmbedMetadata(ogImageUrl?: string) { export function getMiniAppEmbedMetadata(ogImageUrl?: string) {
return { return {
version: "next", version: 'next',
imageUrl: ogImageUrl ?? APP_OG_IMAGE_URL, imageUrl: ogImageUrl ?? APP_OG_IMAGE_URL,
button: { button: {
title: APP_BUTTON_TEXT, title: APP_BUTTON_TEXT,
action: { action: {
type: "launch_frame", type: 'launch_frame',
name: APP_NAME, name: APP_NAME,
url: APP_URL, url: APP_URL,
splashImageUrl: APP_SPLASH_URL, splashImageUrl: APP_SPLASH_URL,
@ -72,7 +83,10 @@ export async function getFarcasterMetadata(): Promise<MiniAppManifest> {
console.log('Using pre-signed mini app metadata from environment'); console.log('Using pre-signed mini app metadata from environment');
return metadata; return metadata;
} catch (error) { } catch (error) {
console.warn('Failed to parse MINI_APP_METADATA from environment:', error); console.warn(
'Failed to parse MINI_APP_METADATA from environment:',
error
);
} }
} }
@ -86,7 +100,9 @@ export async function getFarcasterMetadata(): Promise<MiniAppManifest> {
const secretEnvVars = getSecretEnvVars(); const secretEnvVars = getSecretEnvVars();
if (!secretEnvVars) { if (!secretEnvVars) {
console.warn('No seed phrase or FID found in environment variables -- generating unsigned metadata'); console.warn(
'No seed phrase or FID found in environment variables -- generating unsigned metadata'
);
} }
let accountAssociation; let accountAssociation;
@ -100,34 +116,41 @@ export async function getFarcasterMetadata(): Promise<MiniAppManifest> {
type: 'custody', type: 'custody',
key: custodyAddress, key: custodyAddress,
}; };
const encodedHeader = Buffer.from(JSON.stringify(header), 'utf-8').toString('base64'); const encodedHeader = Buffer.from(JSON.stringify(header), 'utf-8').toString(
'base64'
);
const payload = { const payload = {
domain domain,
}; };
const encodedPayload = Buffer.from(JSON.stringify(payload), 'utf-8').toString('base64url'); const encodedPayload = Buffer.from(
JSON.stringify(payload),
'utf-8'
).toString('base64url');
const signature = await account.signMessage({ const signature = await account.signMessage({
message: `${encodedHeader}.${encodedPayload}` message: `${encodedHeader}.${encodedPayload}`,
}); });
const encodedSignature = Buffer.from(signature, 'utf-8').toString('base64url'); const encodedSignature = Buffer.from(signature, 'utf-8').toString(
'base64url'
);
accountAssociation = { accountAssociation = {
header: encodedHeader, header: encodedHeader,
payload: encodedPayload, payload: encodedPayload,
signature: encodedSignature signature: encodedSignature,
}; };
} }
return { return {
accountAssociation, accountAssociation,
frame: { frame: {
version: "1", version: '1',
name: APP_NAME ?? "Neynar Starter Kit", name: APP_NAME ?? 'Neynar Starter Kit',
iconUrl: APP_ICON_URL, iconUrl: APP_ICON_URL,
homeUrl: APP_URL, homeUrl: APP_URL,
imageUrl: APP_OG_IMAGE_URL, imageUrl: APP_OG_IMAGE_URL,
buttonTitle: APP_BUTTON_TEXT ?? "Launch Mini App", buttonTitle: APP_BUTTON_TEXT ?? 'Launch Mini App',
splashImageUrl: APP_SPLASH_URL, splashImageUrl: APP_SPLASH_URL,
splashBackgroundColor: APP_SPLASH_BACKGROUND_COLOR, splashBackgroundColor: APP_SPLASH_BACKGROUND_COLOR,
webhookUrl: APP_WEBHOOK_URL, webhookUrl: APP_WEBHOOK_URL,

View File

@ -1,60 +1,60 @@
import type { Config } from "tailwindcss"; import type { Config } from 'tailwindcss';
/** /**
* Tailwind CSS Configuration * Tailwind CSS Configuration
* *
* This configuration centralizes all theme colors for the mini app. * This configuration centralizes all theme colors for the mini app.
* To change the app's color scheme, simply update the 'primary' color value below. * To change the app's color scheme, simply update the 'primary' color value below.
* *
* Example theme changes: * Example theme changes:
* - Blue theme: primary: "#3182CE" * - Blue theme: primary: "#3182CE"
* - Green theme: primary: "#059669" * - Green theme: primary: "#059669"
* - Red theme: primary: "#DC2626" * - Red theme: primary: "#DC2626"
* - Orange theme: primary: "#EA580C" * - Orange theme: primary: "#EA580C"
*/ */
export default { export default {
darkMode: "media", darkMode: 'media',
content: [ content: [
"./src/pages/**/*.{js,ts,jsx,tsx,mdx}", './src/pages/**/*.{js,ts,jsx,tsx,mdx}',
"./src/components/**/*.{js,ts,jsx,tsx,mdx}", './src/components/**/*.{js,ts,jsx,tsx,mdx}',
"./src/app/**/*.{js,ts,jsx,tsx,mdx}", './src/app/**/*.{js,ts,jsx,tsx,mdx}',
], ],
theme: { theme: {
extend: { extend: {
colors: { colors: {
// Main theme color - change this to update the entire app's color scheme // Main theme color - change this to update the entire app's color scheme
primary: "#8b5cf6", // Main brand color primary: '#8b5cf6', // Main brand color
"primary-light": "#a78bfa", // For hover states 'primary-light': '#a78bfa', // For hover states
"primary-dark": "#7c3aed", // For active states 'primary-dark': '#7c3aed', // For active states
// Secondary colors for backgrounds and text // Secondary colors for backgrounds and text
secondary: "#f8fafc", // Light backgrounds secondary: '#f8fafc', // Light backgrounds
"secondary-dark": "#334155", // Dark backgrounds 'secondary-dark': '#334155', // Dark backgrounds
// Legacy CSS variables for backward compatibility // Legacy CSS variables for backward compatibility
background: 'var(--background)', background: 'var(--background)',
foreground: 'var(--foreground)' foreground: 'var(--foreground)',
}, },
borderRadius: { borderRadius: {
lg: 'var(--radius)', lg: 'var(--radius)',
md: 'calc(var(--radius) - 2px)', md: 'calc(var(--radius) - 2px)',
sm: 'calc(var(--radius) - 4px)' sm: 'calc(var(--radius) - 4px)',
}, },
// Custom spacing for consistent layout // Custom spacing for consistent layout
spacing: { spacing: {
'18': '4.5rem', '18': '4.5rem',
'88': '22rem', '88': '22rem',
}, },
// Custom container sizes // Custom container sizes
maxWidth: { maxWidth: {
'xs': '20rem', xs: '20rem',
'sm': '24rem', sm: '24rem',
'md': '28rem', md: '28rem',
'lg': '32rem', lg: '32rem',
'xl': '36rem', xl: '36rem',
'2xl': '42rem', '2xl': '42rem',
} },
} },
}, },
plugins: [require("tailwindcss-animate")], plugins: [require('tailwindcss-animate')],
} satisfies Config; } satisfies Config;

View File

@ -1,4 +1,4 @@
{ {
"buildCommand": "next build", "buildCommand": "next build",
"framework": "nextjs" "framework": "nextjs"
} }