# ENG

## ⚙️ Installation Requirements: 

Python version 3.11.6 or higher

Download: 

1 | Clone the repository

```bash
git clone https://github.com/0xStarLabs/StarLabs-0G.git
```

```
cd StarLabs-0G
```

2 | Create and activate virtual environment (optional but recommended)

```
python -m venv venv
```

```
venv\Scripts\activate
```

3 | Install dependencies

```bash
pip install -r requirements.txt
```

4 | Launch (after configuration)

```bash
py main.py
```

 

## 📁 Setup (data folder)

Here you can find all user's data necessary for work. \
private\_keys.txt - private keys from wallets. 1 line = 1 key. \
proxies.txt - proxies. 1 line = 1 proxy, or if there are less proxies than accounts, then they will be repeated one after another to be enough for all accounts. \
\
Proxy format is user:pass\@ip:port. \ <mark style="color:yellow;">ONLY HTTP proxies are supported.</mark>

## 📝 Config.yaml&#x20;

This section details each function in the config.yaml file. Most variables are self-explanatory from their names and comments above each one, so I'll describe only the main ones:

DISCORD\_TOKEN\_FOR\_PARSIN

```
SEND_TELEGRAM_LOGS: false - enable logs in telegram

TELEGRAM_BOT_TOKEN: “12317283:lskjalsdfasdfasd-sdfadfasd” - Telegram bot token.
You can find it in BotFather.

TELEGRAM_USERS_IDS: [235123432] - IDs of TG accounts to send logs to.
```

```
FLOW

SKIP_FAILED_TASKS: false - whether to skip failed tasks or not. If it is true,
then the bot will go to do other tasks if the current one failed.
If false, then it will finish the job and start from this task another time.
```

{% code overflow="wrap" %}

```javascript
>>> CAPTCHA
SOLVIUM_API_KEY: “x” - API key https://t.me/solvium_crypto_bot to solve the captcha.

USE_NOCAPTCHA: false - if you want to use nocaptcha.io/register?c=SWVtru, put true here.

NOCAPTCHA_API_KEY: “x” - API key nocaptcha.io/register?c=SWVtru.
```

{% endcode %}

The config can be customized both through a text document in the <mark style="color:yellow;">config.yaml</mark> file and through the web interface (example on the screenshot below).\
To start the web interface, start the bot with the command <mark style="color:yellow;">python main.py</mark> and select menu item <mark style="color:yellow;">\[2] Edit config.</mark>\
**After that the bot will launch the config by URL** [<mark style="color:yellow;">**http://127.0.0.1:**</mark>](http://127.0.0.1:3456)<mark style="color:yellow;">**3456**</mark>**&#x20;which you can open in any browser on your PC and customize the config from there.** By default, the bot itself opens a web browser with the desired URL.\
\&#xNAN;*This config and website is launched and runs locally on your PC.*

After customizing the functions in the config, click the <mark style="color:yellow;">Save Configuration</mark> button in the top right corner of the page.

To exit the config, go back to the console and press <mark style="color:yellow;">CTRL + C</mark> several times, or just close the console.

<figure><img src="/files/mZk5P5pZo7Ma7J0Ikuyb" alt=""><figcaption><p>Config example</p></figcaption></figure>

## ▶️ Usage&#x20;

Before launching the bot, you need to open the tasks.py file in the main project folder and there customize the order of actions as specified in the example. After that you can run the bot with the command python main.py. In the menu you should select 3 and then the database settings will be opened. For the first run press 1 (Create/Reset Database) and the bot creates a database in the data folder. For each key will be generated routes of actions. Also in this menu you will be able to look at the remaining tasks, recreate the database, etc.

Now you can exit the menu with button 6 and start the bot - 1.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://star-labs.gitbook.io/star-labs/software/0g/eng.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.