What is Runebase?
Runebase is a decentralized blockchain project built on Bitcoin's UTXO model, with support for Ethereum Virtual Machine based smart contracts, and secured by a proof of stake consensus model. It achieves this through the revolutionary Account Abstraction Layer which allows the EVM to communicate with Runebase's Bitcoin-like UTXO blockchain. For more general information about Runebase as well as links to join our community, go to https://runebase.org
Welcome to the Runebase Ignition Main Network. This is the main network where the tokens hold value and should be guarded very carefully. If you are testing the network, or developing unstable software on Runebase, we highly recommend using either testnet or regtest mode.
The major features of the Runebase network include:
- Compatibility with the Ethereum Virtual Machine, which allows for compatibility with most existing Solidity based smart contracts. No special solidity compiler is required to deploy your smart contract to Runebase.
- A Proof of Stake consensus system which is optimized for Runebase's contract model. Any user can stake and help to secure the network. There is no voting, master nodes, or minimum amount required. There have been transactions as small as 2 Runebase that have created blocks in the past.
- The Decentralized Governance Protocol is completely implemented and functional, which allows certain network parameters to be modified without a fork or other network disruption. This currently controls parameters like block size, gas prices, etc.
- Uses the UTXO transaction model and is compatible with Bitcoin, allowing for existing tooling and workflows to be used with Runebase. This allows for the infamous SPV protocol to be used which is ideal for light wallets on mobile phones and IoT devices.
Note: Runebase Core is considered beta software. We make no warranties or guarantees of its security or stability.
Runebase Documentation and Usage Resources
These are some resources that might be helpful in understanding Runebase. Note that the unofficial documents are not created by the Runebase team.
Basic usage resources:
- Official Runebase Usage Guide
- Unofficial Runebase staking tutorial
- Unofficial Runebase staking tutorial on Raspberry Pi
- Unofficial guide for keeping your wallet safe
- Block explorer
- Unofficial block explorer
- Unofficial Raspberry Pi Web UI
- Deploying a custom token to Runebase
- Early example faucet contract
- Unofficial Runebase Hello World tutorial
- Runebase Book - A Developer's Guide To RUNEBASE
General Info about Runebase:
- Mainnet event AMA
- Runebase's PoS vs CASPER
- Technical article explaining Runebase's PoS model in depth
- Unofficial What is Runebase article
- Smart contract deployment tool
- A toolkit for building runebase light wallets
- CORS runebased RPC proxy for DApp
- Docker images for running runebase services
- HTTP API that powers the block explorer and the RUNEBASE web wallet
What is Runebase Core?
Runebase Core is our primary mainnet wallet. It implements a full node and is capable of storing, validating, and distributing all history of the Runebase network. Runebase Core is considered the reference implementation for the Runebase network.
Runebase Core currently implements the following:
- Sending/Receiving Runebase
- Sending/Receiving QRC20 tokens on the Runebase network
- Staking and creating blocks for the Runebase network
- Creating and interacting with smart contracts
- Running a full node for distributing the blockchain to other users
- "Prune" mode, which minimizes disk usage
- Regtest mode, which enables developers to very quickly build their own private Runebase network for Dapp testing
- Compatibility with the Bitcoin Core set of RPC commands and APIs
Runebase Core uses a full node model, and thus requires downloading the entire blockchain. If you do not need the entire blockchain, and do not intend on developing smart contracts, it may be more ideal to use an alternative wallet such as one of our light wallets that can be synchronized in a matter of seconds.
A light wallet that supports the Ledger hardware wallet and is based on the well known Electrum wallet software.
iOS and Android Wallets
These wallets run on mobile devices and synchronize quickly.
Android Download: https://play.google.com/store/apps/details?id=org.runebase.wallet
iOS Download: https://github.com/runebase/runebase-ios (open source, we are still working with Apple to get approval for their app store)
Ledger Chrome Wallet
This light wallet runs in your Chrome browser as a browser extension. This wallet requires a Ledger device to use.
Building Runebase Core
Build on Ubuntu
This is a quick start script for compiling Runebase on Ubuntu sudo apt-get install build-essential libtool autotools-dev automake pkg-config libssl-dev libevent-dev bsdmainutils git cmake libboost-all-dev sudo apt-get install software-properties-common sudo add-apt-repository ppa:bitcoin/bitcoin sudo apt-get update sudo apt-get install libdb4.8-dev libdb4.8++-dev # If you want to build the Qt GUI: sudo apt-get install libqt5gui5 libqt5core5a libqt5dbus5 qttools5-dev qttools5-dev-tools libprotobuf-dev protobuf-compiler qrencode git clone https://github.com/runebase/runebase --recursive cd runebase # Note autogen will prompt to install some more dependencies if needed ./autogen.sh ./configure make -j2
Build on CentOS
Here is a brief description for compiling Runebase on CentOS, for more details please refer to the specific document
# Compiling boost manually sudo yum install python-devel bzip2-devel git clone https://github.com/boostorg/boost.git cd boost git checkout boost-1.66.0 git submodule update --init --recursive ./bootstrap.sh --prefix=/usr --libdir=/usr/lib64 ./b2 headers sudo ./b2 -j4 install # Installing Dependencies for Runebase sudo yum install epel-release sudo yum install libtool libdb4-cxx-devel openssl-devel libevent-devel # If you want to build the Qt GUI: sudo yum install qt5-qttools-devel protobuf-devel qrencode-devel # Building Runebase git clone --recursive https://github.com/runebase/runebase.git cd runebase ./autogen.sh ./configure make -j4
Build on OSX
The commands in this guide should be executed in a Terminal application.
The built-in one is located in
Install the OS X command line tools:
When the popup appears, click
Then install Homebrew.
brew install cmake automake berkeley-db4 libtool boost --c++11 --without-single --without-static miniupnpc openssl pkg-config protobuf qt5 libevent imagemagick --with-librsvg qrencode
NOTE: Building with Qt4 is still supported, however, could result in a broken UI. Building with Qt5 is recommended.
Build Runebase Core
Clone the runebase source code and cd into
git clone --recursive https://github.com/runebase/runebase.git cd runebase
Configure and build the headless runebase binaries as well as the GUI (if Qt is found).
You can disable the GUI build by passing
./autogen.sh ./configure make
It is recommended to build and run the unit tests:
Then you can either run the command-line daemon using
src/runebase-cli, or you can run the Qt GUI using
For in-depth description of Sparknet and how to use Runebase for interacting with contracts, please see sparknet-guide.
Runebase is GPLv3 licensed.
master branch is regularly built and tested, but is not guaranteed to be
completely stable. Tags are created
regularly to indicate new official, stable release versions of Runebase.
The contribution workflow is described in CONTRIBUTING.md.
Developer IRC can be found on Freenode at #runebase-dev.
Testing and code review is the bottleneck for development; we get more pull requests than we can review and test on short notice. Please be patient and help out by testing other people's pull requests, and remember this is a security-critical project where any mistake might cost people lots of money.
Developers are strongly encouraged to write unit tests for new code, and to
submit new unit tests for old code. Unit tests can be compiled and run
(assuming they weren't disabled in configure) with:
make check. Further details on running
and extending unit tests can be found in /src/test/README.md.
There are also regression and integration tests, written
in Python, that are run automatically on the build server.
These tests can be run (if the test dependencies are installed) with:
Manual Quality Assurance (QA) Testing
Changes should be tested by somebody other than the developer who wrote the code. This is especially important for large or high-risk changes. It is useful to add a test plan to the pull request description if testing the changes is not straightforward.