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 list of Runtime transactions #845

Open
wants to merge 31 commits into
base: main
Choose a base branch
from

Conversation

matevz
Copy link
Member

@matevz matevz commented Mar 15, 2022

This PR adds tools/extract-runtime-txs tool which parses Rust, Golang and TypeScript code for runtime transactions and generates a markdown list.

TODO:

  • Some helper queries like getParameters() per each module are not generated.
  • Fix missing runtime-sdk/src/types.rs error after rebase. This is because runtime-sdk/src/ is considered as a runtime-sdk module due to #handler[query =... snippets in dispatcher.rs.
  • Split transactions.md to

@codecov
Copy link

codecov bot commented Mar 15, 2022

Codecov Report

Merging #845 (dd4835e) into main (1d8816f) will decrease coverage by 0.53%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##             main     #845      +/-   ##
==========================================
- Coverage   68.00%   67.46%   -0.54%     
==========================================
  Files         128      131       +3     
  Lines       11030    11118      +88     
==========================================
  Hits         7501     7501              
- Misses       3497     3585      +88     
  Partials       32       32              
Impacted Files Coverage Δ
runtime-sdk-macros/src/lib.rs 0.00% <ø> (ø)
tools/extract-runtime-txs/tests/rust/basic.rs 0.00% <0.00%> (ø)
...s/extract-runtime-txs/tests/rust/basic_comments.rs 0.00% <0.00%> (ø)
tools/extract-runtime-txs/tests/rust/types.rs 0.00% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1d8816f...dd4835e. Read the comment docs.

@matevz matevz force-pushed the matevz/docs/runtime-transactions branch 3 times, most recently from 24ecdd1 to f52bcda Compare March 17, 2022 11:16
@matevz matevz force-pushed the matevz/docs/runtime-transactions branch from f52bcda to 6743eeb Compare March 17, 2022 16:34
@matevz matevz force-pushed the matevz/docs/runtime-transactions branch 4 times, most recently from b4e6141 to e4e345a Compare March 22, 2022 16:40
@matevz matevz force-pushed the matevz/docs/runtime-transactions branch from e4e345a to 62795f6 Compare March 30, 2022 08:59
@kostko
Copy link
Member

kostko commented Mar 30, 2022

@matevz matevz force-pushed the matevz/docs/runtime-transactions branch 3 times, most recently from 470c885 to 0b61c19 Compare April 4, 2022 14:03
@matevz matevz marked this pull request as ready for review April 4, 2022 14:37
@matevz matevz requested review from pro-wh and ptrus as code owners April 4, 2022 14:37
@matevz matevz force-pushed the matevz/docs/runtime-transactions branch from b0c608c to c20dca0 Compare April 5, 2022 11:30
@kostko
Copy link
Member

kostko commented Apr 5, 2022

Would be great if methods were grouped by kind (call, query) first.

@matevz matevz force-pushed the matevz/docs/runtime-transactions branch 2 times, most recently from 28e47db to 3028144 Compare April 5, 2022 12:05
@matevz matevz force-pushed the matevz/docs/runtime-transactions branch from 1e77ad1 to dd4835e Compare July 15, 2022 10:39
@ptrus ptrus requested a review from peternose as a code owner October 16, 2023 15:28
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

Successfully merging this pull request may close these issues.

2 participants