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

Add developer docs on Penumbra SDK #34

Open
conorsch opened this issue Oct 4, 2024 · 0 comments
Open

Add developer docs on Penumbra SDK #34

conorsch opened this issue Oct 4, 2024 · 0 comments

Comments

@conorsch
Copy link
Contributor

conorsch commented Oct 4, 2024

The current dev docs https://guide.penumbra.zone/dev don't sufficiently explain how to code against Penumbra, when writing integrations or applications. We should absolutely call out the fact that although Penumbra is a Cosmos chain, one cannot use the Cosmos SDK. This violation of assumptions has caused friction for several devs, so let's write it down. Consider the following feedback shared from a recent developer:


  • Penumbra documentation suggestions
    • RPC service
      • Create a document that outlines how to interact with the tendermint-compatible blockchain service using a unique transaction format based on actions instead of traditional messages.
      • Describe supported endpoints , like status, blocks, block_results, tx, and events subscriptions.
  • Transaction payload
    • Transactions are structured around actions rather than messages. Explain the payload differences with examples.
  • Actions
    • Describe supported actions like spend,output, undelegateA
    • Describe tx parameters, detection data, etc
  • Events
    • List supported events, and show how clients can subscribe to various events emitted by the blockchain.
    • Describe supported events e.g. EventBlockRoot, EventAnchor , etc

In a nutshell, we need to highlight the importance of using custom protobuf messages via the buf tooling. That would go a long way in saving new devs time while orienting themselves to build against Penumbra.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant