A lightweight, fast Typescript interface for Farcaster Hubs. Designed to work with [Hubble](https://github.com/farcasterxyz/hubble/) and any other Hub that implements the [Farcaster protocol](https://github.com/farcasterxyz/protocol).
npm install @farcaster/hub-nodejsA lightweight, fast Typescript interface for Farcaster Hubs. Designed to work with Hubble and any other Hub that implements the Farcaster protocol.
- Call any Hub endpoint from a NodeJS environment.
- Serializes and deserializes Farcaster protobufs into Javascript objects.
- Has helpers to create and sign Farcaster messages.
- Written entirely in TypeScript, with strict types for safety.
Read the documentation, see more examples or get started with the guide below.
Install @farcaster/hub-nodejs with the package manager of your choice
``bash`
npm install @farcaster/hub-nodejs
yarn add @farcaster/hub-nodejs
pnpm install @farcaster/hub-nodejs
`typescript
import { getSSLHubRpcClient } from '@farcaster/hub-nodejs';
client.$.waitForReady(Date.now() + 5000, async (e) => {
if (e) {
console.error(Failed to connect to ${hubRpcEndpoint}:, e);Connected to ${hubRpcEndpoint}
process.exit(1);
} else {
console.log();``
const castsResult = await client.getCastsByFid({ fid: 8928 });
castsResult.map((casts) => casts.messages.map((cast) => console.log(cast.data?.castAddBody?.text)));
client.close();
}
});
The HTTP API endpoints are documented here.
An OpenAPI spec is provided here.
Please see our contributing guidelines before making a pull request.
MIT License