-
Notifications
You must be signed in to change notification settings - Fork 134
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
analyzing smart contract cost and efficiency #711
analyzing smart contract cost and efficiency #711
Conversation
@briwylde08 |
Thank you for your contribution! We will review and get back to you. I did allocate three weeks to our reviewers and there's a lot to review so apologies in advance if there are any delays! |
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.
Hi @Myestery! Thank you for your contribution. I think this could use a lot more information on specific techniques and examples for us to consider it for the documentation. While you do touch on some topics, it would be great to have deeper dives on optimization techniques. For example, you could start with a complicated, expensive contract that is unoptimized, then go step by step on various ways on how you can save on instruction or storage costs (e.g. combining steps in a loop, different storage mechanisms, events over storage, etc.). You already do this a bit, but the complex_transfer
and simple_transfer
are accomplishing fundamentally different things; it'd be better if they accomplished the same thing, but one was much cheaper than the other.
@Shaptic I have added more context, examples and deep dive to the documentation |
Hello @briwylde08 @Shaptic |
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.
This is coming along nicely, but there's still some room for improvement for this to be maximally useful for readers. I added a few comments below! Feel free to tag me again when they're resolved.
docs/build/guides/conventions/analyzing-smart-contract-cost.mdx
Outdated
Show resolved
Hide resolved
docs/build/guides/conventions/analyzing-smart-contract-cost.mdx
Outdated
Show resolved
Hide resolved
docs/build/guides/conventions/analyzing-smart-contract-cost.mdx
Outdated
Show resolved
Hide resolved
Hello @Shaptic Ready for your Review |
Hello @Shaptic |
@Myestery this is looking really good at first glance, I'll do a final review first thing tomorrow! |
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.
Thanks for the reminder - this looks great!! This will be super helpful to people new to optimizing their code for the smart contract environment. Passing it off to @briwylde08 for a final look at grammar etc. + bounty approval.
docs/build/guides/conventions/analyzing-smart-contract-cost.mdx
Outdated
Show resolved
Hide resolved
* analyzing smart contract cost and efficiency * talk about contract size * formatting & words * add more examples and expand deep dive * format:mdx * fix docusaurus Admonitions * fix code samples using bash * add storage mechanisms to docs * attend to PR comments * Add a small typo fix * editorial nits --------- Co-authored-by: Bri <92327786+briwylde08@users.noreply.github.com> Co-authored-by: George <Shaptic@users.noreply.github.com>
@briwylde08
Bounty submission for #609
fix #609