-
Notifications
You must be signed in to change notification settings - Fork 318
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
Proofread Nodes & Modes #967
Proofread Nodes & Modes #967
Conversation
@@ -1,7 +1,7 @@ | |||
# Message Modes Cookbook |
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.
Sentence case
@@ -1,7 +1,7 @@ | |||
# Message Modes Cookbook | |||
|
|||
Understanding the different modes and flags available for sending messages is crucial to ensure that your smart contracts behave as intended. | |||
While [message modes](/v3/documentation/smart-contracts/message-management/sending-messages#message-modes) section provided detailed descriptions of these modes and flags, in this section we will illustrate their practical application through specific examples. | |||
While the [message modes](/v3/documentation/smart-contracts/message-management/sending-messages#message-modes) section provides detailed descriptions of these modes and flags, in this section we will illustrate their practical application through specific examples. | |||
|
|||
:::info IMPORTANT |
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.
Is it necessary to point to this example here?
Looks not clear, how this example will help readers, who just opened page.
@@ -11,23 +11,23 @@ You can check [this example](https://testnet.tonviewer.com/transaction/42ed45726 | |||
|
|||
Please check how [get_balance](/v3/documentation/smart-contracts/func/docs/stdlib/#get_balance) works to better understand `balance` inside TVM. | |||
|
|||
All TON tokens owned by a contract are reflected in the [contract balance](https://github.com/ton-blockchain/ton/blob/7151ff26279fef6dcfa1f47fc0c5b63677ae2458/crypto/block/block.tlb#L263C1-L265C20). Some of these tokens are also attributed to the currently processed incoming [message](/v3/documentation/data-formats/tlb/msg-tlb#commonmsginfo) - a mechanism that works effectively because any TON transaction involving a [non-system contract](/v3/documentation/smart-contracts/contracts-specs/governance) processes exactly one incoming message at a time. | |||
All TON tokens owned by a contract are reflected in the [contract balance](https://github.com/ton-blockchain/ton/blob/7151ff26279fef6dcfa1f47fc0c5b63677ae2458/crypto/block/block.tlb#L263C1-L265C20). Some of these tokens are also attributed to the currently processed incoming [message](/v3/documentation/data-formats/tlb/msg-tlb#commonmsginfo) — a mechanism that works effectively because any TON transaction involving a [non-system contract](/v3/documentation/smart-contracts/contracts-specs/governance) processes exactly one incoming message at a time. |
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.
Examples are really helpful, and links should be provided. However, let's maintain a balance, such as one link per paragraph or about three links per page.
@@ -40,17 +40,17 @@ The table is populated based on [this example](https://tonviewer.com/transaction | |||
|
|||
| Fee in Explorer | Value | How it's obtained | | |||
| :------------------------------------------------------------------------------------------------ | :---------- | :------------------------------ | | |||
| Total fee | 0,001982134 | gas + storage + action + import | |
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.
Capitalized Total fee
seems inconsistent here. Could it be total fee
?
@@ -40,17 +40,17 @@ The table is populated based on [this example](https://tonviewer.com/transaction | |||
|
|||
| Fee in Explorer | Value | How it's obtained | |
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.
Use sentence case in the headers.
Fee in explorer
@@ -1,7 +1,7 @@ | |||
# Message Modes Cookbook | |||
|
|||
Understanding the different modes and flags available for sending messages is crucial to ensure that your smart contracts behave as intended. | |||
While [message modes](/v3/documentation/smart-contracts/message-management/sending-messages#message-modes) section provided detailed descriptions of these modes and flags, in this section we will illustrate their practical application through specific examples. | |||
While the [message modes](/v3/documentation/smart-contracts/message-management/sending-messages#message-modes) section provides detailed descriptions of these modes and flags, in this section we will illustrate their practical application through specific examples. |
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.
Seems better for reading:
While the [message modes](https://github.com/memearchivarius/ton-docs-meme/blob/proofread_docs/v3/documentation/smart-contracts/message-management/sending-messages#message-modes) section provides detailed descriptions of these modes and flags, this section illustrates their practical application through specific examples.
|
||
Therefore, any blockchain payment may come either: | ||
|
||
- From the incoming message `value`. | ||
For instance, computation fees are paid in this way, unless contract calls [accept_message](v3/documentation/smart-contracts/transaction-fees/accept-message-effects). This ensures that malicious actors cannot spend contract's balance on handling their data. | ||
- From the contract `balance` (will not touch amount of TON designated as incoming this transaction). | ||
For instance, computation fees are paid in this way, unless the contract calls [accept_message](/v3/documentation/smart-contracts/transaction-fees/accept-message-effects). This ensures that malicious actors cannot spend the contract's balance on handling their data. |
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.
Cut unnecessary words:
For instance, computation fees are paid this way unless the contract calls [accept_message](/v3/documentation/smart-contracts/transaction-fees/accept-message-effects). This ensures malicious actors cannot spend the contract's balance handling their data.
For instance, computation fees are paid in this way, unless contract calls [accept_message](v3/documentation/smart-contracts/transaction-fees/accept-message-effects). This ensures that malicious actors cannot spend contract's balance on handling their data. | ||
- From the contract `balance` (will not touch amount of TON designated as incoming this transaction). | ||
For instance, computation fees are paid in this way, unless the contract calls [accept_message](/v3/documentation/smart-contracts/transaction-fees/accept-message-effects). This ensures that malicious actors cannot spend the contract's balance on handling their data. | ||
- From the contract `balance` (will not touch the amount of TON designated as incoming this transaction). | ||
Storage fees in workchains 0 and -1, as well as most actions, are currently examples of this. |
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.
Cut unnecessary words:
Storage fees in workchains 0 and -1 and most actions are currently examples of this.
|
||
- Storage, consisting of [account storage](https://github.com/ton-blockchain/ton/blob/7151ff26279fef6dcfa1f47fc0c5b63677ae2458/crypto/block/transaction.cpp#L651-L675) and [in_msg import](https://github.com/ton-blockchain/ton/blob/7151ff26279fef6dcfa1f47fc0c5b63677ae2458/crypto/block/transaction.cpp#L783-L816) | ||
- [Credit](https://github.com/ton-blockchain/ton/blob/7151ff26279fef6dcfa1f47fc0c5b63677ae2458/crypto/block/transaction.cpp#L959-L981), where in_msg `value` is added to the `balance` | ||
- [Credit](https://github.com/ton-blockchain/ton/blob/7151ff26279fef6dcfa1f47fc0c5b63677ae2458/crypto/block/transaction.cpp#L959-L981), where the in_msg `value` is added to the `balance` | ||
- Compute, where the actual smart contract code is executed in TVM |
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.
Use active voice:
Compute, where TVM executes the actual smart contract code
@@ -11,23 +11,23 @@ You can check [this example](https://testnet.tonviewer.com/transaction/42ed45726 | |||
|
|||
Please check how [get_balance](/v3/documentation/smart-contracts/func/docs/stdlib/#get_balance) works to better understand `balance` inside TVM. | |||
|
|||
All TON tokens owned by a contract are reflected in the [contract balance](https://github.com/ton-blockchain/ton/blob/7151ff26279fef6dcfa1f47fc0c5b63677ae2458/crypto/block/block.tlb#L263C1-L265C20). Some of these tokens are also attributed to the currently processed incoming [message](/v3/documentation/data-formats/tlb/msg-tlb#commonmsginfo) - a mechanism that works effectively because any TON transaction involving a [non-system contract](/v3/documentation/smart-contracts/contracts-specs/governance) processes exactly one incoming message at a time. | |||
All TON tokens owned by a contract are reflected in the [contract balance](https://github.com/ton-blockchain/ton/blob/7151ff26279fef6dcfa1f47fc0c5b63677ae2458/crypto/block/block.tlb#L263C1-L265C20). Some of these tokens are also attributed to the currently processed incoming [message](/v3/documentation/data-formats/tlb/msg-tlb#commonmsginfo) — a mechanism that works effectively because any TON transaction involving a [non-system contract](/v3/documentation/smart-contracts/contracts-specs/governance) processes exactly one incoming message at a time. |
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.
Use active voice:
A contract's [balance](https://github.com/ton-blockchain/ton/blob/7151ff26279fef6dcfa1f47fc0c5b63677ae2458/crypto/block/block.tlb#L263C1-L265C20) reflects all TON tokens it owns.
This approach effectively attributes some of these tokens to the currently processed incoming [message](/v3/documentation/data-formats/tlb/msg-tlb#commonmsginfo) because any TON transaction involving a non-system contract processes exactly one incoming message at a time.
Moved this work to the #970 |
Description
#965
Checklist