Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/standard-crypto/farcaster-js
https://github.com/standard-crypto/farcaster-js
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/standard-crypto/farcaster-js
- Owner: standard-crypto
- License: mit
- Created: 2021-09-08T18:58:59.000Z (almost 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-10T00:47:36.000Z (3 months ago)
- Last Synced: 2024-04-14T16:18:27.726Z (3 months ago)
- Language: TypeScript
- Size: 4.9 MB
- Stars: 112
- Watchers: 2
- Forks: 14
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Lists
- awesome-farcaster - standard-crypto/farcaster-js
README
# Farcaster.js
A collection of tools for interacting with the Farcaster social network.
- [Farcaster Hub REST API](#farcaster-hub-rest-api)
- [Neynar REST APIs](#neynar-rest-apis)
- [Signers](#signers)
- [Privy](#privy)
## Farcaster Hub REST API
Farcaster hubs expose a public REST API which can be used for simple queries.
***Setup:***
```sh
# Install all farcaster-js tools
npm install axios @standard-crypto/farcaster-js
# ...or install only the Hub REST API client
npm install axios @standard-crypto/farcaster-js-hub-rest
```
***Example:***
```ts
import { HubRestAPIClient, ExternalEd25519Signer } from '@standard-crypto/farcaster-js';
import { NobleEd25519Signer } from '@farcaster/core';
const client = new HubRestAPIClient();
console.log(await client.getHubInfo());
// Use a private key
const signerPrivateKey = '0x...';
const fid = 111;
const writeClient = new HubRestAPIClient({ hubUrl: 'https://hub.farcaster.standardcrypto.vc:2281' });
const publishCastResponse = await writeClient.submitCast({ text: 'This is a test cast submitted from farcaster-js' }, fid, signerPrivateKey);
console.log(`new cast hash: ${publishCastResponse.hash}`);
// Use an external signer
const nobleSigner = new NobleEd25519Signer(new Uint8Array([]));
const _signMessage = async(messageHash: Uint8Array): Promise => {
const res = await nobleSigner.signMessageHash(messageHash);
if (res.isErr()) {
throw res.error;
}
return res._unsafeUnwrap();
};
const _getPublicKey = async(): Promise => {
const res = await nobleSigner.getSignerKey();
if (res.isErr()) {
throw res.error;
}
return res._unsafeUnwrap();
};
const externalSigner = new ExternalEd25519Signer(_signMessage, _getPublicKey);
const publishCastExternalSignerResponse = await writeClient.submitCast({ text: 'This is a test cast submitted from farcaster-js using an external signer' }, fid, externalSigner);
console.log(`new cast hash with external signer: ${publishCastExternalSignerResponse.hash}`);
```
See the [@standard-crypto/farcaster-js-hub-rest](./packages/farcaster-js-hub-rest/README.md)
package for more info.
## Neynar REST APIs
***Setup:***
```sh
# Install all farcaster-js tools
npm install axios @standard-crypto/farcaster-js
# ...or install only the Neynar API client
npm install axios @standard-crypto/farcaster-js-neynar
```
***Example:***
```ts
import { NeynarAPIClient, NeynarV2 } from '@standard-crypto/farcaster-js';
const signerUuid = 'approvedSignerUUID';
const client = new NeynarAPIClient('apiKey');
// Publish cast
const cast = await client.v2.publishCast(signerUuid, 'This is a test cast.');
// React to cast
await client.v2.reactToCast(signerUuid, NeynarV2.ReactionType.Like, cast.hash);
```
## Signers
Signers are required to write data to Farcaster. You can learn more about signers from these resources ([Farcaster](https://docs.farcaster.xyz/developers/guides/accounts/create-account-key), [Neynar](https://docs.neynar.com/docs/write-to-farcaster-with-neynar-managed-signers), [Privy](https://docs.privy.io/guide/react/recipes/misc/farcaster-writes#_2-create-an-embedded-farcaster-signer)).
This package includes a CLI for creating signers. You can run the code below to generate a signer:
```
farcaster-js create-signer
```
Read more about the CLI in [farcaster-js-cli](./packages/farcaster-js-cli/README.md).
Additionally, signers may be created programmatically without use of the CLI. See the examples in [farcaster-js-neynar](./packages/farcaster-js-neynar/README.md#create-a-signer) or follow [this guide](https://docs.privy.io/guide/react/recipes/misc/farcaster-writes#_1-login-with-farcaster) from Privy for logging users in with Farcaster and authorizing a signer.
### Privy
[Privy](https://privy.io) enables users to easily log in to your app using their Farcaster account. Follow [this guide](https://docs.privy.io/guide/react/recipes/misc/farcaster-writes) to enable Farcaster login and begin writing messages. See the example below for usage once logging in with Farcaster is integrated.
```
import { HubRestAPIClient, ExternalEd25519Signer } from '@standard-crypto/farcaster-js';
import { useExperimentalFarcasterSigner, usePrivy } from '@privy-io/react-auth';
const client = new HubRestAPIClient();
console.log(await client.getHubInfo());
const { user } = usePrivy();
const { getFarcasterSignerPublicKey, signFarcasterMessage } = useExperimentalFarcasterSigner();
// Use a Privy embedded signer
const privySigner = new ExternalEd25519Signer(signFarcasterMessage, getFarcasterSignerPublicKey);
const fid = user.farcaster.fid!;
const publishCastExternalSignerResponse = await client.submitCast({ text: 'This is a test cast submitted from farcaster-js using an external signer' }, fid, privySigner);
console.log(`new cast hash with privy embedded signer signer: ${publishCastExternalSignerResponse.hash}`);
```
***Usage Versus Hub APIs:***
The REST APIs exposed by a Farcaster hub are designed to provide protocol entities optimized for the transport and indexing layer. Neynar APIs are designed for building at the application-layer.
Neynar v1 APIs are designed to replicate the deprecated Warpcast APIs to ensure that the ecosystem of products built on those APIs can continue thriving with minimal switching costs. The Neynar v1 APIs should act serve a drop-in replacement for applications using `farcaster-js` pre-version 6.0.
Neynar v2 APIs bring in additional support for new Farcaster protocol primitives like channels and signer management with much more support for storage, sign in with farcaster and new features delivered regularly.
See for API access and more details.
See the [@standard-crypto/farcaster-js-neynar](./packages/farcaster-js-neynar/README.md)
package for more on the Neynar API client.