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: Add ABCI++ tutorials #9272

Closed
6 tasks done
Tracked by #9053
thanethomson opened this issue Aug 16, 2022 · 9 comments
Closed
6 tasks done
Tracked by #9053

docs: Add ABCI++ tutorials #9272

thanethomson opened this issue Aug 16, 2022 · 9 comments
Assignees
Labels
C:abci Component: Application Blockchain Interface C:docs Component: Documentation

Comments

@thanethomson
Copy link
Contributor

thanethomson commented Aug 16, 2022

I've split out this issue from #9053. We need to add the following tutorials relating to ABCI++ before v0.37.0 lands:

  • getting-started.md [small, 0.5 days]
  • indexing-transactions.md [small, 0.5 days]
  • abci-cli.md (review only) [small, 0.5 days]
  • what-is-tendermint.md (ABCI section) [small, 0.5 days]
  • go-built-in.md and go.md (same changes) [medium, 2 days]
  • new go-abci-plus-plus tutorial to demonstrate advanced ABCI++ usage
    • for the time being, just PrepareProposal/ProcessProposal
@thanethomson thanethomson changed the title abci++: Add tutorials docs: Add ABCI++ tutorials Aug 16, 2022
@cmwaters
Copy link
Contributor

Some of these pages like indexing-transactions I don't think need touching. Sergio, Samantha and myself have had some prior discussion on working on the new ABCI docs so perhaps we can be assigned that work

@sergio-mena
Copy link
Contributor

Right. File indexing-transactions will need to be changed for v0.38.x when we introduce FinalizeBlock, but not now. Let's leave it in this list though (I'll strike it through) so we can reuse this list for tracking our work on v0.38.x

@sergio-mena
Copy link
Contributor

About assigning, I believe each of these could be picked up in parallel, so feel free to (a) assign this issue to yourself (you'd be picking all files), or (b) to hit the "convert to issue" button above for those files you want to pick up.

In the second case, please don't forget to:

  • Assign the child issue to yourself
  • Set the project to Tendermint, so that other members of the team (and of the community) have visibility on what's currently going on
  • Set the status to "in progress"

@cmwaters
Copy link
Contributor

I was thinking about this a little more. I know previously we had thought about writing a guide to building a public forum, but I think taking dydx's use case and writing a guide to an orderbook with an oracle might better demonstrate ABCI++ functionality

@sergio-mena
Copy link
Contributor

Shouldn't we rather do that for v0.38.x, once we have vote extensions?
I think the work in this issue should rather be light... just adapting the text of those documents to the new API (only talking about PrepareProposal/ProcessProposal)

@cmwaters
Copy link
Contributor

Well if you wanted to demonstrate a non-trivial case (i.e. where the txs are returned back to Tendermint), then an orderbook is a good example

@sergio-mena
Copy link
Contributor

Good. In that case, please add one extra checkbox to this tracking issue: this extra checkbox should mention the creation of the tutorial on non-trivial usage of PrepareProposal/ProcessProposal (orderbook).

@thanethomson thanethomson added C:docs Component: Documentation C:abci Component: Application Blockchain Interface labels Nov 7, 2022
@lasarojc
Copy link
Contributor

lasarojc commented Nov 10, 2022

PR 9688 addresses points 1, 3, 4, 5 in the checklist.

@sergio-mena
Copy link
Contributor

Closing this issue: as per conversation on Mon, the advanced ABCI++ tutorial is considered a stretch goal for this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:abci Component: Application Blockchain Interface C:docs Component: Documentation
Projects
Status: Done/Merged
Development

No branches or pull requests

6 participants
@thanethomson @lasarojc @sergio-mena @cmwaters @samricotta and others