Web3 Feeds - Firebase Cloud Function & Telegram Bot

A simple Telegram bot designed for reading Web3 news, providing quick access to the latest updates from multiple news providers.

This guide provides instructions for setting up the Web3 Feeds project in two configurations:

1. Hosted Solution: Deploying a Telegram bot on a server.
2. Serverless Solution with Telegram Webhook: Utilizing Firebase Cloud Functions to handle Telegram webhook events.

Hosted Solution

sequenceDiagram
    participant TG as Telegram User
    participant Bot as TG Bot (Hosted)
    participant CF as GCP Cloud Function
    participant RSS as RSS Feeds Providers
    
    TG->>Bot: Sends Message
    Bot->>CF: Handles Event & Calls Cloud Function
    CF->>RSS: Fetches Data in Parallel
    RSS-->>CF: Returns Data
    CF-->>Bot: Sends Processed Data
    Bot-->>TG: Replies with Feed Data

Loading

1. Clone the Repository

git clone https://github.com/2b1q/web3-feeds.git
cd web3-feeds

Firebase Cloud Function - RSS Feed Proxy

Setup

1. Clone the repository:

   git clone [email protected]:2b1q/web3-feeds.git
   cd web3-feeds

2. Initialize Firebase project:

   firebase init functions

   • Choose TypeScript
   • Enable ESLint (N)
   • Select your Firebase project

3. Install dependencies:

   cd functions
   npm install

Deploy Cloud Functions

Deploy the Cloud Functions:

firebase deploy --only functions

Make sure to set your API key:

# Set YOUR_API_KEY

Usage

Make a request using your API key:

curl -X GET https://us-central1-YOUR_PROJECT_ID.cloudfunctions.net/getAllFeeds \
     -H \"Authorization: Bearer YOUR_API_KEY\" -s | jq .

---

Telegram Bot Setup

1. Create a Telegram Bot

• Open Telegram and search for @BotFather
• Start a conversation and run:

  /newbot

• Follow the instructions to set a bot name and username.
• Copy the provided bot token.

2. Configure Environment Variables

Create a .env file inside the bot directory:

cd bot
touch .env

Add the following:

BOT_TOKEN=YOUR_TELEGRAM_BOT_TOKEN
CF_API_TOKEN=YOUR_API_KEY

3. Install Dependencies

cd bot
npm install

4. Run the Bot Locally

node index.js

5. Deploy the Bot (Optional)

To keep your bot running continuously, deploy it to a server or use a process manager like pm2:

pm2 start index.js --name web3-feeds-bot
pm2 save

---

Serverless Telegram Bot with Cloud Functions

sequenceDiagram
    participant TG as Telegram User
    participant API as Telegram API
    participant CF as Cloud Function (Serverless)
    participant RSS as RSS Feeds providers
    
    TG->>API: Sends Message
    API->>CF: Triggers Webhook
    CF->>RSS: Fetches Data in Parallel
    RSS-->>CF: Returns Data
    CF-->>API: Sends Processed Data
    API-->>TG: Replies with Feed Data

Loading

Setup Cloud Function as Webhook

1. Deploy your webhook function:

firebase deploy --only functions:telegramBotWebhook

2. Set the Telegram webhook URL:

Replace YOUR_BOT_TOKEN and YOUR_WEBHOOK_URL with your actual values:

curl -X GET \"https://api.telegram.org/botYOUR_BOT_TOKEN/setWebhook?url=YOUR_WEBHOOK_URL\"

Example webhook URL:

https://us-central1-YOUR_PROJECT_ID.cloudfunctions.net/telegramBotWebhook

After successful webhook registration, Telegram will send all updates to your Cloud Function.

---

Telegram Bot Commands

Command	Description
/start	Get started with the bot
/news	Fetch latest 3 news from all providers
/news [provider]	Get latest news from a specific provider (coindesk, cointelegraph, decrypt)
/news [provider] [n]	Get last n news items from a provider
/news all [n]	Get last n news items from all providers

---