eth2.0-specs/specs/merge/client-settings.md

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [The Merge -- Client Settings](#the-merge----client-settings)
    - [Override terminal total difficulty](#override-terminal-total-difficulty)
    - [Override terminal block hash](#override-terminal-block-hash)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

# The Merge -- Client Settings

**Notice**: This document is a work-in-progress for researchers and implementers.

This document specifies configurable settings that clients must implement for the Merge.

### Override terminal total difficulty

To coordinate manual overrides to [`TERMINAL_TOTAL_DIFFICULTY`](./beacon-chain.md#Transition-settings) parameter, clients must provide `--terminal-total-difficulty-override` as a configurable setting. The value provided by this setting must take precedence over pre-configured `TERMINAL_TOTAL_DIFFICULTY` parameter. Clients should accept the setting as a decimal value (i.e., *not* hexadecimal).

Except under exceptional scenarios, this setting is not expected to be used. Sufficient warning to the user about this exceptional configurable setting should be provided.

### Override terminal block hash

To allow for transition coordination around a specific PoW block, clients must also provide `--terminal-block-hash-override` and `--terminal-block-hash-epoch-override` as configurable settings.
* The value provided by `--terminal-block-hash-override` takes precedence over the pre-configured `TERMINAL_BLOCK_HASH` parameter.
* The value provided by `--terminal-block-hash-epoch-override` takes precedence over the pre-configured `TERMINAL_BLOCK_HASH_ACTIVATION_EPOCH` parameter.

Except under exceptional scenarios, these settings are not expected to be used. Sufficient warning to the user about this exceptional configurable setting should be provided.
Run doctoc 2021-09-09 15:45:21 +00:00			`<!-- START doctoc generated TOC please keep comment here to allow auto update -->`
			`<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->`
			`Table of Contents generated with [DocToc](https://github.com/thlorenz/doctoc)`

			`- [The Merge -- Client Settings](#the-merge----client-settings)`
			`- [Override terminal total difficulty](#override-terminal-total-difficulty)`
Re-run doctoc 2021-09-22 18:24:05 +00:00			`- [Override terminal block hash](#override-terminal-block-hash)`
Run doctoc 2021-09-09 15:45:21 +00:00
			`<!-- END doctoc generated TOC please keep comment here to allow auto update -->`

Add new --terminal-total-difficulty-override client_setting 2021-09-08 19:34:33 +00:00			`# The Merge -- Client Settings`

			`Notice: This document is a work-in-progress for researchers and implementers.`

Wording change Co-authored-by: Danny Ryan <dannyjryan@gmail.com> 2021-09-09 15:37:39 +00:00			`This document specifies configurable settings that clients must implement for the Merge.`
Add new --terminal-total-difficulty-override client_setting 2021-09-08 19:34:33 +00:00
			`### Override terminal total difficulty`

Specify format for --terminal-total-difficulty 2021-10-05 09:00:45 +00:00			To coordinate manual overrides to [`TERMINAL_TOTAL_DIFFICULTY`](./beacon-chain.md#Transition-settings) parameter, clients must provide `--terminal-total-difficulty-override` as a configurable setting. The value provided by this setting must take precedence over pre-configured `TERMINAL_TOTAL_DIFFICULTY` parameter. Clients should accept the setting as a decimal value (i.e., not hexadecimal).
Add new --terminal-total-difficulty-override client_setting 2021-09-08 19:34:33 +00:00
ad TBH_ACTIVATION_EPOCH 2021-10-18 19:38:08 +00:00			`Except under exceptional scenarios, this setting is not expected to be used. Sufficient warning to the user about this exceptional configurable setting should be provided.`
Add note about default behavior 2021-09-08 19:57:49 +00:00
Add TERMINAL_BLOCK_HASH override 2021-09-22 18:18:41 +00:00			`### Override terminal block hash`

ad TBH_ACTIVATION_EPOCH 2021-10-18 19:38:08 +00:00			To allow for transition coordination around a specific PoW block, clients must also provide `--terminal-block-hash-override` and `--terminal-block-hash-epoch-override` as configurable settings.
			* The value provided by `--terminal-block-hash-override` takes precedence over the pre-configured `TERMINAL_BLOCK_HASH` parameter.
Fix setup.py parser and rename `TBH_ACTIVATION_EPOCH` -> `TERMINAL_BLOCK_HASH_ACTIVATION_EPOCH` 2021-10-19 03:25:50 +00:00			* The value provided by `--terminal-block-hash-epoch-override` takes precedence over the pre-configured `TERMINAL_BLOCK_HASH_ACTIVATION_EPOCH` parameter.
Add TERMINAL_BLOCK_HASH override 2021-09-22 18:18:41 +00:00
ad TBH_ACTIVATION_EPOCH 2021-10-18 19:38:08 +00:00			`Except under exceptional scenarios, these settings are not expected to be used. Sufficient warning to the user about this exceptional configurable setting should be provided.`