Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V21 release notes #271

Merged
merged 69 commits into from
Jun 10, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
8ec17f9
Initial V21 Release Notes setup
zhyatt Apr 15, 2020
2a896dd
Add SSD free space recommendations
zhyatt Apr 16, 2020
7940fa7
Switch to ledger management page and expand content
zhyatt Apr 16, 2020
a9bb1f8
Minor typo update
zhyatt Apr 16, 2020
7e32206
Add guide to updating the node on another machine
guilhermelawless Apr 21, 2020
7825bac
Add callout for beta testing
zhyatt Apr 21, 2020
9f4b5f8
Minor updates based on feedback
zhyatt Apr 21, 2020
8de16cc
Initial draft of V21 release notes and related epoch upgrade details
zhyatt Apr 23, 2020
5d89ee6
Update downloaded ledger section title and recommended actions, other…
zhyatt Apr 24, 2020
fe82217
Update docs/running-a-node/ledger-management.md
zhyatt Apr 27, 2020
3745fb0
Update docs/running-a-node/ledger-management.md
zhyatt Apr 27, 2020
a2efc1e
Adjust and simplify usage of --compare_rep_weights CLI
zhyatt Apr 27, 2020
ef4e501
Update docs/releases/node-releases.md
zhyatt Apr 27, 2020
949b71d
Update docs/releases/node-releases.md
zhyatt Apr 27, 2020
796caa6
Move release notes out to individual pages for current and previous
zhyatt Apr 27, 2020
4a160aa
Add new heading for top, link from some related spots
zhyatt Apr 27, 2020
45c6a10
Add release details for v19 and v20 under previous release notes headers
zhyatt Apr 27, 2020
ba91d28
Merge branch 'master' into v21-release-notes
zhyatt Apr 27, 2020
dccf102
Merge branch 'master' into v21-release-notes
zhyatt Apr 27, 2020
184ca8c
Move telemetry forge warning to snippet and add to rpc page
zhyatt Apr 27, 2020
2d7c01f
Move some epoch upgrade considerations to network upgrades page and r…
zhyatt Apr 27, 2020
dcfdd71
Various minor updates per feedback
zhyatt Apr 27, 2020
8818c2c
Update docs/running-a-node/ledger-management.md
zhyatt Apr 27, 2020
3cb8749
Update docs/running-a-node/ledger-management.md
zhyatt Apr 27, 2020
6dd4810
Update docs/running-a-node/ledger-management.md
zhyatt Apr 27, 2020
55c1b43
Update docs/running-a-node/ledger-management.md
zhyatt Apr 27, 2020
fdbdbed
Update docs/running-a-node/ledger-management.md
zhyatt Apr 27, 2020
d9ae20b
Merge branch 'ledger-mgmt' into v21-release-notes
zhyatt May 4, 2020
b962a98
Clarify recommended ledger upgrade process
zhyatt May 4, 2020
68685c9
Add release notes reference to block create difficulty in response an…
zhyatt May 4, 2020
bb59273
Add database versions and adjust version details all into snippets
zhyatt May 13, 2020
e2ca3d9
Merge branch 'master' into v21-release-notes
zhyatt May 14, 2020
afe976c
Minor typo and other changes
zhyatt May 18, 2020
d32423c
Callout for websocket enabled by default in docker
zhyatt May 20, 2020
525e3df
Fix links for config moved to work generation guide
zhyatt May 21, 2020
adf3606
Mailing list callout refresh
zhyatt May 26, 2020
0c56e19
Add callout for static log file option
zhyatt May 27, 2020
47b6e73
Resolve conflicts
zhyatt May 27, 2020
b9c53ee
Merge branch 'master' into v21-release-notes
zhyatt May 27, 2020
dc780ef
Convert private key warning to danger callout
zhyatt May 27, 2020
d5ec636
Move mailing list callout to top
zhyatt May 28, 2020
8647ee5
Add basic callout for new difficulty thresholds
zhyatt May 28, 2020
9bf632a
Initial benchmark additions and format updates
zhyatt May 28, 2020
df0d626
Add logging.log_rpc to notable configs
guilhermelawless Jun 8, 2020
e326f54
Remove callouts for --generate_config and --config, these were added …
guilhermelawless Jun 8, 2020
ce78c40
Add callout to --debug_generate_crash_report and update some links to…
guilhermelawless Jun 8, 2020
9d7cf0a
Adjust live network glossary definition for deprecated UDP in V21
zhyatt Jun 8, 2020
8d80ae3
Merge branch 'master' into v21-release-notes
zhyatt Jun 8, 2020
b66de43
Callout telemetry websocket as preferred over regular rpc telemetry c…
zhyatt Jun 8, 2020
614a7fa
Merge branch 'master' into v21-release-notes
zhyatt Jun 8, 2020
3f81de2
Include node telemetry websocket in release notes
zhyatt Jun 8, 2020
653c267
Add turn off RPC logging to release notes
zhyatt Jun 8, 2020
eff186a
Add epoch block signer details to network upgrades
zhyatt Jun 8, 2020
500da65
Merge remote-tracking branch 'origin/master' into v21-release-notes
guilhermelawless Jun 9, 2020
3d306e3
Updates to RPC work_generate
guilhermelawless Jun 9, 2020
c9fc4e7
Add nano-work-server and work generation guide callouts
guilhermelawless Jun 9, 2020
1b89c73
Add release notes draft callout to current release notes page
zhyatt Jun 9, 2020
7b238d6
Expand beta network details
zhyatt Jun 9, 2020
e7a2723
Add active difficulty callout box on network upgrades page
zhyatt Jun 9, 2020
ab6de61
Merge branch 'master' into v21-release-notes
zhyatt Jun 9, 2020
3afbf37
Merge branch 'master' into v21-release-notes
zhyatt Jun 9, 2020
8c56dc3
Fix broken links
zhyatt Jun 9, 2020
de453ae
Broken link fix
zhyatt Jun 9, 2020
35781fd
Add useful guide updates at end of release notes
zhyatt Jun 9, 2020
685ac01
Fix broken link to old pow section, link to glossary instead
guilhermelawless Jun 10, 2020
df4e2a2
Update docs/running-a-node/beta-network.md
zhyatt Jun 10, 2020
500159b
Update docs/releases/current-release-notes.md
zhyatt Jun 10, 2020
c3c8d75
Remove beta ledger file and clarify current builds on node release page
zhyatt Jun 10, 2020
04673cd
Add lines between active releases
zhyatt Jun 10, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 43 additions & 32 deletions docs/commands/command-line-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,10 @@ Changes seed for `<wallet>` to `<seed>`. Note the legacy `--key` option can sti

### --wallet_decrypt_unsafe --wallet=`<wallet>` --password=`<password>`
Decrypts `<wallet>` using `<password>`
**!!THIS WILL PRINT YOUR PRIVATE KEY AND SEED TO STDOUT!!**

!!! danger
**USE WITH CAUTION: THIS WILL PRINT YOUR PRIVATE KEY AND SEED TO STDOUT**

If you didn't set password yet, use --wallet_decrypt_unsafe --wallet=`<wallet>`

### --wallet_destroy --wallet=`<wallet>`
Expand All @@ -137,7 +140,12 @@ Set `<account>` as default representative for `<wallet>`
## Launch options
When initially starting the nano_node or nano_wallet as a service the following launch options are available.

NOTE: These options are only for developer use so please understand the impacts before use.
!!! note "Intended for developer use"
These options are only for developer use so please understand the impacts before use.

### --allow_bootstrap_peers_duplicates
_version 21.0+_
Allow multiple connections to the same peer in bootstrap attempts

### --block_processor_batch_size
Increase block processor transaction batch write size, default 0 (limited by config block_processor_batch_max_time), 256k for fast_bootstrap
Expand All @@ -148,14 +156,6 @@ Increase block processor allowed blocks queue size before dropping live network
### --block_processor_verification_size
Increase batch signature verification size in block processor, default 0 (limited by config signature_checker_threads), unlimited for fast_bootstrap

### --inactive_votes_cache_size
_version 21.0+_
Increase cached votes without active elections size, default 16384

### --vote_processor_capacity
_version 21.0+_
Vote processor queue size before dropping votes, default 144k

### --disable_backup
Turn off automatic wallet backup process

Expand All @@ -175,13 +175,6 @@ Turn off listener on the bootstrap network so incoming TCP (bootstrap) connectio
_version 19.0+_
Turn off use of TCP live network (TCP for bootstrap will remain available)

### --disable_udp (Deprecated)
_version 21.0+_
This option has been deprecated and will be removed in future versions. It has no effect because it is now the default.

_version 19.0+_
Turn off use of UDP live network

### --disable_unchecked_cleanup
Prevent periodic cleaning of unchecked table

Expand All @@ -200,16 +193,16 @@ Disable deletion of unchecked blocks after processing.
_version 21.0+_
Turn on use of the UDP live network.

### --allow_bootstrap_peers_duplicates
_version 21.0+_
Allow multiple connections to the same peer in bootstrap attempts

### --fast_bootstrap
Increase bootstrap processor limits to allow more blocks before hitting full state and verify/write more per database call. Also disable deletion of processed unchecked blocks.

### --batch_size (Deprecated)
_version 18.0+_
Increase sideband upgrade batch size (default 512). Deprecated in _v21_ and will be removed in _v22_ as it will not support upgrades from v18 nodes and earlier.
### --inactive_votes_cache_size
_version 21.0+_
Increase cached votes without active elections size, default 16384

### --vote_processor_capacity
_version 21.0+_
Vote processor queue size before dropping votes, default 144k

## Debug commands

Expand Down Expand Up @@ -240,19 +233,17 @@ List online weights table and current online_weights value
### --debug_dump_representatives
List representatives and weights

### --debug_mass_activity (Deprecated)
Generates fake debug activity. Deprecated in _v21+_, can use `slow_test --gtest_filter=system.generate_mass_activity` instead.

### --debug_output_last_backtrace_dump
_version 19.0+_
Output the stacktrace stored after a node crash.

### --debug_generate_crash_report
_version 21.0+_
After a node crash on linux, this command consumes the dump files generated from that crash and produces a "nano_node_crash_report.txt" file. Requires `addr2line` to be installed on the system. See the [troubleshooting guide](/running-a-node/troubleshooting/#what-to-do-if-the-node-crashes-linux) for more information.

### --debug_opencl
Profile OpenCL work generation for (optional) `--device=<device>` on `--device=<platform>` using `--threads=<threads>` count. To retrieve available platforms & devices run [--diagnostics](#-diagnostics).
Profile OpenCL work generation for (optional) `--device=<device>` on `--device=<platform>` using `--threads=<threads>` count. To retrieve available platforms & devices run [--diagnostics](#-diagnostics).

### --debug_output_last_backtrace_dump
_version 19.0+_
Output the stacktrace stored after a node crash.

Optionals `--difficulty` and `--multiplier` (only the latter is used if both given) in version 21.0+ to set the work generation threshold.

### --debug_profile_bootstrap
Expand Down Expand Up @@ -291,3 +282,23 @@ Profile signature verification

### --debug_xorshift_profile
[Disabled] Profile xorshift algorithms

## Deprecated commands

### Debug

##### --debug_mass_activity (Deprecated)
Generates fake debug activity. Deprecated in _v21+_, can use `slow_test --gtest_filter=system.generate_mass_activity` instead.

### Launch options

##### --batch_size (Deprecated)
_version 18.0+_
Increase sideband upgrade batch size (default 512). Deprecated in _v21_ and will be removed in _v22_ as it will not support upgrades from v18 nodes and earlier.

##### --disable_udp (Deprecated)
_version 21.0+_
This option has been deprecated and will be removed in future versions. It has no effect because it is now the default.

_version 19.0+_
Turn off use of UDP live network
7 changes: 5 additions & 2 deletions docs/commands/rpc-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -640,8 +640,10 @@ _version 21.0+_
Work version string. Currently "work_1" is the default and only valid option. Only used if optional **work** is not given.

**Optional "difficulty"**
_version 21.0+_

_version 21.0+_
Difficulty value (16 hexadecimal digits string, 64 bit). Uses **difficulty** value to generate work. Only used if optional **work** is not given.

If difficulty and work values are both not given, RPC processor tries to calculate difficulty for work generation based on ledger data: epoch from previous block or from link for receive subtype; block subtype from previous block balance.

---
Expand Down Expand Up @@ -2795,7 +2797,8 @@ Work version string. Currently "work_1" is the default and only valid option.
**Optional "block"**

_version 21.0+_
A valid Nano block (string or JSON). Using the optional `json_block` is recommended. If provided and `difficulty` or `multiplier` are both not given, RPC processor tries to calculate the appropriate difficulty threshold based on ledger data.
A valid Nano block (string or JSON). Using the optional `json_block` is recommended. If provided and `difficulty` or `multiplier` are both not given, RPC processor tries to calculate the appropriate difficulty threshold based on ledger data.
***Note:*** block should be the one where the resulting work value will be used, not the previous block.

**Optional "json_block"**

Expand Down
2 changes: 1 addition & 1 deletion docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ A block with funds being transferred to an [account](#account) owned by a [walle
Blocks on an account chain before the first v1 block (which is often the v1 epoch block but can be other types). The first v1 block and all subsequent blocks are stateful blocks.

#### live network
A sub-network established between peers via User Datagram Protocol (UDP) for communicating newly published blocks, votes and other non-bootstrap related traffic. This is available within all Nano networks (main, beta and test networks).
A sub-network established between peers via Transmission Control Protocol (TCP) for communicating newly published blocks, votes and other non-bootstrap related traffic. This is available within all Nano networks (main, beta and test networks). In versions prior to V19, this was done via User Datagram Protocol (UDP). UDP was retained as a fallback for peer connection for versions 19 and 20. As of V21, use of UDP is deprecated.

#### online voting weight
Also called online stake, it is a trended value. The node samples online representative weights every 5 minutes across a rolling 2 week period. The online voting weight value is the median of those samples.
Expand Down
11 changes: 11 additions & 0 deletions docs/images/mailing-list.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/integration-guides/the-basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Because each block contains the current state of the account, the `"type"` of th
| balance | decimal string | 16 bytes | Resulting balance (in [raw](#units)) |
| link | - | 32 bytes | Multipurpose field - see link table below |
| signature | 128 hex-char string | 64 bytes | ED25519+Blake2b 512-bit signature |
| work | 16 hex-char string | 8 bytes | [Proof of Work](#proof-of-work) Nonce |
| work | 16 hex-char string | 8 bytes | [Proof of Work](../glossary.md#proof-of-work-pow) Nonce |

Depending on the action each transaction intends to perform, the `"link"` field will have a different value for [block_create](/commands/rpc-protocol#block_create) RPC command:

Expand Down
Loading