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

[ref-docs]: Improve ref-docs for signed extensions #3234

Closed
wants to merge 2 commits into from

Conversation

jsdw
Copy link
Contributor

@jsdw jsdw commented Feb 6, 2024

The goals of this signed extension ref doc is to provide an overview of signed extensions, with links to various examples (eg current signed extensions and the trait itself) to learn more. This page is linked from the extrinsic_encoding docs so that, when from learning how to encode signed extensions as part of extrinsics there, you can come here for a bit of a deeper look into what they are and some examples showing how they are useful.

I did find myself struggling to decide what was worth writing here though as opposed to on the trait etc itself. I also am not an expert on writing signed extensions (being more of a consumer/encoder of them from client code), but nevertheless I thought I'd have a stab at this :)

Feedback welcome!

Closes paritytech/polkadot-sdk-docs#42

@jsdw jsdw added R0-silent Changes should not be mentioned in any release notes T11-documentation This PR/Issue is related to documentation. labels Feb 6, 2024
@jsdw jsdw marked this pull request as ready for review February 6, 2024 17:32
Copy link
Contributor

@kianenigma kianenigma left a comment

Choose a reason for hiding this comment

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

I don't mind this, but I was thinking maybe we should also wait for #2280, and then revamp this page? cc @georgepisaltu wdyt? Do you think is it worth teaching people about signed extensions at this point?

Copy link
Contributor

@georgepisaltu georgepisaltu left a comment

Choose a reason for hiding this comment

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

Signed extensions are becoming deprecated in favor of a new interface, TransactionExtension. More details on that in #2280.

I think waiting for TransactionExtension to drop and revamping this is the best course of action. A very good starting point is the PR description of #2280. I will also review the proposed docs here as I am sure there will be bits and pieces that will still be relevant.

@jsdw
Copy link
Contributor Author

jsdw commented Feb 7, 2024

I think waiting for TransactionExtension to drop and revamping this is the best course of action. A very good starting point is the PR description of #2280. I will also review the proposed docs here as I am sure there will be bits and pieces that will still be relevant.

Yup, I agree; I've looked through the new PR and related bits, and while I'm sure bits are still relevant, I'm happy to wait until that stuff merges and then have another look and update the details/examples/etc to line up with the new stuff :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
R0-silent Changes should not be mentioned in any release notes T11-documentation This PR/Issue is related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Ref docs for signed_extensions
3 participants