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 gnoclient reference & how-to guide #1562

Merged
merged 23 commits into from
Mar 29, 2024

Conversation

leohhhn
Copy link
Contributor

@leohhhn leohhhn commented Jan 19, 2024

Description

This PR adds the reference documentation to the newly added gnoclient.
The reference docs for gnoclient are mostly generated by using a godoc to markdown tool, with slight modifications.

It also adds a how-to guide on how to connect to a Gno.land chain from Go.

Along the way:

  • Adds index pages & minor doc improvements for tm2-js & gno-js
  • Updates godoc comments in client
  • Changes gnoclient function signatures to all be on the same type of receiver (all tests pass). I realize this could've been a different PR but its a small change with no functional/practical impact.
Contributors' checklist...
  • Added new tests, or not needed, or not feasible
  • Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
  • Updated the official documentation or not needed
  • No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
  • Added references to related issues and PRs
  • Provided any useful hints for running manual tests
  • Added new benchmarks to generated graphs, if any. More info here.

@leohhhn leohhhn added the 📖 documentation Improvements or additions to documentation label Jan 19, 2024
@github-actions github-actions bot removed the 📖 documentation Improvements or additions to documentation label Jan 25, 2024
@github-actions github-actions bot added the 📦 ⛰️ gno.land Issues or PRs gno.land package related label Mar 26, 2024
Copy link

codecov bot commented Mar 26, 2024

Codecov Report

Attention: Patch coverage is 62.50000% with 3 lines in your changes are missing coverage. Please review.

Project coverage is 44.83%. Comparing base (8376831) to head (7b1f6bd).
Report is 8 commits behind head on master.

Files Patch % Lines
gno.land/pkg/gnoclient/client_queries.go 40.00% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1562      +/-   ##
==========================================
- Coverage   47.55%   44.83%   -2.73%     
==========================================
  Files         388      459      +71     
  Lines       61279    67625    +6346     
==========================================
+ Hits        29144    30322    +1178     
- Misses      29695    34760    +5065     
- Partials     2440     2543     +103     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@leohhhn leohhhn marked this pull request as ready for review March 26, 2024 08:58
@leohhhn leohhhn requested review from a team and moul as code owners March 26, 2024 08:58
@leohhhn leohhhn requested a review from gfanton March 26, 2024 09:20
Copy link
Member

@gfanton gfanton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good! Adding an example of a typical flow with gnoclient would be cool.

docs/reference/gnoclient/client.md Show resolved Hide resolved
@leohhhn leohhhn requested a review from zivkovicmilos March 27, 2024 01:27
@leohhhn leohhhn changed the title docs: add gnoclient reference docs: add gnoclient reference & how-to guide Mar 27, 2024
@leohhhn
Copy link
Contributor Author

leohhhn commented Mar 28, 2024

Latest preview of the PR: https://www.loom.com/share/c51d5d18f0b74e6aa8e7aa388343e1bd?sid=0b12d2e3-2699-4d7a-b1d2-4dbb30deded1

Copy link
Member

@zivkovicmilos zivkovicmilos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 💯

gno.land/pkg/gnoclient/client_txs.go Outdated Show resolved Hide resolved
gno.land/pkg/gnoclient/signer_test.go Outdated Show resolved Hide resolved
@zivkovicmilos zivkovicmilos merged commit b9bb9fe into gnolang:master Mar 29, 2024
183 of 184 checks passed
@leohhhn leohhhn deleted the docs/gnoclient branch March 30, 2024 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📦 ⛰️ gno.land Issues or PRs gno.land package related
Projects
Status: Done
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants