Skip to content

Commit 729b802

Browse files
committed
chore: adding mermaid plugin
1 parent daa85f9 commit 729b802

File tree

7 files changed

+979
-15
lines changed

7 files changed

+979
-15
lines changed

main/.vitepress/config.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import { defineConfig } from 'vitepress';
21
import { nav } from './themeConfig/nav.js';
32
import { rewrites } from './themeConfig/rewrites.js';
3+
import { withMermaid } from "vitepress-plugin-mermaid";
44

5-
export default defineConfig({
5+
export default withMermaid({
66
/* --- FOR DEPLOYMENT TO GITHUB PAGES--- */
77
base: '/', // The base URL the site will be deployed at.
88
outDir: '../dist',
-415 KB
Loading
1000 KB
Loading
-589 KB
Binary file not shown.

main/guides/orchestration/index.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,6 @@ Agoric’s Orchestration APIs simplify controlling accounts on remote chains, mo
1414
<img src="./assets/chains.png" width="100%" />
1515
<br/>
1616

17-
<br/>
18-
<img src="./assets/chains4.png" width="100%" />
19-
<br/>
20-
21-
<br/>
22-
<img src="./assets/chains5.png" width="100%" />
23-
<br/>
24-
2517
## Orchestration Overview
2618

2719
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.
@@ -36,6 +28,34 @@ The Orchestration API handles asynchronous tasks and complex workflows, includin
3628

3729
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.
3830

39-
<br/>
40-
<img src="/reference/assets/sequence-diagrams/orchestration-workflow-1.svg" width="100%" />
41-
<br/>
31+
```mermaid
32+
---
33+
title: Orchestration Osmosis Transfer Example
34+
---
35+
sequenceDiagram
36+
participant contract
37+
38+
contract->>OrchLib: provideOrchestration
39+
OrchLib --> contract: orch
40+
create participant orch
41+
contract --> orch: getChain('osmosis')
42+
orch->>AgoricNames: lookup('chain', 'osmosis')
43+
AgoricNames-->>orch: ChainInfo for osmosis
44+
orch --> contract: osmosis chain object
45+
46+
participant osmosis
47+
contract->>osmosis: makeAccount()
48+
osmosis --> contract: osmoAccount123
49+
50+
create participant osmoAccount123
51+
contract->>osmoAccount123: getAddress()
52+
53+
contract->>osmoAccount123: getBalances()
54+
contract->>osmoAccount123: send(amount, receiverAddress)
55+
osmoAccount123-->>contract: Transaction Status
56+
57+
%% note Cross-Chain Operation
58+
contract->>osmoAccount123: transferSteps(amount, transferMsg)
59+
%% note Execute Steps Across Chains
60+
osmoAccount123-->>contract: Transfer Complete
61+
```

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,12 @@
6767
"eslint-plugin-prettier": "^5.2.1",
6868
"glob": "7.1.7",
6969
"import-meta-resolve": "^2.2.2",
70+
"mermaid": "^11.3.0",
7071
"prettier": "^3.3.3",
7172
"ses": "^1.8.0",
7273
"stylus": "^0.62.0",
73-
"vitepress": "1.3.4"
74+
"vitepress": "1.3.4",
75+
"vitepress-plugin-mermaid": "^2.0.17"
7476
},
7577
"globals": {
7678
"harden": "readonly"

0 commit comments

Comments
 (0)