Skip to content

Commit cdb5cae

Browse files
committed
lint: format api docs with prettier
1 parent 8d36262 commit cdb5cae

File tree

1 file changed

+17
-2
lines changed
  • main/guides/orchestration/getting-started

1 file changed

+17
-2
lines changed

main/guides/orchestration/getting-started/api.md

+17-2
Original file line numberDiff line numberDiff line change
@@ -9,78 +9,93 @@ See [Orchestration API Spec](https://agoric-sdk.pages.dev/modules/_agoric_orches
99
The [`Orchestrator`](https://agoric-sdk.pages.dev/interfaces/_agoric_orchestration.Orchestrator) interface provides a set of high-level methods to manage and interact with interchain accounts. Below are the primary methods:
1010

1111
### getChain
12-
Retrieves the chain information and provides access to chain-specific methods. See [getChain](https://agoric-sdk.pages.dev/interfaces/_agoric_orchestration.Orchestrator#getChain)
12+
13+
Retrieves the chain information and provides access to chain-specific methods. See [getChain](https://agoric-sdk.pages.dev/interfaces/_agoric_orchestration.Orchestrator#getChain).
1314

1415
```javascript
1516
const chain = await orchestrator.getChain('chainName');
1617
```
1718

1819
### makeLocalAccount
19-
Creates a new `LocalchainAccount`. See [makeLocalAccount](https://agoric-sdk.pages.dev/interfaces/_agoric_orchestration.Orchestrator#makeLocalAccount).
20+
21+
Creates a new `LocalChainAccount`. See [makeLocalAccount](https://agoric-sdk.pages.dev/interfaces/_agoric_orchestration.Orchestrator#makeLocalAccount).
2022

2123
```javascript
2224
const localAccount = await orchestrator.makeLocalAccount();
2325
```
2426

2527
### getBrandInfo
28+
2629
Returns information about a `denom`, including the equivalent local Brand, the chain where the denom is held, and the chain that issues the corresponding asset. See [getBrandInfo](https://agoric-sdk.pages.dev/interfaces/_agoric_orchestration.Orchestrator#getBrandInfo).
2730

2831
```javascript
2932
const brandInfo = orchestrator.getBrandInfo('denom');
3033
```
3134

3235
### asAmount
36+
3337
Converts a denom amount to an `Amount` with a brand. See [asAmount](https://agoric-sdk.pages.dev/interfaces/_agoric_orchestration.Orchestrator#asAmount).
3438

3539
```javascript
3640
const amount = orchestrator.asAmount({ denom: 'uatom', value: 1000n });
3741
```
3842

3943
## OrchestrationAccount
44+
4045
An [`OrchestrationAccount`](https://agoric-sdk.pages.dev/types/_agoric_orchestration.OrchestrationAccount) is a type alias that combines the [`OrchestrationAccountI`](https://agoric-sdk.pages.dev/interfaces/_agoric_orchestration.OrchestrationAccountI) interface with additional methods. Below are the primary methods available:
4146

4247
### getAddress
48+
4349
Retrieves the address of the account on the remote chain. See [getAddress](https://agoric-sdk.pages.dev/interfaces/_agoric_orchestration.OrchestrationAccountI#getAddress).
50+
4451
```javascript
4552
const address = await orchestrationAccount.getAddress();
4653
```
4754

4855
### getBalances
56+
4957
Returns an array of amounts for every balance in the account. See [getBalances](https://agoric-sdk.pages.dev/interfaces/_agoric_orchestration.OrchestrationAccountI#getBalances).
5058

5159
```javascript
5260
const balances = await orchestrationAccount.getBalances();
5361
```
5462

5563
### getBalance
64+
5665
Retrieves the balance of a specific denom for the account. See [getBalance](https://agoric-sdk.pages.dev/interfaces/_agoric_orchestration.OrchestrationAccountI#getBalance).
5766

5867
```javascript
5968
const balance = await orchestrationAccount.getBalance('uatom');
6069
```
6170

6271
### send
72+
6373
Transfers an amount to another account on the same chain. The promise settles when the transfer is complete. See [send](https://agoric-sdk.pages.dev/interfaces/_agoric_orchestration.OrchestrationAccountI#send).
6474

6575
```javascript
6676
await orchestrationAccount.send(receiverAddress, amount);
6777
```
6878

6979
### transfer
80+
7081
Transfers an amount to another account, typically on another chain. The promise settles when the transfer is complete. See [transfer](https://agoric-sdk.pages.dev/interfaces/_agoric_orchestration.OrchestrationAccountI#transfer).
7182

7283
```javascript
7384
await orchestrationAccount.transfer(amount, destinationAddress);
7485
```
7586

7687
### transferSteps
88+
7789
Transfers an amount to another account in multiple steps. The promise settles when the entire path of the transfer is complete. See [transferSteps](https://agoric-sdk.pages.dev/interfaces/_agoric_orchestration.OrchestrationAccountI#transferSteps).
90+
7891
```javascript
7992
await orchestrationAccount.transferSteps(amount, transferMsg);
8093
```
8194

8295
### deposit
96+
8397
Deposits payment from Zoe to the account. For remote accounts, an IBC Transfer will be executed to transfer funds there.
98+
8499
```javascript
85100
await orchestrationAccount.deposit(payment);
86101
```

0 commit comments

Comments
 (0)