Skip to content

Commit 1a2fc75

Browse files
committed
fixup! comments
1 parent 343be45 commit 1a2fc75

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

main/guides/orchestration/getting-started/contract-walkthrough/cross-chain-unbond.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,16 @@ Cosmos-based chain and transferring them to another chain using IBC (Inter-Block
1212

1313
## Overview
1414

15-
The Unbond Contract leverages the Agoric orchestration to interact with external chains, like Osmosis and Stride, to facilitate unbonding and transferring assets from one chain to another.
15+
The Unbond Contract leverages the Agoric Orchestration API to interact with external chains, like Osmosis and Stride, to facilitate unbonding and transferring assets from one chain to another.
1616

1717
The contract consists of two main parts:
1818

1919
- **Contract File (`unbond.contract.js`)**: Defines the contract structure, and public-facing APIs.
2020
- **Flows File (`unbond.flows.js`)**: Implements the logic for the unbonding and transfer operations.
2121

22-
---
23-
2422
## Contract: `unbond.contract.js`
2523

26-
This file contains the main orchestration contract, which is wrapped using the `withOrchestration` helper for Zoe. It exposes a public facet that allows users to initiate the unbonding process and transfer assets to another chain.
24+
This file contains the main Orchestration contract, which is wrapped using the `withOrchestration` helper for Zoe. It exposes a public facet that allows users to initiate the unbonding process and transfer assets to another chain.
2725

2826
### Imports
2927

@@ -42,7 +40,7 @@ The `contract` function when wrapped inside `withOrchestration` defines the [`st
4240
- `zcf`: Zoe Contract Facet.
4341
- `privateArgs`: Object containing remote references to various services.
4442
- `zone`: A `Zone` object with access to storage for persistent data.
45-
- `OrchestrationTools`: A set of orchestration related tools needed by the contract.
43+
- `OrchestrationTools`: A set of Orchestration related tools needed by the contract.
4644

4745
```js
4846
const contract = async (
@@ -74,17 +72,17 @@ const contract = async (
7472

7573
The `orchestrateAll` function links the flows from the flows file to the contract logic. In this case, it links the `unbondAndTransfer` flow. The `publicFacet` exposes the `makeUnbondAndTransferInvitation` method, which creates a Zoe invitation to allow users to make an offer for the unbonding and transferring process.
7674

77-
The following code defines the `start` function of the contract that is returned by a call to `withOrchestration` with [`contract` function](#contract-function) as a parameter. In essence `contract` function is the entry point or `start` function of this contract with some orchestration setup.
75+
### `start` function
76+
77+
The following code defines the `start` function of the contract that is returned by a call to `withOrchestration` with [`contract` function](#contract-function) as a parameter. In essence `contract` function is the entry point or `start` function of this contract with some Orchestration setup.
7878

7979
```js
8080
export const start = withOrchestration(contract);
8181
```
8282

83-
---
84-
8583
## Flows: `unbond.flows.js`
8684

87-
This file contains the orchestration flow that performs the unbonding and transferring of assets across chains.
85+
This file contains the Orchestration flow that performs the unbonding and transferring of assets across chains.
8886

8987
### Flow Function: `unbondAndTransfer`
9088

0 commit comments

Comments
 (0)