Awesome
<h1 align="center">π· Waves Node</h1> <p align="center"> <a href="https://github.com/wavesplatform/Waves/actions" target="_blank"> <img alt="Checks status" src="https://badgen.net/github/checks/wavesplatform/waves?cache=600" /> </a> <a href="https://github.com/wavesplatform/Waves/releases" target="_blank"> <img alt="Downloads" src="https://badgen.net/github/assets-dl/wavesplatform/waves?color=blue" /> </a> <a href="https://hub.docker.com/r/wavesplatform/wavesnode" target="_blank"> <img alt="Docker pulls" src="https://badgen.net/docker/pulls/wavesplatform/wavesnode?icon=docker" /> </a> <br/> <a href="https://twitter.com/wavesprotocol" target="_blank"> <img alt="Twitter: Waves Tech" src="https://badgen.net/twitter/follow/wavesprotocol?icon=twitter&label=follow%20on%20Twitter" /> </a> <a href="https://medium.com/wavesprotocol" target="_blank"> <img alt="Medium: Waves Tech" src="https://badgen.net/runkit/msmolyakov/get-medium-followers?icon=medium&cache=86400" /> </a> <a href="https://t.me/waves_ride_dapps_dev" target="_blank"> <img alt="Telegram" src="https://badgen.net/badge/icon/Waves%20Dev%20Jedi?icon=telegram&label=Telegram"/> </a> <a href="https://github.com/msmolyakov/awesome-waves" target="_blank"> <img alt="Awesome Waves" src="https://badgen.net/badge/icon/Awesome%20Waves?icon=awesome&label&color=pink" /> </a> </p>Waves is an open source blockchain protocol. <br/> You can use it to build your own decentralized applications. Waves provides full blockchain ecosystem including smart contracts language called RIDE.
β¨ Demo
<p align="center"> <img src="https://user-images.githubusercontent.com/1945126/78667964-88209480-78e2-11ea-9304-72178a6a5974.gif" alt="Waves Node Run Demo"> </p>Waves node is a host connected to the blockchain network with the following functions:
- Processing and validation of transactions
- Generation and storage of blocks
- Network communication with other nodes
- REST API
- Extensions management
Learn more about Waves Node in the documentation.
ποΈ Getting started
A quick introduction of the minimal setup you need to get a running node.
Prerequisites:
Linux systems:
sudo apt-get update
sudo apt-get install openjdk-11-jre
java -jar node/target/waves-all*.jar path/to/config/waves-{network}.conf
Mac systems (assuming already installed homebrew):
brew cask install adoptopenjdk/openjdk/adoptopenjdk11
java -jar node/target/waves-all*.jar path/to/config/waves-{network}.conf
Windows systems (assuming already installed OpenJDK 11):
java -jar node/target/waves-all*.jar path/to/config/waves-{network}.conf
Using docker, follow the official image documentation.
More details on how to install a node for different platforms you can find in the documentation.
π§ Configuration
The best starting point to understand available configuration parameters is this article.
The easiest way to start playing around with configurations is to use default configuration files for different networks; they're available in network-defaults.conf.
Logging configuration with all available levels and parameters is described here.
π¨βπ» Development
The node can be built and installed wherever Java can run. To build and test this project, you will have to follow these steps:
<details><summary><b>Show instructions</b></summary>1. Setup the environment.
- Install Java for your platform:
sudo apt-get update
sudo apt-get install openjdk-11-jre # Ubuntu
# or
# brew cask install adoptopenjdk/openjdk/adoptopenjdk11 # Mac
- Install SBT (Scala Build Tool)
Please follow the SBT installation instructions depending on your platform (Linux, Mac, Windows)
2. Clone this repo
git clone https://github.com/wavesplatform/Waves.git
cd Waves
3. Compile and run tests
sbt checkPR
4. Run integration tests (optional)
Create a Docker image before you run any test:
sbt node-it/docker
- Run all tests. You can increase or decrease number of parallel running tests by changing
waves.it.max-parallel-suites
system property:
sbt -Dwaves.it.max-parallel-suites=1 node-it/test
- Run one test:
sbt node-it/testOnly *.TestClassName
# or
# bash node-it/testOnly full.package.TestClassName
5. Build packages
sbt packageAll # Mainnet
sbt -Dnetwork=testnet packageAll # Testnet
sbt packageAll
βproduces only deb
package along with a fat jar
.
6. Install DEB package
deb
package is located in target folder. You can replace '*' with actual package name:
sudo dpkg -i node/target/*.deb
7. Run an extension project locally during development (optional)
sbt "extension-module/run /path/to/configuration"
8. Configure IntelliJ IDEA (optional)
The majority of contributors to this project use IntelliJ IDEA for development, if you want to use it as well please follow these steps:
- Click
Add configuration
(orEdit configurations...
). - Click
+
to add a new configuration, chooseApplication
. - Specify:
- Main class:
com.wavesplatform.Application
- Program arguments:
/path/to/configuration
- Use classpath of module:
extension-module
- Main class:
- Click
OK
. - Run this configuration.
π€ Contributing
If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.
For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.
Please follow the code of conduct during communication with each other.
βΉοΈ Support (get help)
Keep up with the latest news and articles, and find out all about events happening on the Waves Protocol.
β Links
- Documentation
- Blockchain clients for Mainnet: Waves Exchange, Waves FX, SIGN app
- Blockchain clients for Testnet: Waves Exchange
- Blockchain Explorer: Mainnet, Testnet, Stagenet
- Ride Online IDE
π Licence
The code in this project is licensed under MIT license
π Acknowledgements
We use YourKit full-featured Java Profiler to make Waves node faster. YourKit, LLC is the creator of innovative and intelligent tools for profiling Java and .NET applications.
Take a look at YourKit's leading software products: YourKit Java Profiler and YourKit .NET Profiler.