consensys/doc.ethsigner

EthSigner software documentation

ConsenSys EthSigner

This documentation repo is built using Docusaurus 2.

Local Development

$ npm install
$ npm run prepare
$ npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

doc.ethsigner's Issues

Hashicorp Tutorial Page Tls vs No-TLS

The Hashicorp tutorial page is a little ambiguous, as it appears the Hashicorp Vault has been created without TLS, but we then start EthSigner using a fingerprint file (meaning Ethsigner expects to use a TLS connection to hashicorp)

Maybe the fingerprint information should go in the reference, and the tutorial should explicity use a hashicorp dev valult with no TLS) - and the ethsigner commandline should have the --tls-enabled=false

EthSigner supports GoQuorum private transactions

EthSigner now supports GoQuorum private transactions, but the documentation states otherewise.

See:

• https://docs.ethsigner.consensys.net/en/latest/Reference/API-Methods/#eea_sendtransaction
• https://github.com/ConsenSys/protocol-misc/issues/256

subcommand links go to wrong page

The 3 links on this page https://docs.ethsigner.consensys.net/en/latest/HowTo/Use-Single-Signer/
link to the wrong page.

• Missing content
• Outdated content
• Wrong content
• Confusing or misleading content
• Other

The broken page

https://docs.ethsigner.consensys.net/en/latest/HowTo/Use-Single-Signer/

Change suggestion

They should go to
https://docs.ethsigner.consensys.net/en/latest/Reference/CLI/CLI-Subcommands/

Add issue and PR templates

Add 2 issue templates:

• Doc tool bug report
• Doc content issue report

Add 2 PR templates:

• Content pull request
• DocOps pull request

See also PegaSysEng/Misc#67

Sample Epic

Sample epic for the purposes of ZenHub interface walkthrough

Doc how to view metrics

PR: Consensys/ethsigner#328

Doc eth_signTransaction

PR: Consensys/ethsigner#336

Rename --bonsai-maximum-back-layers-to-load option to --bonsai-historical-block-limit

See: https://github.com/hyperledger/besu/pull/5337/files

Doc GoQuorum private transaction type

PR: Consensys/ethsigner#349

Replace Orion references with Tessera

Orion has been deprecated, we should mention Tessera instead.

Fix example command line

On https://docs.ethsigner.pegasys.tech/en/latest/Tutorials/Start-EthSigner/, the following example is provided for starting Besu:

besu --network=dev --miner-enabled --miner-coinbase=0xfe3b557e8fb62b89f4916b721be55ceb828dbd73 --rpc-http-cors-origins="all" --host-whitelist=* --rpc-http-enabled --rpc-http-port=8590 --data-path=/Users/me/Datadir

There's two things that need fixing:

• The host-whitelist wildcard needs "" around it. ie, --host-whitelist="*"
• The data-path needs updating to be clearer that it's an example and will need to be updated to an existing directory

Doc that --tls-known-clients-file and --tls-allow-any-client are mutually exclusive

PR: Consensys/ethsigner#209

Fix typos

s/TIMOUT/TIMEOUT: https://docs.ethsigner.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#downstream-http-request-timeout

s/ETHSIGNER__METRICS/ETHSIGNER_METRICS: https://docs.ethsigner.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#metrics-enabled

extra (") character in tls-known-clients-file=""/Users/me/my_node/knownClients" : https://docs.ethsigner.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#tls-known-clients-file

Add notes that ethsigner is not multi-tenant enabled

With the introduction of multi-key signing, it might be assumed that ethsigner is also multi-tenant enabled, but it is not. Meaning, anyone with access to submit txs to ethsigner can use any of the keys that are available in the signer, so its more important with multi-key signing to ensure that ethsigner is secured to only authorised users who should make use of those private keys. We should capture this information somehow.

Include full path required for Hashicorp keys

See: Consensys/ethsigner#259

The secret path on the command line requires the full path - /v1/secret/ethsignerSigningKey

Update headers to use sentence case

All navigation and page headers should be updated to use sentence-style capitalization.

Doc TLS options for Hashicorp subcommand

PR: Consensys/ethsigner#204

End to end TLS

End to end TLS - https://pegasys1.atlassian.net/browse/ES-58

Diagram requires updating

The diagram needs updating (web3j-eea deprecation in favour of web3js-quorum)

https://docs.ethsigner.consensys.net/en/latest/Concepts/Overview/

Document eth_sign API

Document the eth_sign API.

See Consensys/ethsigner#263

typos

Found some typos on EthSigner docs.

1. typo s/TIMOUT/TIMEOUT https://docs.ethsigner.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#downstream-http-request-timeout
2. typo s/ETHSIGNER__METRICS/ETHSIGNER_METRICS https://docs.ethsigner.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#metrics-enabled
3. typo (extra " character) https://docs.ethsigner.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#tls-known-clients-file
   tls-known-clients-file=""/Users/me/my_node/knownClients"
4. https://docs.ethsigner.consensys.net/en/latest/Reference/CLI/CLI-Subcommands/#key-version
   azure-signer.key-name=key-version="7c01fe58d68148bba5824ce418241092"
   should be azure-signer.key-version="7c01fe58d68148bba5824ce418241092"

Check the issue type in the following list (insert X instead of space between [ ]): -->

• Missing content
• Outdated content
• Wrong content
• Confusing or misleading content
• Other

The broken page

See above. eg https://docs.ethsigner.consensys.net/en/latest/Reference/CLI/CLI-Syntax/#downstream-http-request-timeout

Migrate Ethsigner doc to new Doctools

See https://github.com/ConsenSys/doc.ethsigner for doc source code.

To do

• Create a github issue for migrating this doc (on the doc repos)
• Have agreement from the Ethsigner team
• Setup project on Cloudflare doc worker KV
• integrate design elements (no change for now, migrating as is)
• Exact site name: no change
• Expected domain: https://consensys.net/docs/ethsigner/
• Logo (SVG): no change
• Colour palette: no change
• Define content license: no change
• Disable Github repos interaction for 1 week to make sure no collisions in PRs
• Disable Github webhooks with RTD and Circle CI
• Disable Circle CI build (in circle project config)
• Create a new main branch from master (next default will be main)
• Remove everything except /docs content and mkdocs.yml file
• Copy files from doctools.template except /docs
• Update mkdocs.*.yml files
• Update Docker compose file
• Preview the site locally
• Make adjustments (logo, favicon)
• Update Readme
• Create production and preview environments on Github
• Create production secrets (see doctools.template)
• Create the Cloudflare KV entry
• Push the main branch to upstream: the migration has to be on a branch in the upstream repos, not a fork!
• Create a first PR to activate workflows (add “fixes #” to close the initial issue automatically
• Setup branch rule for main and require workflow
• Setup @ConsenSys/consensys-docops team as admin on repo and keep @ConsenSys/protocol-pliny as maintainers
• Test the new doc site is published on new URL consensys.net/docs/ethsigner
• Setup main as default branch
• Create release for the latest stable version
• Update Cloudflare DNS CNAMEs
• Test the old doc site domain redirects to the new docs.ethsigner.consensys.net
• Restore Github interactions
• Communicate on the new doc site

ConsenSys product contact

@ConsenSys/protocol-groot (PM @ryanjjones10 )

Update docker hub link from pegasysng/ethsigner to consensys/ethsigner

Describe the bug

We have moved Ethsigner docker images from pegasyseng/ethsigner to consensys/ethsigner. Need to update the docs.
This should only be merged after Ethsigner 21.10.0 release.

I'll create a PR with the changes.

• Missing content
• Outdated content
• Wrong content
• Confusing or misleading content
• Other

The broken page

[Paste the doc site page link here.]

Change suggestion

Replase pegasyseng/ethsigner with consensys/ethsigner

Test Infura

Move API documentation to the reference section.

The APIs are currently documented in the "Make transactions" topic.

Suggest moving to the reference section to be consistent with the rest of the documentation.

Add EthSigner high availability guidelines

Add EthSigner high availability guidelines

Replace Placeholder TLS image

Doc how to configure EthSigner for use with Infura

See blog post: https://medium.com/@corgi.desu/a-study-on-blockchain-key-management-systems-part-1-a668eedee058

Incorrect Environment Variable Name in Documentation for Azure Key Vault Name

Version: pegasyseng/ethsigner:21.3.0

Problem: Documentation mismatch

Description: Documentation for azure-signer states that the environment variable name for the Azure Key Vault name should be ETHSIGNER_AZURE_SIGNER_KEYVAULT_NAME (keyvault-name), which is ignored when set.
The variable which is read while the ethsigner starts is ETHSIGNER_AZURE_SIGNER_KEY_VAULT_NAME, with an extra _ between KEY and VAULT.

Doc requirement to explicitly specify if the whitelist and/or CA clients should be allowed to connect

PR: Consensys/ethsigner#211

Update repo links to ConsenSys

Essentially

• s/PegaSysEng/ConsenSys
• s/pegasys.tech/consensys.net
• the security email address needs updating

Doc how to use TOML config file and env variable for EthSigner

PR: Consensys/ethsigner#316

There's another PR required before this work is complete for doc'ing.

Add Azure tenant ID parameter

Breaking change notification
As a result of upgrading the Azure library, an Azure tenantid must be provided. Need to add this to the docs and to the changelog

Add to Azure to subcommands and to the Azure TOML files

Remove warning about EOL issue in password file

PR: Consensys/ethsigner#254

Use-Multiple-Signers page description is indicating single signer

https://docs.ethsigner.pegasys.tech/en/latest/HowTo/Use-Multiple-Signers/