Simple, elegant, fast, Layer-1 blockchain based cryptocurrency written in 6k lines of C++
MIT License
30
stars
40
forks
source link
readme
Pandanite
[Pandanite](http://www.bamboocrypto.io) is a minimalist implementation of a layer 1 cryptocurrency similar to Bitcoin. It is designed with utmost simplicity and user friendliness in mind and is written from the ground up in C++ — it isn't yet another re-packaging of existing open-source blockchain code (where's the fun in that?!).
### Circulation
Pandanite is minted by miners who earn rewards. Mining payments occur using the *thwothirding* algorithm, which yields a total final circulation of ~99.1M PDN:
- 6647477.8490 PDN carried over from previous forks distributed
- 50 PDN per block at Heights 1 to 515736
- 50\*(2/3) PDN per block from blocks 515737 to 515736+666666
- 50\*(2/3)^2 PDN per block from blocks 515736+666667 to 515736+2\*666666
etc.
#### Comparison with halving
Block reward changes are more often and have less impact compared to halving:
The payout curve is smoother in twothirding compared to halving:
### Technical Implementation
Pandanite is written from the ground up in C++. We want the Pandanite source code to be simple, elegant, and easy to understand. Rather than adding duct-tape to an existing currency, we built Pandanite from scratch with lots of love. There are a few optimizations that we have made to help further our core objectives:
* Switched encryption scheme from [secp256k1](https://github.com/bitcoin-core/secp256k1) (which is used by ETH & BTC) to [ED25519](https://ed25519.cr.yp.to/) -- results in 8x speedup during verification and public keys half the size.
* Up to 25,000 transactions per block, 90 second block time
### Getting Started
*Windows*:
Windows is not currently supported as a build environment. You may run the [dcrptd miner](https://github.com/De-Crypted/dcrptd-miner/releases) to mine Pandanite
*Mac OSX* build pre-requirements
```
brew install leveldb
brew install cmake
pip3 install conan
```
*Ubuntu 18.04 LTS* install pre-requirements
```
sudo apt update
sudo apt-get -y install make cmake automake libtool python3-pip libleveldb-dev curl git
sudo update-alternatives --install /usr/bin/python python /usr/bin/python3.6 1
sudo pip3 install conan==1.59
```
*Ubuntu 20.04 LTS* install pre-requirements
```
sudo apt-get update
sudo apt-get -y install make cmake automake libtool python3-pip libleveldb-dev curl git
sudo update-alternatives --install /usr/bin/python python /usr/bin/python3.8 1
sudo pip3 install conan==1.59
```
*Ubuntu 22.04 LTS* install pre-requirements
```
sudo apt-get update
sudo apt-get -y install make cmake automake libtool python3-pip libleveldb-dev curl git
sudo update-alternatives --install /usr/bin/python python /usr/bin/python3.10 1
sudo pip3 install conan==1.59
```
### Building
```
git clone https://github.com/pandanite-crypto/pandanite
cd pandanite
mkdir build
cd build
conan install .. --build=missing
cd ..
cmake .
```
*Ubuntu 18.04 Requires a code change to build server
in src/server/server.cpp change:
```
Line 10
#include
to
#include
Lines 50, 52, & 58
std::filesystem::...
to
std::experimental::filesystem::...
```
To compile the miner run the following command:
```
make miner
```
You will also need the keygen app to create a wallet for your miner:
```
make keygen
```
To compile the node server:
```
make server
```
To compile a simple CLI tool that lets you send PDN:
```
make cli
```
For a separate, interactive GUI wallet see https://github.com/pandanite-crypto/pandanite-wallet
### Usage
Start by generating `keys.json`.
```
./bin/keygen
```
***Keep a copy of this file in a safe location*** -- it contains pub/private keys to the wallet that the miner will mint coins to. If you lose this file you lose your coins. We recommend keeping an extra copy on a unique thumbdrive (that you don't re-use) the moment you generate it.
To start mining:
```
./bin/miner
```
To host a node:
```
./bin/server
```
Some server running args:
```
-n (Custom Name, shows on peer list)
-p (Custom Port, default is 3000)
--testnet (Run in testnet mode, good for testing your mining setup)
```
Full list of arguments can be found here: https://github.com/pandanite-crypto/pandanite/blob/master/src/core/config.cpp
To send PDN to another address (run with --local flag if the server you want to use is listening on localhost):
```
./bin/cli
```
### Docker
Pandanite is pre-built for amd64 and arm64 with [GitHub Actions](https://github.com/pandanite-crypto/pandanite/actions) and distributed with the [GitHub Container Registry](https://github.com/pandanite-crypto/pandanite/pkgs/container/pandanite)
#### Running with Docker
with `docker`
```shell
docker run -d --name pandanite -p 3000:3000 -v $(pwd)/pandanite-data:/pandanite/data ghcr.io/pandanite-crypto/pandanite:latest server
docker logs -f pandanite
```
You can follow the progress of server sync from `http://localhost:3000`
Running with `docker-compose` is recommended to easily add more options like cpu usage limits and a health checks:
```yaml
version: '3.4'
services:
pandanite:
image: ghcr.io/pandanite-crypto/pandanite:latest
command: server
ports:
- 3000:3000
volumes:
- ./pandanite-data:/pandanite/data
restart: unless-stopped
cpus: 8
healthcheck:
test: ["CMD", "curl", "-sf", "http://127.0.0.1:3000"]
interval: 10s
timeout: 3s
retries: 3
start_period: 10s
```
#### Building with docker
Clone this repository and then
```shell
docker build . -t pandanite
docker run [OPTIONS] pandanite server
```
Running CI build locally
```shell
docker run --privileged --rm tonistiigi/binfmt --install all
docker buildx create --use
GITHUB_REPOSITORY=NeedsSomeValue GITHUB_SHA=NeedsSomeValue docker buildx bake --progress=plain
```