docs: pre-1.0 doc updates #322
Closed
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
✅ Deploy Preview for tealscript ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
joe-p
force-pushed
the
docs/pre_1.0_docs
branch
3 times, most recently
from
d46339c
to
d963e91
Compare
joe-p
force-pushed
the
docs/pre_1.0_docs
branch
2 times, most recently
from
977e10b
to
875d9c9
Compare
nullun
reviewed
Jan 29, 2024
nullun
reviewed
Feb 7, 2024
|
|
||
| ## Argument Types | ||
|
|
||
| If you are writing a method that must be accompanied by an atomic trasnaction, you can set the argument type to one of the following types: `PayTxn`, `AssetTransferTxn`, `AppCallTxn`, `KeyRegTxn`, `AssetConfigTxn`, or `AssetFreezeTxn` |
There was a problem hiding this comment.
Suggested change
| If you are writing a method that must be accompanied by an atomic trasnaction, you can set the argument type to one of the following types: `PayTxn`, `AssetTransferTxn`, `AppCallTxn`, `KeyRegTxn`, `AssetConfigTxn`, or `AssetFreezeTxn` | |
| If you are writing a method that must be accompanied by an atomic transaction, you can set the argument type to one of the following types: `PayTxn`, `AssetTransferTxn`, `AppCallTxn`, `KeyRegTxn`, `AssetConfigTxn`, or `AssetFreezeTxn` |
nullun
reviewed
Feb 7, 2024
|
|
||
| ## Verifying An Atomic Transaction | ||
|
|
||
| Simply having an atomic trasnsaction as an argument doesn't gurantee anything about the transaction itself. As such, it's important to verify the fields of the transaction to ensure it is doing what you want. There are multiple methods for verifying the different types of transactions: `verifyPayTxn`, `verifyAssetConfigTxn`, `verifyAssetTransferTxn`, `verifyAppCallTxn`, and `verifyKeyRegTxn`. If you the transaction could be multiple different types, use the `verifyTxn` method. |
There was a problem hiding this comment.
Suggested change
| Simply having an atomic trasnsaction as an argument doesn't gurantee anything about the transaction itself. As such, it's important to verify the fields of the transaction to ensure it is doing what you want. There are multiple methods for verifying the different types of transactions: `verifyPayTxn`, `verifyAssetConfigTxn`, `verifyAssetTransferTxn`, `verifyAppCallTxn`, and `verifyKeyRegTxn`. If you the transaction could be multiple different types, use the `verifyTxn` method. | |
| Simply having an atomic transaction as an argument doesn't guarantee anything about the transaction itself. As such, it's important to verify the fields of the transaction to ensure it is doing what you want. There are multiple methods for verifying the different types of transactions: `verifyPayTxn`, `verifyAssetConfigTxn`, `verifyAssetTransferTxn`, `verifyAppCallTxn`, and `verifyKeyRegTxn`. If the transaction could be multiple different types, use the `verifyTxn` method. |
joe-p
force-pushed
the
docs/pre_1.0_docs
branch
from
f6fb202
to
b43021d
Compare
|
Closing because #439 |
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.
Closes #164