From 89a371a549e5ba4ea29387d829e4e620bca47e90 Mon Sep 17 00:00:00 2001
From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com>
Date: Wed, 5 Feb 2025 20:45:43 +0000
Subject: [PATCH] Documentation edits made through Mintlify web editor
---
mint.json | 66 +++++++++++++++++++----------
protocol-overview.mdx | 96 +++++++++++++++++++++++++++++++++++++++++++
2 files changed, 140 insertions(+), 22 deletions(-)
create mode 100644 protocol-overview.mdx
diff --git a/mint.json b/mint.json
index 6e4beda..33f3b68 100644
--- a/mint.json
+++ b/mint.json
@@ -6,11 +6,10 @@
"light": "/logo/light.svg"
},
"feedback": {
- "thumbsRating" : true
+ "thumbsRating": true
},
"favicon": "/favicon.svg",
- "background": {
- },
+ "background": {},
"colors": {
"primary": "#FF0093",
"light": "#FF0093",
@@ -20,10 +19,10 @@
"to": "#FF0093"
}
},
- "sidebar" : {
+ "sidebar": {
"items": "border"
},
- "modeToggle" : {
+ "modeToggle": {
"default": "dark",
"isHidden": true
},
@@ -60,14 +59,14 @@
"url": "changelog"
}
],
- "anchors": [
- ],
+ "anchors": [],
"navigation": [
{
"group": "Layerswap V0 Bridge",
"pages": [
"introduction",
- "security"
+ "security",
+ "protocol-overview"
]
},
{
@@ -79,7 +78,7 @@
"integration/mixed",
{
"group": "Cookbooks",
- "icon" : "book",
+ "icon": "book",
"pages": [
"integration/cookbooks/wallet",
"integration/cookbooks/website"
@@ -101,7 +100,9 @@
},
{
"group": "Changelog",
- "pages": ["changelog/api"]
+ "pages": [
+ "changelog/api"
+ ]
}
],
"footer": {
@@ -116,33 +117,54 @@
{
"title": "Resources",
"links": [
- { "label": "Brand Assets", "url": "https://layerswap.notion.site/Layerswap-brand-guide-0822bc4f1a2d4af7bc2f1acbb05119e2?pvs=74" },
- { "label": "Public Roadmap", "url": "https://layerswap.ducalis.io/layerswap-roadmap" }
+ {
+ "label": "Brand Assets",
+ "url": "https://layerswap.notion.site/Layerswap-brand-guide-0822bc4f1a2d4af7bc2f1acbb05119e2?pvs=74"
+ },
+ {
+ "label": "Public Roadmap",
+ "url": "https://layerswap.ducalis.io/layerswap-roadmap"
+ }
]
- },
+ },
{
"title": "Layerswap V0",
"links": [
- { "label": "App", "url": "https://layerswap.io/app" },
- { "label": "Docs", "url": "https://docs.layerswap.io" },
- { "label": "Explorer", "url": "https://layerswap.io/explorer" }
+ {
+ "label": "App",
+ "url": "https://layerswap.io/app"
+ },
+ {
+ "label": "Docs",
+ "url": "https://docs.layerswap.io"
+ },
+ {
+ "label": "Explorer",
+ "url": "https://layerswap.io/explorer"
+ }
]
},
{
"title": "Layerswap V8",
"links": [
- { "label": "App", "url": "https://layerswap.io/v8" },
- { "label": "Docs", "url": "https://v8-docs.layerswap.io" }
+ {
+ "label": "App",
+ "url": "https://layerswap.io/v8"
+ },
+ {
+ "label": "Docs",
+ "url": "https://v8-docs.layerswap.io"
+ }
]
}
]
},
- "api" : {
- "baseUrl" : "https://api.layerswap.io/"
+ "api": {
+ "baseUrl": "https://api.layerswap.io/"
},
"metadata": {
"og:title": "Layerswap V0 | Cross-Chain Bridge",
- "og:description" : "Layerswap V0 is a cross-chain bridge that enables users to swap assets across different blockchains.",
- "og:logo" : "/logo/dark.svg"
+ "og:description": "Layerswap V0 is a cross-chain bridge that enables users to swap assets across different blockchains.",
+ "og:logo": "/logo/dark.svg"
}
}
\ No newline at end of file
diff --git a/protocol-overview.mdx b/protocol-overview.mdx
new file mode 100644
index 0000000..cf2f195
--- /dev/null
+++ b/protocol-overview.mdx
@@ -0,0 +1,96 @@
+---
+title: 'Protocol Overview'
+description: 'End-to-end explanation of Layerswap protocol operations'
+icon: diagram-project
+---
+
+Layerswap enables seamless crypto transfers across different networks and exchanges through a robust protocol that handles millions of dollars in daily transactions. Here's how it works from end to end:
+
+
+
+ Partners must first:
+ 1. Register at layerswap.io/dashboard
+ 2. Create an organization and app
+ 3. Obtain API keys for either mainnet or testnet environments
+
+
+
+ Transfers can be initiated in two ways:
+
+
+
+ Create programmatic swaps using the API:
+ ```bash
+ curl --location 'https://api.layerswap.io/api/swap' \
+ --header 'X-LS-APIKEY: {YOUR_APP_APIKEY}' \
+ --header 'Content-Type: application/json' \
+ --data '{
+ "source": "ETHEREUM_MAINNET",
+ "destination": "IMX_MAINNET",
+ "amount": 0.001,
+ "asset": "ETH",
+ "source_address": "0x...",
+ "destination_address": "0x...",
+ "refuel": false
+ }'
+ ```
+
+
+ Embed Layerswap directly or redirect to hosted page:
+ ```javascript
+
+ ```
+
+
+
+
+
+ Layerswap supports two transfer methods:
+
+
+ Direct wallet connections where the dApp composes and sends transactions for signing and execution. Used when wallet connection is available.
+
+
+
+ Layerswap generates a unique deposit address for each swap. Any transaction sent to this address completes the swap - ideal when direct wallet connection isn't possible.
+
+
+
+
+
+ 
+
+
+ 1. **User Transfer Pending**: Initial state after swap creation
+ 2. **LS Transfer Pending**: After user transaction is received and matched
+ 3. **Completed**: After successful destination network transaction
+ 4. **Failed**: If destination transaction cannot be processed
+ 5. **Cancelled/Expired**: If user cancels or 4-day window expires
+
+
+
+ Partners can track swap status through:
+
+
+
+ Query swap status endpoints periodically
+
+
+ Receive real-time notifications for status changes
+
+
+
+
+
+
+For production deployments, always use mainnet API keys. Testnet keys should only be used for development and testing purposes.
+
+
+
+API keys should be stored securely and never exposed in client-side code. Always make API calls from your backend services.
+
\ No newline at end of file