Skip to content

Commit 1d18ebf

Browse files
committed
[Doc] Document sapling parameters for installation/upgrade
1 parent ba705a6 commit 1d18ebf

File tree

1 file changed

+33
-19
lines changed

1 file changed

+33
-19
lines changed

doc/release-notes.md

Lines changed: 33 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,20 @@ How to Upgrade
1616

1717
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/PIVX-Qt (on Mac) or pivxd/pivx-qt (on Linux).
1818

19+
#### Sapling Parameters
20+
In order to run, PIVX Core now requires two files, `sapling-output.params` and `sapling-spend.params` (with total size ~50 MB), to be saved in a specific location.
21+
22+
For the following packages, no action is required by the user:
23+
- macOS release `dmg` binaries will use the params that are bundled into the .app bundle.
24+
- Windows installer `.exe` will automatically copy the files in the proper location.
25+
- Linux `PPA/Snap/Copr` installs will automatically copy the files in the proper location.
26+
27+
For the other packages, the user must save the param files in the proper location, before being able to run PIVX v5.0.0:
28+
- macOS/Linux `tar.gz` tarballs include a bash script (`install-params.sh`) to copy the parameters in the appropriate location.
29+
- Windows `.zip` users need to manually copy the files from the `share/pivx` folder to the `%APPDATA%\PIVXParams` directory.
30+
- self compilers can run the script from the repository sources (`params/install-params.sh`), or copy the files directly from the `params` subdirectory.
31+
32+
1933

2034
Compatibility
2135
==============
@@ -59,7 +73,7 @@ A brand new manager encapsulating all Sapling related capabilities inside the wa
5973
* New address type: shield addresses (using bech32 format).
6074
* New derivation path for Sapling keys: Shield addresses are derived from the unique wallet's master seed (same as regular & cold staking addresses. The wallet's seed is able to restore PIVs and Shield PIVs equally).
6175
* Support for Sapling extended full viewing keys, incoming viewing keys, outgoing viewing keys and spending keys.
62-
* Sapling notes management:
76+
* Sapling notes management:
6377
- Notes decryption.
6478
- Blockchain scanning protocol: handling when and how to store a Sapling output and its related keys. As well as mark used notes.
6579
- Notes metadata cache: retrieving information without requiring to decrypt notes on-demand.
@@ -84,7 +98,7 @@ A large number of performance and stability improvements over the complete tier
8498
Plus, tier two and masternodes capabilities have been introduced to regtest, enabling the local testing environment setup and the creation of a functional testing framework for the area.
8599
This work is directly correlated with a substantial efficiency improvement for the entire software, not only for masternodes, and is one of the building blocks for the new tier two network and sync protocol that will be continued post-v5.
86100

87-
Instant Proposal Removal:
101+
Instant Proposal Removal:
88102
The threshold was increased to 30% of negative votes.
89103
The proposal will never be removed before its first superblock.
90104

@@ -319,7 +333,7 @@ Each new command is detailed below:
319333
4. fee (numeric, optional), The fee amount to attach to this transaction.
320334
If not specified, the wallet will try to compute the minimum possible fee for a shield TX,
321335
based on the expected transaction size and the current value of -minRelayTxFee.
322-
336+
323337
Result:
324338
transaction (string) hex string of the transaction
325339
```
@@ -437,7 +451,7 @@ Several RPC commands have had changes to their input arguments or output fields
437451

438452
* `getblock`
439453
A new JSON entry (`finalsaplingroot`) has been added to the return object. (string) The root of the Sapling commitment tree after applying this block.
440-
454+
441455
* `getblockheader`
442456
A new JSON object (`shield_pool_value`) has been added to the return object with the following information:
443457
```
@@ -447,7 +461,7 @@ Several RPC commands have had changes to their input arguments or output fields
447461
"valueDelta": (numeric) Change in value held by the Sapling circuit over this block
448462
}
449463
```
450-
464+
451465
* `getblockchaininfo`
452466
A new JSON entry (`initial_block_downloading`) has been added to the return object. (boolean) whether the node is in initial block downloading state or not.
453467
A new JSON object (`shield_pool_value`) has been added to the return object with the following information:
@@ -462,35 +476,35 @@ Several RPC commands have had changes to their input arguments or output fields
462476
* `getblockindexstats`
463477
The `fFeeOnly` input argument has been removed.
464478
The `spendcount` and `pubspendcount` return objects have been removed due to zerocoin deprecation.
465-
479+
466480
* `preparebudget` and `submitbudget`
467481
A maximum of `6` payment cycles per proposal (`20` on testnet) is now imposed for newly created proposals. Amounts higher than this limit will now return an error message.
468-
482+
469483
* `getbudgetprojection`
470484
A typo in the JSON return fields has been corrected; `Alloted` and `TotalBudgetAlloted` have been renamed to `Allotted` and `TotalBudgetAllotted` respectively.
471-
485+
472486
* `startmasternode`
473487
A new optional input argument (`reload_conf`) has been added to reload the client's `masternode.conf` file in real-time. This optional argument is only available when running `startmasternode` with "alias" being specified as the first argument.
474-
488+
475489
* `decodemasternodebroadcast`
476490
The `nlastdsq` JSON return entry has been removed. This was a remnant from pre-zerocoin "CoinJoin" mixing.
477-
491+
478492
* `getinfo`
479493
The `zerocoinbalance` JSON return entry and the `zPIVsupply` return JSON object have been removed due to zerocoin deprecation.
480494
The `balance` JSON return entry is now all inclusive (the sum of all transparent and shield PIV)
481495
The `moneysupply` JSON return entry is the total PIV supply (the sum of all transparent and shield PIV)
482496
A new JSON return entry (`transparentsupply`) has been added to return the sum of the value of all unspent outputs when the chainstate was last flushed to disk.
483497
A new JSON return entry (`shieldsupply`) has been added to return the shield supply at the chain tip.
484498
Integrators should switch to the newly added `getsupplyinfo` RPC command for the purpose of obtaining supply information as it is more robust and does not rely on information caching.
485-
499+
486500
* `validateaddress`
487501
The `account` JSON return entry has been removed due to the removal of the internal accounting system. The `label` entry was it's replacement.
488-
502+
489503
* `getrawtransaction`
490504
A new JSON return entry (`type`) has been added which indicates via a numeric value the type of transaction (currently not fully implemented).
491505
A new JSON return array (`shield_addresses`) has been added which will contain a list of shield address strings involved in the transaction (if that information is available to the local client).
492506
Two new JSON return entries (`extraPayloadSize` and `extraPayload`) have been added pre-emptively to support future implementation of "special" transactions (currently NYI).
493-
507+
494508
* `getrawtransaction` and `decoderawtransaction`
495509
New JSON output entries have been added to both these commands to detail sapling input/output information after the `vout` array in the following format:
496510
```
@@ -520,22 +534,22 @@ Several RPC commands have had changes to their input arguments or output fields
520534
],
521535
"bindingSig": hex, (string) Prove consistency of valueBalance with the value commitments in spend descriptions and output descriptions, and proves knowledge of the randomness used for the spend and output value commitments
522536
```
523-
537+
524538
* `getbalance`
525539
The `account` input argument has been removed due to the removal of the internal accounting system.
526540
A new optional input argument (`includeShield`) has been added to include shield balance. Default is `true`.
527-
541+
528542
* `getcoldstakingbalance` and `getdelegatedbalance`
529543
The optional `account` input argument has been removed due to the removal of the internal accounting system.
530-
544+
531545
* `listreceivedbyaddress`, `listreceivedbylabel`, `listsinceblock`, and `gettransaction`
532546
The JSON return entry `account` has been removed due to the removal of the internal accounting system.
533547
The JSON return entry `bcconfirmations` has been marked as deprecated and will be removed in the future.
534-
548+
535549
* `listunspent`
536550
The JSON return entry `account` has been removed due to the removal of the internal accounting system.
537551
A new JSON entry (`generated`) has been added to indicate if the txout is a coinstake transaction.
538-
552+
539553

540554
#### Removed RPC Commands
541555

@@ -603,4 +617,4 @@ Detailed release notes follow. This overview includes changes that affect behavi
603617
Thanks to everyone who directly contributed to this release:
604618

605619

606-
As well as everyone that helped translating on [Transifex](https://www.transifex.com/projects/p/pivx-project-translations/), the QA team during Testing and the Node hosts supporting our Testnet.
620+
As well as everyone that helped translating on [Transifex](https://www.transifex.com/projects/p/pivx-project-translations/), the QA team during Testing and the Node hosts supporting our Testnet.

0 commit comments

Comments
 (0)