Integrate the Web3Signer REST API spec. - #343
Conversation
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
|
@bgravenorst is attempting to deploy a commit to the Consensys Team on Vercel. A member of the Team first needs to authorize it. |
|
I have read the CLA Document and I hereby sign the CLA You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
| ## The APIs | ||
|
|
||
| Web3Signer supports REST and [JSON-RPC APIs](../reference/api/_category_.json) to sign consensus layer and execution layer payloads | ||
| Web3Signer supports REST and [JSON-RPC APIs](../reference/api/json-rpc.md) to sign consensus layer and execution layer payloads |
There was a problem hiding this comment.
| Web3Signer supports REST and [JSON-RPC APIs](../reference/api/json-rpc.md) to sign consensus layer and execution layer payloads | |
| Web3Signer supports [REST](../reference/api/rest.md) and [JSON-RPC APIs](../reference/api/json-rpc.md) to sign consensus layer and execution layer payloads |
There was a problem hiding this comment.
As a (lazy) user, when I jump into an API reference I expect to see the classic items -- how to authenticate, what the rate limits are. Given this is local service none of that applies, but the security expectations are similar, so I would recommend that the reference section would still be a good location to provide context on how the service is protected.
Consider an index page for the APIs that links user back into the docs to reinforce the security mechanisms. Something like:
Web3Signer provides two API surfaces:
[HTTP REST API](link)(used for key management, metadata, health checks, and similar operations)[Ethereum JSON-RPC Signing API](link)(for signing operations such as eth_sign and eth_sendRawTransaction)
Both APIs run on the same underlying HTTP server. Because neither API surface provides application-level authentication (such as API keys, Basic Auth, or OAuth), the following network-level protections are recommended:
[TLS encryption](link)for all API communication[Host allowlist](link)to restrict which hosts may connect to Web3Signer- Firewalling and use of private interfaces to limit network exposure
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
e6f78ed to
570bc58
Compare
d7e65f2 to
3a6d7bd
Compare
Updates:
src/openapi-specs/.http://localhost:9000to prevent//pathdisplay issues.@redocly/cli@2.12.6intosrc/openapi-specs/*-bundled.yaml.docs/reference/api/**isn’t committed.Preview: https://doc-web3signer-git-fork-bgravenorst-doc-339-consensys-ddffed67.vercel.app/development/reference/api/eth2/healthcheck