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

Add/Update dapp-orca-basics Docs #1232

Merged
merged 3 commits into from
Oct 9, 2024
Merged

Add/Update dapp-orca-basics Docs #1232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8110710
chore: update orca docs structure/nav/sidebar
amessbee Oct 7, 2024
fa8b5e0
docs; orca dapp UI docs
amessbee Oct 7, 2024
21bdf09
chore: adding modified links _redirects
amessbee Oct 8, 2024
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
12 changes: 11 additions & 1 deletion _redirects
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,18 @@
/guides/js-programming/ses/ses-guide.html https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/guide.md
/guides/js-programming/ses/ses-reference https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/reference.md
/guides/js-programming/ses/ses-reference.html https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/reference.md
/guides/orchestration/getting-started/contract-walkthroughs /guides/orchestration/contract-walkthroughs
/guides/orchestration/getting-started/contract-walkthroughs.html /guides/orchestration/contract-walkthroughs
/guides/orchestration/getting-started/contract-walkthrough/cross-chain-unbond /guides/orchestration/contract-walkthroughs/cross-chain-unbond
/guides/orchestration/getting-started/contract-walkthrough/cross-chain-unbond.html /guides/orchestration/contract-walkthroughs/cross-chain-unbond
/guides/orchestration/getting-started/contract-walkthrough/orchestration-basics /guides/orchestration/orchestration-basics
/guides/orchestration/getting-started/contract-walkthrough/orchestration-basics.html /guides/orchestration/orchestration-basics
/guides/orchestration/getting-started/contract-walkthrough/send-anywhere /guides/orchestration/contract-walkthroughs/send-anywhere
/guides/orchestration/getting-started/contract-walkthrough/send-anywhere.html /guides/orchestration/contract-walkthroughs/send-anywhere
/guides/orchestration/getting-started/key-concepts /guides/orchestration/key-concepts
/guides/orchestration/getting-started/key-concepts.html /guides/orchestration/key-concepts
/guides/wallet/api /reference/wallet-api/
/guides/wallet/api.html /reference/wallet-api.html
/guides/wallet/api.html /reference/wallet-api.html
/guides/wallet/api/* /reference/wallet-api/:splat
/platform /guides/platform/
/platform /guides/platform/
Expand Down
28 changes: 21 additions & 7 deletions main/.vitepress/config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,23 +127,37 @@ export default defineConfig({
items: [
{
text: 'Key Concepts and APIs',
link: '/guides/orchestration/getting-started/key-concepts',
link: '/guides/orchestration/key-concepts',
},
{
text: 'Contract Walkthroughs',
link: '/guides/orchestration/getting-started/contract-walkthroughs',
link: '/guides/orchestration/contract-walkthroughs/',
items: [
{
text: 'Send Anywhere Example',
link: '/guides/orchestration/getting-started/contract-walkthrough/send-anywhere',
link: '/guides/orchestration/contract-walkthroughs/send-anywhere',
},
{
text: 'Cross-Chain Swap Example',
link: '/guides/orchestration/getting-started/contract-walkthrough/cross-chain-swap',
text: 'Cross-Chain Unbond Example',
link: '/guides/orchestration/contract-walkthroughs/cross-chain-unbond',
}
]
},
{
text: 'Example Orchestration DApp',
Copy link
Member

Choose a reason for hiding this comment

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

Ideally, like we discussed in today's sync, I would like this to be after key concepts but it doesn't have to be done in this PR. We would also need to rethink what to call that section because then Example Orchestration Dapp wouldn't work imo

link: '/guides/orchestration/orchestration-basics/',
items: [
{
text: 'Installation and Deployment',
link: '/guides/orchestration/orchestration-basics/installation',
},
{
text: 'Cross-Chain Unbond Example',
link: '/guides/orchestration/getting-started/contract-walkthrough/cross-chain-unbond',
text: 'Orca Contract walkthrough',
link: '/guides/orchestration/orchestration-basics/contract',
},
{
text: 'UI Walkthrough',
link: '/guides/orchestration/orchestration-basics/ui',
}
]
},
Expand Down
25 changes: 19 additions & 6 deletions main/.vitepress/themeConfig/nav.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,35 @@ export const nav = [
},
{
text: 'Key Concepts and APIs',
link: '/guides/orchestration/getting-started/key-concepts',
link: '/guides/orchestration/key-concepts',
},
{
text: 'Contract Walkthroughs',
items: [
{
text: 'Send Anywhere Example',
link: '/guides/orchestration/getting-started/contract-walkthrough/send-anywhere',
link: '/guides/orchestration/contract-walkthroughs/send-anywhere',
},
{
text: 'Cross-Chain Swap Example',
link: '/guides/orchestration/getting-started/contract-walkthrough/cross-chain-swap',
text: 'Cross-Chain Unbond Example',
link: '/guides/orchestration/contract-walkthroughs/cross-chain-unbond',
}
]
},
{
text: 'Example Orchestration DApp',
items: [
{
text: 'Installation and Deployment',
link: '/guides/orchestration/orchestration-basics/installation',
},
{
text: 'Cross-Chain Unbond Example',
link: '/guides/orchestration/getting-started/contract-walkthrough/cross-chain-unbond',
text: 'Orca Contract walkthrough',
link: '/guides/orchestration/orchestration-basics/contract',
},
{
text: 'UI Walkthrough',
link: '/guides/orchestration/orchestration-basics/ui',
}
]
},
Expand Down
0 ...ontract-walkthrough/cross-chain-unbond.md → ...ntract-walkthroughs/cross-chain-unbond.md
View file
Open in desktop
File renamed without changes.
24 changes: 6 additions & 18 deletions .../getting-started/contract-walkthroughs.md → ...hestration/contract-walkthroughs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# Contract Walkthroughs

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

In this section, we will cover three primary contracts:
In this section, we will cover two primary contracts:

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

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.

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

[See Contract Overview](/guides/orchestration/getting-started/contract-walkthrough/send-anywhere)

## Swap Contract

The Swap Contract demonstrates how to swap assets between the Agoric chain and another blockchain. This example covers:

- Initializing and setting up the contract.
- Creating and managing accounts on different chains.
- Executing cross-chain asset transfers.
- Handling errors and ensuring secure transactions.

[See Contract Overview](/guides/orchestration/getting-started/contract-walkthrough/cross-chain-swap)
[See Contract Overview](/guides/orchestration/contract-walkthroughs/send-anywhere)

## Unbond Contract

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

[See Contract Overview](/guides/orchestration/getting-started/contract-walkthrough/cross-chain-unbond)
[See Contract Overview](/guides/orchestration/contract-walkthroughs/cross-chain-unbond)
6 changes: 3 additions & 3 deletions ...ted/contract-walkthrough/send-anywhere.md → ...on/contract-walkthroughs/send-anywhere.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ The contract begins by importing various modules and utilities necessary for its

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

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

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