The world's first HDD-mined cryptocurrency using an energy efficient and fair Proof-of-Commitment (PoC+) consensus algorithm running since August 2014.
See CONTRIBUTING.md
- Proof of Commitment - ASIC proof / Energy efficient and sustainable mining
- No ICO/Airdrops/Premine
- Fully Community Driven
- Turing-complete smart contracts, via SmartJ and SmartC
- Asset Exchange; Updateable On-chain Data (Aliases), Naming System, Crowdfunds, NFTs, games, and more (via smart contracts)
- Block time is 4 minutes
- Block size is 375,360 byte
- Minimum transaction size is 184 bytes
- Minimum network fee is 0.01 Signa
- Transactions per second is at least 16
- Smart Transactions per second (multiple payouts) is up to 5,000 STPS
- Maximum 1,200,000 balance changes per block
- Total Supply: 2,138,119,200 SIGNA up to block 972k + 100 SIGNA per block after that
- Block reward started at 10,000/block in 2014
- Block reward decreased at 5% each month with a minimum mining incentive of 100 SIGNA per block
- Automated burning of subscription interval payment fees and smart contract step fees from block 1,029,000 SIP-36
- Decentralized Peer-to-Peer network with spam protection
- Built in Java - runs anywhere, from a Raspberry Pi to a Phone
- Fast sync with multithreaded CPU or, optionally, an OpenCL GPU
- HTTP API for clients to interact with network
- Interactive OpenAPI Documentation
Any recent 64-bit Windows should suffice. To install Java 21, follow these steps:
- Download the latest JDK 21 installer for Windows from the official Oracle JDK website.
- Run the installer and follow the setup instructions.
- Add the JDK
bindirectory (e.g.,C:\Program Files\Java\jdk-21\bin) to your system's PATH environment variable if it's not added automatically.
You need Java 64-bit 21 installed.
For Linux: Install the openjdk-21-jre or openjdk-21-jdk package depending on your distribution:
- On Debian/Ubuntu:
sudo apt install openjdk-21-jdk - On Fedora:
sudo dnf install java-21-openjdk - On Arch Linux:
sudo pacman -S jdk-openjdkFor macOS: Install Java 21 using Homebrew: - Run
brew install openjdk@21 - Add the JDK to your shell profile if not done automatically, e.g.,
export PATH="/usr/local/opt/openjdk@21/bin:$PATH"for Bash/Zsh To check your Java version, runjava -version. You should get an output similar to the following:
openjdk version "21.0.1" 2023-09-19
OpenJDK Runtime Environment (build 21.0.1+12-arch)
OpenJDK 64-Bit Server VM (build 21.0.1+12-arch, mixed mode, sharing)
The important part is that the Java version starts with 21. (Java 21)
Tipp: Use SDKMAN! for easy installation of Java 21
Signum Node uses an embedded file based database (H2) as default. But it's possible to use either MariaDB or PostgreSQL as alternative database.
The minimum required version of MariaDB is 10.6.
H2 is a very fast file based (embedded) database is marked for deprecation due to instability. Signum Node builds up the entire database out of the box and does not require any further set up.
This makes H2 an interesting choice especially for less-technical users who just want to start and/or run a local (not publicly accessible) node. It is strongly recommended to migrate to an alternative like SQLite as H2 will be removed soon.
Choose this, if you want to run just a local node without public exposure and/or
you don't want to connect to the database while running the node. Furthermore, the resulting database file is easily shareable, such others can use a snapshot and sync from there.
Update: H2 has proven to be unstable and is officially marked for deprecation. Migration is advised immediately. Refer to supported alternatives like SQLite, MariaDB, or PostgreSQL. Update: H2 has proven to be unstable. We do not recommend the usage of H2 anymore
Sqlite is just like H2 a file based (embedded) database. Signum Node builds up the entire database out of the box and does not require any further set up. This makes Sqlite an interesting choice especially for less-technical users who just want to start and/or run a local (not publicly accessible) node. Choose this, if you want to run just a local node without public exposure. Furthermore, the resulting database file is easily shareable, such others can use a snapshot and sync from there. Sqlite is considered as a replacement for H2.
MariaDB and PostgreSQL on the other hand require an additional set-up. It is the better choice for publicly accessible nodes, as they are considered more stable, especially under higher load.
MariaDB and PostgreSQL are not as fast as H2, so expect higher re-synchronisation times. The performance hit for MariaDB and PostgreSQL is related to the TCP/IP connection, which is per se slower than File-IO (especially for SSDs). Due to that model concurrent access is possible, i.e. one can run an additional service against the same database, which is not possible with H2, as the file gets locked.
| Stability | Speed | Setup | Backup | Concurrency | Purpose | |
|---|---|---|---|---|---|---|
| - (1) | ⭐⭐⭐ | ⭐⭐⭐ | ⭐⭐⭐ | ❌ | Local Node [DEPRECATED] | |
| Sqlite | ⭐⭐ | ⭐⭐* | ⭐⭐⭐ | ⭐⭐⭐ | ✅ (3) | Local Node |
| MariaDB | ⭐⭐ | ⭐ | ⭐ | ⭐ | ✅ | Public Node, Additional Services |
| PostgreSQL | ⭐⭐ (2) | ⭐ | ⭐ | ⭐ | ✅ | Public Node, Additional Services |
(1) DEPRECATED - H2 - even with updated Version 2 - has proven to be unstable and causing database issues - mostly File I/O exceptions, OOM and data inconsistencies. It will be removed with 3.9, so move to sqlite
(2) PostgreSQL support is still experimental. So, stability needs to be proven over time, but in general Postgres itself is as least stable/reliable as MariaDB.
(3) Sqlite supports concurrent reading. Writing is still limited to one writer at a time.
See in the following documents how to set up for different database
Grab the latest release (or, if you prefer, compile yourself using the instructions below)
In the conf directory, copy node-default.properties into a new file named node.properties and modify this file to suit your needs (See "Configuration" section below)
To run the node, double click on signum-node.exe (if on Windows) or run java -jar signum-node.jar.
On most systems this will show you a monitoring window and will create a tray icon to show that Signum node is running. To disable this, instead run java -jar signum-node.jar --headless.
Starting with the release version 3.3.0 and higher the concept of the config file changed. To run the node for mainnet with the default options, no configuration change is needed.
All default/recommended parameters are defined in code by the Signum Node but you can overwrite the parameter within the config file to suit your needs.
The default values for the available settings are shown in the conf/node-default.properties file as commented out.
Configure your cash-back
As an incentive for users to run their own full nodes, SIP-35 introduced the concept of fee cash-back. In order to receive the 25% cashback on the fees for transactions created by your node, set your own account ID in the configuration file:
node.cashBackId = 8952122635653861124Note: the example ID above 8952122635653861124 is the SNA account.
The cash-back is paid from block 1,029,000.
SQLite/MariaDB
By default Signum Node is using SQLite (file based) as database.
If you like to use MariaDB you will need to adjust your conf/node.properties:
#### DATABASE ####
DB.Url=jdbc:mariadb://localhost:3306/signum
DB.Username=
DB.Password=Please modify the DB.Url to your own specifications (port 3306 is the standard port from MariaDB) and also set the DB.Username and DB.Password according your setup for the created database.
UPnP-Portforwarding
By default the UPnP port forwarding is activated. If you run the node on a VPS you can deactivate this by setting it to "no".
## Port for incoming peer to peer networking requests, if enabled.
# P2P.Port = 8123
## Use UPnP-Portforwarding
P2P.UPnP = noEnable SNR
If you set on the P2P.myPlatform a valid Signum address and you fulfill the SNR requirements your node aka the set Signum address will be rewarded with the SNR.
The SNR (Signum Network Reward) is a community driven bounty paid to all node-operators which run continuous (uptime > 80%) and with the newest release a Signum node.
## My platform, to be announced to peers.
## Enter your Signum address here for SNR rewards, see here: https://signum.community/signum-snr-awards/
P2P.myPlatform = S-ABCD-EFGH-IJKL-MNOPYou can check your node using the explorer.
The Signum Node is not hardware demanding nor it needs a fast internet connection. The specifications for the hardware is as follows:
- Minimum : 1 vCPU, 1 GB RAM, 20 GB HD, Minimum Swapfile 2GB (Linux)
- Recommended : 2 vCPU, 2 GB RAM, 20 GB HD, Minimum Swapfile 4GB (Linux)
Tuning options
If you run the minimum requirement you can turn off the indirectIncomingService in the config file to reduce CPU and file usage. By default this parameter is activated.
## Enable the indirect incoming tracker service. This allows you to see transactions where you are paid
## but are not the direct recipient eg. Multi-Outs.
node.indirectIncomingService.enable = falseStarting with the Signum node version 3.3.0 and higher the node is able to handle different chains in a multiverse manner. All parameters for a different chain are set in the code section of the node and can be activated by pointing to the other chain aka universe in the config file. No additional setting is needed.
In order to run a testnet node adjust your conf/node.properties to:
## Run with a different network
# Testnet network
node.network = signum.net.TestnetNetworkIf no custom DB is set, a H2 file will be created as db/signum-testnet.mv.db.
For a MariaDB setup you need to configure a testnet instance in the config file.
In order to run a private (local) chain with mock mining just select the network:
node.network = signum.net.MockNetworkThis will allow you to forge new blocks as soon as you submit a new nonce. Note that P2P is disabled when running in this mode.
Since Version 3.4.3 the new interactive API documentation based on OpenAPI Spec V3 is shipped and active by default.
You can access it via <host>:8125/api-doc (or <host>:6876/api-doc for Testnet respectively).
Read more about the documentation
Run these commands (the main branch is always the latest stable release):
git clone https://github.com/signum-network/signum-node.git
cd signum-node
./gradlew distYour packaged release will now be available in the build/distribution directory.
Clone the repository as instructed above and run these commands:
git switch develop
./gradlew distYour packaged release will now be available in the build/distribution directory.
Please note that development builds will refuse to run outside of testnet or a private chain
Clone the repository as instructed above and run:
./gradlew testEach Node Distribution has the latest wallet versions (at time of distribution) included automatically. Usually, no further action is required.
The Phoenix Wallet and Classic Wallet are maintained in separate repositories and must be installed before usage. This approach ensures that both wallets can be updated independently without requiring a full deployment of the node. Scripts for installing and updating both wallets are available in the distribution package. Users can execute them as needed to ensure they are using the latest versions.
This is only for users building the node software locally and not using the binary distribution packages
During the first run of the node, both the Classic Wallet and Phoenix Wallet must be installed manually using their respective scripts.
To install the Phoenix Wallet:
Run ./update-phoenix.sh (available in the distribution package).
To update or install the Classic Wallet:
Run ./update-classic.sh (available in the distribution package).
Note for Windows users: As the installation scripts are designed for BSD/GNU Linux environments and are not natively supported on Windows, Windows users should use Windows Subsystem for Linux (WSL) to execute these commands.
Steps to install WSL:
- Open PowerShell as Administrator and run:
wsl --install - Follow the instructions to set up a Linux distribution on your system.
Once WSL is set up, access the distribution and navigate to the folder containing the scripts. Then run:
./update-phoenix.sh
./update-classic.shTo cut a new (pre)-release just create a tag of the following format vD.D.D[-suffix]. Githubs actions automatically creates
a pre-release with entirely build executable as zip.
git tag v3.0.1-beta
git push --tagsSee DOCKER.md for information on running and building docker images.
To get more details about how to work with database changes look at more detailed docs.
Main Developer: jjos2372. Donation address: S-JJQS-MMA4-GHB4-4ZNZU
Frequent Contributors:
- ohager. Donation address: S-9K9L-4CB5-88Y5-F5G4Z
- damccull. Donation address: S-GXBA-7JP9-NR7S-DCQ4V
- ipr0310. Donation address: S-36WQ-GYQN-D856-9DUJH
- frankTheTank72
For more information, see Credits