Thanks to visit codestin.com
Credit goes to github.com

Skip to content

borshchevik/borsh

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

What is Borshchevik?

Borshchevik is a decentralized blockchain project forked from Qtum, 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 Borshchevik's Bitcoin-like UTXO blockchain. For more general information about the original Qtum blockchain, go to https://qtum.org

Welcome to the Borshchevik 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 Borshchevik, we highly recommend using either testnet or regtest mode.

The major features of the Borshchevik network include:

  1. 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 Borshchevik.
  2. A Proof of Stake consensus system which is optimized for Borshchevik's contract model. Any user can stake and help to secure the network.
  3. 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.
  4. Uses the UTXO transaction model and is compatible with Bitcoin, allowing for existing tooling and workflows to be used with Borshchevik. This allows for the infamous SPV protocol to be used which is ideal for light wallets on mobile phones and IoT devices.

Note: Borshchevik Core is considered beta software. We make no warranties or guarantees of its security or stability.

Borshchevik Documentation and Usage Resources

These are some resources that might be helpful in understanding Borshchevik.

Basic usage resources:

Block explorer

What is Borshchevik Core?

Borshchevik Core is our primary mainnet wallet. It implements a full node and is capable of storing, validating, and distributing all history of the Borshchevik network. Borshchevik Core is considered the reference implementation for the Borshchevik network.

Borshchevik Core currently implements the following:

  • Sending/Receiving BORSH coins
  • Sending/Receiving BRC20 tokens on the Borshchevik network
  • Staking and creating blocks for the Borshchevik 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 Borshchevik network for Dapp testing
  • Testnet mode, using the public Borshchevik Testnet, with faucet available
  • Compatibility with the Bitcoin Core set of RPC commands and APIs
  • Full SegWit capability with p2sh-segwit (legacy) and bech32 (native) addresses

Alternative Wallets

Borshchevik 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.

Borshchevik Web Wallet

A browser wallet that supports the Ledger hardware wallet, offline cold wallet, restoration from mobile wallets, creation of QRC20 tokens and QRC1155 NFTs.

Web site https://borshwallet.com

Community Resources

Make sure to check out these resources as well for more information and to keep up to date with all the latest news about Borshchevik. At least 1 developer is always around, so if you're developing on Borshchevik and need help, we'd love to welcome you to our community.

Website
Telegram
GitHub

Borshchevik Smart Contract Limitations

  • EVM smart contracts cannot receive coins from or send coins to any address type other than pay-to-pubkeyhash (starts with Q) addresses. This is due to a limitation in the EVM
  • Contracts are not allowed to create contracts with an initial endowment of coins. The contract must first be created, and then be sent coins in a separate transaction. Humans are also not allowed to create contracts with an initial endowment of coins.
  • Although all of the infrastructure is present, Borshchevik Core does not currently parse Solidity event data. You must parse this yourself using either searchlogs or -record-log-opcodes features.
  • It is not possible to send a contract coins without also executing the contract. This is also the case of Ethereum. This was promised in earlier discussions and technically does work, but due to lack of time for testing this feature was disabled.
  • In Borshchevik there can be multiple addresses used to create a proof-of-stake block. However, the EVM can only see the first output using the coinbase operation in Solidity (this address is also the one registered for the continuous staker rewards after 2000 blocks).

Building Borshchevik Core

Validate and Reproduce Binaries

Borshchevik uses a tool called Gitian to make reproducible builds that can be verified by anyone. Instructions on setting up a Gitian VM and building Borshchevik are provided in Gitan Building

Build on Ubuntu

This is a quick start script for compiling Borshchevik on Ubuntu

sudo apt-get install build-essential libtool autotools-dev automake pkg-config libssl-dev libevent-dev bsdmainutils git cmake libboost-all-dev libgmp3-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/borshchevik/borsh --recursive
cd borsh

# 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 Borshchevik 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 Borshchevik
sudo yum install epel-release
sudo yum install libtool libdb4-cxx-devel openssl-devel libevent-devel gmp-devel

# If you want to build the Qt GUI:
sudo yum install qt5-qttools-devel protobuf-devel qrencode-devel

# Building Borshchevik
git clone --recursive https://github.com/borshchevik/borsh.git
cd borsh
./autogen.sh
./configure
make -j4

Build on Mac OS

The commands in this guide should be executed in a Terminal application. The built-in one is located in /Applications/Utilities/Terminal.app.

Preparation

Install the Mac OS command line tools:

xcode-select --install

When the popup appears, click Install.

Then install Homebrew.

Dependencies

brew install cmake automake berkeley-db@4 libtool [email protected] miniupnpc openssl pkg-config protobuf qt@5 libevent imagemagick librsvg qrencode gmp

After installing all dependencies, make sure to run "brew link [email protected]" NOTE: This will work for building on Intel Macs and Apple Silicon Macs

NOTE: Building with Qt4 is still supported, however, could result in a broken UI. Building with Qt5 is recommended.

Build Borshchevik Core

  1. Clone the borshchevik source code and cd into borsh

     git clone --recursive https://github.com/borshchevik/borsh.git
     cd borsh
    
  2. Build borshchevik-core:

    Configure and build the headless borshchevik binaries as well as the GUI (if Qt is found).

    You can disable the GUI build by passing --without-gui to configure.

    ./autogen.sh
    ./configure
    make
    
  3. It is recommended to build and run the unit tests:

    make check
    

Run

Then you can either run the command-line daemon using src/borshd and src/borsh-cli, or you can run the Qt GUI using src/qt/borsh-qt

License

Borshchevik is GPLv3 licensed.

Development Process

The 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 Borshchevik.

The contribution workflow is described in CONTRIBUTING.md and useful hints for developers can be found in doc/developer-notes.md.

Testing

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.

Automated Testing

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. These tests can be run (if the test dependencies are installed) with: test/functional/test_runner.py

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.

About

Borsh Core Wallet

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 72.2%
  • Python 15.0%
  • C 5.8%
  • Shell 3.1%
  • M4 1.2%
  • Makefile 0.8%
  • Other 1.9%