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

Added orchestration overview and a code snippet #1129

Merged
6 commits merged into from
Jun 25, 2024
Merged
Show file tree
Hide file tree
Changes from 4 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
4 changes: 4 additions & 0 deletions main/.vitepress/config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -412,6 +412,10 @@ export default defineConfig({
},
],
},
{
text: 'Orchestration',
link: '/guides/orchestration/',
},
{
text: 'JavaScript Framework',
ariaLabel: 'JavaScript Framework',
Expand Down
32 changes: 32 additions & 0 deletions main/guides/orchestration/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Orchestration Overview

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) protocol within Cosmos. The API acts as an
abstraction layer, streamlining multi-step processes.


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

The orchestration client 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.


## Example API Usage

```javascript
const amount = coins(100, 'utia');
const celestiaChain = await orchestration.getChain('celestia');
const icaCelestia = await celestiaChain.createAccount();
await icaOsmosis.transfer(icaCelestia.getAddress(), amount);
await E(timerService).delay(600n);
return icaCelestia.delegate(celestiaValidator, amount);
```
Loading