diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 7e6b68d7..1dab8ad9 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -8,6 +8,7 @@ - [New Mnemonic](new_mnemonic.md) - [Existing Mnemonic](existing_mnemonic.md) - [Generate BLS to Execution Change](generate_bls_to_execution_change.md) +- [Generate BLS to Execution Change Keystore](generate_bls_to_execution_change_keystore.md) - [Exit Transaction Keystore](exit_transaction_keystore.md) - [Exit Transaction Mnemonic](exit_transaction_mnemonic.md) - [Partial Deposit](partial_deposit.md) @@ -18,6 +19,7 @@ - [Keystore](keystore_file.md) - [Deposit Data](deposit_data_file.md) - [BLS to Execution Change](bls_to_execution_change_file.md) +- [BLS to Execution Change Keystore](bls_to_execution_change_keystore_file.md) - [Signed Exit Transaction](signed_exit_transaction_file.md) # Development diff --git a/docs/src/bls_to_execution_change_keystore_file.md b/docs/src/bls_to_execution_change_keystore_file.md new file mode 100644 index 00000000..0d9d9ab9 --- /dev/null +++ b/docs/src/bls_to_execution_change_keystore_file.md @@ -0,0 +1,20 @@ +# BLS to Execution Change Keystore file + +A BLS to execution change keystore file is created when calling the **[generate-bls-to-execution-change-keystore](generate_bls_to_execution_change_keystore.md)** command. + +The BLS to execution change keystore file is a JSON file. The format is very similar to the [BLS to execution change file](bls_to_execution_change_file.md) but with the `from_bls_pubkey` and `metadata` attributes removed. + +## Utilizing + +There is currently no integration with this file format with either the execution layer or beacon chain. The `signature` value must be provided as the `keystore_signature` for the [Signature file](https://github.com/eth-educators/update-credentials-without-mnemonic?tab=readme-ov-file#signature-file-format). + +## Example +```JSON +{ + "message":{ + "validator_index":"1804776", + "to_execution_address":"0x4d496ccc28058b1d74b7a19541663e21154f9c84" + }, + "signature":"0xa1e47e6b1fdf4dd5f1dd3ddb3d47d2dcf446d096d49d90afef06a38dc02fba6b4d16d1dc1184c791e54666dabb8bdedd0660bc9bb3bc5d0e592eaf5f0c978cca4fcafe4037672940d6f1a44d2a33503c30cb98ca695979b1de9e321a8a694bc2", +} +``` diff --git a/docs/src/generate_bls_to_execution_change_keystore.md b/docs/src/generate_bls_to_execution_change_keystore.md index 00f0d4e9..621016f8 100644 --- a/docs/src/generate_bls_to_execution_change_keystore.md +++ b/docs/src/generate_bls_to_execution_change_keystore.md @@ -25,6 +25,9 @@ Signs a withdrawal credential update message using the provided keystore. This s - **`--devnet_chain_setting`**: The custom chain setting of a devnet or testnet. Note that it will override your `--chain` choice. This should be a JSON string containing an object with the following keys: network_name, genesis_fork_version, exit_fork_version and genesis_validator_root. +## Output files +A successful call to this command will result in one [BLS to Execution Change file](bls_to_execution_change_file.md) created. + ## Example Usage ```sh