Skip to content

Commit b9e6d53

Browse files
committed
docs(orchestration): getBalances @throws when prohibited by chain
1 parent 674bbf0 commit b9e6d53

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

packages/orchestration/src/orchestration-api.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,10 +234,18 @@ export interface OrchestrationAccountCommon {
234234
*/
235235
getAddress: () => CosmosChainAddress;
236236

237-
/** @returns an array of amounts for every balance in the account. */
237+
/**
238+
* @returns an array of amounts for every balance in the account.
239+
*
240+
* @throws when prohibited (see `icqEnabled` in {@link CosmosChainInfo})
241+
*/
238242
getBalances: () => Promise<DenomAmount[]>;
239243

240-
/** @returns the balance of a specific denom for the account. */
244+
/**
245+
* @returns the balance of a specific denom for the account.
246+
*
247+
* @throws when prohibited (see `icqEnabled` in {@link CosmosChainInfo})
248+
*/
241249
getBalance: (denom: DenomArg) => Promise<DenomAmount>;
242250

243251
/**

0 commit comments

Comments
 (0)