Sumokoin

Development Resources

Web: www.sumokoin.org
Mail: contact@sumokoin.org

Please note that code is developed on the dev branch, if you want to check out the latest updates, before they are merged on main branch, please refer there. Master branch will always point to a version that we consider stable, so you can download the code by simply typing git clone https://github.com/sumoprojects/sumokoin.git

Introduction

Sumokoin (スモコイン in Japanese) is a fork from Monero, one of the most respectable cryptocurrency well-known for security, privacy, untraceability and active development. Starting as an educational project, we found that it would be great to create a new coin with high level of privacy by (1) moving forward right away to Ring Confidential Transactions (RingCT), (2) setting minimum transaction mixin to 12 that would greatly reduce chance of being attacked, traced or identified by (blockchain) statistical analysis.

Sumokoin, therefore, is a new Monero without its legacy, a truely fungible cryptocurrency among just a few ones in the market.

Coin Supply & Emission

Total supply: 88,888,888 coins in first 20 years, then 263,000 coins each year for inflation. About 10% (~8.8 million) was premined to reserve for future development, i.e. 80 million coins available for community mining.
Coin symbol: SUMO
Coin Units:
- 1 Sumoshi = 0.000000001 SUMO (10-9 - the smallest coin unit)
- 1 Sumokun = 0.000001 SUMO (10-6)
- 1 Sumosan = 0.001 SUMO (10-3)
Hash algorithm: CryptoNight (Proof-Of-Work)
Emission scheme: Sumokoin's block reward changes every 6-months as the following "Camel" distribution* (inspired by real-world mining production like of crude oil, coal etc. that is often slow at first, accelerated in the next few years before declined and depleted). However, the emission path of Sumokoin is generally not far apart from what of Bitcoin (view charts below).

* The emulated algorithm of Sumokoin block-reward emission can be found in Python and C++ scripts at scripts directory.

About this Project

This is the core implementation of Sumokoin. It is open source and completely free to use without restrictions, except for those specified in the license agreement below. There are no restrictions on anyone creating an alternative implementation of Sumokoin that uses the protocol and network in a compatible manner.

As with many development projects, the repository on Github is considered to be the "staging" area for the latest changes. Before changes are merged into that branch on the main repository, they are tested by individual developers in their own branches, submitted as a pull request, and then subsequently tested by contributors who focus on testing and code reviews. That having been said, the repository should be carefully considered before using it in a production environment, unless there is a patch in the repository for a particular show-stopping issue you are experiencing. It is generally a better idea to use a tagged release for stability.

Anyone is welcome to contribute to Sumokoin's codebase! If you have a fix or code change, feel free to submit is as a pull request directly to the "master" branch. In cases where the change is relatively small or does not affect other parts of the codebase it may be merged in immediately by any one of the collaborators. On the other hand, if the change is particularly large or complex, it is expected that it will be discussed at length either well in advance of the pull request being submitted, or even directly on the pull request.

License

Please view LICENSE

Compiling Sumokoin from Source

Dependencies

The following table summarizes the tools and libraries required to build. A few of the libraries are also included in this repository (marked as "Vendored"). By default, the build uses the library installed on the system, and ignores the vendored sources. However, if no library is found installed on the system, then the vendored source will be built and used. The vendored sources are also used for statically-linked builds because distribution packages often include only shared library binaries (.so) but not static library archives (.a).

| Dep | Min. Version | Vendored | Debian/Ubuntu Pkg | Arch Pkg | Optional | Purpose | | -------------- | ------------- | ---------| ------------------ | -------------- | -------- | -------------- | | GCC | 4.7.3 | NO | build-essential | base-devel | NO | | | CMake | 3.0.0 | NO | cmake | cmake | NO | | | pkg-config | any | NO | pkg-config | base-devel | NO | | | Boost | 1.58 | NO | libboost-all-dev | boost | NO | | | OpenSSL | basically any | NO | libssl-dev | openssl | NO | sha256 sum | | BerkeleyDB | 4.8 | NO | libdb{,++}-dev | db | NO | | | libevent | 2.0 | NO | libevent-dev | libevent | NO | | | libunbound | 1.4.16 | YES | libunbound-dev | unbound | NO | | | libminiupnpc | 2.0 | YES | libminiupnpc-dev | miniupnpc | YES | NAT punching | | libunwind | any | NO | libunwind8-dev | libunwind | YES | stack traces | | ldns | 1.6.17 | NO | libldns-dev | ldns | YES | ? | | expat | 1.1 | NO | libexpat1-dev | expat | YES | ? | | GTest | 1.5 | YES | libgtest-dev^ | gtest | YES | test suite | | Doxygen | any | NO | doxygen | doxygen | YES | documentation | | Graphviz | any | NO | graphviz | graphviz | YES | documentation |

[^] On Debian/Ubuntu libgtest-dev only includes sources and headers. You must build the library binary manually. This can be done with the following command sudo apt-get install libgtest-dev && cd /usr/src/gtest && sudo cmake . && sudo make && sudo mv libg* /usr/lib/

Build instructions

Sumokoin uses the CMake build system and a top-level Makefile that invokes cmake commands as needed.

On Linux and OS X

Install the dependencies (see the list above)

- On Ubuntu 16.04, essential dependencies can be installed with the following command:
```
  sudo apt install build-essential cmake libboost-all-dev libssl-dev pkg-config
```
Change to the root of the source code directory and build:
```
 cd sumokoin
 make
```
Optional: If your machine has several cores and enough memory, enable parallel build by running make -j<number of threads> instead of make. For this to be worthwhile, the machine should have one core and about 2GB of RAM available per thread.
The resulting executables can be found in build/release/bin
Add PATH="$PATH:$HOME/sumokoin/build/release/bin" to .profile
Run Sumokoin with sumokoind --detach
Optional: build and run the test suite to verify the binaries:
```
  make release-test
```
NOTE: coretests test may take a few hours to complete.
Optional: to build binaries suitable for debugging:
```
   make debug
```
Optional: to build statically-linked binaries:
```
   make release-static
```
Optional: build documentation in doc/html (omit HAVE_DOT=YES if graphviz is not installed):
```
  HAVE_DOT=YES doxygen Doxyfile
```

On the Raspberry Pi

Tested on a Raspberry Pi 2 with a clean install of minimal Debian Jessie from https://www.raspberrypi.org/downloads/raspbian/

apt-get update && apt-get upgrade to install all of the latest software
Install the dependencies for Sumokoin except libunwind and libboost-all-dev
Increase the system swap size:

	sudo /etc/init.d/dphys-swapfile stop  
	sudo nano /etc/dphys-swapfile  
	CONF_SWAPSIZE=1024  
	sudo /etc/init.d/dphys-swapfile start

Install the latest version of boost (this may first require invoking apt-get remove --purge libboost* to remove a previous version if you're not using a clean install):

	cd  
	wget https://sourceforge.net/projects/boost/files/boost/1.62.0/boost_1_62_0.tar.bz2  
	tar xvfo boost_1_62_0.tar.bz2  
	cd boost_1_62_0  
	./bootstrap.sh  
	sudo ./b2

Wait ~8 hours

sudo ./bjam install
Wait ~4 hours
Change to the root of the source code directory and build:
```
  cd sumokoin
  make release
```
Wait ~4 hours
The resulting executables can be found in build/release/bin
Add PATH="$PATH:$HOME/sumokoin/build/release/bin" to .profile
Run Sumokoin with sumokoind --detach
You may wish to reduce the size of the swap file after the build has finished, and delete the boost directory from your home directory

On Windows:

Binaries for Windows are built on Windows using the MinGW toolchain within MSYS2 environment. The MSYS2 env

Sumokoin

Install / Use

README

Sumokoin

Development Resources

Introduction

Coin Supply & Emission

About this Project

License

Compiling Sumokoin from Source

Dependencies

Build instructions

On Linux and OS X

On the Raspberry Pi

On Windows: