-
Notifications
You must be signed in to change notification settings - Fork 262
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
Add subxt documentation #546
Conversation
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Co-authored-by: Tarik Gul <[email protected]>
Co-authored-by: Tarik Gul <[email protected]>
Co-authored-by: Tarik Gul <[email protected]>
Co-authored-by: Tarik Gul <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
subxt/src/extrinsic/mod.rs
Outdated
//! 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good to me; I think what you wrote above was sufficient anyway :)
Co-authored-by: James Wilson <[email protected]>
Co-authored-by: James Wilson <[email protected]>
Co-authored-by: James Wilson <[email protected]>
Co-authored-by: James Wilson <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
…add_documentation
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
This PR adds subxt documentation with in-line examples.
While at it, simplify the number of params of
codegen
functions.Closes #542.