fix: ask for client id in scripts

This commit is contained in:
lucas-neynar 2025-03-18 10:58:19 -07:00
parent a66e219438
commit 990ffe1448
No known key found for this signature in database
5 changed files with 94 additions and 22 deletions

View File

@ -13,7 +13,7 @@ npx create-neynar-farcaster-frame@latest
To run the project: To run the project:
```{bash} ```{bash}
cd yourProjectName cd <PROJECT_NAME>
npm run dev npm run dev
``` ```

View File

@ -150,10 +150,29 @@ async function init() {
} else { } else {
answers.useNeynar = true; answers.useNeynar = true;
answers.neynarApiKey = neynarKeyAnswer.neynarApiKey; answers.neynarApiKey = neynarKeyAnswer.neynarApiKey;
// Get Neynar client ID if using Neynar
if (answers.useNeynar) {
const neynarClientIdAnswer = await inquirer.prompt([
{
type: 'input',
name: 'neynarClientId',
message: 'Enter your Neynar client ID:',
validate: (input) => {
if (input && !/^[a-zA-Z0-9-]+$/.test(input)) {
return 'Invalid Neynar client ID format';
}
return true;
}
}
]);
answers.neynarClientId = neynarClientIdAnswer.neynarClientId;
}
} }
} else { } else {
answers.useNeynar = false; answers.useNeynar = false;
answers.neynarApiKey = null; answers.neynarApiKey = null;
answers.neynarClientId = null;
} }
// Ask about localhost vs tunnel // Ask about localhost vs tunnel
@ -342,9 +361,11 @@ async function init() {
const custodyAddress = account.address; const custodyAddress = account.address;
// Look up FID using custody address // Look up FID using custody address
if (!fid) {
console.log('\nLooking up FID...'); console.log('\nLooking up FID...');
const neynarApiKey = answers.useNeynar ? answers.neynarApiKey : 'FARCASTER_V2_FRAMES_DEMO'; const neynarApiKey = answers.useNeynar ? answers.neynarApiKey : 'FARCASTER_V2_FRAMES_DEMO';
const fid = await lookupFidByCustodyAddress(custodyAddress, neynarApiKey); fid = await lookupFidByCustodyAddress(custodyAddress, neynarApiKey);
}
// Write seed phrase and FID to .env.local for manifest signature generation // Write seed phrase and FID to .env.local for manifest signature generation
fs.appendFileSync(envPath, `\nSEED_PHRASE="${answers.seedPhrase}"`); fs.appendFileSync(envPath, `\nSEED_PHRASE="${answers.seedPhrase}"`);
@ -364,6 +385,9 @@ async function init() {
fs.appendFileSync(envPath, `\nNEXT_PUBLIC_FRAME_DESCRIPTION="${answers.description}"`); fs.appendFileSync(envPath, `\nNEXT_PUBLIC_FRAME_DESCRIPTION="${answers.description}"`);
fs.appendFileSync(envPath, `\nNEXT_PUBLIC_FRAME_BUTTON_TEXT="${answers.buttonText}"`); fs.appendFileSync(envPath, `\nNEXT_PUBLIC_FRAME_BUTTON_TEXT="${answers.buttonText}"`);
fs.appendFileSync(envPath, `\nNEYNAR_API_KEY="${answers.useNeynar ? answers.neynarApiKey : 'FARCASTER_V2_FRAMES_DEMO'}"`); fs.appendFileSync(envPath, `\nNEYNAR_API_KEY="${answers.useNeynar ? answers.neynarApiKey : 'FARCASTER_V2_FRAMES_DEMO'}"`);
if (answers.neynarClientId) {
fs.appendFileSync(envPath, `\nNEYNAR_CLIENT_ID="${answers.neynarClientId}"`);
}
fs.appendFileSync(envPath, `\nUSE_TUNNEL="${answers.useTunnel}"`); fs.appendFileSync(envPath, `\nUSE_TUNNEL="${answers.useTunnel}"`);
fs.unlinkSync(envExamplePath); fs.unlinkSync(envExamplePath);

View File

@ -1,6 +1,6 @@
{ {
"name": "create-neynar-farcaster-frame", "name": "create-neynar-farcaster-frame",
"version": "1.0.11", "version": "1.0.12",
"type": "module", "type": "module",
"files": [ "files": [
"bin/index.js" "bin/index.js"

View File

@ -10,9 +10,7 @@ import dotenv from 'dotenv';
dotenv.config({ path: '.env.local' }); dotenv.config({ path: '.env.local' });
dotenv.config({ path: '.env', override: true }); dotenv.config({ path: '.env', override: true });
// TODO: validate this file // TODO: make sure rebuilding is supported
// TODO: add other stuff to .env necessary for prod deployment
// TODO: update app to use saved manifest from .env if not running in dev mode
const __dirname = path.dirname(fileURLToPath(import.meta.url)); const __dirname = path.dirname(fileURLToPath(import.meta.url));
const projectRoot = path.join(__dirname, '..'); const projectRoot = path.join(__dirname, '..');
@ -40,7 +38,7 @@ async function validateSeedPhrase(seedPhrase) {
} }
} }
async function generateFarcasterMetadata(domain, accountAddress, seedPhrase) { async function generateFarcasterMetadata(domain, accountAddress, seedPhrase, webhookUrl) {
const header = { const header = {
type: 'custody', type: 'custody',
key: accountAddress, key: accountAddress,
@ -66,14 +64,14 @@ async function generateFarcasterMetadata(domain, accountAddress, seedPhrase) {
}, },
frame: { frame: {
version: "1", version: "1",
name: process.env.NEXT_PUBLIC_FRAME_NAME || "Frames v2 Demo", name: process.env.NEXT_PUBLIC_FRAME_NAME,
iconUrl: `${domain}/icon.png`, iconUrl: `${domain}/icon.png`,
homeUrl: domain, homeUrl: domain,
imageUrl: `${domain}/opengraph-image`, imageUrl: `${domain}/opengraph-image`,
buttonTitle: process.env.NEXT_PUBLIC_FRAME_BUTTON_TEXT || "Launch Frame", buttonTitle: process.env.NEXT_PUBLIC_FRAME_BUTTON_TEXT,
splashImageUrl: `${domain}/splash.png`, splashImageUrl: `${domain}/splash.png`,
splashBackgroundColor: "#f7f7f7", splashBackgroundColor: "#f7f7f7",
webhookUrl: `${domain}/api/webhook`, webhookUrl,
}, },
}; };
} }
@ -118,7 +116,7 @@ async function main() {
{ {
type: 'input', type: 'input',
name: 'buttonText', name: 'buttonText',
message: 'Enter the text for your frame button (e.g., Launch Frame):', message: 'Enter the text for your frame button:',
default: process.env.NEXT_PUBLIC_FRAME_BUTTON_TEXT || 'Launch Frame', default: process.env.NEXT_PUBLIC_FRAME_BUTTON_TEXT || 'Launch Frame',
validate: (input) => { validate: (input) => {
if (input.trim() === '') { if (input.trim() === '') {
@ -129,6 +127,50 @@ async function main() {
} }
]); ]);
// Get Neynar API key from user if not already in .env.local
let neynarApiKey = process.env.NEYNAR_API_KEY;
let neynarClientId = null;
if (!neynarApiKey) {
const { neynarApiKey: inputNeynarApiKey } = await inquirer.prompt([
{
type: 'password',
name: 'neynarApiKey',
message: 'Enter your Neynar API key (optional - leave blank to skip):',
default: null
}
]);
neynarApiKey = inputNeynarApiKey;
} else {
console.log('Using existing Neynar API key from .env')
}
// Only ask for client ID if we have an API key
if (neynarApiKey) {
neynarClientId = process.env.NEYNAR_CLIENT_ID;
if (!neynarClientId) {
const { neynarClientId: inputNeynarClientId } = await inquirer.prompt([
{
type: 'input',
name: 'neynarClientId',
message: 'Enter your Neynar client ID (required for Neynar webhook):',
validate: (input) => {
if (!input) {
return 'Client ID is required when using Neynar API key';
}
if (!/^[a-zA-Z0-9-]+$/.test(input)) {
return 'Invalid Neynar client ID format';
}
return true;
}
}
]);
neynarClientId = inputNeynarClientId;
} else {
console.log('Using existing Neynar client ID from .env');
}
}
// Get seed phrase from user if not already in .env.local // Get seed phrase from user if not already in .env.local
let seedPhrase = process.env.SEED_PHRASE; let seedPhrase = process.env.SEED_PHRASE;
if (!seedPhrase) { if (!seedPhrase) {
@ -149,7 +191,7 @@ async function main() {
]); ]);
seedPhrase = inputSeedPhrase; seedPhrase = inputSeedPhrase;
} else { } else {
console.log('Using existing seed phrase from .env.local'); console.log('Using existing seed phrase from .env');
} }
// Validate seed phrase and get account address // Validate seed phrase and get account address
@ -158,7 +200,13 @@ async function main() {
// Generate and sign manifest // Generate and sign manifest
console.log('\n🔨 Generating frame manifest...'); console.log('\n🔨 Generating frame manifest...');
const metadata = await generateFarcasterMetadata(domain, accountAddress, seedPhrase);
// 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, accountAddress, seedPhrase, webhookUrl);
console.log('\n✅ Frame manifest generated' + (seedPhrase ? ' and signed' : '')); console.log('\n✅ Frame manifest generated' + (seedPhrase ? ' and signed' : ''));
// Read existing .env file or create new one // Read existing .env file or create new one
@ -184,8 +232,8 @@ async function main() {
// 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}"`] : []),
...(process.env.NEYNAR_CLIENT_ID ? ...(neynarClientId ?
[`NEYNAR_CLIENT_ID="${process.env.NEYNAR_CLIENT_ID}"`] : []), [`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}"`] : []),

View File

@ -41,7 +41,7 @@ export async function sendNeynarFrameNotification({
const notification = { const notification = {
title, title,
body, body,
target_url: process.env.NEXT_PUBLIC_URL, target_url: process.env.NEXT_PUBLIC_URL!,
}; };
const result = await client.publishFrameNotifications({ const result = await client.publishFrameNotifications({
@ -49,12 +49,12 @@ export async function sendNeynarFrameNotification({
notification notification
}); });
if (result.success) { if (result.notification_deliveries.length > 0) {
return { state: "success" }; return { state: "success" };
} else if (result.status === 429) { } else if (result.notification_deliveries.length === 0) {
return { state: "rate_limit" }; return { state: "no_token" };
} else { } else {
return { state: "error", error: result.error || "Unknown error" }; return { state: "error", error: result || "Unknown error" };
} }
} catch (error) { } catch (error) {
return { state: "error", error }; return { state: "error", error };