Add subxt documentation #546
Merged
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
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
jsdw
reviewed
May 23, 2022
jsdw
reviewed
May 23, 2022
jsdw
reviewed
May 23, 2022
jsdw
reviewed
May 23, 2022
jsdw
reviewed
May 23, 2022
jsdw
reviewed
May 23, 2022
jsdw
reviewed
May 23, 2022
jsdw
reviewed
May 23, 2022
jsdw
reviewed
May 23, 2022
Co-authored-by: Tarik Gul <47201679+TarikGul@users.noreply.github.com>
Co-authored-by: Tarik Gul <47201679+TarikGul@users.noreply.github.com>
Co-authored-by: Tarik Gul <47201679+TarikGul@users.noreply.github.com>
Co-authored-by: Tarik Gul <47201679+TarikGul@users.noreply.github.com>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
jsdw
reviewed
Jun 14, 2022
jsdw
reviewed
Jun 14, 2022
jsdw
reviewed
Jun 14, 2022
jsdw
reviewed
Jun 14, 2022
jsdw
reviewed
Jun 14, 2022
jsdw
reviewed
Jun 14, 2022
jsdw
reviewed
Jun 14, 2022
jsdw
reviewed
Jun 14, 2022
subxt/src/extrinsic/mod.rs
Outdated
Comment on lines
32
to
43
| //! For this implementation: | ||
| //! - "signed extra" contains: | ||
| //! - sp_runtime::Era: This is utilized to determine the longevity of a transaction. | ||
| //! - nonce: Account index (aka nonce) that stores the number of previous transactions | ||
| //! associated with a sender account. This is utilized to avoid replay attacks. | ||
| //! - tip: A tip payment for including the transaction in the block. | ||
| //! - "additional" contains: | ||
| //! - spec_version: The version of the runtime specification of the node. | ||
| //! - transaction_version: The version of the extrinsic interface. This allows hardware | ||
| //! wallets to know which transactions can be safely signed. | ||
| //! - genesis_hash: The hash of the Genesis block. | ||
| //! - mortality_checkpoint: The block hash after which the transaction becomes valid. |
There was a problem hiding this comment.
I'm happy to keep this, but aware that it can easily fall out of sync with reality if these things change :)
There was a problem hiding this comment.
In that case, we could remove this for now. It's hard to notice when those things change, even so, remember to update the comment. We could add it back later when things are stable enough.
There was a problem hiding this comment.
Sounds good to me; I think what you wrote above was sufficient anyway :)
jsdw
reviewed
Jun 14, 2022
jsdw
reviewed
Jun 14, 2022
Co-authored-by: James Wilson <james@jsdw.me>
Co-authored-by: James Wilson <james@jsdw.me>
Co-authored-by: James Wilson <james@jsdw.me>
Co-authored-by: James Wilson <james@jsdw.me>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
…add_documentation
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
jsdw
approved these changes
Jun 14, 2022
This was referenced Oct 26, 2022
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.
This PR adds subxt documentation with in-line examples.
While at it, simplify the number of params of
codegenfunctions.Closes #542.