chore: Add reference doc: Comparison of ways to communicate with Gno.land #2324

jefft0 · 2024-06-11T08:53:03Z

Fixes #2026
cc: @leohhhn

Signed-off-by: Jeff Thompson <[email protected]>

zivkovicmilos

Thank you for the writeup 🙏

I've left some comments, mostly concerns regarding the wording about Amino

Can we open a parallel docs.gno.land PR? @leohhhn, please give @jefft0 the pointers

zivkovicmilos · 2024-06-12T15:09:04Z

docs/how-to-guides/interact-with-gnoland-without-gnokey.md

+
+# Interact with Gno.land without gnokey
+
+A [previous tutorial](interact-with-gnoland.md) showed how to interact with the


Is this link valid? @leohhhn

It looks like this file was removed a couple days ago. 5541e35
@leohhhn , is there another equivalent doc that we can link to?

That file has been removed since it was outdated. Can you please rephrase this paragraph to exclude the link/include mentions of other related things in the docs?

zivkovicmilos · 2024-06-12T15:11:39Z

docs/how-to-guides/interact-with-gnoland-without-gnokey.md

+other methods to interact with gno.land without using `gnokey`, and when you might
+want to use them. This is mainly for developers writing an application.
+
+## RPC WebSocket


I would note this as the JSON-RPC interface, ws or not

zivkovicmilos · 2024-06-12T15:12:08Z

docs/how-to-guides/interact-with-gnoland-without-gnokey.md

+## RPC WebSocket
+
+**What is it?** The RPC interface is the base-level method to interact with the
+gno.land blockchain over a WebSocket connection. The actual RPC messages are Protobuf format.


What do you mean by Protobuf format?

zivkovicmilos · 2024-06-12T15:13:38Z

docs/how-to-guides/interact-with-gnoland-without-gnokey.md

+gno.land blockchain over a WebSocket connection. The actual RPC messages are Protobuf format.
+
+**When to use it?** The RPC WebSocket interface is used under-the-hood by `gnokey` and all
+the other methods. Some of the messages are simple and your app could open a WebSocket


As far as I know, gnokey uses the http interface exclusively, not the WS one

zivkovicmilos · 2024-06-12T15:16:18Z

docs/how-to-guides/interact-with-gnoland-without-gnokey.md

+
+## gRPC clients generated by Protobuf
+
+**What is it?** The core Gno codebase uses the light-weight


light-weight 👁️ 👄 👁️

zivkovicmilos · 2024-06-12T15:18:51Z

docs/how-to-guides/interact-with-gnoland-without-gnokey.md

+id: interact-with-gnoland-without-gnokey
+---
+
+# Interact with Gno.land without gnokey


I'm on the fence about this title, I think it's too general (the article doesn't even mention the JS clients)

+1 @jefft0

Let's think about a good title that is not too general. See last comment.

leohhhn · 2024-06-26T17:18:02Z

docs/how-to-guides/interact-with-gnoland-without-gnokey.md

+id: interact-with-gnoland-without-gnokey
+---
+
+# Interact with Gno.land without gnokey


+1 @jefft0

Let's think about a good title that is not too general. See last comment.

leohhhn · 2024-06-26T17:19:31Z

docs/how-to-guides/interact-with-gnoland-without-gnokey.md

+
+# Interact with Gno.land without gnokey
+
+A [previous tutorial](interact-with-gnoland.md) showed how to interact with the


That file has been removed since it was outdated. Can you please rephrase this paragraph to exclude the link/include mentions of other related things in the docs?

docs/how-to-guides/interact-with-gnoland-without-gnokey.md

leohhhn · 2024-06-26T17:23:39Z

docs/how-to-guides/interact-with-gnoland-without-gnokey.md

+different programming language. Instead, you can import a Protobuf library to format and parse
+the messages for interacting with the blockchain.
+
+## Go code with `gnoclient` and `crypto/keys`


I think for this section we should definitely reference the how-to guide on Connecting from Go, as well as the godoc for gnoclient, which can also be found in the official docs in the reference section.

leohhhn · 2024-06-26T21:57:12Z

@jefft0 Sorry for the delayed review.

This is definitely something that we want to have, but I see this as more of a reference page than a How-to guide. For it to be a how-to guide, it would need actual examples on how to, say, use RPC for Gno.land.

I do see value in having this one-pager as sort of an overview on the possibilities; we should put it under the Reference section, while making sure we include more things such as gno-js & tm2-js just like @zivkovicmilos mentioned. We could have this as a reference page, and then build out the separate how-to guides for each of the ways you can connect.

Also, we should think of a better title, and possibly not compare all things to gnokey/gnoweb, but simply have a general overview of each way of connecting. It would also be good to mention existing how-to guides/tutorials, such as for gnoclient.

Co-authored-by: Leon Hudak <[email protected]>

…okey.md

zivkovicmilos · 2024-08-15T12:36:49Z

@jefft0 did you get the chance to address the comments? 👀

…okey.md

codecov · 2024-08-20T08:49:05Z

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

…act-with-gnoland. Address comments. Signed-off-by: Jeff Thompson <[email protected]>

jefft0 · 2024-08-20T10:17:03Z

@jefft0 did you get the chance to address the comments? 👀

@zivkovicmilos and @leohhhn, we believe that we addressed all your comments. Please check again. Note that it is now a new filename moved to the reference folder, so inline comments may not match now.

…e to make lint happy Signed-off-by: Jeff Thompson <[email protected]>

…okey.md

Gno2D2 · 2024-12-17T15:35:56Z

🛠 PR Checks Summary

🔴 Changes to 'docs' folder must be reviewed/authored by at least one devrel and one tech-staff

Manual Checks (for Reviewers):

IGNORE the bot requirements for this PR (force green CI check)

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)
🔴 Changes to 'docs' folder must be reviewed/authored by at least one devrel and one tech-staff
🟢 Pending initial approval by a review team member, or review from tech-staff

☑️ Contributor Actions:

Fix any issues flagged by automated checks.
Follow the Contributor Checklist to ensure your PR is ready for review.
- Add new tests, or document why they are unnecessary.
- Provide clear examples/screenshots, if necessary.
- Update documentation, if required.
- Ensure no breaking changes, or include BREAKING CHANGE notes.
- Link related issues/PRs, where applicable.

☑️ Reviewer Actions:

Complete manual checks for the PR, including the guidelines and additional checks if applicable.

📚 Resources:

Debug

Automated Checks

Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 The pull request was created from a fork (head branch repo: jefft0/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

Changes to 'docs' folder must be reviewed/authored by at least one devrel and one tech-staff

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 A changed file matches this pattern: ^docs/ (filename: docs/reference/comparison-of-ways-to-interact-with-gnoland.md)

Then

🔴 Requirement not satisfied
└── 🔴 And
    ├── 🟢 Or
    │   ├── 🔴 Pull request author is a member of the team: tech-staff
    │   └── 🟢 At least 1 user(s) of the team tech-staff reviewed pull request(with state "APPROVED")
    └── 🔴 Or
        ├── 🔴 Pull request author is a member of the team: devrels
        └── 🔴 At least 1 user(s) of the team devrels reviewed pull request(with state "APPROVED")

Pending initial approval by a review team member, or review from tech-staff

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🟢 Requirement satisfied
└── 🟢 If
    ├── 🟢 Condition
    │   └── 🟢 Or
    │       ├── 🟢 At least 1 user(s) of the organization reviewed the pull request (with state "APPROVED")
    │       ├── 🟢 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🟢 Then
        └── 🟢 Not (🔴 This label is applied to pull request: review/triage-pending)

Manual Checks

**IGNORE** the bot requirements for this PR (force green CI check)
If
🟢 Condition met
└── 🟢 On every pull request
Can be checked by

Any user with comment edit permission

thehowl · 2025-01-16T14:59:12Z

ping @leohhhn @zivkovicmilos

aeddi

Nitpick: I find the addition very useful, but for a table/matrix of this kind, I would have preferred to provide it in text format (markdown) rather than as a jpg.
This allows for potentially seeing the diffs in the git history for future changes, easily modifying it, copying/pasting part or all of its content, displaying it in a terminal, etc.

costinberty · 2025-02-05T11:14:56Z

@aeddi thanks for thr remark to make the table in markdown format. I'm on it

aeddi · 2025-02-05T13:53:38Z

Thank you @costinberty :)
FYI, it was just a suggestion, no worries if we merge without it.

docs/reference/comparison-of-ways-to-interact-with-gnoland.md

Signed-off-by: Jeff Thompson <[email protected]>

…okey.md

jefft0 · 2025-02-18T11:56:41Z

The linter CI says "go: ../misc/devdeps/go.mod requires go >= 1.23.0 (running go 1.22.10)" . I merged the latest from master, right after PR #3772 . But still got the linter error.

…okey.md

jefft0 · 2025-02-18T14:04:24Z

The linter CI says "go: ../misc/devdeps/go.mod requires go >= 1.23.0 (running go 1.22.10)" . I merged the latest from master, right after PR #3772 . But still got the linter error.

Never mind. The linter CI check passes after merging master with PR #3773 .

jefft0 added 2 commits June 5, 2024 16:23

chore: In docs, add interact-with-gnoland-without-gnokey.md

2c12aa9

Signed-off-by: Jeff Thompson <[email protected]>

Update Interact_with_gnoland_without_gnokey.jpg

97fa916

Signed-off-by: Jeff Thompson <[email protected]>

jefft0 requested a review from moul as a code owner June 11, 2024 08:53

github-actions bot assigned jefft0 Jun 11, 2024

zivkovicmilos approved these changes Jun 12, 2024

View reviewed changes

leohhhn self-requested a review June 26, 2024 16:52

leohhhn requested changes Jun 26, 2024

View reviewed changes

jefft0 and others added 2 commits July 3, 2024 15:09

Update docs/how-to-guides/interact-with-gnoland-without-gnokey.md

dcd7492

Co-authored-by: Leon Hudak <[email protected]>

Merge branch 'master' into chore/add-interact-with-gnoland-without-gn…

9e74fa6

…okey.md

Merge branch 'master' into chore/add-interact-with-gnoland-without-gn…

d3444c2

…okey.md

chore: Rename interact-with-gnoland... to comparison-of-ways-to-inter…

d99d6f5

…act-with-gnoland. Address comments. Signed-off-by: Jeff Thompson <[email protected]>

jefft0 changed the title ~~chore: Add how-to guide for how to interact with the chain without using Gnoweb or Gnokey~~ chore: Add reference doc: Comparison of ways to communicate with Gno.land Aug 20, 2024

chore: comparison-of-ways-to-interact-with-gnoland: Add ending newlin…

5f1917b

…e to make lint happy Signed-off-by: Jeff Thompson <[email protected]>

Kouteki added review/triage-pending PRs opened by external contributors that are waiting for the 1st review and removed review/triage-pending PRs opened by external contributors that are waiting for the 1st review labels Oct 3, 2024

Merge branch 'master' into chore/add-interact-with-gnoland-without-gn…

a44261b

…okey.md

Gno2D2 requested review from a team December 17, 2024 15:35

thehowl requested a review from leohhhn December 18, 2024 11:56

aeddi reviewed Feb 4, 2025

View reviewed changes

costinberty reviewed Feb 18, 2025

View reviewed changes

docs/reference/comparison-of-ways-to-interact-with-gnoland.md Outdated Show resolved Hide resolved

chore: Use a markdown table in interact-with-gnoland-without-gnokey.md

b35261b

Signed-off-by: Jeff Thompson <[email protected]>

Merge branch 'master' into chore/add-interact-with-gnoland-without-gn…

4f523c8

…okey.md

jefft0 added 2 commits February 18, 2025 13:03

Merge branch 'master' into chore/add-interact-with-gnoland-without-gn…

8e34aab

…okey.md

Merge branch 'master' into chore/add-interact-with-gnoland-without-gn…

a7f56b1

…okey.md


		# Interact with Gno.land without gnokey

		A [previous tutorial](interact-with-gnoland.md) showed how to interact with the


		## gRPC clients generated by Protobuf

		What is it? The core Gno codebase uses the light-weight

chore: Add reference doc: Comparison of ways to communicate with Gno.land #2324

Are you sure you want to change the base?

chore: Add reference doc: Comparison of ways to communicate with Gno.land #2324

Conversation

jefft0 commented Jun 11, 2024

zivkovicmilos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leohhhn Jun 26, 2024 • edited Loading

Choose a reason for hiding this comment

leohhhn Jun 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leohhhn commented Jun 26, 2024 • edited Loading

zivkovicmilos commented Aug 15, 2024

codecov bot commented Aug 20, 2024 • edited Loading

Codecov Report

jefft0 commented Aug 20, 2024

Gno2D2 commented Dec 17, 2024 • edited Loading

🛠 PR Checks Summary

Manual Checks (for Reviewers):

✅ Automated Checks (for Contributors):

☑️ Contributor Actions:

☑️ Reviewer Actions:

📚 Resources:

If

Then

If

Then

If

Then

If

Can be checked by

thehowl commented Jan 16, 2025

aeddi left a comment • edited Loading

Choose a reason for hiding this comment

costinberty commented Feb 5, 2025

aeddi commented Feb 5, 2025

jefft0 commented Feb 18, 2025 • edited Loading

jefft0 commented Feb 18, 2025 • edited Loading

leohhhn Jun 26, 2024 •

edited

Loading

leohhhn Jun 26, 2024 •

edited

Loading

leohhhn commented Jun 26, 2024 •

edited

Loading

codecov bot commented Aug 20, 2024 •

edited

Loading

Gno2D2 commented Dec 17, 2024 •

edited

Loading

aeddi left a comment •

edited

Loading

jefft0 commented Feb 18, 2025 •

edited

Loading

jefft0 commented Feb 18, 2025 •

edited

Loading