Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anastasiarods/moxie-alerts-bot
Farcaster Moxie Alert Bot that posts messages about Moxie buy/sell events
https://github.com/anastasiarods/moxie-alerts-bot
farcaster farcaster-bot
Last synced: 27 days ago
JSON representation
Farcaster Moxie Alert Bot that posts messages about Moxie buy/sell events
- Host: GitHub
- URL: https://github.com/anastasiarods/moxie-alerts-bot
- Owner: anastasiarods
- License: mit
- Created: 2024-09-09T14:53:19.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-12T17:52:11.000Z (2 months ago)
- Last Synced: 2024-09-13T07:06:49.234Z (2 months ago)
- Topics: farcaster, farcaster-bot
- Language: TypeScript
- Homepage:
- Size: 44.9 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Farcaster bot for on-chain alerts
Simple open-source bot that monitors on-chain events in real-time and posts decoded messages to Farcaster. Key features:
- Needs only an RPC URL for real-time monitoring and transaction decoding
- Uses Airstack API to get Farcaster user's data (this API is free if you have an Airstack Fan Token)
- 0 dependencies on any external storage
### Step 0: Prerequisites
- An installed Bun (see installation guide [here](https://bun.sh/docs/installation))
- An Etherscan(Basescan) account (sign up [here](https://basescan.org/register))
- A Farcaster account (can be yours or a separate one for your bot)
- An Airstack API key (sing up [here](https://www.airstack.xyz/))
- An RPC Url that supports `eht_subsribe` method, for example [Tenderly](https://tenderly.co/) or [Alchemy](https://www.alchemy.com/).
### Step 1: Clone the Repository
Clone the Bot [repository](https://github.com/anastasiarods/moxie-alerts-bot) and install project dependencies:
```bash
git clone https://github.com/anastasiarods/moxie-alerts-bot
cd moxie-alerts-bot
bun i
```
### Step 2: Add Etherscan, Airstack API keys, and RPC URL
Copy and rename the `.env.example` file to `.env`, then paste API keys into the `AIRSTACK_API_KEY` and `ETHERSCAN_API_KEY` variables.
```bash
cp .env.example .env
vim .env
```
We use Airstack to fetch Farcaster user info based on the wallet address and Etherscan API key (from the free plan) to fetch contract ABIs and avoid hitting rate limits. The Etherscan API could be optional if the transactions you are interested in do not interact with many contracts.
Add an RPC URL that supports the `eth_subscribe` method to the `WS_RPC_URL` variable. Note that the `WS_RPC_URL` string must start with `ws://`. We use `WS_RPC_URL` to monitor new transactions based on conditions and also to decode transactions.
### Step 3: Create a Farcaster Account Key or Signer (manual method)
A Farcaster signer is a separate Ed25519 public and private key pair connected to your Farcaster account that you need for posting messages on your behalf. To connect the key pair, you have to send a transaction from your Farcaster wallet to the Key Registry Farcaster smart contract. At the moment of writing this guide, there was no simple way to create and connect the signer without using 3rd party APIs. So we made a script to generate the required transaction, and to run it you need to do the following:
1. **Fund your Farcaster custody wallet on Optimism to cover gas fees:**: You need some ETH on the Optimism chain to pay for the gas. A 1 dollar or less would be enough. Click on the 3 dots near your profile, press "About," and there you will find your custody address.
2. **Get your Farcaster recovery phrase and FID**: On your phone, go to settings -> advanced -> recovery phrase, and write this recovery phrase into the `MNEMONIC` variable in the `scripts/create-signer.ts` file. Also paste your bot's FID into the `FID` variable.
3. **Run the script**: Run the following command `bun run scripts/create-signer.ts`. The result of this script will be an Optimism transaction like [this](https://optimistic.etherscan.io/tx/0x9eecacefceb6f120c3ef50222eabb15d86fd5feac6dae3fdf09dccb7687c70d4), and a public and private key printed in the console. Do not share the private key.
4. **Add env variables**: Add the private key generated from the script and the bot's account FID into the `SIGNER_PRIVATE_KEY` and `ACCOUNT_FID` variables.
### Step 4: Start the Bot
Use the following command to start bot locally:
```bash
bun run src/index.ts
```
### Step 5: Check the guide to learn how it works and modify it
The [guide](https://loop-decoder.3loop.io/recipes/fc-bot/) describes all components of the bot and how to modify it to monitor the different EVM contacts.
## Feedback
Let me know on Farcaster ([@nastya](https://warpcast.com/nastya)) if you encounter any problems or have any questions, I'd love to help you!