docs: Update destination Arg Description in ICA transfer
#10983
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
Deploying agoric-sdk with
|
| Latest commit: |
f675508
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f0269b7f.agoric-sdk.pages.dev |
| Branch Preview URL: | https://ms-update-ica-transfer-docs.agoric-sdk.pages.dev |
dckc
reviewed
Feb 11, 2025
| @@ -193,8 +193,9 @@ export interface OrchestrationAccountCommon { | |||
| * Transfer an amount to another account, typically on another chain. | |||
| * The promise settles when the transfer is complete. | |||
| * @param amount - the amount to transfer. Can be provided as pure data using denoms or as ERTP Amounts. | |||
| * @param destination - the account to transfer the amount to. | |||
| * @param [opts] - an optional memo to include with the transfer, which could drive custom PFM behavior, and timeout parameters | |||
| * @param destination - the account to transfer the amount to. The denom in the destination arg has to be | |||
There was a problem hiding this comment.
oops! the denom is in the amount, not the destination
| * @param destination - the account to transfer the amount to. | ||
| * @param [opts] - an optional memo to include with the transfer, which could drive custom PFM behavior, and timeout parameters | ||
| * @param destination - the account to transfer the amount to. The denom in the destination arg has to be | ||
| * registered with `chainHub` via {@link `registerAsset`} API. |
There was a problem hiding this comment.
Suggested change
| * registered with `chainHub` via {@link `registerAsset`} API. | |
| * registered with `chainHub` via {@link `registerAsset`} method. |
| * @param destination - the account to transfer the amount to. | ||
| * @param [opts] - an optional memo to include with the transfer, which could drive custom PFM behavior, and timeout parameters | ||
| * @param destination - the account to transfer the amount to. The denom in the destination arg has to be | ||
| * registered with `chainHub` via {@link `registerAsset`} API. |
There was a problem hiding this comment.
This link doesn't seem to work.
you might try {@link ChainHub}, after checking that ChainHub is imported.
Hm. It might not be imported. It's sort of a lower level concept than OrchestrationAccount.
I should think this over a bit.
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.
refs: #9966
Description
Security Considerations
None
Scaling Considerations
None
Documentation Considerations
Documentation for
transfershould also be updated if necessary.