https://github.com/ertan/go-farcaster

https://github.com/ertan/go-farcaster

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/ertan/go-farcaster
• Owner: ertan
• License: mit
• Created: 2023-02-01T06:25:56.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-04-08T20:50:24.000Z (about 1 year ago)
• Last Synced: 2024-02-08T10:23:36.512Z (5 months ago)
• Language: Go
• Size: 61.5 KB
• Stars: 11
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-farcaster - ertan/go-farcaster

README

        
# Farcaster Go Client

This is the Golang implementation for Farcaster client based on the [official v2 API documentation](https://farcasterxyz.notion.site/Merkle-v2-API-Documentation-c19a9494383a4ce0bd28db6d44d99ea8).

Inspired by [Rust](https://github.com/TheLDB/farcaster-rs) and [Python](https://github.com/a16z/farcaster-py) client implementations. Coauthored by GitHub Copilot and ChatGPT. 🙏

## Installation

```

go get github.com/ertan/go-farcaster

```

## Usage

```

apiUrl := "https://api.warpcast.com"

mnemonic := "Farcaster mnemonic"

providerWs := "Optional: Goerli endpoint"

fc := farcaster.NewFarcasterClient(apiUrl, mnemonic, providerWs)

casts, _, err := fc.Casts.GetRecentCasts(10)

```

You can find other examples under `examples/` directory.

## Development

In order to test the examples you need to set the following environment variables in .env file in the repo's root directory. 

```

FARCASTER_API_URL    = "https://api.warpcast.xyz"

FARCASTER_MNEMONIC   = "your mnemonic"

ETHEREUM_PROVIDER_WS = "your Goerli endpoint"

```

Registry is built based on the event logs to get fid <> fname <> address mappings. If `ETHEREUM_PROVIDER_WS` variable isn't set, you can still use the API. Mnemonic is required for authorization to access most of the API endpoints. However, it's not required by the client as some endpoints are open to public.

### Examples

Some examples to test the client are:

```

go run examples/casts/casts_example.go

```

```

go run examples/reactions/reactions_example.go

```

```

go run examples/users/users_example.go

```

## Future Work

- Tests! There are currently no unit tests for the client, just examples. 😅

- Missing comments on exported functions and structs.