Sumokoin

Copyright (c) 2017-2021, Sumokoin Projects

Portions Copyright (c) 2014-2021, The Monero Project

Portions Copyright (c) 2012-2013, The Cryptonote developers

Table of Contents

• Development resources
• Coverage
• Introduction
• Coin Supply & Emission
• About this project
• License
• Compiling Sumokoin from source
  • Dependencies
• Using Tor
• Pruning
• Debugging
• Known issues

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

Coverage

| Type | Status | |--------------|-----------| |Workflows |

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 (current minimum mixin set at 48) 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<a name="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 R (cnR, CNv4) (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 | Fedora | Optional | Purpose | | ------------ | ------------- | -------- | -------------------- | ------------ | ------------------- | -------- | --------------- | | GCC | 5.4.0 | NO | build-essential | base-devel | gcc | NO | | | CMake | 3.5 | NO | cmake | cmake | cmake | NO | | | pkg-config | any | NO | pkg-config | base-devel | pkgconf | NO | | | Boost | 1.58 | NO | libboost-all-dev | boost | boost-devel | NO | C++ libraries | | OpenSSL | basically any | NO | libssl-dev | openssl | openssl-devel | NO | sha256 sum | | libzmq | 4.2.0 | NO | libzmq3-dev | zeromq | zeromq-devel | NO | ZeroMQ library | | OpenPGM | ? | NO | libpgm-dev | libpgm | openpgm-devel | NO | For ZeroMQ | | libnorm[2] | ? | NO | libnorm-dev | | | YES | For ZeroMQ | | libunbound | 1.4.16 | YES | libunbound-dev | unbound | unbound-devel | NO | DNS resolver | | libevent | ? | NO | libevent-dev | libevent | libevent-devel | YES | For unbound | libsodium | ? | NO | libsodium-dev | libsodium | libsodium-devel | NO | cryptography | | libunwind | any | NO | libunwind8-dev | libunwind | libunwind-devel | YES | Stack traces | | liblzma | any | NO | liblzma-dev | xz | xz-devel | YES | For libunwind | | libreadline | 6.3.0 | NO | libreadline6-dev | readline | readline-devel | YES | Input editing | | ldns | 1.6.17 | NO | libldns-dev | ldns | ldns-devel | YES | SSL toolkit | | expat | 1.1 | NO | libexpat1-dev | expat | expat-devel | YES | XML parsing | | GTest | 1.5 | YES | libgtest-dev[1] | gtest | gtest-devel | YES | Test suite | | Doxygen | any | NO | doxygen | doxygen | doxygen | YES | Documentation | | Graphviz | any | NO | graphviz | graphviz | graphviz | YES | Documentation | | libhidapi | ? | NO | libhidapi-dev | hidapi | hidapi-devel | YES | Hardware wallet | | libusb | ? | NO | libusb-1.0-0-dev | libusb | libusbx-devel | YES | Hardware wallet | | protoc | ? | NO | protobuf-compiler | protobuf | protobuf-compiler | YES | Hardware wallet | | libudev | ? | No | libudev-dev | systemd | systemd-devel | YES | Hardware wallet |

[1] 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/ [2] libnorm-dev is needed if your zmq library was built with libnorm, and not needed otherwise

Install all dependencies at once on Debian/Ubuntu:

sudo apt update && sudo apt install build-essential cmake pkg-config libssl-dev libzmq3-dev libunbound-dev libsodium-dev libunwind8-dev liblzma-dev libreadline6-dev libldns-dev libexpat1-dev libpgm-dev qttools5-dev-tools libhidapi-dev libusb-1.0-0-dev libudev-dev libboost-chrono-dev libboost-date-time-dev libboost-filesystem-dev libboost-locale-dev libboost-program-options-dev libboost-regex-dev libboost-serialization-dev libboost-system-dev libboost-thread-dev ccache doxygen graphviz

Install all dependencies at once on macOS with the provided Brewfile: