Skip to content

Commit

Permalink
docs: update docs to use octez-x rather than tezos-x for the commands (
Browse files Browse the repository at this point in the history
…#636)

* Contributor: rvermootenct, Effort=0.5h
* Reviewer: jdsika, Effort=0h
  • Loading branch information
Ryan Vermooten authored Dec 14, 2022
1 parent 2c4eaea commit 49756ae
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/paymentaddress.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ An address can only be used for payments if it satisfies the following criteria:

::

./tezos-client reveal key for <alias>
./octez-client reveal key for <alias>

- 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.
6 changes: 3 additions & 3 deletions docs/tezossigner.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ There are three steps, first get the secret key of the payment address, second i

::

./tezos-client show address <myaddressalias> -S
./octez-client show address <myaddressalias> -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 <myaddressalias> encrypted:edesk1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
./octez-signer import secret key <myaddressalias> 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.
6 changes: 3 additions & 3 deletions src/cli/client_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
)
)
Expand All @@ -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://<signer_addr>:<port> (default {PRIVATE_SIGNER_URL})"
)
Expand All @@ -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://<signer_addr>:<port> (default {PRIVATE_SIGNER_URL})"
)
Expand Down

0 comments on commit 49756ae

Please sign in to comment.