Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Examples how to communicate with the Ledger from the client side #201

Open
ashcherbakov opened this issue Jan 27, 2022 · 2 comments
Labels
enhancement New feature or request size: XL

Comments

@ashcherbakov
Copy link
Contributor

ashcherbakov commented Jan 27, 2022

We have docs with CLI commands and REST endpoints for queries.
However, some clients may need to work with the Ledger from code (programmatically).
In particular, there is no way to submit and sign a txn via REST. The transaction needs to be built and signed via gRPC (from code), and then can be published via either REST or gRPC.

We need the following examples and docs for clients:

  • Write requests via gRPC and REST (building and signing transactions)
  • Read requests via gRPC
  • Write requests via Tendermint RPC
  • Read requests via Tendermint RPC
  • [Optionally] Verification of proofs via Tendermint's light client if Tendermint RPC is used
  • [Optionally] Better docs for CLI
  • [Optionally] Better docs for REST read requests
    • consider Swagger which can be generated by Cosmos

Consider adding the examples as demo tests executed in CI.

Consider adding examples for multiple programming languages where it makes sense.

@ashcherbakov ashcherbakov added this to Backlog in DCL via automation Jan 27, 2022
@ashcherbakov ashcherbakov moved this from Backlog to To do in DCL Jan 27, 2022
@ashcherbakov ashcherbakov moved this from To do to Backlog in DCL Jan 27, 2022
@ashcherbakov
Copy link
Contributor Author

openapi has been exported at https://zigbee-alliance.github.io/distributed-compliance-ledger/ as part of #206

@ashcherbakov ashcherbakov added enhancement New feature or request size: L labels Mar 15, 2022
@ashcherbakov ashcherbakov added this to the v1.0: Main Net Launch milestone Mar 15, 2022
@ashcherbakov ashcherbakov moved this from Backlog to To do in DCL Mar 15, 2022
@hawk248
Copy link
Collaborator

hawk248 commented Mar 22, 2022

Post 1.0

@ashcherbakov ashcherbakov moved this from To do to Backlog in DCL Mar 23, 2022
@ashcherbakov ashcherbakov removed this from the v1.1: Post Main Net Launch milestone Oct 25, 2022
@ashcherbakov ashcherbakov removed this from Backlog in DCL Feb 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request size: XL
Projects
None yet
Development

No branches or pull requests

2 participants