mirror of https://github.com/farcasterxyz/hub-monorepo.git synced 2026-02-11 21:45:09 -05:00

Files

dependabot[bot] 4cba08e76b build(deps): bump protobufjs in /packages/hub-nodejs/examples/write-data (#1092 )

Bumps [protobufjs](https://github.com/protobufjs/protobuf.js) from 7.2.2 to 7.2.4.
- [Release notes](https://github.com/protobufjs/protobuf.js/releases)
- [Changelog](https://github.com/protobufjs/protobuf.js/blob/master/CHANGELOG.md)
- [Commits](https://github.com/protobufjs/protobuf.js/compare/protobufjs-v7.2.2...protobufjs-v7.2.4)

---
updated-dependencies:
- dependency-name: protobufjs
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

2023-07-10 14:32:18 -07:00

docs

chore: use viem in @farcaster/core (#1037 )

2023-06-26 11:27:13 -05:00

examples

build(deps): bump protobufjs in /packages/hub-nodejs/examples/write-data (#1092 )

2023-07-10 14:32:18 -07:00

src

chore: switch from eslint/prettier to rome (#1074 )

2023-07-04 19:09:15 -07:00

.eslintrc.cjs

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

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

CHANGELOG.md

chore: Release 1.3.3 (#1065 )

2023-07-02 21:52:27 -07: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

build(deps): bump @grpc/grpc-js from 1.8.7 to 1.8.8 (#1083 )

2023-07-10 14:31:50 -07:00

README.md

docs: update client to use waitForReady pattern (#922 )

2023-05-09 08:22:13 -05:00

rome.json

chore: switch from eslint/prettier to rome (#1074 )

2023-07-04 19:09:15 -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();
  }
});

Contributing

Please see our contributing guidelines before making a pull request.

License

MIT License