The BitShares Core software has been updated to the 6.1.0 Feature Release. The codename of the 6.x releases is "Mekong". The Core software is used to build the validation nodes that perform consensus of all transactions on the BitShares blockchain, and a command-line wallet tool to interact with nodes. This release includes improvements but does not include any changes to the consensus protocol.
A blockchain replay will automatically be performed after the validation node software is restarted. This typically takes a few hours on a modern CPU.
This release contains breaking changes about the elasticsearch plugin and the es_objects plugin. For nodes with one of those 2 plugins enabled, please check the Node Plugins section before upgrade.
Due to the changes in PR 2648 and PR 2642, nodes with the account_history plugin enabled will have increased memory usage and higher spikes by default. It is a trade-off for better serving certain APIs. Node operators can set the min-blocks-to-keep and the max-ops-per-acc-by-min-blocks startup options to different values to achieve different behaviors.
Docker users please refer to the following section for breaking changes regarding Docker.
How to Upgrade with Docker
The pre-built Docker image can be found on the BitShares Core Docker page and can be downloaded with the following command.
docker pull bitshares/bitshares-core:6.1
or
docker pull bitshares/bitshares-core:6.1.0
Note:
Starting from this release, when we add a new image to Docker Hub with a major.minor.patch version tag, we also add or update the corresponding major.minor version tag. Therefore, users using the major.minor version tag will always get the latest patch for that version.
Starting from this release, the bitsharesentry.sh file is set to the default ENTRYPOINT but no longer to the default CMD, which may affect your deployment.
By default, the Docker container will run with the bitshares user with UID 10000 and GID 10001 (instead of root), and all existing files in the data directory will be updated to be owned by bitshares:bitshares (from root) on startup.
How to Upgrade from Source Code
Note:
The code base requires a compiler that supports the C++ 14 standard
The minimum supported boost version is 1.58, the maximum is 1.74
The minimum supported CMake version is 3.2
For Ubuntu users, it is recommended to build in Ubuntu 20.04 LTS (Focal Fossa). Ubuntu 16.04 LTS (Xenial Xerus) may still work, but it is no longer tested.
Obtain the Source Code
The source code may be obtained by checking out the 6.1.0 tag. Download the source at:
Your standard process for deploying the node software and the command-line wallet software may be used. No additional requirements or precautions will be required to deploy the new release.
Binaries for download
Binaries of the node software and the command-line wallet software are pre-built and available for download.
Note:
These binary builds are reproducible and were built using Gitian. Please check the README of Gitian if you want to verify and/or contribute.
Starting from version 6.0.0, pre-built Linux binaries will not run on Ubuntu 16.04 LTS (Xenial).
abitmore
commented
1 year ago
Note: the final release is here: https://github.com/bitshares/bitshares-core/releases/tag/6.1.0
Note: this is a draft and will be updated. Some links may not be available yet.The BitShares Core software has been updated to the 6.1.0 Feature Release. The codename of the
6.xreleases is "Mekong". The Core software is used to build the validation nodes that perform consensus of all transactions on the BitShares blockchain, and a command-line wallet tool to interact with nodes. This release includes improvements but does not include any changes to the consensus protocol.Documentation for users may be be found at How BitShares Works.
Documentation for BitShares developers may be found at the BitShares Developer Portal.
Who Should Upgrade
It is recommended that all nodes and all command-line wallets be upgraded, although it is not required.
All nodes will benefit from the P2P network security improvements.
API nodes will benefit from the new APIs.
Docker image users will benefit from security updates and reduced Docker image size.
Command-line wallet users will benefit from command-line wallet improvements.
ElasticSearch nodes will benefit from new data, new program options and bug fixes.
Account history plugin users will benefit from new program options.
How To Upgrade
Precautions
elasticsearchplugin and thees_objectsplugin. For nodes with one of those 2 plugins enabled, please check the Node Plugins section before upgrade.account_historyplugin enabled will have increased memory usage and higher spikes by default. It is a trade-off for better serving certain APIs. Node operators can set themin-blocks-to-keepand themax-ops-per-acc-by-min-blocksstartup options to different values to achieve different behaviors.How to Upgrade with Docker
The pre-built Docker image can be found on the BitShares Core Docker page and can be downloaded with the following command.
or
Note:
major.minor.patchversion tag, we also add or update the correspondingmajor.minorversion tag. Therefore, users using themajor.minorversion tag will always get the latest patch for that version.bitsharesentry.shfile is set to the defaultENTRYPOINTbut no longer to the defaultCMD, which may affect your deployment.bitsharesuser with UID10000and GID10001(instead ofroot), and all existing files in the data directory will be updated to be owned bybitshares:bitshares(fromroot) on startup.How to Upgrade from Source Code
Note:
Obtain the Source Code
The source code may be obtained by checking out the 6.1.0 tag. Download the source at:
Build the Binaries
The binaries may be built by using your pre-existing process, or by following the standard instructions that can be found in the wiki:
Deploy the Binaries
Your standard process for deploying the node software and the command-line wallet software may be used. No additional requirements or precautions will be required to deploy the new release.
Binaries for download
Binaries of the node software and the command-line wallet software are pre-built and available for download.
Note:
6.0.0, pre-built Linux binaries will not run on Ubuntu 16.04 LTS (Xenial).36e24b86b5493981b6774cc7f58194a3f0f31eea6b1b40aeda4f989b5bd324e17796e05314c78e155e67081f8157cfb476901af7cf038bf96465792c1cc6a83f4e9d7387dc29846bdcb5715adfd43f67817ef317439b2029a5e42c1305a59893Changes
The changes for 6.1.0 Feature Release are summarized below.
Node Functionality
static_variantstatic_cast<size_t>(tag) < count()Node Plugins
es_objectsplugin, update program options (with breaking changes)block_timeandis_virtualfields tooperation_history_objectapi_helper_indexesplugin to supportdatabase_api::get_next_object_idAPIes-objects-max-mapping-depthto 10API
Please check the linked pull requests for more info and documentation.
history_api::get_block_operation_historyAPIapi-limit-get-market-historyandapi-limit-get-full-accounts-subscribenode startup optionsdatabase_api::get_margin_positionsAPI to only return the first page (usedatabase_api::get_call_orders_by_accountAPI to get more data)login_api::get_infoAPI to return data defined by a newapi-node-infonode startup optionlogin_api::get_configAPI to return configured API limitslogin_api::get_available_api_setsAPIlogin_api::logoutAPIlogin_apiblock_timeandis_virtualfields tooperation_history_objecthistory_api::get_account_history_by_timeAPIhistory_api::get_block_operations_by_timeAPIdatabase_api::get_next_object_idAPIcustom_operations_api::get_storage_infoAPI with pagination and optional parameter support, addapi-limit-get-storage-infonode startup optionget_order_bookAPI to return limit order owners and other infoget_block_headerandget_block_header_batchAPIs to optionally return witness signaturesCommand-Line (CLI) Wallet
transaction_handle_typeto 32 bits and handle overflowSoftware Design
connection_rejected_messagemember orderobject_idandobject_id_typeBuild Process and Continuous Integration (CI)
build-dockerworkflowcurlv7.77or higher in mac.travisand related filesGITHUB_REF_NAMEvariable provided by Githubsonar-scanworkflow with Ubuntu 20.04 instead ofubuntu-latestDocumentation
Release Contributors
@abitmore (https://github.com/abitmore) @ioBanker (https://github.com/ioBanker) @jmjatlanta (https://github.com/jmjatlanta) @oxarbitrage (https://github.com/oxarbitrage)