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.

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

Orchestration landing page doc update for launch #1235

Merged
merged 6 commits into from
Oct 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion main/.vitepress/themeConfig/nav.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export const nav = [
collapsed: true,
items: [
{
text: 'What is Orchestration?',
text: 'What is Agoric Orchestration?',
link: '/guides/orchestration/',
},
{
Expand Down
23 changes: 16 additions & 7 deletions main/guides/orchestration/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,26 @@
# Orchestration Overview
# What is Agoric Orchestration?

Agoric's Orchestration API is a tool to help developers build seamless applications out of disparate interoperable chains and services.
This composability allows for the development of user-centric applications that leverage the unique strengths of different blockchain ecosystems.
Agoric’s Orchestration capability allows developers to easily build cross-chain interactions into existing applications or to create novel cross-chain-focused products.

The Agoric Orchestration API simplifies interactions between multiple networks, particularly those
using the [Inter-Blockchain Communication (IBC)](/glossary/#ibc) protocol within Cosmos. The API acts as an
abstraction layer, streamlining multi-step processes.
The Agoric Orchestration API sits on top of Agoric’s novel VM that provides three key elements that make multichain applications possible:

- **Remote account control and transfer**: Use the Orchestration APIs to easily create accounts on remote chains, transfer assets, and invoke contracts. Your Agoric contract orchestrates all behavior directly.
- **Multiblock execution with `async` and `await`**: Agoric applications communicate asynchronously and await responses which may come in the same block or many blocks (or weeks!) later. Contracts simply continue executing when the response arrives.
Jovonni marked this conversation as resolved.
Show resolved Hide resolved
- **On-chain Timers**: Contracts can set timers for regular execution which makes executing common activities like subscriptions easy.

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- **On-chain Timers**: Contracts can set timers for regular execution which makes executing common activities like subscriptions easy.
- **On-chain Timers**: Contracts can set timers for regular execution which makes scheduling execution of common activities like subscriptions easy.

Agoric’s Orchestration APIs simplify controlling accounts on remote chains, moving assets, and using capabilities on any chain the API reaches.

## Orchestration Overview

Agoric's Orchestration API is a tool to help developers build seamless applications out of disparate interoperable chains and services. This composability allows for the development of user-centric applications that leverage the unique strengths of different blockchain ecosystems.

The Agoric Orchestration API simplifies interactions between multiple networks, particularly those using the [Inter-Blockchain Communication (IBC)](/glossary/#ibc) protocol within Cosmos. The API acts as an abstraction layer, streamlining multi-step processes.

Orchestration integrates with existing Agoric components ([SwingSet](/guides/platform/#swingset), Cosmos modules) and introduces vat-orchestration. This [vat](/glossary/#vat) manages Inter-Chain Account (ICA) identities and connections to host chains, ensuring proper transaction authorization.

The Orchestration API handles asynchronous tasks and complex workflows, including those spanning multiple chains. This empowers smart contracts for actions like inter-chain staking and multi-hop transfers, facilitated by notifications from the transfer vat and IBC middleware updates. Orchestration simplifies complex cross-chain interactions within a secure and user-controlled environment on the Agoric platform.

# Introduction to Orchestration API Flow
## Introduction to Orchestration API Flow

The following sequence diagram provides a comprehensive overview of the orchestration process within the Agoric platform. This example illustrates the interaction between various components, highlighting how the orchestration library (`OrchLib`) facilitates cross-chain operations. This is a good first example to understand the flow of the Orchestration API, showing the steps involved in creating and managing cross-chain transactions.

Expand Down
Loading