https://github.com/xterna/cryptos-faucets-bot
Automatically claim crypto faucets.
https://github.com/xterna/cryptos-faucets-bot
Last synced: 12 months ago
JSON representation
Automatically claim crypto faucets.
- Host: GitHub
- URL: https://github.com/xterna/cryptos-faucets-bot
- Owner: XternA
- License: mit
- Created: 2020-12-14T01:23:01.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-02-07T11:56:14.000Z (over 2 years ago)
- Last Synced: 2025-03-30T08:51:16.555Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 45.9 KB
- Stars: 36
- Watchers: 4
- Forks: 13
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## About This Project
A faucet company offering free crypto rolls every hour from Cryptos Faucets. The aim of this script is to automate the rolls and collect the free cryptos.
This was a project developed for personal use and better left ran unattended. You can run this on your computer or server, wherever you choose to run it.
The current coins that's claimed is: **BTC ETH LTC BNB USDT USDC TRON LINK ADA DOGE NEO DASH NEM XRP**
The bot also is capable of applying promo codes that **[Crypto Faucets](https://twitter.com/cryptosfaucets)** occasically publishes, provided the code hasn't been applied to the account before. This allows the account to gain additional coin claims and reset the wait counter.
## Getting Started
In order to run the script, you will require Node.js to be pre-installed first. The script uses a combination of [Node.js](https://nodejs.org/en), [Puppeteer](https://github.com/puppeteer/puppeteer) and [Chromium](https://www.chromium.org).
### Prerequisites
Install Node.js: https://nodejs.org/en/download/
Once installed, using the `Terminal` (Linux/macOS) or `Command Prompt` (Windows), simply execute `npm i` or `npm install` in the directory of this project. Node.js's package manager will then automatically install all the required dependencies from `package.json`.
## Usage
With all the pre-requisites setup and completed the rest is pretty straightforward.
A brief note in case you're not familiar with command line or terminal usage. On Windows, you can simply run the `.bat` file or via Command Prompt by typing in the command.
On Linux and macOS, you will need to run the `.sh` file via a Terminal.
### 1. Bot Configuration
You need to first edit the `config.ini` and supply an email and password. The email and password will be used to sign up and login to claim the rewards across the sites.
#### Credentials
Replace the section `` and `` with your chosen credentials.
```ini
[user]
email=
pass=
```
Rest assured, I'm not interested in your credentials as this is only used by the bot to run locally to automate a human interaction as you would do so manually.
#### Browser
This is not required if the bot works for you. Definately required if you plan to run on a Raspberry Pi.
For instances where the bot fails to run the bundled Chromium browser, you will need to supply a path to a browser, e.g. running on a Raspberry Pi requires it's own compiled version of the Chromium browser so the path has to be supplied.
To supply the browser can be done as example syntax:
**Note: Your browser path may differ.**
```ini
### Windows ###
browserpath=C:\Program Files (x86)\Google\Chrome\Application\chrome.exe
### Linux ###
browserpath=/usr/bin/chromium-browser
```
### 2. Signing Up
You need to first sign up to the Faucet site with an account before you can start claiming the coins.
To make life simpler, there is a `signup.sh/.bat` script that will automatically do the registering for you. It will read the configuration file `config.ini` for the credentials you've provided. All you have to do is just execute the script.
Once the script bot signed up to all the sites, you just need to check your mail box for the email you've used in the `config.ini` and confirm the account creation otherwise the bot won't be able to claim the rewards.
#### Windows
```console
signup.bat
```
#### Linux | macOS
Make sure that the script is executable if it isn't.
```console
chmod +x signup.sh
sh signup.sh
```
### 3. Running the Bot
Running the bot is as simple as executing the `shell (Unix)` or `batch (Windows)` script.
#### Windows
```console
crypto-bot.bat
```
#### Linux | macOS
Make sure that the script is executable if it isn't.
```console
chmod +x crypto-bot.sh
sh crypto-bot.sh
```
### 4. Updating
When changes have been pushed out, you can update the bots to the latest from this repository by invoking `git pull` from the main directory.
In the event that the command failed due to your local changes conflicting, you will need to reset the local changes to default and then pull the latest changes. You can do this with `git reset --hard`. This will revert all changes and you can proceed with pulling the new changes. Note that resetting means you need to re-configure your `config.ini` again.
If after updating, the bot fails when attempting to run, simply remove the `node_modules` completely and re-install the required modules with `npm i`.
To remove the node modules from `Terminal` or `Command Prompt`, invoke:
#### Linux | macOS
```console
rm -rf node_modules
```
#### Windows
```console
rd /q/s node_modules
```
### New Faucets Added
In addition to updates, there may occasionally be new faucets added. If that's the case, after you've update the bots, you can simply run the `signup.sh/bat` script to register any new faucets that have been added.
## Running Unattended
Because it's a script that's ran on console level, you can set the script to run at startup. There are various ways to achieve this.
### Windows
You can use Windows' built-in Task Scheduler to make the script run at startup. You can find out how to do that **[here](https://www.thewindowsclub.com/run-batch-files-silently-on-windows)**.
### Linux | macOS
On UNIX type systems you could use a combination of **[crontab](https://help.dreamhost.com/hc/en-us/articles/215767047-Creating-a-custom-Cron-Job)** and **[screen](https://linuxize.com/post/how-to-use-linux-screen/)** to create a cron job to run on startup. You can choose not to use `screen` if you like.
## Support & Donations
If you choose to register the sites manually instead and or to support the project, kindly register with my referral links. You can also share the links and the bot with others.
**I also accept donations:**
- **BTC:** bc1qq993w3mxsf5aph5c362wjv3zaegk37tcvw7rl4
- **ETH:** 0x2601B9940F9594810DEDC44015491f0f9D6Dd1cA
- **PayPal:** [@xterna](@xterna)
#### Referrals to Faucet
[](https://freebitcoin.io/?ref=366602)
**BTC- https://freebitcoin.io/?ref=366602**
[](https://freeethereum.com/?ref=96650)
**ETH - https://freeethereum.com/?ref=96650**
[](https://free-ltc.com/?ref=27952)
**LTC - https://free-ltc.com/?ref=27952**
[](https://freetether.com/?ref=114067)
**USDT - https://freetether.com/?ref=114067**
[](https://freeusdcoin.com/?ref=75332)
**USDC - https://freeusdcoin.com/?ref=75332**
[](https://freebinancecoin.com/?ref=72163)
**BNB - https://freebinancecoin.com/?ref=72163**
[](https://freechainlink.io/?ref=34381)
**LINK - https://freechainlink.io/?ref=34381**
[](https://freeneo.io/?ref=39047)
**NEO - https://freeneo.io/?ref=39047**
[](https://freecardano.com/?ref=249042)
**ADA - https://freecardano.com/?ref=249042**
[](https://free-doge.com/?ref=14646)
**DOGE - https://freecardano.com/?ref=249042**
[](https://free-tron.com/?ref=100636)
**TRON - https://free-tron.com/?ref=100636**
[](https://freedash.io/?ref=54242)
**DASH - https://freedash.io/?ref=54242**
[](https://coinfaucet.io/?ref=698164)
**XRP - https://coinfaucet.io/?ref=698164**
[](https://freenem.com/?ref=251426)
**NEM - https://freenem.com/?ref=251426**