mirror of
https://github.com/farcasterxyz/hub-monorepo.git
synced 2026-04-18 03:00:22 -04:00
b8eaa9a857
* docs: fix all instances of types imports * docs: fix issues with EthersEip712Signers * docs: fix issues with NobleEd25519Signer * docs: fix issues with Builders and Utils * docs: cleanup primary README example
Documentation
@farcaster/hub-nodejs has five major components:
- A Client, which can send and receive messages from a Farcaster Hub.
- Messages, which are the atomic units of change on the Farcaster network.
- Builders, which can be used to construct new messages.
- Signers, which are required by Builders to sign messages.
- Utils, which are helpers to deal with Farcaster idiosyncrasies.
Idiosyncrasies
There are four important things to know about the package:
- Fixed length data is encoded in byte formats, instead of strings.
- Errors are handled with a monadic pattern, instead of try-catch.
- Timestamps are calculated from the Farcaster epoch, not the Unix epoch.
- Only Nodejs is supported, and browser support is a work in progress.
There are also a few Farcaster-specific terms that are very commonly used in this package:
| Term | Description |
|---|---|
| Cast | A public message posted by a user |
| Fid | A Farcaster id, issued by the Id Registry on Ethereum |
| Fname | A Farcaster username, issued by the Name Registry on Ethereum. |
| Hub | A node in the Farcaster network which stores Farcaster Messages |
| Reaction | A public action between a user and a piece of content (e.g. like, recast) |