# Faucet Extractor PoC
This project is a Proof of Concept (PoC) for a faucet extractor. It sends a request to a given URL of a faucet and tries to claim a testnet token.
## Features
- Sends a request to a specified faucet URL
- Attempts to claim testnet tokens
## Requirements
- Python 3.10
- `requests` library
- `python-dotenv` library
## Environment Variables
The following environment variables need to be set before using the project:
- `DISCORD_WEBHOOK_URL` (optional) - Discord webhook URL for notifications
- `ERC20_ADDRESSES` - Comma-separated list of ERC20 addresses
- `BERA_FAUCET_URL` - Bera faucet URL
- `MONAD_FAUCET_URL` - Monad faucet URL
## Installation
### Method 1: Install from PyPI (Recommended)
Install the package directly from PyPI:
```bash
pip install faucet-extractor-poc
```
### Method 2: Install from Source
1. Clone the repository:
```bash
git clone https://github.com/niagarafinance/faucet-extractor-poc.git
```
2. Navigate to the project directory:
```bash
cd faucet-extractor-poc
```
3. Install the package in development mode:
```bash
pip install -e .
```
## Usage
Before running the project, make sure to set the required environment variables.
```bash
export BERA_FAUCET_URL="https://bera-faucet-url.com"
export MONAD_FAUCET_URL="https://monad-faucet-url.com"
```
To run the project, use the appropriate command:
### Using the installed package
```bash
faucet-extractor --faucet MON 0x1234567890123456789012345678901234567890
```
### Multiple addresses with faucet type
```bash
faucet-extractor --faucet BERA 0xAddress1 0xAddress2 0xAddress3
```
### Using environment variable with faucet
```bash
export ERC20_ADDRESSES="0xAddress1,0xAddress2"
faucet-extractor --faucet BERA
```
### Running directly from the source
If you installed from source, you can also run the module directly:
```bash
python -m src.faucet_extractor_poc.extract --faucet MON 0x1234567890123456789012345678901234567890
```
### Show help
```bash
faucet-extractor --help
```
Raw data
{
"_id": null,
"home_page": "https://github.com/niagarafinance/faucet-extractor-poc",
"name": "faucet-extractor-poc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "testnet, faucet, ethereum, erc20, web3",
"author": "Niagara Finance",
"author_email": "niagarafinance@proton.me",
"download_url": "https://files.pythonhosted.org/packages/33/e6/76af2238f97bc4081d4ac31934afe36232cc855b7cb412119c6edfd8768e/faucet_extractor_poc-1.2.1.tar.gz",
"platform": null,
"description": "# Faucet Extractor PoC\n\nThis project is a Proof of Concept (PoC) for a faucet extractor. It sends a request to a given URL of a faucet and tries to claim a testnet token.\n\n## Features\n\n- Sends a request to a specified faucet URL\n- Attempts to claim testnet tokens\n\n## Requirements\n\n- Python 3.10\n- `requests` library\n- `python-dotenv` library\n\n## Environment Variables\n\nThe following environment variables need to be set before using the project:\n\n- `DISCORD_WEBHOOK_URL` (optional) - Discord webhook URL for notifications\n- `ERC20_ADDRESSES` - Comma-separated list of ERC20 addresses\n- `BERA_FAUCET_URL` - Bera faucet URL\n- `MONAD_FAUCET_URL` - Monad faucet URL\n\n## Installation\n\n### Method 1: Install from PyPI (Recommended)\n\nInstall the package directly from PyPI:\n\n```bash\npip install faucet-extractor-poc\n```\n\n### Method 2: Install from Source\n\n1. Clone the repository:\n\n ```bash\n git clone https://github.com/niagarafinance/faucet-extractor-poc.git\n ```\n\n2. Navigate to the project directory:\n\n ```bash\n cd faucet-extractor-poc\n ```\n\n3. Install the package in development mode:\n\n ```bash\n pip install -e .\n ```\n\n## Usage\n\nBefore running the project, make sure to set the required environment variables.\n\n```bash\nexport BERA_FAUCET_URL=\"https://bera-faucet-url.com\"\nexport MONAD_FAUCET_URL=\"https://monad-faucet-url.com\"\n```\n\nTo run the project, use the appropriate command:\n\n### Using the installed package\n\n```bash\nfaucet-extractor --faucet MON 0x1234567890123456789012345678901234567890\n```\n\n### Multiple addresses with faucet type\n\n```bash\nfaucet-extractor --faucet BERA 0xAddress1 0xAddress2 0xAddress3\n```\n\n### Using environment variable with faucet\n\n```bash\nexport ERC20_ADDRESSES=\"0xAddress1,0xAddress2\"\nfaucet-extractor --faucet BERA\n```\n\n### Running directly from the source\n\nIf you installed from source, you can also run the module directly:\n\n```bash\npython -m src.faucet_extractor_poc.extract --faucet MON 0x1234567890123456789012345678901234567890\n```\n\n### Show help\n\n```bash\nfaucet-extractor --help\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Testnet faucet extractor (Proof of Concept)",
"version": "1.2.1",
"project_urls": {
"Homepage": "https://github.com/niagarafinance/faucet-extractor-poc"
},
"split_keywords": [
"testnet",
" faucet",
" ethereum",
" erc20",
" web3"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c762a65917cea86048b90642e65a51975d9cc250cacc5743a083a64bae9f9869",
"md5": "e63fad1bc99e4aeef6b90172b3488764",
"sha256": "9aad65aa3bf7ddea79d4ed9f3a760015b78e12245e44be06f036c6b8413600fd"
},
"downloads": -1,
"filename": "faucet_extractor_poc-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e63fad1bc99e4aeef6b90172b3488764",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 10119,
"upload_time": "2025-03-18T20:42:49",
"upload_time_iso_8601": "2025-03-18T20:42:49.984649Z",
"url": "https://files.pythonhosted.org/packages/c7/62/a65917cea86048b90642e65a51975d9cc250cacc5743a083a64bae9f9869/faucet_extractor_poc-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "33e676af2238f97bc4081d4ac31934afe36232cc855b7cb412119c6edfd8768e",
"md5": "abb59f6ca48765e6a9e1fc9898edfdfe",
"sha256": "3f5d3d187501f6e9aa4874bea7f2943ed15ff6f4bb9ba772af7c767a440dbf7c"
},
"downloads": -1,
"filename": "faucet_extractor_poc-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "abb59f6ca48765e6a9e1fc9898edfdfe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 8376,
"upload_time": "2025-03-18T20:42:51",
"upload_time_iso_8601": "2025-03-18T20:42:51.736500Z",
"url": "https://files.pythonhosted.org/packages/33/e6/76af2238f97bc4081d4ac31934afe36232cc855b7cb412119c6edfd8768e/faucet_extractor_poc-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-18 20:42:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "niagarafinance",
"github_project": "faucet-extractor-poc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "faucet-extractor-poc"
}
JSON
