From ef6e18a4946089877848b4490e68819d33981cd4 Mon Sep 17 00:00:00 2001 From: Lawson Kight Date: Wed, 25 Sep 2024 15:34:10 -0700 Subject: [PATCH] bridge sdk animation --- docs/bridge/docs/01-About/index.md | 3 + docs/bridge/docs/02-Bridge/02-SDK/index.md | 7 + docs/bridge/src/components/BridgeFlow.tsx | 305 ++++++++++++++++++++ docs/bridge/src/css/custom.css | 20 ++ docs/bridge/static/img/synapse-animated.svg | 153 ++++++++++ docs/bridge/static/img/synapse-mark.svg | 13 + 6 files changed, 501 insertions(+) create mode 100644 docs/bridge/src/components/BridgeFlow.tsx create mode 100644 docs/bridge/static/img/synapse-animated.svg create mode 100644 docs/bridge/static/img/synapse-mark.svg diff --git a/docs/bridge/docs/01-About/index.md b/docs/bridge/docs/01-About/index.md index 49b573588e..feea738693 100644 --- a/docs/bridge/docs/01-About/index.md +++ b/docs/bridge/docs/01-About/index.md @@ -1,6 +1,9 @@ --- title: About --- +
+ +![Synapse mark](/img/synapse-mark.svg) # Use Synapse diff --git a/docs/bridge/docs/02-Bridge/02-SDK/index.md b/docs/bridge/docs/02-Bridge/02-SDK/index.md index d0e2ef796c..51442c223a 100644 --- a/docs/bridge/docs/02-Bridge/02-SDK/index.md +++ b/docs/bridge/docs/02-Bridge/02-SDK/index.md @@ -2,12 +2,19 @@ title: SDK --- +import { BridgeFlow } from '@site/src/components/BridgeFlow' + # Bridge SDK The Synapse Bridge SDK is the easiest way to integrate cross-chain token & liquidity transfers into your application. It is fully isomorphic and can be used on both client and server sides. The Synapse Bridge SDK is built on top of the [Synapse Router](/docs/Routers/Synapse-Router) contract. +
+ +The SDK sends user assets to a bridge contract, which are moved to the destination chain, and then returned to the user. +
+ :::note requires Node v16+ The SDK has only been fully tested on Node 16+ or greater. Earlier versions may experience errors. diff --git a/docs/bridge/src/components/BridgeFlow.tsx b/docs/bridge/src/components/BridgeFlow.tsx new file mode 100644 index 0000000000..bb1713eca1 --- /dev/null +++ b/docs/bridge/src/components/BridgeFlow.tsx @@ -0,0 +1,305 @@ +export const BridgeFlow = () => { + return ( + + + + + + + + + + + + + + + + + {/* + + + + + + + + + + + */} + + + originChain + + + destChain + + App / SDK + Wallet + Bridge + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + {/* + + + + + + + + + + + + + + + + + + + + + + + + + */} + + ) +} diff --git a/docs/bridge/src/css/custom.css b/docs/bridge/src/css/custom.css index c545be10e2..165cec8522 100644 --- a/docs/bridge/src/css/custom.css +++ b/docs/bridge/src/css/custom.css @@ -92,3 +92,23 @@ table thead tr { text-align: left; border: none; } + +svg text { + font-family: monospace; +} + +figure { + margin: 2rem 0; + text-align: center; + display: grid; + gap: 1rem; + justify-items: center; + + & caption { + text-align: center; + width: 100%; + font-style: italic; + opacity: .67; + + } +} \ No newline at end of file diff --git a/docs/bridge/static/img/synapse-animated.svg b/docs/bridge/static/img/synapse-animated.svg new file mode 100644 index 0000000000..7e015f3bb8 --- /dev/null +++ b/docs/bridge/static/img/synapse-animated.svg @@ -0,0 +1,153 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/bridge/static/img/synapse-mark.svg b/docs/bridge/static/img/synapse-mark.svg new file mode 100644 index 0000000000..6b3008d4e1 --- /dev/null +++ b/docs/bridge/static/img/synapse-mark.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + +