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

📨 Section for transaction envelopes #1011

Closed
JFWooten4 opened this issue Oct 1, 2024 · 3 comments
Closed

📨 Section for transaction envelopes #1011

JFWooten4 opened this issue Oct 1, 2024 · 3 comments

Comments

@JFWooten4
Copy link
Contributor

JFWooten4 commented Oct 1, 2024

What problem does your feature solve?

The present transaction envelope specifications are quite brief. 💭 Namely, there are almost no programmatic examples employing envelopes specifically outside of fee bumps. This despite the reality of envelopes' foundational role throughout the development lifecycle.

What would you like to see?

A page which can be linked as a supplement to the brief glossary index for transaction envelopes. 📄 This full explainer would detail the many creation nuances embedded in managing transaction envelopes across different SDK languages.1 Moreover, it might contextualize the design choices around maximum signers and muxed address storage by explaining how this data gets stored in the transaction envelope object. 🧠

What alternatives are there?

We could leave new developers to uncover these nuances themselves through trial-and-error. However, this would likely lead to underknown bugs in language-specific SDKs, without a common documentation framework to reference. 🐜 Lastly, it'd be a much easier href for citations.

Footnotes

  1. See, e.g., different community interpretations for storing, parsing, and building envelopes.

@briwylde08
Copy link
Contributor

This makes a good point! I think this might be better suited for the JS SDK docs: https://stellar.github.io/js-stellar-sdk/

Going to close this and suggest it there.

@github-project-automation github-project-automation bot moved this from Ideas to Done in Dev Docs Jan 7, 2025
@JFWooten4
Copy link
Contributor Author

@briwylde08 are you the author of the new issue? Wanted to mark the new items for future follow-up <3

@briwylde08
Copy link
Contributor

Moved to Discussions: #1205

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

2 participants