mirror of
https://github.com/farcasterxyz/hub-monorepo.git
synced 2026-02-11 13:35:05 -05:00
f42e8a262b
* docs: add bytes-hex docs * add: timestamp docs * docs: verification table, params and return * docs: add hubresult wrapper type * docs: clarify some examples, address nit * update: s/hexString/byteArray * docs: add import to toFarcasterTime
@farcaster/hub-nodejs
A lightweight, fast Typescript interface for Farcaster Hubs. Designed to work with Hubble and any other Hub that implements the Farcaster protocol.
Features
- 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.
Installation
Install @farcaster/hub-nodejs with the package manager of your choice
npm install @farcaster/hub-nodejs
yarn add @farcaster/hub-nodejs
pnpm install @farcaster/hub-nodejs
Quickstart
Fetching Data from Hubs
import { getHubRpcClient } from '@farcaster/hub-nodejs';
(async () => {
const client = await getHubRpcClient('127.0.0.1:2283');
const castsResult = await client.getCastsByFid({ fid: 2 });
castsResult.map((casts) => casts.messages.map((cast) => console.log(cast.data?.castAddBody?.text)));
})();
Contributing
Please see our contributing guidelines before making a pull request.
License
MIT License