mirror of https://github.com/farcasterxyz/hub-monorepo.git synced 2026-01-10 05:38:07 -05:00

Files

Bob 47f5e7d41d Fixed typos and improved clarity in documentation (#2455 )

Changes made:

typos - types ( Correcting a typo to the intended word)
LocalACcount - LocalAccount (Fixing the capitalization error to match
the proper format)



<!-- start pr-codex -->

---

## PR-Codex overview
This PR focuses on correcting typos in test descriptions and
documentation related to the `getStoreLimit` function and the
`Eip712Signer` class.

### Detailed summary
- Changed the test description from "multiple unit typos" to "multiple
unit types" in `packages/core/src/limits.test.ts`.
- Corrected "LocalACcount" to "LocalAccount" in
`packages/hub-nodejs/docs/signers/ViemLocalEip712Signer.md`.

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`

<!-- end pr-codex -->

2025-01-08 19:41:43 -08:00

docs

Fixed typos and improved clarity in documentation (#2455 )

2025-01-08 19:41:43 -08:00

examples

chore(deps): bump cross-spawn from 7.0.3 to 7.0.6 in /packages/hub-nodejs/examples/hello-world (#2425 )

2024-12-09 13:28:34 -08:00

src

feat: support social verifications for twitter and github (#2370 )

2024-10-24 22:43:15 -05:00

biome.json

chore: replace rome with biome (#1351 )

2023-09-07 08:43:02 -05:00

CHANGELOG.md

chore: bump version (#2387 )

2024-10-28 12:26:15 -05:00

jest.config.ts

refactor(farcaster/hub-nodejs): rename farcaster/js to farcaster/hub-nodejs (#658 )

2023-03-16 13:08:05 -07:00

package.json

chore: bump version (#2387 )

2024-10-28 12:26:15 -05:00

README.md

docs: add OpenAPI spec for hub-web (#1537 )

2024-01-19 16:16:52 -08:00

spec.yaml

Removed the hyphen in onchain and offchain to maintain a consistent style (#2315 )

2024-09-18 20:27:44 -07:00

tsconfig.json

refactor(farcaster/hub-nodejs): rename farcaster/js to farcaster/hub-nodejs (#658 )

2023-03-16 13:08:05 -07:00

tsup.config.ts

chore: update tsup configs (#819 )

2023-04-04 23:21:01 -04:00

README.md

@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 { 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();
  }
});

Documentation

The HTTP API endpoints are documented here.

An OpenAPI spec is provided here.

Contributing

Please see our contributing guidelines before making a pull request.

License

MIT License