Skip to content

Commit 54b346b

Browse files
authored
Merge pull request #1232 from Agoric/ms/adding-orca-dapp-docs
Add/Update `dapp-orca-basics` Docs
2 parents 43d8ef0 + 21bdf09 commit 54b346b

File tree

15 files changed

+333
-306
lines changed

15 files changed

+333
-306
lines changed

_redirects

+11-1
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,18 @@
4444
/guides/js-programming/ses/ses-guide.html https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/guide.md
4545
/guides/js-programming/ses/ses-reference https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/reference.md
4646
/guides/js-programming/ses/ses-reference.html https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/reference.md
47+
/guides/orchestration/getting-started/contract-walkthroughs /guides/orchestration/contract-walkthroughs
48+
/guides/orchestration/getting-started/contract-walkthroughs.html /guides/orchestration/contract-walkthroughs
49+
/guides/orchestration/getting-started/contract-walkthrough/cross-chain-unbond /guides/orchestration/contract-walkthroughs/cross-chain-unbond
50+
/guides/orchestration/getting-started/contract-walkthrough/cross-chain-unbond.html /guides/orchestration/contract-walkthroughs/cross-chain-unbond
51+
/guides/orchestration/getting-started/contract-walkthrough/orchestration-basics /guides/orchestration/orchestration-basics
52+
/guides/orchestration/getting-started/contract-walkthrough/orchestration-basics.html /guides/orchestration/orchestration-basics
53+
/guides/orchestration/getting-started/contract-walkthrough/send-anywhere /guides/orchestration/contract-walkthroughs/send-anywhere
54+
/guides/orchestration/getting-started/contract-walkthrough/send-anywhere.html /guides/orchestration/contract-walkthroughs/send-anywhere
55+
/guides/orchestration/getting-started/key-concepts /guides/orchestration/key-concepts
56+
/guides/orchestration/getting-started/key-concepts.html /guides/orchestration/key-concepts
4757
/guides/wallet/api /reference/wallet-api/
48-
/guides/wallet/api.html /reference/wallet-api.html
58+
/guides/wallet/api.html /reference/wallet-api.html
4959
/guides/wallet/api/* /reference/wallet-api/:splat
5060
/platform /guides/platform/
5161
/platform /guides/platform/

main/.vitepress/config.mjs

+21-7
Original file line numberDiff line numberDiff line change
@@ -127,23 +127,37 @@ export default defineConfig({
127127
items: [
128128
{
129129
text: 'Key Concepts and APIs',
130-
link: '/guides/orchestration/getting-started/key-concepts',
130+
link: '/guides/orchestration/key-concepts',
131131
},
132132
{
133133
text: 'Contract Walkthroughs',
134-
link: '/guides/orchestration/getting-started/contract-walkthroughs',
134+
link: '/guides/orchestration/contract-walkthroughs/',
135135
items: [
136136
{
137137
text: 'Send Anywhere Example',
138-
link: '/guides/orchestration/getting-started/contract-walkthrough/send-anywhere',
138+
link: '/guides/orchestration/contract-walkthroughs/send-anywhere',
139139
},
140140
{
141-
text: 'Cross-Chain Swap Example',
142-
link: '/guides/orchestration/getting-started/contract-walkthrough/cross-chain-swap',
141+
text: 'Cross-Chain Unbond Example',
142+
link: '/guides/orchestration/contract-walkthroughs/cross-chain-unbond',
143+
}
144+
]
145+
},
146+
{
147+
text: 'Example Orchestration DApp',
148+
link: '/guides/orchestration/orchestration-basics/',
149+
items: [
150+
{
151+
text: 'Installation and Deployment',
152+
link: '/guides/orchestration/orchestration-basics/installation',
143153
},
144154
{
145-
text: 'Cross-Chain Unbond Example',
146-
link: '/guides/orchestration/getting-started/contract-walkthrough/cross-chain-unbond',
155+
text: 'Orca Contract walkthrough',
156+
link: '/guides/orchestration/orchestration-basics/contract',
157+
},
158+
{
159+
text: 'UI Walkthrough',
160+
link: '/guides/orchestration/orchestration-basics/ui',
147161
}
148162
]
149163
},

main/.vitepress/themeConfig/nav.js

+19-6
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,35 @@ export const nav = [
1515
},
1616
{
1717
text: 'Key Concepts and APIs',
18-
link: '/guides/orchestration/getting-started/key-concepts',
18+
link: '/guides/orchestration/key-concepts',
1919
},
2020
{
2121
text: 'Contract Walkthroughs',
2222
items: [
2323
{
2424
text: 'Send Anywhere Example',
25-
link: '/guides/orchestration/getting-started/contract-walkthrough/send-anywhere',
25+
link: '/guides/orchestration/contract-walkthroughs/send-anywhere',
2626
},
2727
{
28-
text: 'Cross-Chain Swap Example',
29-
link: '/guides/orchestration/getting-started/contract-walkthrough/cross-chain-swap',
28+
text: 'Cross-Chain Unbond Example',
29+
link: '/guides/orchestration/contract-walkthroughs/cross-chain-unbond',
30+
}
31+
]
32+
},
33+
{
34+
text: 'Example Orchestration DApp',
35+
items: [
36+
{
37+
text: 'Installation and Deployment',
38+
link: '/guides/orchestration/orchestration-basics/installation',
3039
},
3140
{
32-
text: 'Cross-Chain Unbond Example',
33-
link: '/guides/orchestration/getting-started/contract-walkthrough/cross-chain-unbond',
41+
text: 'Orca Contract walkthrough',
42+
link: '/guides/orchestration/orchestration-basics/contract',
43+
},
44+
{
45+
text: 'UI Walkthrough',
46+
link: '/guides/orchestration/orchestration-basics/ui',
3447
}
3548
]
3649
},
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
# Contract Walkthroughs
22

3-
This section is designed to provide detailed explanations and insights into example orchestration smart contracts.
3+
This section is designed to provide detailed explanations and insights into example Orchestration smart contracts.
44

5-
In this section, we will cover three primary contracts:
5+
In this section, we will cover two primary contracts:
66

77
1. **Assets Transfer Contract**: A guide to `send-anywhere` contract that demonstrates a simple yet robust and secure way for cross-chain assets transfer.
8-
2. **Swap Contract**: A comprehensive guide to the process of swapping assets between different chains using the Agoric orchestration library.
9-
3. **Unbond Contract**: A detailed walkthrough of the unbonding and liquid staking process, highlighting the steps involved in managing cross-chain operations.
8+
2. **Unbond Contract**: A detailed walkthrough of the unbonding and liquid staking process, highlighting the steps involved in managing cross-chain operations.
109

1110
Each walkthrough will include detailed explanations of the contract code, providing insights into the mechanics and best practices of smart contract development on the Agoric platform. By the end of these walkthroughs, you should have a solid understanding of how to utilize Agoric’s tools and libraries to create robust and efficient cross-chain smart contracts.
1211

@@ -17,20 +16,9 @@ The "Send Anywhere" contract is a robust and secure solution for transferring as
1716
- Assets are securely held in a local account before being transferred.
1817
- Detailed logs are kept for transparency and error tracing.
1918
- The contract is resilient to failure, with built-in rollback mechanisms.
20-
- By using Agoric’s orchestration tools, this contract provides a secure way to facilitate cross-chain asset transfers.
19+
- By using Agoric’s Orchestration tools, this contract provides a secure way to facilitate cross-chain asset transfers.
2120

22-
[See Contract Overview](/guides/orchestration/getting-started/contract-walkthrough/send-anywhere)
23-
24-
## Swap Contract
25-
26-
The Swap Contract demonstrates how to swap assets between the Agoric chain and another blockchain. This example covers:
27-
28-
- Initializing and setting up the contract.
29-
- Creating and managing accounts on different chains.
30-
- Executing cross-chain asset transfers.
31-
- Handling errors and ensuring secure transactions.
32-
33-
[See Contract Overview](/guides/orchestration/getting-started/contract-walkthrough/cross-chain-swap)
21+
[See Contract Overview](/guides/orchestration/contract-walkthroughs/send-anywhere)
3422

3523
## Unbond Contract
3624

@@ -40,4 +28,4 @@ The Unbond Contract focuses on the process of unbonding staked assets and perfor
4028
- Implementing delegation and undelegation logic.
4129
- Managing asynchronous operations and ensuring the completion of long-running processes.
4230

43-
[See Contract Overview](/guides/orchestration/getting-started/contract-walkthrough/cross-chain-unbond)
31+
[See Contract Overview](/guides/orchestration/contract-walkthroughs/cross-chain-unbond)

main/guides/orchestration/getting-started/contract-walkthrough/send-anywhere.md renamed to main/guides/orchestration/contract-walkthroughs/send-anywhere.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ The contract begins by importing various modules and utilities necessary for its
2626

2727
- **State management**: `makeSharedStateRecord` is imported to create and manage the state across contract incarnations.
2828
- **Type validation**: `AmountShape` and `InvitationShape` ensure that the contract works with correct data types, such as amounts and invitations.
29-
- **Orchestration utilities**: `withOrchestration` is imported to facilitate interactions with orchestration functions.
30-
- **Flows**: The orchestration flows for handling transfers are imported from `send-anywhere.flows.js` to be made available to Zoe.
29+
- **Orchestration utilities**: `withOrchestration` is imported to facilitate interactions with Orchestration functions.
30+
- **Flows**: The Orchestration flows for handling transfers are imported from `send-anywhere.flows.js` to be made available to Zoe.
3131

3232
These imports set up the contract for the validation, orchestration, and execution of transfers through Zoe API.
3333

@@ -204,4 +204,4 @@ The "Send Anywhere" contract is a robust and flexible solution for transferring
204204
- Assets are securely held in a local account before being transferred.
205205
- Detailed logs are kept for transparency and error tracing.
206206
- The contract is resilient to failure, with built-in rollback mechanisms.
207-
- By using Agoric’s orchestration tools, this contract provides a secure way to facilitate cross-chain asset transfers.
207+
- By using Agoric’s Orchestration tools, this contract provides a secure way to facilitate cross-chain asset transfers.

0 commit comments

Comments
 (0)