ethstaker-deposit 1.3.1__tar.gz

ethstaker_deposit-1.3.1/LICENSE

@@ -0,0 +1,116 @@
+CC0 1.0 Universal
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific
+works ("Commons") that the public can reliably and without fear of later
+claims of infringement build upon, modify, incorporate in other works, reuse
+and redistribute as freely as possible in any form whatsoever and for any
+purposes, including without limitation commercial purposes. These owners may
+contribute to the Commons to promote the ideal of a free culture and the
+further production of creative, cultural and scientific works, or to gain
+reputation or greater distribution for their Work in part through the use and
+efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation
+of additional consideration or compensation, the person associating CC0 with a
+Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
+and publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not limited
+to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display, communicate,
+  and translate a Work;
+
+  ii. moral rights retained by the original author(s) and/or performer(s);
+
+  iii. publicity and privacy rights pertaining to a person's image or likeness
+  depicted in a Work;
+
+  iv. rights protecting against unfair competition in regards to a Work,
+  subject to the limitations in paragraph 4(a), below;
+
+  v. rights protecting the extraction, dissemination, use and reuse of data in
+  a Work;
+
+  vi. database rights (such as those arising under Directive 96/9/EC of the
+  European Parliament and of the Council of 11 March 1996 on the legal
+  protection of databases, and under any national implementation thereof,
+  including any amended or successor version of such directive); and
+
+  vii. other similar, equivalent or corresponding rights throughout the world
+  based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
+and Related Rights and associated claims and causes of action, whether now
+known or unknown (including existing as well as future claims and causes of
+action), in the Work (i) in all territories worldwide, (ii) for the maximum
+duration provided by applicable law or treaty (including future time
+extensions), (iii) in any current or future medium and for any number of
+copies, and (iv) for any purpose whatsoever, including without limitation
+commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
+the Waiver for the benefit of each member of the public at large and to the
+detriment of Affirmer's heirs and successors, fully intending that such Waiver
+shall not be subject to revocation, rescission, cancellation, termination, or
+any other legal or equitable action to disrupt the quiet enjoyment of the Work
+by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+judged legally invalid or ineffective under applicable law, then the Waiver
+shall be preserved to the maximum extent permitted taking into account
+Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
+is so judged Affirmer hereby grants to each affected person a royalty-free,
+non transferable, non sublicensable, non exclusive, irrevocable and
+unconditional license to exercise Affirmer's Copyright and Related Rights in
+the Work (i) in all territories worldwide, (ii) for the maximum duration
+provided by applicable law or treaty (including future time extensions), (iii)
+in any current or future medium and for any number of copies, and (iv) for any
+purpose whatsoever, including without limitation commercial, advertising or
+promotional purposes (the "License"). The License shall be deemed effective as
+of the date CC0 was applied by Affirmer to the Work. Should any part of the
+License for any reason be judged legally invalid or ineffective under
+applicable law, such partial invalidity or ineffectiveness shall not
+invalidate the remainder of the License, and in such case Affirmer hereby
+affirms that he or she will not (i) exercise any of his or her remaining
+Copyright and Related Rights in the Work or (ii) assert any associated claims
+and causes of action with respect to the Work, in either case contrary to
+Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+  a. No trademark or patent rights held by Affirmer are waived, abandoned,
+  surrendered, licensed or otherwise affected by this document.
+
+  b. Affirmer offers the Work as-is and makes no representations or warranties
+  of any kind concerning the Work, express, implied, statutory or otherwise,
+  including without limitation warranties of title, merchantability, fitness
+  for a particular purpose, non infringement, or the absence of latent or
+  other defects, accuracy, or the present or absence of errors, whether or not
+  discoverable, all to the greatest extent permissible under applicable law.
+
+  c. Affirmer disclaims responsibility for clearing rights of other persons
+  that may apply to the Work or any use thereof, including without limitation
+  any person's Copyright and Related Rights in the Work. Further, Affirmer
+  disclaims responsibility for obtaining any necessary consents, permissions
+  or other rights required for any use of the Work.
+
+  d. Affirmer understands and acknowledges that Creative Commons is not a
+  party to this document and has no duty or obligation with respect to this
+  CC0 or use of the Work.
+
+For more information, please see
+<http://creativecommons.org/publicdomain/zero/1.0/>

ethstaker_deposit-1.3.1/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.4
+Name: ethstaker_deposit
+Version: 1.3.1
+Summary: Secure key generation for deposits
+Project-URL: Homepage, https://github.com/ethstaker/ethstaker-deposit-cli
+Requires-Python: <4,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.4.2
+Requires-Dist: eth-typing>=6.0.0
+Requires-Dist: eth-utils>=6.0.0
+Requires-Dist: pycryptodome>=3.23.0
+Requires-Dist: pyperclip>=1.11.0
+Requires-Dist: py-ecc>=8.0.0
+Requires-Dist: ssz>=0.5.2
+Requires-Dist: jsonschema>=4.26.0
+Requires-Dist: colorama>=0.4.6; sys_platform == "win32"
+Provides-Extra: test
+Requires-Dist: exceptiongroup==1.3.1; extra == "test"
+Requires-Dist: mypy==2.3.1; extra == "test"
+Requires-Dist: pytest==9.1.1; extra == "test"
+Requires-Dist: pytest-asyncio==1.4.0; extra == "test"
+Requires-Dist: backports-asyncio-runner==1.2.0; python_version < "3.11" and extra == "test"
+Requires-Dist: coverage==7.15.4; extra == "test"
+Requires-Dist: tomli==2.4.1; extra == "test"
+Requires-Dist: iniconfig==2.3.0; extra == "test"
+Requires-Dist: mypy-extensions==1.1.0; extra == "test"
+Requires-Dist: packaging==26.3; extra == "test"
+Requires-Dist: pluggy==1.6.0; extra == "test"
+Requires-Dist: typing-extensions==4.16.0; extra == "test"
+Requires-Dist: ruff==0.16.4; extra == "test"
+Requires-Dist: Pygments==2.20.0; extra == "test"
+Requires-Dist: pathspec==1.1.1; extra == "test"
+Requires-Dist: pip-audit==2.10.1; extra == "test"
+Dynamic: license-file
+
+# ethstaker-deposit-cli docs
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+## Documentation
+- [Introduction](https://deposit-cli.ethstaker.cc/landing.html)
+- [Quick Setup](https://deposit-cli.ethstaker.cc/quick_setup.html)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Introduction
+
+`ethstaker-deposit-cli` is a tool for creating [EIP-2335 format](https://eips.ethereum.org/EIPS/eip-2335) BLS12-381 keystores and a corresponding `deposit_data*.json` file for [Ethereum Staking Launchpad](https://github.com/ethereum/staking-launchpad) or the [Gnosis Beacon Chain deposit UI](https://github.com/gnosischain/gbc-deposit-ui/). One can also provide a keystore file to generate a `signed_exit_transaction*.json` file to be broadcast at a later date to exit a validator.
+
+- **Warning: Please generate your keystores on your own safe, completely offline device.**
+- **Warning: Please backup your mnemonic, keystores, and password securely.**
+
+Please read [Launchpad Validator FAQs](https://launchpad.ethereum.org/faq#keys) before generating the keys.
+
+The project has been through various security audits over the years. You can find them here:
+- March 4, 2026: [Security assessment report by Trail of Bits](https://github.com/trailofbits/publications/blob/master/reviews/2026-03-ethstaker-deposit-cli-securityreview.pdf)
+- December 13, 2024: [Security assessment report by Trail of Bits](https://github.com/trailofbits/publications/blob/master/reviews/2024-12-ethstaker-depositcli-securityreview.pdf)
+- September 4, 2020: [Security assessment report by Trail of Bits](https://github.com/trailofbits/publications/blob/master/reviews/ETH2DepositCLI.pdf) of the original staking-deposit-cli project
+
+## Canonical Deposit Contract and Launchpad
+
+Ethstaker confirms the canonical Ethereum staking deposit contract addresses and launchpad URLs.
+Please be sure that your ETH is deposited only to this deposit contract address, depending on chain.
+
+Depositing to the wrong address **will** lose you your ETH.
+
+- Ethereum mainnet
+  - Deposit address: [0x00000000219ab540356cBB839Cbe05303d7705Fa](https://etherscan.io/address/0x00000000219ab540356cBB839Cbe05303d7705Fa)
+  - [Launchpad](https://launchpad.ethereum.org/)
+- Ethereum Hoodi testnet
+  - Deposit address: [0x00000000219ab540356cBB839Cbe05303d7705Fa](https://hoodi.etherscan.io/address/0x00000000219ab540356cBB839Cbe05303d7705Fa)
+  - [Launchpad](https://hoodi.launchpad.ethereum.org/)
+
+- Plataberget testnet
+  - Deposit address: [0x00000000219ab540356cBB839Cbe05303d7705Fa](https://dora.plataberget.ethpandaops.io/address/0x00000000219ab540356cbb839cbe05303d7705fa)
+  - [Validator deposits via Dora](https://dora.plataberget.ethpandaops.io/validators/deposits/submit)
+  - Plataberget is expected to be shut down by the end of 2026.
+
+- Gnosis mainnet
+  - Deposit address: [0x0B98057eA310F4d31F2a452B414647007d1645d9](https://gnosis.blockscout.com/address/0x0B98057eA310F4d31F2a452B414647007d1645d9)
+  - [Gnosis Beacon Chain deposit UI](https://deposit.gnosischain.com/)
+- Chiado testnet
+  - Deposit address: [0xb97036A26259B7147018913bD58a774cf91acf25](https://gnosis-chiado.blockscout.com/address/0xb97036A26259B7147018913bD58a774cf91acf25)
+  - [Gnosis Beacon Chain deposit UI](https://deposit.gnosischain.com/)

ethstaker_deposit-1.3.1/README.md

@@ -0,0 +1,49 @@
+# ethstaker-deposit-cli docs
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+## Documentation
+- [Introduction](https://deposit-cli.ethstaker.cc/landing.html)
+- [Quick Setup](https://deposit-cli.ethstaker.cc/quick_setup.html)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Introduction
+
+`ethstaker-deposit-cli` is a tool for creating [EIP-2335 format](https://eips.ethereum.org/EIPS/eip-2335) BLS12-381 keystores and a corresponding `deposit_data*.json` file for [Ethereum Staking Launchpad](https://github.com/ethereum/staking-launchpad) or the [Gnosis Beacon Chain deposit UI](https://github.com/gnosischain/gbc-deposit-ui/). One can also provide a keystore file to generate a `signed_exit_transaction*.json` file to be broadcast at a later date to exit a validator.
+
+- **Warning: Please generate your keystores on your own safe, completely offline device.**
+- **Warning: Please backup your mnemonic, keystores, and password securely.**
+
+Please read [Launchpad Validator FAQs](https://launchpad.ethereum.org/faq#keys) before generating the keys.
+
+The project has been through various security audits over the years. You can find them here:
+- March 4, 2026: [Security assessment report by Trail of Bits](https://github.com/trailofbits/publications/blob/master/reviews/2026-03-ethstaker-deposit-cli-securityreview.pdf)
+- December 13, 2024: [Security assessment report by Trail of Bits](https://github.com/trailofbits/publications/blob/master/reviews/2024-12-ethstaker-depositcli-securityreview.pdf)
+- September 4, 2020: [Security assessment report by Trail of Bits](https://github.com/trailofbits/publications/blob/master/reviews/ETH2DepositCLI.pdf) of the original staking-deposit-cli project
+
+## Canonical Deposit Contract and Launchpad
+
+Ethstaker confirms the canonical Ethereum staking deposit contract addresses and launchpad URLs.
+Please be sure that your ETH is deposited only to this deposit contract address, depending on chain.
+
+Depositing to the wrong address **will** lose you your ETH.
+
+- Ethereum mainnet
+  - Deposit address: [0x00000000219ab540356cBB839Cbe05303d7705Fa](https://etherscan.io/address/0x00000000219ab540356cBB839Cbe05303d7705Fa)
+  - [Launchpad](https://launchpad.ethereum.org/)
+- Ethereum Hoodi testnet
+  - Deposit address: [0x00000000219ab540356cBB839Cbe05303d7705Fa](https://hoodi.etherscan.io/address/0x00000000219ab540356cBB839Cbe05303d7705Fa)
+  - [Launchpad](https://hoodi.launchpad.ethereum.org/)
+
+- Plataberget testnet
+  - Deposit address: [0x00000000219ab540356cBB839Cbe05303d7705Fa](https://dora.plataberget.ethpandaops.io/address/0x00000000219ab540356cbb839cbe05303d7705fa)
+  - [Validator deposits via Dora](https://dora.plataberget.ethpandaops.io/validators/deposits/submit)
+  - Plataberget is expected to be shut down by the end of 2026.
+
+- Gnosis mainnet
+  - Deposit address: [0x0B98057eA310F4d31F2a452B414647007d1645d9](https://gnosis.blockscout.com/address/0x0B98057eA310F4d31F2a452B414647007d1645d9)
+  - [Gnosis Beacon Chain deposit UI](https://deposit.gnosischain.com/)
+- Chiado testnet
+  - Deposit address: [0xb97036A26259B7147018913bD58a774cf91acf25](https://gnosis-chiado.blockscout.com/address/0xb97036A26259B7147018913bD58a774cf91acf25)
+  - [Gnosis Beacon Chain deposit UI](https://deposit.gnosischain.com/)

ethstaker_deposit-1.3.1/ethstaker_deposit/VERSION

@@ -0,0 +1 @@
+1.3.1

ethstaker_deposit-1.3.1/ethstaker_deposit/__init__.py

@@ -0,0 +1,4 @@
+from importlib.resources import files
+
+__version__ = files(__package__).joinpath("VERSION").read_text().strip()
+__all__ = ["__version__"]

ethstaker_deposit-1.3.1/ethstaker_deposit/__main__.py

@@ -0,0 +1,4 @@
+from ethstaker_deposit import deposit
+
+if __name__ == "__main__":
+    deposit.run()

ethstaker_deposit-1.3.1/ethstaker_deposit/bls_to_execution_change_keystore.py

@@ -0,0 +1,72 @@
+import json
+import os
+from typing import Any
+from eth_typing import HexAddress
+from eth_utils import to_canonical_address
+from py_ecc.bls import G2ProofOfPossession as bls
+
+from ethstaker_deposit.exceptions import ValidationError
+from ethstaker_deposit.settings import BaseChainSetting
+from ethstaker_deposit.utils.ssz import (
+    BLSToExecutionChangeKeystore,
+    SignedBLSToExecutionChangeKeystore,
+    compute_signing_root,
+    compute_bls_to_execution_change_keystore_domain,
+)
+from ethstaker_deposit.utils.file_handling import (
+    sensitive_opener,
+)
+
+
+def bls_to_execution_change_keystore_generation(
+        chain_setting: BaseChainSetting,
+        signing_key: int,
+        withdrawal_address: HexAddress,
+        validator_index: int) -> SignedBLSToExecutionChangeKeystore:
+    if withdrawal_address is None:
+        raise ValueError("The withdrawal address should NOT be empty.")
+    if chain_setting.GENESIS_VALIDATORS_ROOT is None:
+        raise ValidationError("The genesis validators root should NOT be empty "
+                              "for this chain to obtain the BLS to execution change.")
+
+    message = BLSToExecutionChangeKeystore(  # type: ignore[no-untyped-call]
+        validator_index=validator_index,
+        to_execution_address=to_canonical_address(withdrawal_address),
+    )
+    domain = compute_bls_to_execution_change_keystore_domain(
+        fork_version=chain_setting.GENESIS_FORK_VERSION,
+        genesis_validators_root=chain_setting.GENESIS_VALIDATORS_ROOT,
+    )
+    signing_root = compute_signing_root(message, domain)
+    signature = bls.Sign(signing_key, signing_root)
+
+    return SignedBLSToExecutionChangeKeystore(  # type: ignore[no-untyped-call]
+        message=message,
+        signature=signature,
+    )
+
+
+def export_bls_to_execution_change_keystore_json(folder: str,
+                                                 signed_execution_change: SignedBLSToExecutionChangeKeystore,
+                                                 timestamp: float) -> str:
+    signed_bls_to_execution_change_keystore_json: dict[str, Any] = {}
+
+    address = '0x' + signed_execution_change.message.to_execution_address.hex()  # type: ignore[attr-defined]
+    index = signed_execution_change.message.validator_index  # type: ignore[attr-defined]
+    signature = '0x' + signed_execution_change.signature.hex()  # type: ignore[attr-defined]
+
+    message = {
+        'to_execution_address': address,
+        'validator_index': index,
+    }
+    signed_bls_to_execution_change_keystore_json.update({'message': message})
+    signed_bls_to_execution_change_keystore_json.update({'signature': signature})
+
+    filefolder = os.path.join(
+        folder,
+        f'bls_to_execution_change_keystore_signature-{index}-{int(timestamp)}.json'
+    )
+
+    with open(filefolder, 'w', encoding='utf-8', opener=sensitive_opener) as f:
+        json.dump(signed_bls_to_execution_change_keystore_json, f)
+    return filefolder

ethstaker_deposit-1.3.1/ethstaker_deposit/cli/builder.py

@@ -0,0 +1,171 @@
+import click
+import pyperclip
+from typing import Any
+
+from ethstaker_deposit.key_handling.key_derivation.mnemonic import (
+    get_mnemonic,
+    reconstruct_mnemonic,
+)
+from ethstaker_deposit.cli.existing_mnemonic import (
+    validate_mnemonic,
+)
+from ethstaker_deposit.exceptions import ValidationError
+from ethstaker_deposit.utils import config
+from ethstaker_deposit.utils.click import (
+    captive_prompt_callback,
+    choice_prompt_func,
+    jit_option,
+    prompt_if_none,
+    prompt_if_other_is_none,
+)
+from ethstaker_deposit.utils.constants import (
+    MNEMONIC_LANG_OPTIONS,
+    WORD_LISTS_PATH,
+)
+from ethstaker_deposit.utils.intl import (
+    fuzzy_reverse_dict_lookup,
+    load_text,
+    get_first_options,
+)
+from ethstaker_deposit.utils.terminal import clear_terminal
+from ethstaker_deposit.utils.validation import validate_int_range
+
+from .generate_builder_keys import (
+    generate_builder_keys,
+    generate_builder_keys_arguments_decorator,
+)
+
+languages = get_first_options(MNEMONIC_LANG_OPTIONS)
+
+
+def _mnemonic_language_default() -> str | None:
+    # If an existing mnemonic was supplied, its language is auto-detected by validate_mnemonic.
+    # A fresh mnemonic needs a wordlist language chosen up-front
+    ctx = click.get_current_context(silent=True)
+    if ctx is not None and ctx.params.get('mnemonic'):
+        return None
+    return load_text(['arg_mnemonic_language', 'default'], func='builder')
+
+
+def _process_mnemonic_language(mnemonic_language: str, _: Any) -> str | None:
+    return fuzzy_reverse_dict_lookup(mnemonic_language, MNEMONIC_LANG_OPTIONS) if mnemonic_language else None
+
+
+def _resolve_mnemonic(ctx: click.Context, param: Any, mnemonic: str) -> str | None:
+    if mnemonic:
+        # Provided directly via --mnemonic
+        return validate_mnemonic(mnemonic=mnemonic, language=ctx.params.get('mnemonic_language'))
+    if config.non_interactive:
+        return None
+    has_existing = click.confirm(load_text(['arg_mnemonic', 'existing_confirm'], func='builder'), default=False)
+    if not has_existing:
+        return None
+    return captive_prompt_callback(
+        lambda mnemonic, _: validate_mnemonic(mnemonic=mnemonic, language=ctx.params.get('mnemonic_language')),
+        lambda: load_text(['arg_mnemonic', 'prompt'], func='builder'),
+        prompt_if=prompt_if_none,
+    )(ctx, param, mnemonic)
+
+
+def _resolve_mnemonic_password(ctx: click.Context, param: Any, mnemonic_password: str) -> str:
+    resolved = captive_prompt_callback(
+        lambda x, _: x,
+        lambda: load_text(['arg_mnemonic_password', 'prompt'], func='builder'),
+        lambda: load_text(['arg_mnemonic_password', 'confirm'], func='builder'),
+        lambda: load_text(['arg_mnemonic_password', 'mismatch'], func='builder'),
+        hide_input=True,
+    )(ctx, param, mnemonic_password)
+    if resolved and not ctx.params.get('mnemonic'):
+        # Do not allow mnemonic password if mnemonic is not provided
+        raise ValidationError(load_text(['err_mnemonic_password_not_allowed'], func='builder'))
+    return resolved
+
+
+@click.command(
+    help=load_text(['arg_builder', 'help'], func='builder'),
+)
+@click.pass_context
+@jit_option(
+    callback=_resolve_mnemonic,
+    help=lambda: load_text(['arg_mnemonic', 'help'], func='builder'),
+    param_decls='--mnemonic',
+    default=None,
+    prompt=False,
+    type=str,
+    is_eager=True,
+)
+@jit_option(
+    callback=_resolve_mnemonic_password,
+    default='',
+    help=lambda: load_text(['arg_mnemonic_password', 'help'], func='builder'),
+    hidden=True,
+    param_decls='--mnemonic_password',
+    prompt=False,
+)
+@jit_option(
+    callback=captive_prompt_callback(
+        _process_mnemonic_language,
+        choice_prompt_func(lambda: load_text(['arg_mnemonic_language', 'prompt'], func='builder'), languages),
+        default=_mnemonic_language_default,
+        prompt_if=prompt_if_other_is_none('mnemonic'),
+    ),
+    default=_mnemonic_language_default,
+    help=lambda: load_text(['arg_mnemonic_language', 'help'], func='builder'),
+    param_decls='--mnemonic_language',
+    prompt=False,
+)
+@jit_option(
+    # We do not want to request a start index if a mnemonic is not provided as it
+    # is assumed to be 0, unless provided. If a mnemonic is provided we must request
+    # the start index if not already provided
+    callback=lambda ctx, param, num: (
+        captive_prompt_callback(
+            lambda num, _: validate_int_range(num, 0, 2**32),
+            lambda: load_text(['arg_builder_start_index', 'prompt'], func='builder'),
+            lambda: load_text(['arg_builder_start_index', 'confirm'], func='builder'),
+            prompt_if=prompt_if_none,
+        )(ctx, param, num)
+        if ctx.params.get('mnemonic')
+        else captive_prompt_callback(
+            lambda num, _: validate_int_range(num, 0, 2**32),
+            lambda: load_text(['arg_builder_start_index', 'prompt'], func='builder'),
+        )(ctx, param, num)
+    ),
+    default=0,
+    help=lambda: load_text(['arg_builder_start_index', 'help'], func='builder'),
+    param_decls="--builder_start_index",
+    prompt=False,
+)
+@generate_builder_keys_arguments_decorator
+def builder(ctx: click.Context, mnemonic: str, mnemonic_password: str, mnemonic_language: str, **kwargs: Any) -> None:
+    if not mnemonic:
+        mnemonic = get_mnemonic(language=mnemonic_language, words_path=WORD_LISTS_PATH)
+        test_mnemonic = ''
+        while mnemonic != reconstruct_mnemonic(test_mnemonic, WORD_LISTS_PATH, mnemonic_language):
+            clear_terminal()
+            click.echo(
+                load_text(['msg_mnemonic_presentation'], func='builder')
+                + '\n\n********************\n'
+                + load_text(['msg_mnemonic_clipboard_warning'], func='builder')
+                + '\n********************'
+            )
+            click.echo(f'\n\n{mnemonic}\n\n')
+            click.pause(load_text(['msg_press_any_key'], func='builder'))
+
+            clear_terminal()
+            test_mnemonic = click.prompt(
+                load_text(['msg_mnemonic_retype_prompt'], func='builder')
+                + '\n\n********************\n'
+                + load_text(['msg_mnemonic_clipboard_warning'], func='builder')
+                + '\n********************\n\n'
+            )
+        clear_terminal()
+        # Clear clipboard
+        try:  # Failing this on headless Linux is expected
+            click.pause(load_text(['msg_confirm_clipboard_clearing'], func='builder'))
+            pyperclip.copy(' ')
+        except Exception:  # noqa: S110
+            pass
+
+    ctx.obj = {'mnemonic': mnemonic, 'mnemonic_password': mnemonic_password}
+    ctx.forward(generate_builder_keys)

ethstaker_deposit-1.3.1/ethstaker_deposit/cli/existing_mnemonic.py

@@ -0,0 +1,126 @@
+import click
+import pyperclip
+from typing import Any
+from collections.abc import Callable
+
+from ethstaker_deposit.exceptions import MultiLanguageError, ValidationError
+from ethstaker_deposit.key_handling.key_derivation.mnemonic import (
+    reconstruct_mnemonic,
+)
+from ethstaker_deposit.utils import config
+from ethstaker_deposit.utils.constants import (
+    MNEMONIC_LANG_OPTIONS,
+    WORD_LISTS_PATH,
+)
+from ethstaker_deposit.utils.click import (
+    captive_prompt_callback,
+    choice_prompt_func,
+    jit_option,
+    prompt_if_none,
+)
+from ethstaker_deposit.utils.intl import fuzzy_reverse_dict_lookup, get_first_options, load_text
+from ethstaker_deposit.utils.validation import validate_int_range
+from .generate_keys import (
+    generate_keys,
+    generate_keys_arguments_decorator,
+)
+
+
+def load_mnemonic_arguments_decorator(function: Callable[..., Any]) -> Callable[..., Any]:
+    '''
+    This is a decorator that, when applied to a parent-command, implements the
+    to obtain the necessary arguments for the generate_keys() subcommand.
+    '''
+    decorators = [
+        jit_option(
+            callback=lambda c, _, mnemonic:
+                captive_prompt_callback(
+                    lambda mnemonic, _: validate_mnemonic(mnemonic=mnemonic,
+                                                          language=c.params.get('mnemonic_language')),
+                    prompt=lambda: load_text(['arg_mnemonic', 'prompt'], func='existing_mnemonic'),
+                    prompt_if=prompt_if_none,
+                )(c, _, mnemonic),
+            help=lambda: load_text(['arg_mnemonic', 'help'], func='existing_mnemonic'),
+            param_decls='--mnemonic',
+            prompt=False,
+            type=str,
+        ),
+        jit_option(
+            callback=captive_prompt_callback(
+                lambda x, _: x,
+                lambda: load_text(['arg_mnemonic_password', 'prompt'], func='existing_mnemonic'),
+                lambda: load_text(['arg_mnemonic_password', 'confirm'], func='existing_mnemonic'),
+                lambda: load_text(['arg_mnemonic_password', 'mismatch'], func='existing_mnemonic'),
+                hide_input=True,
+            ),
+            default='',
+            help=lambda: load_text(['arg_mnemonic_password', 'help'], func='existing_mnemonic'),
+            hidden=True,
+            param_decls='--mnemonic_password',
+            prompt=False,
+        ),
+        jit_option(
+            callback=validate_mnemonic_language,
+            default=None,
+            help=lambda: load_text(['arg_mnemonic_language', 'help'], func='existing_mnemonic'),
+            param_decls='--mnemonic_language',
+            prompt=None,
+        ),
+    ]
+    for decorator in reversed(decorators):
+        function = decorator(function)
+    return function
+
+
+def validate_mnemonic(mnemonic: str, language: str | None = None) -> str:
+    try:
+        reconstructed_mnemonic = reconstruct_mnemonic(mnemonic, WORD_LISTS_PATH, language)
+    except MultiLanguageError as e:
+        # Get discovered languages from error and prompt user to select one of them
+        available_languages = sorted(get_first_options({lang: MNEMONIC_LANG_OPTIONS[lang] for lang in e.languages}))
+        prompt_message = choice_prompt_func(lambda: load_text(['arg_mnemonic_language'], func='validate_mnemonic'),
+                                            available_languages,
+                                            False)
+        language = click.prompt(prompt_message())
+        mnemonic_language = fuzzy_reverse_dict_lookup(language, MNEMONIC_LANG_OPTIONS)
+        return validate_mnemonic(mnemonic=mnemonic, language=mnemonic_language)
+
+    if reconstructed_mnemonic is not None:
+        return reconstructed_mnemonic
+    else:
+        raise ValidationError(load_text(['err_invalid_mnemonic']))
+
+
+def validate_mnemonic_language(ctx: click.Context, param: Any, language: str) -> str | None:
+    return fuzzy_reverse_dict_lookup(language, MNEMONIC_LANG_OPTIONS) if language else None
+
+
+@click.command(
+    help=load_text(['arg_existing_mnemonic', 'help'], func='existing_mnemonic'),
+)
+@load_mnemonic_arguments_decorator
+@jit_option(
+    callback=captive_prompt_callback(
+        lambda num, _: validate_int_range(num, 0, 2**32),
+        lambda: load_text(['arg_validator_start_index', 'prompt'], func='existing_mnemonic'),
+        lambda: load_text(['arg_validator_start_index', 'confirm'], func='existing_mnemonic'),
+        prompt_if=prompt_if_none,
+    ),
+    default=0,
+    help=lambda: load_text(['arg_validator_start_index', 'help'], func='existing_mnemonic'),
+    param_decls="--validator_start_index",
+    prompt=False,  # the callback handles the prompt
+)
+@generate_keys_arguments_decorator
+@click.pass_context
+def existing_mnemonic(ctx: click.Context, mnemonic: str, mnemonic_password: str, **kwargs: Any) -> None:
+    ctx.obj = {} if ctx.obj is None else ctx.obj  # Create a new ctx.obj if it doesn't exist
+    ctx.obj.update({'mnemonic': mnemonic, 'mnemonic_password': mnemonic_password})
+    # Clear clipboard
+    try:  # Failing this on headless Linux is expected
+        if not config.non_interactive:
+            click.pause(load_text(['msg_confirm_clipboard_clearing']))
+        pyperclip.copy(' ')
+    except Exception:  # noqa: S110
+        pass
+    ctx.forward(generate_keys)