Comparing debridge with farcaster
debridge
View full →Author
@0xinit
Stars
53
Repository
0xinit/cryptoskills
deBridge Solana SDK Development Guide
A comprehensive guide for building Solana programs with the deBridge Solana SDK - enabling decentralized cross-chain transfers of arbitrary messages and value between blockchains.
Overview
deBridge is a cross-chain infrastructure protocol enabling:
- Cross-Chain Transfers: Bridge assets between Solana and 20+ EVM chains
- Message Passing: Send arbitrary messages across blockchains
- External Calls: Execute smart contract calls on destination chains
- Sub-Second Settlement: ~2 second median settlement time
- Capital Efficiency: Intent-based architecture with 4bps lowest spreads
Key Features
- 26+ security audits (Halborn, Zokyo, Ackee Blockchain)
- $200K bug bounty on Immunefi
- 100% uptime since launch
- Zero security incidents
Quick Start
Installation
Add the SDK to your Anchor/Solana program:
cargo add --git ssh://git@github.com/debridge-finance/debridge-solana-sdk.git debridge-solana-sdk
Or add to Cargo.toml:
[dependencies]
debridge-solana-sdk = { git = "ssh://git@github.com/debridge-finance/debridge-solana-sdk.git" }
Basic Setup (Anchor)
use anchor_lang::prelude::*;
use debridge_solana_sdk::prelude::*;
declare_id!("YourProgramId11111111111111111111111111111");
#[program]
pub mod my_bridge_program {
use super::*;
pub fn send_cross_chain(
ctx: Context<SendCrossChain>,
target_chain_id: [u8; 32],
receiver: Vec<u8>,
amount: u64,
) -> Result<()> {
// Invoke deBridge send
debridge_sending::invoke_debridge_send(
debridge_sending::SendIx {
target_chain_id,
receiver,
is_use_asset_fee: false, // Use native SOL for fees
amount,
submission_params: None,
referral_code: None,
},
ctx.remaining_accounts,
)?;
Ok(())
}
}
#[derive(Accounts)]
pub struct SendCrossChain<'info> {
#[account(mut)]
pub sender: Signer<'info>,
// Additional accounts passed via remaining_accounts
}
Core Concepts
1. Chain IDs
deBridge uses 32-byte chain identifiers for all supported networks:
use debridge_solana_sdk::chain_ids::*;
// Solana
let solana = SOLANA_CHAIN_ID; // Solana mainnet
// EVM Chains
let ethereum = ETHEREUM_CHAIN_ID; // Chain ID: 1
let polygon = POLYGON_CHAIN_ID; // Chain ID: 137
let bnb = BNB_CHAIN_CHAIN_ID; // Chain ID: 56
let arbitrum = ARBITRUM_CHAIN_ID; // Chain ID: 42161
let avalanche = AVALANCHE_CHAIN_ID; // Chain ID: 43114
let fantom = FANTOM_CHAIN_ID; // Chain ID: 250
let heco = HECO_CHAIN_ID; // Chain ID: 128
2. Program IDs
use debridge_solana_sdk::{DEBRIDGE_ID, SETTINGS_ID};
// Main deBridge program for sending/claiming
let debridge_program = DEBRIDGE_ID;
// Settings and confirmation storage program
let settings_program = SETTINGS_ID;
3. Fee Structure
deBridge supports multiple fee payment methods:
// Native Fee (SOL)
is_use_asset_fee: false // Pay fees in SOL
// Asset Fee
is_use_asset_fee: true // Pay fees in the bridged token
// Fee Constants
const BPS_DENOMINATOR: u64 = 10000; // Basis points divisor
4. Flags
Control transfer behavior with flags:
use debridge_solana_sdk::flags::*;
// Available flags (bit positions)
const UNWRAP_ETH: u8 = 0; // Unwrap to native ETH on destination
const REVERT_IF_EXTERNAL_FAIL: u8 = 1; // Revert if external call fails
const PROXY_WITH_SENDER: u8 = 2; // Include sender in proxy call
const SEND_HASHED_DATA: u8 = 3; // Send data as hash
const DIRECT_WALLET_FLOW: u8 = 31; // Use direct wallet flow
// Setting flags on submission params
let mut flags = [0u8; 32];
flags.set_reserved_flag(UNWRAP_ETH);
flags.set_reserved_flag(REVERT_IF_EXTERNAL_FAIL);
Sending Cross-Chain Transfers
Basic Token Transfer
use debridge_solana_sdk::prelude::*;
pub fn send_tokens(
ctx: Context<SendTokens>,
amount: u64,
) -> Result<()> {
debridge_sending::invoke_debridge_send(
debridge_sending::SendIx {
target_chain_id: chain_ids::ETHEREUM_CHAIN_ID,
receiver: recipient_eth_address.to_vec(),
is_use_asset_fee: false,
amount,
submission_params: None,
referral_code: Some(12345), // Optional referral
},
ctx.remaining_accounts,
)?;
Ok(())
}
Transfer with Fixed Native Fee
pub fn send_with_native_fee(
ctx: Context<Send>,
target_chain_id: [u8; 32],
receiver: Vec<u8>,
amount: u64,
) -> Result<()> {
// Get the fixed fee for the target chain
let fee = debridge_sending::get_chain_native_fix_fee(
&target_chain_id,
ctx.remaining_accounts,
)?;
debridge_sending::invoke_debridge_send(
debridge_sending::SendIx {
target_chain_id,
receiver,
is_use_asset_fee: false,
amount,
submission_params: None,
referral_code: None,
},
ctx.remaining_accounts,
)?;
Ok(())
}
Transfer with Asset Fee
pub fn send_with_asset_fee(
ctx: Context<Send>,
target_chain_id: [u8; 32],
receiver: Vec<u8>,
amount: u64,
) -> Result<()> {
// Check if asset fee is available for this chain
let is_available = debridge_sending::is_asset_fee_available(
&target_chain_id,
ctx.remaining_accounts,
)?;
if !is_available {
return Err(error!(ErrorCode::AssetFeeNotAvailable));
}
debridge_sending::invoke_debridge_send(
debridge_sending::SendIx {
target_chain_id,
receiver,
is_use_asset_fee: true, // Use asset for fees
amount,
submission_params: None,
referral_code: None,
},
ctx.remaining_accounts,
)?;
Ok(())
}
Transfer with Exact Amount
pub fn send_exact_amount(
ctx: Context<Send>,
target_chain_id: [u8; 32],
receiver: Vec<u8>,
exact_receive_amount: u64,
) -> Result<()> {
// Calculate total amount including fees
let total_with_fees = debridge_sending::add_all_fees(
exact_receive_amount,
&target_chain_id,
ctx.remaining_accounts,
)?;
debridge_sending::invoke_debridge_send(
debridge_sending::SendIx {
target_chain_id,
receiver,
is_use_asset_fee: true,
amount: total_with_fees,
submission_params: None,
referral_code: None,
},
ctx.remaining_accounts,
)?;
Ok(())
}
Transfer from PDA (Signed)
pub fn send_from_pda(
ctx: Context<SendFromPda>,
target_chain_id: [u8; 32],
receiver: Vec<u8>,
amount: u64,
pda_seeds: Vec<Vec<u8>>,
) -> Result<()> {
// Use signed variant for PDA-owned tokens
debridge_sending::invoke_debridge_send_signed(
debridge_sending::SendIx {
target_chain_id,
receiver,
is_use_asset_fee: false,
amount,
submission_params: None,
referral_code: None,
},
ctx.remaining_accounts,
&pda_seeds,
)?;
Ok(())
}
Message Passing
Send messages without token transfers:
use debridge_solana_sdk::prelude::*;
pub fn send_message(
ctx: Context<SendMessage>,
target_chain_id: [u8; 32],
receiver: Vec<u8>,
message_data: Vec<u8>,
) -> Result<()> {
// Create submission params with message
let submission_params = debridge_sending::SendSubmissionParamsInput {
execution_fee: 0,
flags: [0u8; 32],
fallback_address: receiver.clone(),
external_call_shortcut: compute_keccak256(&message_data),
};
// Send message (zero amount)
debridge_sending::invoke_send_message(
debridge_sending::SendIx {
target_chain_id,
receiver,
is_use_asset_fee: false,
amount: 0, // No token transfer
submission_params: Some(submission_params),
referral_code: None,
},
ctx.remaining_accounts,
)?;
Ok(())
}
External Calls
Execute smart contract calls on destination chains:
Initialize External Call Buffer
pub fn init_external_call(
ctx: Context<InitExternalCall>,
target_chain_id: [u8; 32],
external_call_data: Vec<u8>,
) -> Result<()> {
let shortcut = compute_keccak256(&external_call_data);
debridge_sending::invoke_init_external_call(
debridge_sending::InitExternalCallIx {
external_call_len: external_call_data.len() as u32,
chain_id: target_chain_id,
external_call_shortcut: shortcut,
external_call: external_call_data,
},
ctx.remaining_accounts,
)?;
Ok(())
}
Send with External Call
pub fn send_with_external_call(
ctx: Context<SendWithExternalCall>,
target_chain_id: [u8; 32],
receiver: Vec<u8>, // Target contract address
amount: u64,
external_call_data: Vec<u8>,
execution_fee: u64, // Fee for executor on destination
) -> Result<()> {
let shortcut = compute_keccak256(&external_call_data);
// Set flags for external call behavior
let mut flags = [0u8; 32];
flags.set_reserved_flag(flags::REVERT_IF_EXTERNAL_FAIL);
let submission_params = debridge_sending::SendSubmissionParamsInput {
execution_fee,
flags,
fallback_address: ctx.accounts.fallback.key().to_bytes().to_vec(),
external_call_shortcut: shortcut,
};
debridge_sending::invoke_debridge_send(
debridge_sending::SendIx {
target_chain_id,
receiver,
is_use_asset_fee: false,
amount,
submission_params: Some(submission_params),
referral_code: None,
},
ctx.remaining_accounts,
)?;
Ok(())
}
Claim Verification
Verify claims on the receiving side:
Validate Incoming Claims
use debridge_solana_sdk::check_claiming::*;
pub fn receive_tokens(ctx: Context<ReceiveTokens>) -> Result<()> {
// Get and validate the parent claim instruction
let claim_ix = ValidatedExecuteExtCallIx::try_from_current_ix()?;
// Validate submission details
let validation = SubmissionAccountValidation {
receiver_validation: Some(ctx.accounts.receiver.key()),
token_mint_validation: Some(ctx.accounts.token_mint.key()),
source_chain_id_validation: Some(chain_ids::ETHEREUM_CHAIN_ID),
..Default::default()
};
claim_ix.validate_submission_account(
&ctx.accounts.submission_account,
&validation,
)?;
// Proceed with claim logic
Ok(())
}
Get Submission Key
pub fn get_claim_info(ctx: Context<ClaimInfo>) -> Result<Pubkey> {
let claim_ix = ValidatedExecuteExtCallIx::try_from_current_ix()?;
let submission_key = claim_ix.get_submission_key()?;
Ok(submission_key)
}
Fee Queries
Get Transfer Fees
// Get base transfer fee (in BPS)
let transfer_fee = debridge_sending::get_transfer_fee(
ctx.remaining_accounts,
)?;
// Get transfer fee for specific chain
let chain_fee = debridge_sending::get_transfer_fee_for_chain(
&target_chain_id,
ctx.remaining_accounts,
)?;
// Get default native fix fee
let default_fee = debridge_sending::get_default_native_fix_fee(
ctx.remaining_accounts,
)?;
// Get chain-specific native fix fee
let native_fee = debridge_sending::get_chain_native_fix_fee(
&target_chain_id,
ctx.remaining_accounts,
)?;
// Get asset fix fee for chain
let asset_fee = debridge_sending::try_get_chain_asset_fix_fee(
&target_chain_id,
ctx.remaining_accounts,
)?;
Calculate Total Amount with Fees
// Add transfer fee to amount
let with_transfer_fee = debridge_sending::add_transfer_fee(
amount,
ctx.remaining_accounts,
)?;
// Add all fees (transfer + execution + asset fees)
let total_amount = debridge_sending::add_all_fees(
amount,
&target_chain_id,
ctx.remaining_accounts,
)?;
Chain Support Queries
// Check if chain is supported
let is_supported = debridge_sending::is_chain_supported(
&target_chain_id,
ctx.remaining_accounts,
)?;
// Get chain support info
let chain_info = debridge_sending::get_chain_support_info(
&target_chain_id,
ctx.remaining_accounts,
)?;
// Check if asset fee is available
let asset_fee_available = debridge_sending::is_asset_fee_available(
&target_chain_id,
ctx.remaining_accounts,
)?;
PDA Derivation
Bridge Account
use debridge_solana_sdk::keys::*;
// Find bridge PDA for a token mint
let (bridge_address, bump) = BridgePubkey::find_bridge_address(&token_mint);
// Create with known bump
let bridge_address = BridgePubkey::create_bridge_address(&token_mint, bump)?;
Chain Support Info
// Find chain support info PDA
let (chain_support_info, bump) = ChainSupportInfoPubkey::find_chain_support_info_address(
&target_chain_id,
);
Asset Fee Info
// Find asset fee info PDA
let (asset_fee_info, bump) = AssetFeeInfoPubkey::find_asset_fee_info_address(
&bridge_pubkey,
&target_chain_id,
);
// Get default bridge fee address
let default_fee = AssetFeeInfoPubkey::default_bridge_fee_address();
External Call Storage
// Find external call storage PDA
let (storage, bump) = ExternalCallStoragePubkey::find_external_call_storage_address(
&shortcut,
&owner,
);
// Find external call meta PDA
let (meta, bump) = ExternalCallMetaPubkey::find_external_call_meta_address(
&storage_account,
);
Required Accounts
The SDK requires specific accounts passed via remaining_accounts. The account order is important:
| Index | Account | Signer | Writable | Description |
|---|---|---|---|---|
| 0 | Bridge | No | Yes | Bridge account for token |
| 1 | Token Mint | No | No | SPL Token mint |
| 2 | Staking Wallet | No | Yes | Staking rewards wallet |
| 3 | Mint Authority | No | No | Token mint authority |
| 4 | Chain Support Info | No | No | Target chain config |
| 5 | Settings Program | No | No | deBridge settings |
| 6 | SPL Token Program | No | No | Token program |
| 7 | State | No | No | Protocol state |
| 8 | deBridge Program | No | No | Main deBridge program |
| ... | Additional accounts | - | - | Varies by operation |
TypeScript Client Integration
Setup
import { Connection, Keypair, PublicKey, Transaction } from '@solana/web3.js';
import { Program, AnchorProvider, Wallet } from '@coral-xyz/anchor';
const connection = new Connection('https://api.mainnet-beta.solana.com');
const wallet = new Wallet(keypair);
const provider = new AnchorProvider(connection, wallet, {});
// deBridge Program IDs
const DEBRIDGE_PROGRAM_ID = new PublicKey('DEbrdGj3HsRsAzx6uH4MKyREKxVAfBydijLUF3ygsFfh');
const SETTINGS_PROGRAM_ID = new PublicKey('DeSetTwWhjZq6Pz9Kfdo1KoS5NqtsM6G8ERbX4SSCSft');
Build Send Transaction
import {
TOKEN_PROGRAM_ID,
getAssociatedTokenAddress
} from '@solana/spl-token';
async function buildSendTransaction(
tokenMint: PublicKey,
amount: bigint,
targetChainId: Uint8Array,
receiver: Uint8Array,
): Promise<Transaction> {
// Derive required PDAs
const [bridge] = PublicKey.findProgramAddressSync(
[Buffer.from('BRIDGE'), tokenMint.toBuffer()],
DEBRIDGE_PROGRAM_ID
);
const [chainSupportInfo] = PublicKey.findProgramAddressSync(
[Buffer.from('CHAIN_SUPPORT_INFO'), targetChainId],
SETTINGS_PROGRAM_ID
);
const [state] = PublicKey.findProgramAddressSync(
[Buffer.from('STATE')],
DEBRIDGE_PROGRAM_ID
);
// Build instruction with remaining accounts
const instruction = await program.methods
.sendViaDebridge(
Array.from(targetChainId),
Array.from(receiver),
new BN(amount.toString()),
)
.remainingAccounts([
{ pubkey: bridge, isSigner: false, isWritable: true },
{ pubkey: tokenMint, isSigner: false, isWritable: false },
// ... additional required accounts
])
.instruction();
return new Transaction().add(instruction);
}
Build External Call Data
import { ethers } from 'ethers';
import { keccak256 } from '@ethersproject/keccak256';
function buildExternalCallData(
targetContract: string,
functionSig: string,
params: any[]
): { data: Uint8Array; shortcut: Uint8Array } {
const iface = new ethers.Interface([functionSig]);
const calldata = iface.encodeFunctionData(
functionSig.split('(')[0].replace('function ', ''),
params
);
const data = ethers.getBytes(calldata);
const shortcut = ethers.getBytes(keccak256(data));
return { data, shortcut };
}
// Example: ERC20 approve call
const { data, shortcut } = buildExternalCallData(
'0xTargetContract...',
'function approve(address spender, uint256 amount)',
['0xSpenderAddress...', ethers.parseEther('1000')]
);
Testing
Anchor Test Setup
# Anchor.toml
[provider]
cluster = "mainnet" # Use mainnet for testing with real deBridge
[programs.mainnet]
my_program = "YourProgramId..."
Run Tests
# Full build and test
cd example_program && anchor build && anchor test
# Test only (skip rebuild)
anchor test --skip-build --skip-deploy
Local Testing Tips
- Use Mainnet Fork: deBridge infrastructure is on mainnet
- Mock Remaining Accounts: Create mock accounts for unit tests
- Test Fee Calculations: Verify fee amounts before sending
Build Features
The SDK supports different environments via Cargo features:
# Production (default) - uses hardcoded program IDs
debridge-solana-sdk = { git = "..." }
# Custom environment - uses env vars
debridge-solana-sdk = { git = "...", features = ["env"] }
Environment variables for custom networks:
DEBRIDGE_PROGRAM_PUBKEY: Custom deBridge program IDDEBRIDGE_SETTINGS_PROGRAM_PUBKEY: Custom settings program ID
Resources
Skill Structure
debridge/
├── SKILL.md # This file
├── resources/
│ ├── sdk-api-reference.md # Complete SDK API reference
│ ├── chain-ids.md # Supported chain identifiers
│ ├── program-ids.md # Program IDs and PDAs
│ └── error-codes.md # Error types and handling
├── examples/
│ ├── basic-transfer/ # Simple cross-chain transfer
│ ├── external-calls/ # External call execution
│ ├── message-passing/ # Message-only transfers
│ └── fee-configurations/ # Fee payment options
└── docs/
└── troubleshooting.md # Common issues and solutions
farcaster
View full →Author
@0xinit
Stars
53
Repository
0xinit/cryptoskills
Farcaster
Farcaster is a sufficiently decentralized social protocol. Users register onchain identities (FIDs) on OP Mainnet and publish social data (casts, reactions, links) as offchain messages to Snapchain, a purpose-built message ordering layer. Neynar provides the primary API infrastructure and, since January 2026, owns the Farcaster protocol itself. Frames v2 (Mini Apps) enable full-screen interactive web applications embedded inside Farcaster clients like Warpcast.
What You Probably Got Wrong
-
Manifest
accountAssociationdomain MUST exactly match the FQDN where/.well-known/farcaster.jsonis hosted. A mismatch causes silent failure -- the Mini App will not load, no error is surfaced to the developer, and Warpcast simply shows nothing. The domain in the signature payload must be byte-identical to the hosting domain (no trailing slash, no protocol prefix, no port unless non-standard). -
Neynar webhooks MUST be verified via HMAC-SHA512 at write time. Check the
X-Neynar-Signatureheader against the raw request body. Never parse JSON before verification -- you must verify the raw bytes.
import crypto from "node:crypto";
import type { IncomingHttpHeaders } from "node:http";
function verifyNeynarWebhook(
rawBody: Buffer,
headers: IncomingHttpHeaders,
webhookSecret: string
): boolean {
const signature = headers["x-neynar-signature"];
if (typeof signature !== "string") return false;
const hmac = crypto.createHmac("sha512", webhookSecret);
hmac.update(rawBody);
const computedSignature = hmac.digest("hex");
return crypto.timingSafeEqual(
Buffer.from(signature, "hex"),
Buffer.from(computedSignature, "hex")
);
}
-
Farcaster is NOT a blockchain. It is a social protocol with an onchain registry (OP Mainnet) for identity and key management, plus an offchain message layer (Snapchain) for social data. Casts, reactions, and follows are never posted to any blockchain.
-
FIDs are onchain but casts are NOT. Farcaster IDs (FIDs) live in the IdRegistry contract on OP Mainnet. Casts, reactions, and link messages are stored on Snapchain and are not onchain data.
-
Frames v2 is NOT Frames v1 -- completely different spec. Frames v1 used static OG images with action buttons and server-side rendering. Frames v2 (Mini Apps) are full-screen interactive web applications loaded in an iframe with SDK access to wallet, user context, and notifications. Do not mix the two APIs.
-
Neynar is NOT just an API provider. Neynar acquired Farcaster from Merkle Manufactory in January 2026. Neynar now owns and operates the protocol, the Snapchain infrastructure, and the primary API layer.
-
Frame images must be static. Frame preview images (OG images shown in feed) cannot contain JavaScript. They are rendered as static images by the client. Interactive behavior only works inside the launched Mini App.
-
@farcaster/frame-sdkand@farcaster/miniapp-sdkare converging. Both packages exist butframe-sdkis the current stable package for Frames v2. Check import paths -- functionality overlaps but the packages are not yet unified. -
Farcaster timestamps use a custom epoch. Timestamps are seconds since January 1, 2021 00:00:00 UTC (Farcaster epoch), not Unix epoch. To convert:
unixTimestamp = farcasterTimestamp + 1609459200. -
Cast text has a 1024 BYTE limit, not characters. UTF-8 multibyte characters (emoji, CJK, accented characters) consume 2-4 bytes each. A 1024-character cast with emoji will exceed the limit.
-
Warpcast aggressively caches OG/frame images. Changing content at the same URL will not update the preview in Warpcast feeds. Use cache-busting query parameters or new URLs when updating frame images.
Critical Context
Neynar acquired Farcaster from Merkle Manufactory in January 2026. This means:
- Neynar operates the protocol, Snapchain validators, and the Hub network
- The Neynar API is the canonical way to interact with Farcaster
- Warpcast remains the primary client, now under Neynar's umbrella
- The open-source protocol spec and hub software remain MIT-licensed
- Third-party hubs can still run, but Neynar controls the reference implementation
Protocol Architecture
Snapchain
Snapchain replaced the Hub network in April 2025 as Farcaster's offchain message ordering layer.
| Property | Detail |
|---|---|
| Consensus | Malachite BFT (Tendermint-derived) |
| Throughput | 10,000+ messages per second |
| Sharding | Account-level -- each FID's messages are ordered independently |
| Finality | Sub-second for message acceptance |
| Data model | Append-only log of signed messages per FID |
| Validator set | Operated by Neynar (post-acquisition) |
Messages on Snapchain are CRDTs (Conflict-free Replicated Data Types). Each message type has merge rules that ensure consistency across nodes without coordination:
- CastAdd conflicts with a later CastRemove for the same hash -- remove wins
- ReactionAdd conflicts with ReactionRemove for the same target -- last-write-wins by timestamp
- LinkAdd conflicts with LinkRemove -- last-write-wins by timestamp
Message Structure
Every Farcaster message is an Ed25519-signed protobuf:
MessageData {
type: MessageType // CAST_ADD, REACTION_ADD, LINK_ADD, etc.
fid: uint64 // Farcaster ID of the author
timestamp: uint32 // Farcaster epoch seconds
network: Network // MAINNET = 1
body: MessageBody // Type-specific payload
}
Message {
data: MessageData
hash: bytes // Blake3 hash of serialized MessageData
hash_scheme: BLAKE3
signature: bytes // Ed25519 signature over hash
signature_scheme: ED25519
signer: bytes // Public key of the signer (app key)
}
Onchain Registry (OP Mainnet)
Farcaster's onchain contracts manage identity, keys, and storage on OP Mainnet.
Last verified: March 2026
| Contract | Address | Purpose |
|---|---|---|
| IdRegistry | 0x00000000Fc6c5F01Fc30151999387Bb99A9f489b | Maps FIDs to custody addresses |
| KeyRegistry | 0x00000000Fc1237824fb747aBDE0FF18990E59b7e | Maps FIDs to Ed25519 app keys (signers) |
| StorageRegistry | 0x00000000FcCe7f938e7aE6D3c335bD6a1a7c593D | Manages storage units per FID |
| IdGateway | 0x00000000Fc25870C6eD6b6c7E41Fb078b7656f69 | Permissioned FID registration entry point |
| KeyGateway | 0x00000000fC56947c7E7183f8Ca4B62398CaaDF0B | Permissioned key addition entry point |
| Bundler | 0x00000000FC04c910A0b5feA33b03E0447ad0B0aA | Batches register + addKey + rent in one tx |
# Verify IdRegistry is deployed on OP Mainnet
cast code 0x00000000Fc6c5F01Fc30151999387Bb99A9f489b --rpc-url https://mainnet.optimism.io
# Look up custody address for an FID
cast call 0x00000000Fc6c5F01Fc30151999387Bb99A9f489b \
"custodyOf(uint256)(address)" 3 \
--rpc-url https://mainnet.optimism.io
Registration Flow
1. User calls IdGateway.register() or Bundler.register()
-> IdRegistry assigns next sequential FID to custody address
|
2. User (or Bundler) calls KeyGateway.add()
-> KeyRegistry maps FID to an Ed25519 public key (app key / signer)
|
3. User (or Bundler) calls StorageRegistry.rent()
-> Allocates storage units (each unit = 5,000 casts, 2,500 reactions, 2,500 links)
|
4. App key can now sign Farcaster messages on behalf of the FID
Farcaster IDs (FIDs)
Every Farcaster user has an FID -- a sequentially assigned uint256 stored in IdRegistry on OP Mainnet.
| Concept | Description |
|---|---|
| FID | The user's numeric identity, immutable once assigned |
| Custody address | The Ethereum address that owns the FID -- can transfer ownership |
| App key (signer) | Ed25519 key pair registered in KeyRegistry -- signs messages |
| Recovery address | Can initiate FID recovery if custody address is compromised |
An FID can have multiple app keys. Each app (Warpcast, third-party client) registers its own app key via KeyGateway. The custody address can revoke any app key by calling KeyRegistry.remove().
Neynar API v2
Neynar provides the primary API for reading and writing Farcaster data. Current SDK version: @neynar/nodejs-sdk v3.131.0.
Setup
npm install @neynar/nodejs-sdk
import { NeynarAPIClient, Configuration } from "@neynar/nodejs-sdk";
const config = new Configuration({
apiKey: process.env.NEYNAR_API_KEY,
});
const neynar = new NeynarAPIClient(config);
Fetch User by FID
const { users } = await neynar.fetchBulkUsers({ fids: [3] });
const user = users[0];
console.log(user.username, user.display_name, user.follower_count);
Publish a Cast
const response = await neynar.publishCast({
signerUuid: process.env.SIGNER_UUID,
text: "Hello from Neynar SDK",
});
console.log(response.cast.hash);
Fetch Feed
const feed = await neynar.fetchFeed({
feedType: "following",
fid: 3,
limit: 25,
});
for (const cast of feed.casts) {
console.log(`@${cast.author.username}: ${cast.text}`);
}
Search Users
const result = await neynar.searchUser({ q: "vitalik", limit: 5 });
for (const user of result.result.users) {
console.log(`FID ${user.fid}: @${user.username}`);
}
Fetch Cast by Hash
const { cast } = await neynar.lookupCastByHashOrWarpcastUrl({
identifier: "0xfe90f9de682273e05b201629ad2338bdcd89b6be",
type: "hash",
});
console.log(cast.text, cast.reactions.likes_count);
Webhook Configuration
Create webhooks in the Neynar dashboard or via API. Webhooks fire on cast creation, reaction events, follow events, and more.
import express from "express";
import crypto from "node:crypto";
const app = express();
// Raw body is required for signature verification
app.use("/webhook", express.raw({ type: "application/json" }));
app.post("/webhook", (req, res) => {
const rawBody = req.body as Buffer;
const signature = req.headers["x-neynar-signature"] as string;
if (!signature) {
res.status(401).json({ error: "Missing signature" });
return;
}
const hmac = crypto.createHmac("sha512", process.env.NEYNAR_WEBHOOK_SECRET!);
hmac.update(rawBody);
const computed = hmac.digest("hex");
const isValid = crypto.timingSafeEqual(
Buffer.from(signature, "hex"),
Buffer.from(computed, "hex")
);
if (!isValid) {
res.status(401).json({ error: "Invalid signature" });
return;
}
const event = JSON.parse(rawBody.toString("utf-8"));
console.log("Verified webhook event:", event.type);
res.status(200).json({ status: "ok" });
});
app.listen(3001, () => console.log("Webhook listener on :3001"));
Frames v2 / Mini Apps
Frames v2 are full-screen interactive web applications embedded inside Farcaster clients. They replaced the static image + button model of Frames v1 with a rich SDK-powered experience.
Manifest (/.well-known/farcaster.json)
Every Mini App must serve a manifest at /.well-known/farcaster.json on its domain:
{
"accountAssociation": {
"header": "eyJmaWQiOjM...",
"payload": "eyJkb21haW4iOiJleGFtcGxlLmNvbSJ9",
"signature": "abc123..."
},
"frame": {
"version": "1",
"name": "My Mini App",
"iconUrl": "https://example.com/icon.png",
"homeUrl": "https://example.com/app",
"splashImageUrl": "https://example.com/splash.png",
"splashBackgroundColor": "#1a1a2e",
"webhookUrl": "https://example.com/api/webhook"
}
}
The accountAssociation proves that the FID owner controls the domain. The payload decoded is {"domain":"example.com"} -- this domain MUST match the FQDN hosting the manifest file.
Meta Tags
Add these to your app's HTML <head> for Farcaster clients to discover the Mini App:
<meta name="fc:frame" content='{"version":"next","imageUrl":"https://example.com/og.png","button":{"title":"Launch App","action":{"type":"launch_frame","name":"My App","url":"https://example.com/app","splashImageUrl":"https://example.com/splash.png","splashBackgroundColor":"#1a1a2e"}}}' />
Frame SDK Setup
npm install @farcaster/frame-sdk
import sdk from "@farcaster/frame-sdk";
async function initMiniApp() {
const context = await sdk.context;
// context.user contains the viewing user's FID, username, pfpUrl
console.log(`User FID: ${context.user.fid}`);
console.log(`Username: ${context.user.username}`);
// Signal to the client that the app is ready to render
sdk.actions.ready();
}
initMiniApp();
SDK Actions
// Open an external URL in the client's browser
sdk.actions.openUrl("https://example.com");
// Close the Mini App
sdk.actions.close();
// Compose a cast with prefilled text
sdk.actions.composeCast({
text: "Check out this Mini App!",
embeds: ["https://example.com/app"],
});
// Add a Mini App to the user's favorites (prompts confirmation)
sdk.actions.addFrame();
Transaction Frames
Mini Apps can trigger onchain transactions through the embedded wallet provider. The SDK exposes an EIP-1193 provider that connects to the user's wallet in the Farcaster client.
Wallet Provider Setup
import sdk from "@farcaster/frame-sdk";
import { createWalletClient, custom, parseEther, type Address } from "viem";
import { base } from "viem/chains";
async function sendTransaction() {
const context = await sdk.context;
const provider = sdk.wallet.ethProvider;
const walletClient = createWalletClient({
chain: base,
transport: custom(provider),
});
const [address] = await walletClient.requestAddresses();
const hash = await walletClient.sendTransaction({
account: address,
to: "0xRecipient..." as Address,
value: parseEther("0.001"),
});
return hash;
}
With Wagmi Connector
For apps using wagmi, wrap the SDK's provider as a connector:
import sdk from "@farcaster/frame-sdk";
import { createConfig, http, useConnect, useSendTransaction } from "wagmi";
import { base } from "wagmi/chains";
import { farcasterFrame } from "@farcaster/frame-wagmi-connector";
const config = createConfig({
chains: [base],
transports: {
[base.id]: http(),
},
connectors: [farcasterFrame()],
});
// In your React component:
function MintButton() {
const { connect, connectors } = useConnect();
const { sendTransaction } = useSendTransaction();
async function handleMint() {
connect({ connector: connectors[0] });
sendTransaction({
to: "0xNFTContract..." as `0x${string}`,
data: "0x...", // mint function calldata
value: parseEther("0.01"),
});
}
return <button onClick={handleMint}>Mint</button>;
}
Warpcast Deep Links and Cast Intents
Cast Intent URL
Open Warpcast's compose screen with prefilled content:
https://warpcast.com/~/compose?text=Hello%20Farcaster&embeds[]=https://example.com
| Parameter | Description |
|---|---|
text | URL-encoded cast text |
embeds[] | Up to 2 embed URLs |
channelKey | Channel to post in (e.g., farcaster) |
Deep Links
# Open a user's profile
https://warpcast.com/<username>
# Open a specific cast
https://warpcast.com/<username>/<cast-hash>
# Open a channel
https://warpcast.com/~/channel/<channel-id>
# Open direct cast composer
https://warpcast.com/~/inbox/create/<fid>
Channels
Channels are topic-based feeds identified by a parent_url. A cast is posted to a channel by setting its parent_url to the channel's URL.
// Post a cast to the "ethereum" channel
const response = await neynar.publishCast({
signerUuid: process.env.SIGNER_UUID,
text: "Pectra upgrade is live!",
channelId: "ethereum",
});
Channel Lookup
const channel = await neynar.lookupChannel({ id: "farcaster" });
console.log(channel.channel.name, channel.channel.follower_count);
Channel Feed
const feed = await neynar.fetchFeed({
feedType: "filter",
filterType: "channel_id",
channelId: "ethereum",
limit: 25,
});
Neynar API Pricing
Current as of March 2026
| Plan | Monthly Credits | Price | Webhooks | Rate Limit |
|---|---|---|---|---|
| Free | 100K | $0 | 1 | 5 req/s |
| Starter | 1M | $49/mo | 5 | 20 req/s |
| Growth | 10M | $249/mo | 25 | 50 req/s |
| Scale | 60M | $899/mo | 100 | 200 req/s |
| Enterprise | Custom | Custom | Unlimited | Custom |
Credit costs vary by endpoint. Read operations (user lookup, feed) cost 1-5 credits. Write operations (publish cast, react) cost 10-50 credits. Webhook deliveries are free but count against webhook limits.
Hub / Snapchain Endpoints
Direct hub access for reading raw Farcaster data without the Neynar API abstraction.
| Provider | Endpoint | Auth |
|---|---|---|
| Neynar Hub API | hub-api.neynar.com | API key in x-api-key header |
| Self-hosted Hub | localhost:2283 | None (local) |
Hub HTTP API Examples
# Get casts by FID
curl -H "x-api-key: $NEYNAR_API_KEY" \
"https://hub-api.neynar.com/v1/castsByFid?fid=3&pageSize=10"
# Get user data (display name, bio, pfp)
curl -H "x-api-key: $NEYNAR_API_KEY" \
"https://hub-api.neynar.com/v1/userDataByFid?fid=3"
# Get reactions by FID
curl -H "x-api-key: $NEYNAR_API_KEY" \
"https://hub-api.neynar.com/v1/reactionsByFid?fid=3&reactionType=1"
Hub gRPC API
# Install hubble CLI
npm install -g @farcaster/hubble
# Query via gRPC
hubble --insecure -r hub-api.neynar.com:2283 getCastsByFid --fid 3
Farcaster Epoch Conversion
// Farcaster epoch: January 1, 2021 00:00:00 UTC
const FARCASTER_EPOCH = 1609459200;
function farcasterTimestampToUnix(farcasterTs: number): number {
return farcasterTs + FARCASTER_EPOCH;
}
function unixToFarcasterTimestamp(unixTs: number): number {
return unixTs - FARCASTER_EPOCH;
}
function farcasterTimestampToDate(farcasterTs: number): Date {
return new Date((farcasterTs + FARCASTER_EPOCH) * 1000);
}
Related Skills
- viem -- Used for onchain interactions with Farcaster registry contracts on OP Mainnet and for building transaction frames with the wallet provider
- wagmi -- React hooks for wallet connection in Mini Apps via the
@farcaster/frame-wagmi-connector - x402 -- Payment protocol that can be integrated with Farcaster Mini Apps for paywalled content