Farcasterkit

A unified Typescript API for Farcaster Data

You need to get Farcaster data and need to read all API documentations and even more. Farcasterkit solves this by offering a one stop library that exposes a unified API so you don't need to worry about different implementations (think viem/ethers.js providers but for Farcaster).

Installation

npm install @dtechvision/farcasterkit

Ressources

• [NPM]- TODO
• React Hooks for FarcasterKit
• [Farcaster Channel] - Whut? wow! use /fc-devs
• [Docs] - SOON, for now github Issues + Code
• [Looking for Developers? / need Help?] - cast @samuellhuber or any Maintainer on Farcaster for now

Overview

// soon

Providers

// documentation soon so far this

Contributing

If you offer data APIs that you'd wish to be included please refer to Contributing - Adding Providers

Code

1. Fork the repository: Click here to fork on Github
2. make your contribution and commit it: git add . & git commit -a
3. Push your changes to your fork: git push
4. Open a Pull Request against develop branch: here on Github
5. Answer to Review Questions and contribute!

Feedback & Ideas (non devs welcome!)

You're welcome to open Github Issues to describe your ideas right here.

Adding Providers

Have a look at src/providers/thirdpartyProvider.ts which is a template for adding new Providers.

Then register your Provider class with a nameProvider.ts file in src/providers/thirdparty/ with creation of your class.

your file needs to export a Provider that extens the ThirdPartyProvider like the following code sample

export class NameProvider extends ThirdParty {
    // add constructor to init your values
    // like an API key etc ...
}