Skip to content
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.

Sign up for GitHub

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

docs: Update destination Arg Description in ICA transfer #10983

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Update destination Arg Description in ICA transfer #10983

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions packages/orchestration/src/orchestration-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops! the denom is in the amount, not the destination

* registered with `chainHub` via {@link `registerAsset`} API.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* registered with `chainHub` via {@link `registerAsset`} API.
* registered with `chainHub` via {@link `registerAsset`} method.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

* @param [opts] - an optional memo to include with the transfer, which could drive custom PFM behavior, and timeout parameters
* @returns void
* @throws {Error} if route is not determinable, asset is not recognized, or
* the transfer is rejected (insufficient funds, timeout)
Expand Down
Loading