All notable changes to this tool will be documented in this file.
!> Whenever you're updating between versions where format/hash of keys have changed , or you're changing networks - it is recommended to Backup your Wallet and Pool folders before you proceed with launching cntools on a fresh network.
The format is based on Keep a Changelog, and this adheres to Semantic Versioning.
We have made quite a few changes to not use ptn0 in our scripts and source github structures (except template files), alongwith other changes listed beneath. Please follow steps below for upgrade (from 5.1.0 or earlier):
- Execute the below (by default it will set you up against mainnet network), do not overwrite config please:
cd "$CNODE_HOME"/scripts
curl -sS -o prereqs.sh https://raw.githubusercontent.com/cardano-community/guild-operators/master/scripts/cnode-helper-scripts/prereqs.sh
chmod 755 prereqs.sh
./prereqs.sh -s- Start using updated cnode.sh to run a passive node, or edit the cnode.sh to include your pool keys and run as pool owner.
=======
- Removed +i file locking on .addr files when using
Wallet >> Encryptas these are re-generated from keys and need to be writable - Balance check added to
Funds >> Withdrawfor base address as this is used to pay the withdraw transaction fee
- Ability to select a different pool owner and reward wallet
- Multi-owner support using stake vkey/skey files
- Added TIMEOUT_LEDGER_STATE(default 300s) in cntools.config to be used instead of static 60 seconds for querying shelley ledger-state.
- Option to delete private keys after successful backup
- itnRewards.sh script to claim ITN rewards incl docs update
- More explicit error messages at startup
- POOL_PLEDGECERT_FILENAME removed from config, WALLET_DELEGCERT_FILENAME is used instead for delegation cert to pool, no need to keep a separate cert in pool folder for this, its the wallet that is delegated.
- Wallet vkeys no longer encrypted as skeys are the only ones in need of protection
- Update command change (change applied after this release is active):
- Minor/Patch release: it will warn, backup and replace CNTools script files including cntools.config
- Major release: No change, prompt user to backup and run prereqs.sh according to instructions.
- Troubleshooting improvements:
- Split 'config in json format' and 'hasPrometheus' checks
- Output node sync stats if Shelley transition epoch is to be calculated
- Protocol parameters output check to give an improved error message
- Pool >> Show view updated to show modified pool values if Pool >> Modify has been used to update pool parameters
- The section has also been updated to make it a little bit easier to read
- Pool >> Delegators view also use updated pledge value if a pool modification has been registered to check if pledge is met
- Use mainnet as default, since other testnets are either retired or not being maintained :(
- Backup original files when doing upgrades, so that users do not lose their changes.
- Mainnet uses dedicated condition for slot checks
- Timeout moved to a variable in cntools.library
- KES Calculation for current KES period and KES expiration date Please re-check expiration date using Pool >> Show
- Basic sanity checks for socket file
- calc_slots to be network independent
- prom_host should be calculated from config file, instead of having to update a config
- Major update description updated
- env file update removed from minor update
- Backup & Restore of wallets, pools and configuration files
- External KES rotation script using CNTools library
- Add few flags to control prereqs to allow skipping overwriting files, deploying OS packages, etc
- Minor typo in menu
- Prometheus metrics used for various functions and now required to run CNTools, enabled by default
- Changed references to ptn0 to generalize the usage
- Change CNTools changelog heading format - +1 sublevels for headings (used by newer documentation)
- Delegators previously displayed in
Pool >> Shownow moved to its own menu option This is to de-clutter and because it takes time to parse this data from ledger-state - stake.cert no longer encrypted in wallet
- Redundant sections in guide
- Parse Config for virtual forks, which adds supports for MC4
- CNTools block collector fix
- cntools.sh: Drop an error if log not found, indicating config with no JSON being used
- column application added as a prereq, bsdmainutils/util-linux
- cntoolsBlockCollector.sh get epoch using function
- KES count was not showing up in Katip
- Funds -> Delegation was broken as per recent changes in 1.17, corrected key type for delegation certificate
- Meta description now has a limit of 255 chars to match smash server limit
- ledger-state timeout increased to 60s
- Update ptn0 config to align with hydra config as much as possible, while keeping trace options on
- Stale delegate.counter
- moved update check to be one of the first things CNTools does after start to be able to show critical changes before anything else runs.
- Parse node logs to check the transition from Byron to shelley era, and save the epoch for transition in db folder. This is required for calculating KES keys.
- Please make sure to use config files created by the prereqs.sh, or enable JSON loggers for your config.
- Update cnode.sh.templ to archive logs every time node is restart, this ensures that we're not searching for previous log history when network was changed. Network being changed would automatically deduce db folder was deleted.
- Update default network to MC3
Pool >> Showdelegator rewards parsing from ledger-state
- Slot sync format improvement
- kesExpiration function to use 17 fixed byron transition epochs
- HASH_IDENTIFIER where applicable to differentiate between network modes for commands used, required due to legacy Byron considerations
- add ptn0-praos.json and ptn0-combinator.json to reduce confusion between formats, make prereqs default to combinator, and accept p argument to indicate praos mode.
- cardano-node 1.16.0 refers to txhash using quotes, sed them out
- show what's new at startup after update
- file size check for pool metadata file
- Add nonce in pool metadata JSON to keep registration attempts unique, avoiding one hash pointing to multiple URLs
- Change default network to
mainnet_candidate, and add second argument (g) to run prereqs against guild network
- Default config switched to combinator instead of testnet
- Start maintaining seperate versions of praos and combinator config files.
- Add 10s timeout to wget commmands in case of issue
- timestamp added to pool metadata file to make every creation unique
- Cancel shortcut changed from
[c]to[Esc] - Default pool cost from 256 -> 400
- slotinterval calculation to include decentralisation parameter
- mainnet candidate compatible slot calculation, 17 fixed byron transition epochs (needs to be fixed for mainnet)
- Delete cntools-updater script
- Slots reference was mixing up for shelley testnet in absence of a combinator network
- allow the use of pre-existing metadata from URL when registering or modifying pool
- minimum pool cost check against protocol
- NODE_SOCKET_PATH config parameter(replaced by CARDANO_NODE_SOCKET_PATH)
- Pool metadata information to copy file as-is as well as wait for keypress to make sure file is copied before proceeding with registration.
- numfmt dependency removed in favor of printf formatting
- Vkey delegation fix due to json format switch
- Refresh option to home screen
- ADA not displayed in a couple of the wallet selection menus
- Ability to register multiple relay DNS A records as well as a mix of DNS A and IPv4
- Valid for pool registration and modification
- Now use internal table builder to display previous relays
- Instead of giving relays from previous registration as default values it will now ask if you want to re-register relays exactly as before to minimize steps and complexity
- KES calculation support for both MC and Shelley Testnet
- Slot tip reference calculation for shelley testnet
- Add PROTOCOL_IDENTIFIER and NETWORK_IDENTIFIER instead of harcoded entries for combinator v/s TPraos & testnet v/s magic differentiators respectively.
- Keep both ptn0.yaml and ptn0-combinator.yaml to keep validity with mainnet-combinator
- Revert back default for Public network to Shelley_Testnet as per https://t.me/CardanoStakePoolWorkgroup/282606
- Release
2.1.1included a change to env file and thus require a major version bump. - Modified output on Update screen slightly.
- Basic health check data on main menu
- Epoch, time until next epoch, node tip vs calculated reference tip and a warning if node is lagging behind.
- Address era and encoding to
Wallet >> Show
- KES calculation, now take into account the byron era and the transition period until shelley start
- Credit to Martin @ ATADA for inspiration on how to calculate this
- Version fix to include patch version
- Support for cardano-node 1.15.x
- calculate-min-fee update to reflect change in 1.15.
change was required to support byron witnesses. - gettip update as output is now json formatted
- bech32 addressing in 1.15 required changes to delegator lookup in
Pool >> Show - add --cardano-mode to query parameters
- --mainnet flag for address generation
- calculate-min-fee update to reflect change in 1.15.
- Output verbosity
A new config parameter added for output verbosity using say function.
0 = Minimal - Show relevant information (default)
1 = Normal - More information about whats going on behind the scene
2 = Maximal - Debug level for troubleshooting - Improve delegators list in
Pool >> Show- Identify owners delegations
- Display owner stake in red if
(stake + reward)is below pledge (single-owner only for now)
- Display all lovelace values in floating point ADA with 6 decimals (lovelaces) using locales
- Block Collector summary view
- KES rotation notification/warning on startup and in pool list/show views
- Changelog
- op-cert creation moved from
Pool >> NewtoPool >> Register. - Output changed in various places throughout.
- Include reward in delegators stake.
- Release now include patch version in addition to major and minor version.
In-app update modified to reflect this change. - Block Collector table view
- Various minor code improvements
- Enterprise wallet upgrade option in
Wallet >> List Not a registered wallet on chaininformation from Wallet listing- en_US.UTF-8 locale dependency
- meta_json_url check
- Invalid tx_in when registering stake wallet
- Delegators rewards in
Pool >> Show - Work-around awk versions that only support 32-bit integers
- Sometimes cardano-node log contain duplicate traces for the same slot at log file rollover, now filtered
- Live stake and delegators in
Pool >> Show
- Correct nwmagic - was hardcoded to 42
- Set script locale to fix format issue
- Wallet upgrade option added for backwards compatibility.
Wallet >> LISTnow offer an upgrade option if it finds a wallet with payment address that has funds in it. Special note added in case a genesis address is found. - Update message on startup
- Support for payment address(aka enterprise) minimised to default on base address support, as Everything that can be done with a payment address can also be done with the base address.
- Reduce a step to Update (register) wallet keys, and moved this step to delegate/register pool step based on a check to see if the registration is required.
- Changes for log output and variable names
- Docs and output update
- Replace pool JSON hosting instructions, from stout to copying file, to avoid user errors
- Do not give option or allow sending to same address as source. Base <-> Enterprise for same wallet ok.
- Removed debug code in tx
- A bug fixed for wallet not showing in some cases because reward address file was not generated at wallet creation
- In-app update bugfix
- Default values for relay on pool modify and re-registration
- New pool config parameter for relay type called
typecontaining either IPv4 or DNS_A currently.
- Old relays table on modify/registration redone to include type. Also put together a little different to handle null values and omit quotation marks.
- Pool show updated to show type for relay
- On pool re-registration or modification the old relay valus are now read from pool config. If selection of type match old values the default values are set to old config.
- Minor alignment fix of main menu header
- First versioned released
see github commit history for details before this release - In-app update for cntools
- Update CNTools Doco to include Version on home screen
- Align table for reading relays