Telegram Bot Integration
========================

This document outlines the integration of a Telegram bot designed to interact with blockchain functionalities, including minting NFTs, managing wallet sessions, and more.

Bot Commands
------------


Prompt Command
~~~~~~~~~~~~~~

Generates an image based on the provided prompt and initiates an NFT minting process.

.. code-block:: none

   User: /prompt <image description>
   Bot: <Responds with generated image link>

Get Balance
~~~~~~~~~~~

Retrieves the user's wallet balance.

.. code-block:: none

   User: /getbalance
   Bot: Balance for wallet <wallet_id>: <balance>

Wallet Management
-----------------

When a user sends the ``/wallet`` command, the bot initiates the wallet connection process.

.. code-block:: none

    User: /wallet
    Bot: <Instructions and QR code for connecting the wallet>

The bot generates a unique QR code for the user to scan with their wallet application. This QR code is sent as a direct message (DM) to the user to ensure privacy and security.

QR Code Display
~~~~~~~~~~~~~~~

Upon receiving the ``/wallet`` command, the bot responds with a QR code image and connection instructions. The user is expected to scan this QR code with their wallet app to establish a connection.

.. code-block:: none

    Bot: Please scan this QR code with your wallet app to connect.

.. image:: https://kai-docs.nyc3.cdn.digitaloceanspaces.com/wc.png
    :alt: QR code for wallet connection
    :align: center

Wallet Connection Completion
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Once the user successfully scans the QR code and completes the connection process in their wallet app, the bot detects this event and updates the user's session status to "connected."

The bot then automatically removes the QR code from the DM to maintain security and informs the user of the successful connection.

.. code-block:: none

    Bot: Wallet connected successfully! The QR code has been removed for security purposes.

Disconnecting the Wallet
~~~~~~~~~~~~~~~~~~~~~~~~

Users can disconnect their wallets by using the ``/disconnect`` command. This ensures that the session is securely terminated, and the wallet is no longer linked to the Telegram bot.

.. code-block:: none

   User: /disconnect
   Bot: You are now disconnected. Your wallet session has been securely terminated.

Kadena Token Price Lookups
--------------------------

Provides real time price charts and market cap(if supplied) for Kadena fungible Tokens.

.. code-block:: none

   User: /price heron
   Bot: Please type in a Valid price Symbol
  
.. image:: https://kai-docs.nyc3.cdn.digitaloceanspaces.com/telegram/p1.png
    :alt: Price
    :align: center

Minting NFTs
------------

Guide users through the NFT minting process upon receiving an image.

.. code-block:: none

   User: <Sends an image>
   Bot: Please send the name for your NFT.

Tipping
-------

Allows users to tip the bot.  

.. code-block:: none

   User: /tip <amount>
   Bot: Tip processed TX-ID: <transaction_id>

Additional Functionalities
--------------------------

Describes other features such as participating in games, viewing projects, and interacting with DAOs.

.. code-block:: none

   User: /games
   Bot: <Lists available games>

   User: /projects
   Bot: <Describes available projects and integration process>