Add Move Library section to Move doc #751
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Fantastic work, Xun! Note, I'm moving this file to a doc/src/build subdirectory in PR #743. Thank you so much! |
666lcz
approved these changes
Mar 11, 2022
doc/src/move.md
Outdated
| - Shared and mutable (work-in-progress). | ||
|
|
||
| **Transfer to Address** | ||
| The [`Transfer`](../../sui_programmability/framework/sources/Transfer.move) module provides all the APIs needed to manipuate the ownership of objects. |
There was a problem hiding this comment.
@Clay-Mysten do we plan to also serve this doc in the Dev Portal? The relative path to the source code will not work in Dev Portal right since they are not in the same Repo.
doc/src/move.md
Outdated
| Transfer::transfer(obj, recipient); | ||
| ``` | ||
| This call will fully consume the object, making it no longer accessible in the current transaction. | ||
| Once an account address owns an object, for any future use of this object, the signer of the transaction must be the owner of the object. |
There was a problem hiding this comment.
Does this also include "read" operation?
There was a problem hiding this comment.
Yes, including read operation.
doc/src/move.md
Outdated
| Transfer::share_object(obj); | ||
| ``` | ||
| After this call, `obj` stays mutable, but becomes shared by everyone, i.e. anyone can send a transaction to mutate this object. However, such an object cannot be deleted, transferred or embedded in another object as a field. | ||
| Shared mutable object can be powerful in that it will make programming a lot simpler in many cases, but it comes with the trade-off that it is significantly more expensive to use. One can see the difference of the two programming schemes between not using shared object vs using shared object by looking at the two different implementations of TicTacToe: [No Shared Object](../../sui_programmability/examples/games/sources/TicTacToe.move) vs [Shared Object](../../sui_programmability/examples/games/sources/TicTacToeV2.move). |
There was a problem hiding this comment.
nit: define expensive here to help developers better understand the exact tradeoff(e.g., does it just cost more gas for the users or it's also higher latency, etc..)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As a starting point, this PR adds the following to the Move doc:
Left out
CollectionandNFTto be filled up latter.