From 49756aef852c34d3e6fb140eb5574589ce17e787 Mon Sep 17 00:00:00 2001 From: Ryan Vermooten Date: Wed, 14 Dec 2022 18:23:09 +0200 Subject: [PATCH] docs: update docs to use octez-x rather than tezos-x for the commands (#636) * Contributor: rvermootenct, Effort=0.5h * Reviewer: jdsika, Effort=0h --- docs/paymentaddress.rst | 2 +- docs/tezossigner.rst | 6 +++--- src/cli/client_manager.py | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/paymentaddress.rst b/docs/paymentaddress.rst index e1e9931a..8f0dc175 100644 --- a/docs/paymentaddress.rst +++ b/docs/paymentaddress.rst @@ -9,6 +9,6 @@ An address can only be used for payments if it satisfies the following criteria: :: - ./tezos-client reveal key for + ./octez-client reveal key for - The payment address must be an implicit address (tz). The secret key of the address must be known and imported to the signer before running the TRD. Please refer to the Tezos signer section for detailed instructions. diff --git a/docs/tezossigner.rst b/docs/tezossigner.rst index df2dee12..40eb6de0 100644 --- a/docs/tezossigner.rst +++ b/docs/tezossigner.rst @@ -9,19 +9,19 @@ There are three steps, first get the secret key of the payment address, second i :: - ./tezos-client show address -S + ./octez-client show address -S 2. Import the obtained secret key to the Tezos Signer. For that, you can replace "edesk1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" with your encryped private key in the following command line: :: - ./tezos-signer import secret key encrypted:edesk1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + ./octez-signer import secret key encrypted:edesk1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 3. Launch the Tezos Signer. The following command will use the default IP address (127.0.0.1) and port (6732) of the Tezos signer, but these can be configured differently if desired by the user: :: - ./tezos-signer launch http signer + ./octez-signer launch http signer Normally encrypted accounts are imported to the signer. So, it is necessary to provide the encryption password to the signer at launch. Note that the signer generates generic signatures e.g. sigXXXX but not edsigXXXX. For instructions on how to configure the signer on a docker image please go to the next section. diff --git a/src/cli/client_manager.py b/src/cli/client_manager.py index b3ab6661..e16cb7ab 100644 --- a/src/cli/client_manager.py +++ b/src/cli/client_manager.py @@ -111,7 +111,7 @@ def sign(self, bytes, key_name, timeout=None): ) if response.status_code != HTTPStatus.OK: raise ClientException( - "Error at signing. Make sure tezos-signer is up and running 'tezos-signer launch http signer': '{}'".format( + "Error at signing. Make sure octez-signer is up and running 'octez-signer launch http signer': '{}'".format( response.text ) ) @@ -127,7 +127,7 @@ def check_pkh_known_by_signer(self, key_name, timeout=None): signer_exception = ( f"Error querying the signer at url {signer_url}. \n" - f'Please make sure you have started the signer using "./tezos-signer launch http signer", \n' + f'Please make sure you have started the signer using "./octez-signer launch http signer", \n' f"imported the secret key of the payout address {key_name}, \n" f"and specified the URL of signer using the flag -E http://: (default {PRIVATE_SIGNER_URL})" ) @@ -154,7 +154,7 @@ def get_authorized_keys(self, timeout=None): signer_exception = ( f"Error querying the signer at url {signer_url}. \n" - f'Please make sure to start the signer using "./tezos-signer launch http signer", \n' + f'Please make sure to start the signer using "./octez-signer launch http signer", \n' f"import the secret key of the payout address \n" f"and specify the url using the flag -E http://: (default {PRIVATE_SIGNER_URL})" )