dymensionxyz/cosmos-discord-faucet

A faucet bot for testnets

cosmos-discord-faucet

A Discord bot for dispensing testnet tokens.

Features

• Responds to requests for tokens on multiple testnets
• Response includes a link to the transaction detail in the appropriate block explorer
• Limits the tokens a user can get within a time period for a given testnet
• Limits the tokens an address can get within a time period for a given testnet
• Daily cap for each testnet token
• Requests are saved in local csv file: date, cosmos address, amount, and testnet
• Errors are logged to systemd journal

Requirements

• python 3.8.12+
• dymension v
• Initialized dymension instance
• Faucet keys in dymension keyring

Installation

1. Python dependencies:

cosmos-discord-faucet$ python -m venv .env
cosmos-discord-faucet$ source .env/bin/activate
cosmos-discord-faucet$ pip install -r requirements.txt

1. Create a Discord token
2. Set the bot token as a DISCORD_TOKEN environment variable.
3. Modify the nodes, faucet addresses, amount to send, etc. in config.toml

Usage

This bot can be run stand-alone (mostly for testing), or as a service.

Stand-alone

python cosmos_discord_faucet.py

• This can be run inside a tmux session.

Service

1. Modify the cosmos-discord-faucet.service file as appropriate.
2. Make a copy of cosmos-discord-faucet.service or create a link to it in /etc/systemd/system/.
3. Enable and start the service:

systemctl daemon-reload
systemctl enable cosmos-discord-faucet.service
systemctl start cosmos-discord-faucet.service
systemctl status cosmos-discord-faucet.service

Discord Commands

1. Request tokens through the faucet:
   $request [dymension address] theta|devnet

   • The response will include a ✅ and the transaction hash if it was successful.

2. Request the faucet and node status:
   $faucet_status theta|devnet

3. Request the faucet address:
   $faucet_address theta|devnet

4. Request information for a specific transaction:
   $tx_info [transaction hash ID] theta|devnet

5. Request the address balance:
   $balance [dymension address] theta|devnet

Analytics

The transactions.csv file can be parsed using cosmos_faucet_analytics.py to output faucet usage analytics to a Node Exporter-compatible file.

Analytics Usage

The analytics script can be run stand-alone (mostly for testing), or as a service.

• Modify the log paths and logging period in config_analytics.toml as required.

Analytics Stand-alone

python cosmos_faucet_analytics.py

• This can be run inside a tmux session.

Analytics Service

1. Modify the cosmos-faucet-analytics.service file as appropriate.
2. Make a copy of cosmos-faucet-analytics.service or create a link to it in /etc/systemd/system/.
3. Enable and start the service:

systemctl daemon-reload
systemctl enable cosmos-faucet-analytics.service
systemctl start cosmos-faucet-analytics.service
systemctl status cosmos-faucet-analytics.service

Acknowledgements

This repo is based on cosmos-discord-faucet:

• The cosmospy library calls have been replaced by calls to dymd to avoid deprecated endpoints and messages.
• The address prefix has been switched to cosmos.

cosmos-discord-faucet's Issues

Add optional `netework-id` flag to the balances command so the user will able to fetch balance of only one network

Change the executable to be taken from config vs being hardcoded

As we want to support multiple chains with this discord faucet bot.

Support multiple environments

User will able to receive the rollapp tokens to their hub address

faucet - make sure a user can get 2 fundings per week

as users are requested to fund 2 addresses (sequencer and relayer), and the current faucet limits to 1 per week, we need to change the configuration to allow 2 per week.

Support Celestia network

Failed transaction not being presented as failed

If the transaction submits but fails, for example with status code=13 (insufficent funds) the bot still shows the tx id as if it was succeeded.

Froopyland faucet balance is always empty

Support multiple faucets for different blockchains within the same config

Can't get balance for account

typo in dictionary access. adddress instead of address

Dockerization

Implement Missing Balance Message

Currently, when a transaction is executed in the faucet, and the network does not have a sufficient balance to cover the transaction, the transaction proceeds without failing. This behavior may lead to confusion for users, especially in cases where RollApps frequently do not have sufficient balance.

Display specific error messages for invalid addresses

Currently, when an invalid address is provided in the faucet, the faucet displays a generic error message. however, this can be misleading and unhelpful to users, as the error could result from various address-related issues.

add support for excluding members from faucet limitations

Can't get faucet status

Make faucet HEX (EVM) compatible for dym address

Support Avail network

Utilize the new native-token Field in the Dymension RollApp module

Use the new "native-token" field throughout the dymension RollApp module and replace any existing queries or methods that fetch native token data using the traditional approach.

Dependency:
This issue is dependent on #280.

Use the new network-denom pairs API to improve performances