docs: Add Realm ABI Specification #2833
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The Realm ABI Specification formally describes the protocol and encoding of interactions between realms and external clients, not necessarily written in Go. It can be seen as an extension of the [ABCI](https://github.com/tendermint/tendermint/tree/master/spec/abci) which covers the protocol between blockchain nodes and clients, but without details on their practical applications, such as realms. This PR addresses [#1842]. This is an initial draft commit, work in progress.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2833 +/- ##
==========================================
- Coverage 60.87% 60.85% -0.02%
==========================================
Files 563 563
Lines 75193 75193
==========================================
- Hits 45770 45759 -11
- Misses 26055 26066 +11
Partials 3368 3368
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
leohhhn
changed the title
leohhhn
reviewed
Sep 23, 2024
docs/reference/realm-abi.md
Outdated
|
|
||
| # GNO Realm ABI specification | ||
|
|
||
| The GNO Realm Application Binary Interface (ABI) specifies the interface between realms (GNO smart contracts) and clients interacting with the realms. |
docs/reference/realm-abi.md
Outdated
|
|
||
| Realms implement live programs on the blockchain, also called smart contracts. | ||
|
|
||
| Each realm exists as a package, identified by its URL, and containing the realm source files. A realm has the following properties: |
There was a problem hiding this comment.
Suggested change
| Each realm exists as a package, identified by its URL, and containing the realm source files. A realm has the following properties: | |
| Each realm exists as a package, identified by its package path, and containing the package source files. A realm has the following properties: |
Comment on lines
+95
to
+98
| | Send | repeated [Coin](#coin) | amount to pay | 2 | | ||
| | PkgPath | string | package path of the function to call | 3 | | ||
| | Func | string | function name | 4 | | ||
| | Args | repeated string | function arguments | 5 | |
There was a problem hiding this comment.
I think it's important to make a distinction in that Send can take in a single string of multiple coins, like "1ugnot,3leon,5marc", while Args is a slice of strings instead of a single one.
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Realm ABI Specification formally describes the protocol and encoding of interactions between realms and external clients, not necessarily written in Go.
It can be seen as an extension of the
ABCI which covers the protocol between blockchain nodes and clients, but without details on their practical applications, such as realms.
This PR addresses [#1842].
This is an initial draft commit, work in progress.
Contributors' checklist...
BREAKING CHANGE: xxxmessage was included in the description