Skip to content

Latest commit

 

History

History
123 lines (95 loc) · 2.48 KB

README.md

File metadata and controls

123 lines (95 loc) · 2.48 KB

ParaAgent Telegram Bot

Overview

ParaAgent is a Telegram bot that enables users to:

  • Create a pre-generated Para wallet using the /setuptrade <email> command. (The pregenerated wallet is an EVM wallet on Polygon Amoy)
  • Send POL tokens to a specified wallet using the /sendPol <wallet_address> <pol_amount> command.

Project Structure

This project consists of two main components:

  • bot/ - Contains the Telegram bot logic.
  • examples-hub/ - Spins up a server to interact with Para APIs for wallet creation and transaction handling.

Installation & Setup

1. Setting Up examples-hub/

  1. Navigate to the examples-hub/ folder: 
    cd examples-hub
  2. Install dependencies: 
    yarn install
  3. Rename .env.example to .env: 
    mv .env.example .env
  4. Open .env and enter your credentials:
    • Para API Key
    • Encryption Key (generated using OpenSSL or another tool)
  5. Start the server: 
    yarn dev
    The server will now listen on localhost:3000.

2. Setting Up bot/

  1. Navigate to the bot/ folder: 
    cd bot
  2. Install dependencies: 
    npm install
  3. Rename .env.example to .env: 
    mv .env.example .env
  4. Open .env and enter your Telegram Bot Token.
  5. Start the bot: 
    node bot

Usage

1. Create a Para Wallet

/setuptrade <email>

This command generates a wallet for the given email.

2. Send POL Tokens

/sendPol <wallet_address> <pol_amount>

This command sends the specified amount of POL tokens to the given wallet.

Demonstration

Para Signal Bot(1)

Technologies Used

  • Node.js / Telegraf - Telegram Bot & API interactions
  • Yarn / NPM - Package management
  • Express.js - API server in examples-hub/
  • Para API - For wallet creation and transactions
  • OpenSSL - For encryption key generation

Contributing

  1. Fork the repository.
  2. Create a feature branch: 
    git checkout -b feature-branch
  3. Commit changes: 
    git commit -m "Add new feature"
  4. Push to the branch: 
    git push origin feature-branch
  5. Open a pull request.

License

This project is licensed under the MIT License.

Contact

For any questions or support, feel free to reach out!

🚀 Happy coding!