From 02ae85a60cfa6985e9e65729f564c2d48f71eea7 Mon Sep 17 00:00:00 2001 From: FornaxA Date: Tue, 11 Feb 2020 20:38:33 +0100 Subject: [PATCH] Update release notes --- doc/release-notes.md | 160 ++++++++++++++++++++++--------------------- 1 file changed, 83 insertions(+), 77 deletions(-) diff --git a/doc/release-notes.md b/doc/release-notes.md index a48fb51190a84..04e9114fc782b 100644 --- a/doc/release-notes.md +++ b/doc/release-notes.md @@ -5,34 +5,35 @@ - [Mandatory Update](#mandatory-update) - [How to Upgrade](#how-to-upgrade) - [Compatibility](#compatibility) - - [Mac OSX High Sierra](#mac-osx-high-sierra) - [Noteable Changes](#noteable-changes) - [Migrate Travis as pipeline](#migrate-travis-as-pipeline) - [Zerocoin](#zerocoin) - - [Tokenimplementation](#tokenimplementation) - - [Protocol change](#protocol-change) - - [New RPC Commands](#new-rpc-commands) - - [Tokens](#tokens) - [Masternodes](#masternodes) - - [Deprecated RPC Commands](#deprecated-rpc-commands) + - [Token implementation](#token-implementation) + - [New RPC Commands](#new-rpc-commands) - [Masternodes](#masternodes-1) + - [Deprecated RPC Commands](#deprecated-rpc-commands) + - [Masternodes](#masternodes-2) - [5.0.99 Change log](#5099-change-log) ## ION Core version 5.0.99 is now available -Download at: https://github.com/ioncoincore/ion/releases +Download at: https://bitbucket.org/ioncoin/ion/downloads/ -This is a new major version release, including various bug fixes, performance improvements, implementation of the Atomic Token Protocol (ATP), as well as updated translations. +This is a new major version release, including a new base code, various bug fixes, performance improvements, upgrades to the Atomic Token Protocol (ATP), as well as updated translations. Please report bugs using the issue tracker at github: https://bitbucket.org/ioncoin/ion/issues?status=new&status=open ### Mandatory Update -ION Core v5.0.99 is a mandatory update for all users. This release contains new consensus rules and improvements that are not backwards compatible with older versions. Users will have a grace period of up to two week to update their clients before enforcement of this update is enabled - a grace period that will end at block 1320000 the latest. +ION Core v5.0.99 is an experimental release, intended only for TESTNET. It is not a mandatory update. This release contains new consensus rules and improvements for TESTNET only that are not backwards compatible with older versions. Users will have a grace period of up to one week to update their testnet clients before enforcement of this update is enabled. ### How to Upgrade -If you are running an older version, shut it down. Wait until it has completely shut down (which might take a few minutes for older versions), then run the installer (on Windows) or just copy over /Applications/ION-Qt (on Mac) or iond/ion-qt (on Linux). +- If you are running an older version, shut it down. +- Wait until it has completely shut down (which might take a few minutes for older versions). +- Copy the files in the testnet data folder to a backup medium, and delete all files in the testnet folder except ioncoin.conf and wallet.dat. +- Run the installer (on Windows) or just copy over /Applications/ION-Qt (on Mac) or iond/ion-qt (on Linux). ### Compatibility @@ -42,19 +43,26 @@ Microsoft ended support for Windows XP on April 8th, 2014, No attempt is made to ION Core should also work on most other Unix-like systems but is not frequently tested on them. -#### Mac OSX High Sierra - -Currently there are issues with the 4.x gitian release on MacOS version 10.13 (High Sierra), no reports of issues on older versions of MacOS. - ### Noteable Changes -- core: switch core from pivx to ion -- move to bitbucket -- token implementation (IIP6) -- rebase to dash - - fix regtest and testnet - - new regtest genesis is inline with source - - updated dependencies +- Move to bitbucket + - The ION Core project is now available throug the [ION Coin Bitbucket repository](https://bitbucket.org/ioncoin/ion/) + - The ION Core repository at github will for now remain available, but will no longer be updated. +- Fee policy + - The current release partially implements IIP0006 - the remainder of the IIP0006 implementation will follow in a subsequent update. + - The new fee policy, proposed and adopted in IIP0006, is implemented. As a result, this client will only relay and mine transactions with + a feerate of 0.01 ION per KB. + - The fee calculation approach for token transactions has been made more accurate. +- Core: the core code has been rebased from PivX to Dash. + - The staking functionality has been ported to the new code base. + - The token implementation (ATP) has been ported to the new code base. + - The zerocoin functionality (xION) has been partially ported to the new code base. + - Fixes to regtest and testnet + - A previously unsolved issue related to running regtest scripts no longer occurs in the new code base + - The regtest mining and staking functionality allows generating POS, POW and Hybrid blocks + - The new regtest genesis is inline with the updated source + - Testnet is running the new code base, including deterministic masternodes + - Updated dependencies - boost 1.70 - QT 5.9.8 - expat 2.2.9 @@ -75,53 +83,70 @@ Currently there are issues with the 4.x gitian release on MacOS version 10.13 (H - xcb_proto 1.13 - xproto 7.0.31 - xtrans 1.4.0 - - Support more architectures + - More supported architectures - mips - mipsel - s390x - powerppc64 - powerppc64le - - new gui and artworks + - New gui and artworks - spinner - - updated and refactored build process - - gitian build script extended + - Updated and refactored build process + - Gitian build script extended - can be used with latest debian or ubuntu - added upload to a server over SSH - added hashing of resulted archives - fix latest dependencies -- deployment process - - snapcraft from bitbucket - - snap on launchpad - - ~~continuous build process on circleci~~ - - snapcraft - - ~~deb packages~~ - - ~~rpm packages~~ - - ~~gitian~~ - - ~~bitbucket pipelines~~ -- developers tools +- Developers tools - VSCode - added spellchecker exclusion list - build, debug and scripts for vscode debugger -- all sources spellchecked +- All sources spellchecked - BLS - [BLS Signature Scheme](https://github.com/dashpay/dips/blob/master/dip-0006/bls_signature_scheme.md) - [BLS M-of-N Threshold Scheme and Distributed Key Generation](https://github.com/dashpay/dips/blob/master/dip-0006/bls_m-of-n_threshold_scheme_and_dkg.md#bls-m-of-n-threshold-scheme-and-distributed-key-generation) - ~~I2p support~~ -. ~~new Hybrid-PoW~~ #### Migrate Travis as pipeline #### Zerocoin -- Reimplement zerocoin to new source - -#### Tokenimplementation - -- Reimplement zerocoin to new source +- The core part of the zerocoin functionality has been ported to the new code base. + - This includes all functionality related to verification of zerocoin transactions. + - This excludes functionality to create new zerocoin transactions. -#### Protocol change +#### Masternodes -- Atomic Token Protocol (ATP) +Testnet masternodes requires using the `protx` command: +- Ensure a 20k collateral is available (`masternode outputs`). +- Generate the keys: + - Generate the 'owner private key' (`getnewaddress`). + - Generate the 'voting key address' (`getnewaddress`). + - Generate the 'masternode payout address' (`getnewaddress`). + - Optionally, generate the 'fee source address' (`getnewaddress`). + - Generate the 'operator public and private keys' (`bls generate`). +- Configure the remote wallet: + - Add `masternode=1` to the remote ioncoin.conf + - Add `masternodeblsprivkey=` to the remote ioncoin.conf (the private part of the 'operator public and private keys') + - Add `externalip=` to the remote ioncoin.conf (the external IP address of the server hosting the remote masternode) +- Configure the controller wallet: + - Run the following command in the debug console: `protx register_prepare + ()` + - The above command returns: + - A binary transaction ("tx") + - A collateral address ("collateralAddress") + - A message to sign ("signMessage") + - Run the following command in the debug console: `signmessage ` + - The above command returns a signature + - Finally, submit the registration transaction with the following command: `protx register_submit ` +- When the remote node is started, it will automatically activate. +- Run the sentinel on the remote server to let other masternodes know about yours + - Edit `sentinel.conf` to set the network to 'testnet'. + +#### Token implementation + +- The Atomic Token Protocol (ATP) has been fully ported to the new code base. + - Various improvements have been added to the verification code and the database code for tokens. **Introduction:** @@ -149,22 +174,20 @@ Currently there are issues with the 4.x gitian release on MacOS version 10.13 (H ### New RPC Commands -#### Tokens - -`configuremanagementtoken "ticker" "name" decimalpos "description_url" description_hash ( confirm_send ) ` -`configuretoken "ticker" "name" ( decimalpos "description_url" description_hash ) ( confirm_send ) ` -`createtokenauthorities "groupid" "ionaddress" authoritylist ` -`droptokenauthorities "groupid" "transactionid" outputnr [ authority1 ( authority2 ... ) ] ` -`getsubgroupid "groupid" "data" ` -`gettokenbalance ( "groupid" ) ` -`listtokenauthorities "groupid"` -`listtokenssinceblock "groupid" ( "blockhash" target-confirmations includeWatchonly ) ` -`listtokentransactions "groupid" ( count from includeWatchonly ) ` -`melttoken "groupid" quantity ` -`minttoken "groupid" "ionaddress" quantity ` -`sendtoken "groupid" "address" amount ` -`tokeninfo [list, all, stats, groupid, ticker, name] ( "specifier " ) ` -`scantokens ( ) ` +#### Masternodes + +masternode "command" ... +masternodelist ( "mode" "filter" ) + +`masternode count` - Get information about number of masternodes (DEPRECATED options: 'total', 'ps', 'enabled', 'qualify', 'all') +`masternode current` - Print info on current masternode winner to be paid the next block (calculated locally) +`masternode outputs` - Print masternode compatible outputs +`masternode status` - Print masternode status information +`masternode list` - Print list of all known masternodes (see masternodelist for more info) +`masternode winner` - Print info on next masternode winner to vote for +`masternode winners` - Print list of masternode winners + +### Deprecated RPC Commands #### Masternodes @@ -179,23 +202,6 @@ Currently there are issues with the 4.x gitian release on MacOS version 10.13 (H `listmasternodeconf ( "filter" )` `listmasternodes ( "filter" )` -### Deprecated RPC Commands - -#### Masternodes - -`masternode count` -`masternode current` -`masternode debug` -`masternode genkey` -`masternode outputs` -`masternode start` -`masternode start-alias` -`masternode start-` -`masternode status` -`masternode list` -`masternode list-conf` -`masternode winners` - ### 5.0.99 Change log ckti (1):