mirror of
https://github.com/farcasterxyz/hub-monorepo.git
synced 2026-04-18 03:00:22 -04:00
77b5873b43
* docs: update client to use waitForReady pattern * update: revert waitForReady for hub-web
51 lines
1.6 KiB
Markdown
51 lines
1.6 KiB
Markdown
# @farcaster/hub-nodejs
|
|
|
|
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).
|
|
|
|
## 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](https://github.com/farcasterxyz/hubble/tree/main/packages/hub-nodejs/docs), see more [examples](https://github.com/farcasterxyz/hubble/tree/main/packages/hub-nodejs/examples) or get started with the guide below.
|
|
|
|
## Installation
|
|
|
|
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
|
|
```
|
|
|
|
## Quickstart
|
|
|
|
### Fetching Data from Hubs
|
|
|
|
```typescript
|
|
import { getSSLHubRpcClient } from '@farcaster/hub-nodejs';
|
|
|
|
client.$.waitForReady(Date.now() + 5000, async (e) => {
|
|
if (e) {
|
|
console.error(`Failed to connect to ${hubRpcEndpoint}:`, e);
|
|
process.exit(1);
|
|
} else {
|
|
console.log(`Connected to ${hubRpcEndpoint}`);
|
|
const castsResult = await client.getCastsByFid({ fid: 8928 });
|
|
castsResult.map((casts) => casts.messages.map((cast) => console.log(cast.data?.castAddBody?.text)));
|
|
client.close();
|
|
}
|
|
});
|
|
```
|
|
|
|
## Contributing
|
|
|
|
Please see our [contributing guidelines](https://github.com/farcasterxyz/hubble/blob/main/CONTRIBUTING.md) before making a pull request.
|
|
|
|
## License
|
|
|
|
MIT License
|