đ§Message
Learn how to submit and validate message data using Airstack Hubs API.
Submit Message
You can submit a signed protobuf-serialized message to the Hub by using Airstack Hubs API with the code below:
For this, you will first need to create your own signer to call the submit message API. For details on creating casts with mentions, replies, embeds, and other details, check here.
import {
hexStringToBytes,
getSSLHubRpcClient,
Metadata,
makeCastAdd,
FarcasterNetwork,
} from "@farcaster/hub-nodejs";
import { config } from "dotenv";
config();
const SIGNER_PRIVATE_KEY = '0x...'; // Your signer's private key
const FID = 1; // Your fid
const ed25519Signer = new NobleEd25519Signer(SIGNER_PRIVATE_KEY);
const dataOptions = {
fid: FID,
network: FC_NETWORK,
};
const FC_NETWORK = FarcasterNetwork.MAINNET;
const client = getSSLHubRpcClient("hubs-grpc.airstack.xyz");
// Construct the cast
const cast = await makeCastAdd(
{
text: 'This is a cast!', // Text can be up to 320 bytes long
embeds: [],
embedsDeprecated: [],
mentions: [],
mentionsPositions: [],
},
dataOptions,
ed25519Signer
);
client.$.waitForReady(Date.now() + 5000, async (e) => {
if (e) {
console.error(`Failed to connect to the gRPC server:`, e);
process.exit(1);
} else {
console.log(`Connected to the gRPC server`);
const metadata = new Metadata();
// Provide API key here
metadata.add("x-airstack-hubs", process.env.AIRSTACK_API_KEY as string);
if (cast.isOk()) {
// Broadcast the cast/message to the Farcaster network
const submitResult = await client.submitMessage(
castReplyResult.value,
metadata
);
if (submitResult.isOk()) {
console.log(`Reply posted successfully`);
console.log(Buffer.from(submitResult.value.hash).toString("hex"));
}
} else {
const error = cast.error;
// Handle the error case
console.error(`Error posting reply: ${error}`);
}
// After everything, close the RPC connection
client.close();
}
});import axios from "axios";
import { config } from "dotenv";
import {
makeCastAdd,
FarcasterNetwork,
} from "@farcaster/hub-nodejs";
// Require `npm install @farcaster/core`
import { Message } from "@farcaster/core";
config();
const SIGNER_PRIVATE_KEY = '0x...'; // Your signer's private key
const FID = 1; // Your fid
const ed25519Signer = new NobleEd25519Signer(SIGNER_PRIVATE_KEY);
const dataOptions = {
fid: FID,
network: FC_NETWORK,
};
const FC_NETWORK = FarcasterNetwork.MAINNET;
// Construct the cast
const cast = await makeCastAdd(
{
text: 'This is a cast!', // Text can be up to 320 bytes long
embeds: [],
embedsDeprecated: [],
mentions: [],
mentionsPositions: [],
},
dataOptions,
ed25519Signer
);
const main = async () => {
const server = "https://hubs.airstack.xyz";
try {
// Encode the message into a Buffer (of bytes)
const messageBytes = Buffer.from(Message.encode(cast).finish());
const response = await axios.post(`${server}/v1/submitMessage`,
messageBytes,
{
headers: {
"Content-Type": "application/octet-stream",
// Provide API key here
"x-airstack-hubs": process.env.AIRSTACK_API_KEY as string,
},
}
);
console.log(response);
console.log(json);
} catch (e) {
console.error(e);
}
}
main();{
"data": {
"type": "MESSAGE_TYPE_CAST_ADD",
"fid": 2,
"timestamp": 48994466,
"network": "FARCASTER_NETWORK_MAINNET",
"castAddBody": {
"embedsDeprecated": [],
"mentions": [],
"parentCastId": {
"fid": 226,
"hash": "0xa48dd46161d8e57725f5e26e34ec19c13ff7f3b9"
},
"text": "Cast Text",
"mentionsPositions": [],
"embeds": []
}
},
"hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
"hashScheme": "HASH_SCHEME_BLAKE3",
"signature": "3msLXzxB4eEYe...dHrY1vkxcPAA==",
"signatureScheme": "SIGNATURE_SCHEME_ED25519",
"signer": "0x78ff9a...58c"
}Validate Message
You can validate a signed protobuf-serialized message with the Hub by using Airstack Hubs API with the code below:
If you are validating message for Frames or cast actions, check out Airstack Frames Validator.
import {
Metadata,
getSSLHubRpcClient,
} from "@farcaster/hub-nodejs";
import { config } from "dotenv";
config();
const client = getSSLHubRpcClient("hubs-grpc.airstack.xyz");
client.$.waitForReady(Date.now() + 5000, async (e) => {
if (e) {
console.error(`Failed to connect to the gRPC server:`, e);
process.exit(1);
} else {
console.log(`Connected to the gRPC server`);
const metadata = new Metadata();
// Provide API key here
metadata.add("x-airstack-hubs", process.env.AIRSTACK_API_KEY as string);
// validate message data with `validateMessage`
const submitResult = await client.validateMessage(
message,
metadata
);
console.log(submitResult);
// After everything, close the RPC connection
client.close();
}
});import axios from "axios";
import { config } from "dotenv";
config();
const main = async () => {
const server = "https://hubs.airstack.xyz";
try {
let messageBytes = ""; // signed protobuf-serialized message
const response = await axios.post(`${server}/v1/validateMessage`,
{
headers: {
"Content-Type": "application/octet-stream",
// Provide API key here
"x-airstack-hubs": process.env.AIRSTACK_API_KEY as string,
},
data: new Uint8Array(
messageBytes.match(/.{1,2}/g)!.map(
(byte: string) => parseInt(byte, 16)
)
);
}
);
console.log(response);
console.log(json);
} catch (e) {
console.error(e);
}
}
main();{
"valid": true,
"message": {
"data": {
"type": "MESSAGE_TYPE_FRAME_ACTION",
"fid": 2,
"timestamp": 48994466,
"network": "FARCASTER_NETWORK_MAINNET",
"frameActionBody": {
"url": "https://fcpolls.com/polls/1",
"buttonIndex": 2,
"inputText": "",
"castId": {
"fid": 226,
"hash": "0xa48dd46161d8e57725f5e26e34ec19c13ff7f3b9"
}
}
},
"hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
"hashScheme": "HASH_SCHEME_BLAKE3",
"signature": "3msLXzxB4eEYe...dHrY1vkxcPAA==",
"signatureScheme": "SIGNATURE_SCHEME_ED25519",
"signer": "0x78ff9a...58c"
}
}Developer Support
If you have any questions or need help regarding integrating submitting and validating message data using AIrstack Hubs API into your Farcaster app, please join our Airstack's Telegram group.
More Resources
Last updated