Add doc explaining how to use Move scripts #7449
Conversation
banool
force-pushed
the
banool/move-scripts-doc
branch
3 times, most recently
from
7e39786 to
d8cc15d
Compare
banool
requested review from
clay-aptos,
saharct,
davidiw and
gregnazario
as code owners
There was a problem hiding this comment.
Thanks, Daniel! I made some slight edits and added a short intro. Other than a comment seeking clarity, this LGTM!
Also, I will note this addition in the related and add you for potential next steps:
#6318
|
|
||
| That entry should go in a Move module file. | ||
|
|
||
| Now you need to determine: |
There was a problem hiding this comment.
Is it useful to list these questions here instead of directly below along with the answers?
There was a problem hiding this comment.
So this originally came from Stack Overflow and is therefore meant to be in a Q&A format. Already it's a bit more confusing because it is no longer "I have this problem / question" and "here is the answer", but "you might have this problem" and "here is the answer".
There was a problem hiding this comment.
I'm open to changes, idk what's best now, the style of this doc has changed a lot now lol
There was a problem hiding this comment.
Up to you. I don't feel strongly about this. Was just curious
There was a problem hiding this comment.
I moved the questions to be the intro of the Execution section (which was my gut response yet trying not to trample Daniel's fine work).
| cd testing | ||
| ``` | ||
|
|
||
| 2. Set up the Aptos CLI: |
There was a problem hiding this comment.
Why now link to the CLI doc?
There was a problem hiding this comment.
Hmmm? Not sure what you mean.
There was a problem hiding this comment.
We're just duplicating the steps for setting up the CLI so a ref to the setup CLI page might be more maintainable
There was a problem hiding this comment.
I think doing that for just a single step would be confusing, we don't have a doc that tells you only how to use aptos init. A quick search in the docs reveals that there are like 20 places where we suggest people use aptos init directly in the guide.
There was a problem hiding this comment.
I felt the same way and so wrote:
https://aptos.dev/guides/get-test-funds#create-an-aptos-account
To be fair, this was existent but sparse and mixed into a rather gigantic doc (that I am hoping @gregnazario will let me break into sub-pages someday):
https://aptos.dev/cli-tools/aptos-cli-tool/use-aptos-cli#step-1-run-aptos-init
I can also link to one of the above yet agree with Daniel he's supplying the minimum details to keep the user going. This is why you find aptos init everywhere, I imagine. :-)
There was a problem hiding this comment.
That's a nice doc, feel free to add a link to that if it makes sense :D
banool
force-pushed
the
banool/move-scripts-doc
branch
from
662b265 to
4a7e06e
Compare
|
|
||
| let balance = coin::balance<aptos_coin::AptosCoin>(src_addr); | ||
| if (balance < desired_balance) { | ||
| aptos_account::transfer(src, dest, desired_balance - balance); |
There was a problem hiding this comment.
nit: Might as well demonstrate two calls, especially those against public fun functions that are not callable as normal transactions. For example:
let withdraw_coins = aptos_account::withdraw_coins(...);
aptos_account::deposit_coins(dest, withdraw_coins);
|
Related: |
Description
This is mostly copied from my Stack Overflow post here (which I will update to point to the docs once this lands). I made a few tweaks but it is mostly unchanged. I like the question -> answer format, so I'd prefer to keep it that way.
Test Plan
CI.