Skip to content

Commit

Permalink
Complete overhaul
Browse files Browse the repository at this point in the history
+ Added documentation
+ Added miner.py
- Removed elapMine,py
/ Updated farmer.py, temp fix for reciving thread stopped
  • Loading branch information
tommarekCZE committed Aug 8, 2024
1 parent 0243fa8 commit 7b7c33b
Show file tree
Hide file tree
Showing 10 changed files with 826 additions and 243 deletions.
7 changes: 7 additions & 0 deletions DEVGUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Official API Guide
### API for interacting with Elaptacoin services


#### **Guide is coming soon...**

###### - Elaptacoin Team 2024, Written by tommarek
130 changes: 130 additions & 0 deletions FARMERSETUP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
# Official ElaptaCoin PoS Farmer
Welcome to the official page of ElaptaCoin Proof of Space Farmer!

**Farming utilizes data drives, proving you have certain file. This does not require much power.**

#### Platform support
1. Windows 10/11 (Theoretically Windows 7)
2. Linux x32/x64
3. ARM x64/x32 (Including Android devices with Termux installed)


**DISCLAIMER: There are few instability issues ongoing with the PoS Farmer currently!**

# ElaptaCoin PoW Miner Setup Guide
## Windows and Linux (Packed Executable)
### 1. Download .zip folder for your targeted platform (Linux/Windows)
You can find the latest release on https://github.com/DuckyPolice/Elaptacoin-PUBLIC/releases/latest
![alt text](images/image-2.png)

### 2. Unzip the zip folder.

### 3. Execute the farmer
Open the farmer, the name of the farmer is `farmer.{deb or exe}`

### 4. Configure the farmer
Close the farmer

Open the file `config.json` that was created in the folder where is the farmer

The inside of `config.json` should look like this:

```
{
"plot_directories": [
"D:\\",
"C:\\Users\\tomma\\Desktop\\elapFarm-1.2.1-windows\\_internal"
],
"username": "jerrbar",
"server_ip": "147.185.221.21:20234"
}
```

Replace `username` with username of your Elaptacoin account
###### Don't have account yet? Follow the guide on [read me page](README.md)

Replace the first entry `D:\\` with existing directory where you want to have your plots

If you want to use linux, you need to use file format. `/home` etc...

###### For example, I am going replace the `D:\\` with `C:\\myfolder`

Save the file.

### 5. Generate the plots
The plots are needed for farming, so you want to generate them

You can create up to 32 plots, each one is 3,8 GB in size. For bigger succes in farming. You want to have all 32 plots. But watch out for your drive size!

So to generate plots, you want to open the farmer again

Then enter `plot` and type number `0` to `32`
###### We recommend to generating plots in order to don't cause chaos in plots

### 6. Start mining
Enter `farm` and start mining!

**There is issue with instability, often the miner can restart itself, to interrupt the restarting process, just press any key.**

## ARM Based Devices
### 1. Download .zip folder with the source code

Make sure you are in `/home/yourusername` directory

Copy the link of the `Source code.zip` https://github.com/DuckyPolice/Elaptacoin-PUBLIC/releases/latest
![alt text](images/image-3.png)

After you copied the link use `wget {link}` to download the `Source code.zip`

### 2. Unzip the zip folder.
Use `unzip {file name}` to unzip the `Source code.zip`


### 3. Execute the farmer
Execute the farmer by entering `python farmer.py`

### 4. Configure the farmer
Close the farmer

Open the file `config.json` that was created in the folder where is the farmer
###### You can use `nano config.json` to edit the config inside bash


The inside of `config.json` should look like this:

```
{
"plot_directories": [
"D:\\",
"C:\\Users\\tomma\\Desktop\\elapFarm-1.2.1-windows\\_internal"
],
"username": "jerrbar",
"server_ip": "147.185.221.21:20234"
}
```

Replace `username` with username of your Elaptacoin account
###### Don't have account yet? Follow the guide on [read me page](README.md)

Replace the first entry `D:\\` with existing directory where you want to have your plots

###### For example, I am going replace the `D:\\` with `/home/tommarek/farmPlots`

Save the file.

### 5. Generate the plots
The plots are needed for farming, so you want to generate them

You can create up to 32 plots, each one is 3,8 GB in size. For bigger succes in farming. You want to have all 32 plots. But watch out for your drive size!

So to generate plots, you want to open the farmer again by `python farmer.py`

Then enter `plot` and type number `0` to `32`
###### We recommend to generating plots in order to don't cause chaos in plots

### 6. Start mining
Enter `farm` and start mining!

**There is issue with instability, often the miner can restart itself, to interrupt the restarting process, just press any key.**

###### - Elaptacoin Team 2024, Written by tommarek
110 changes: 110 additions & 0 deletions MINERSETUP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
# Official ElaptaCoin PoW Miner
Welcome to the official page of ElaptaCoin Proof of Work Miner!

#### Here are features that the miner include:
1. **Auto-Reconnect** - If some expection occur or connection would be lost the miner would restart it self (The restarting could be interupted by pressing any key)

2. **Rust hasher** - For better hashing performance we decided to code the hasher inside the Rust

3. **One File** - Only one file `miner.py` needs to be executed. The rest gets installed afterwards
e
5. **Auto Package Install** - The miner auto install all required packages

#### Platform support
1. Windows 10/11 (Theoretically Windows 7)
2. Linux x32/x64
3. ARM x64 (AArch64)

#### Tech Support
Our discord server: https://discord.com/invite/4MzUF5s6xC

#### **Disclaimer! Keep in mind the miner is still in BETA, lot issues while exiting the miner can occur!**

# ElaptaCoin PoW Miner Setup Guide

## Windows
### 1. Download Python 3.8 or 3.9
We recomend downloading Python 3.8/3.9 from Microsoft Store, if you can't download Python 3.8/3.9 you can download it from Python offical webpage

**_(Note that other versions of Python wouldn't work!)_**

### 2. Download the latest release of PoW ElaptaCoin
You can find the latest release on https://github.com/DuckyPolice/Elaptacoin-PUBLIC/releases/latest

### 3 Un-ZIP the latest release ZIP file

### 4. Open the Un-ZIPed directory in Powershell

### 5. Create and Enter Python virtualenv

**Virtualenv should be part of python, if you don't have it you can install the virtualenv by `pip3.9 install virtualenv` or `python3.8 -m venv venv`

Type `python3.9 -m venv venv` or `python3.8 -m venv venv` to create virtualenv

Then type `venv\Scripts\Activate.ps1` in order to activate virtualenv

Make sure there is `(.venv)` before path in powershell

### 6. Run the miner
**You can use `python` now. Because if the virtualenv is activated the `pyhon` refers to the python in the virtualenv**

To run the miner type `python miner.py` or `python3.9 miner.py` or `python3.8 miner.py`

And Enjoy! If experience some errors let us know on our discord server!

## Linux 64x/32x or Linux ARM x64
### 1. Download Python 3.8 or 3.9
We recomend downloading Python by pyenv

#### 1. Install pyenv
Type `curl https://pyenv.run | bash` to your linux console and wait till setup finishes

#### 2. Add pyenv to .bashrc
Type `sudo nano ~/.bashrc` go to end of the file and add these three lines: `export PATH="$HOME/.pyenv/bin:$PATH"` `eval "$(pyenv init --path)"` `eval "$(pyenv virtualenv-init -)"`

And save the file by pressing `CTRL+X`, press `Y` and then press `Enter`

Then type exec `$SHELL`

#### 3. Install the system packages
Type `sudo apt-get install --yes libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev libgdbm-dev lzma lzma-dev tcl-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev wget curl make build-essential openssl`

Then confirm installation by pressing `Y` and wait till the installation finish

#### 4. Setup pyenv
Update the pyenv by typing `pyenv update`

And install the python by typing `pyenv install 3.9.13` or `pyenv install 3.8.10`

**_(Note that other versions of Python wouldn't work!)_**

### 2. Download the latest release of PoW ElaptaCoin
You can find the latest release on https://github.com/DuckyPolice/Elaptacoin-PUBLIC/releases/latest

### 3 Un-ZIP the latest release ZIP file
You can use `unzip`

We recomend to place the directory with miner to user folder

### 4. Open the Un-ZIPed directory in bash

### 5. Create and Enter Python virtualenv

**Virtualenv should be part of python, if you don't have it you can install the virtualenv by `pip3.9 install virtualenv` or `python3.8 -m venv venv`

Type `python3.9 -m venv venv` or `python3.8 -m venv venv` to create virtualenv

Then type `source myvenv/bin/activate` in order to activate virtualenv

Make sure there is `(.venv)` before path in bash

### 6. Run the miner
**You can use `python` now. Because if the virtualenv is activated the `pyhon` refers to the python in the virtualenv**

**The miner needs to be executed by sudo privileges!**

To run the miner type `python miner.py` or `python3.9 miner.py` or `python3.8 miner.py`

And Enjoy! If experience some errors let us know on our discord server!

###### - Elaptacoin Team 2024, Written by tommarek
54 changes: 54 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Welcome to the official github repository of Elaptacoin

## What is Elaptacoin?
**Elaptacoin is a cryptocurrency project built using Python and Flask, incorporating both Proof of Space and Proof of Work consensus mechanisms.**

**[Official WhitePaper](https://docs.google.com/document/d/1Q3ykT3FgjmfyuQHpgezKyv-QMexi1cVoRwKNHT0IKxk/edit?usp=sharing)**

## How to earn Elaptacoin?
**You can earn Elaptacoin by mining, farming or exchange it for another crypto!**

### 1. Create account
**Go to the [official Elaptacoin website](https://wallet.stormsurge.xyz/) and register.**

### 2. Choose method
**There are three methods for now.**

#### 1. Farming
**Farming utilizes data drives, proving you have certain file. This does not require much power.**

Follow [the guide](FARMERSETUP.md) to start farming.

#### 2. Mining (Power Hungry)
**Mining utilizes CPU (GPU mining coming soon) to find hash that starts with specific amount of leading zeros.**

Follow [the guide](MINERSETUP.md) to start mining.

**DISCLAIMER! DO NOT USE CUSTOM MINERS YET! WAIT TILL POOLS UPDATE**

#### 3. Exchange
**You can also use Exchange to exchange Elaptacoin for other crypto**

**List of exchanges:**
- [ElaptaBot Exchange](https://discord.com/invite/4MzUF5s6xC) (DUCO to ELAP)
+ [OTC Discord Channel](https://discord.com/invite/4MzUF5s6xC)

(More exchanges coming soon)

## Technical specifications

|||
|---|---|
|**Ticker**|**ELAP**|
|**Blockchain**|**Centralized**|
|**Supply Chain**|**1 Million ELAP**|
|**Rewards**|**Variable rewards (Viewable in stats explorer)**|
|**Transactions**|**Instant**|
|**Algorithms**|**PoS: SHAKE128 / PoW: SHA256**|
|**Supported Devices**|**PoS: 3.8GB+ Data Drives / PoW: CPUs (GPUs support coming soon...)**|


## For Developers
[API Guide](DEVGUIDE.md)

###### - Elaptacoin Team 2024, Written by tommarek
8 changes: 8 additions & 0 deletions config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"plot_directories": [
"D:\\",
"C:\\Users\\tomma\\Documents\\GitHub\\Elaptacoin-PUBLIC"
],
"username": "tomma",
"server_ip": "147.185.221.21:20234"
}
Loading

0 comments on commit 7b7c33b

Please sign in to comment.