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

Docs/lk exploration [SLT-170] #3141

Merged
merged 46 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
244e77f
update for eslint
lawsonkight Sep 17, 2024
eebb57c
eslint fix
lawsonkight Sep 17, 2024
1218b20
top-level content
lawsonkight Sep 17, 2024
32a85ac
bugfix: remove descriptions from Community links
lawsonkight Sep 17, 2024
8a6eb0d
eslint fix
lawsonkight Sep 18, 2024
866ebaa
folder organization
lawsonkight Sep 18, 2024
b9f11b6
wip: sidebar organization
lawsonkight Sep 18, 2024
6cb652a
cctp router docs refactor
lawsonkight Sep 20, 2024
81ea30d
WIP: RFQ Relayer doc
lawsonkight Sep 20, 2024
2330146
refactor of CCTP and RFQ docs pages
lawsonkight Sep 23, 2024
22855ca
fix build errors
lawsonkight Sep 23, 2024
e3a65c5
bugfix: css dark mode specificity
lawsonkight Sep 23, 2024
cb1118d
bugfix: wrong Redirect import
lawsonkight Sep 23, 2024
ab4a354
Fixes build issue
abtestingalpha Sep 24, 2024
186f0a9
Bridge SDK and Synapse Router
lawsonkight Sep 24, 2024
68ec346
fix broken links
lawsonkight Sep 24, 2024
56bd9c6
rename Bridge SDK Examples page
lawsonkight Sep 25, 2024
fe24140
rebuild yarn.lock
lawsonkight Sep 25, 2024
9eea390
Merge branch 'master' into docs/lk-exploration
abtestingalpha Sep 25, 2024
3d12d5a
Upgrades deps
abtestingalpha Sep 25, 2024
ef6e18a
bridge sdk animation
lawsonkight Sep 25, 2024
b03684b
move sdk animation to bridge page
lawsonkight Sep 25, 2024
32ac668
bugfix: svg initial values
lawsonkight Sep 26, 2024
a18c6b6
bugfix: remove css nesting
lawsonkight Sep 26, 2024
8a66ffd
intermediate token style
lawsonkight Sep 26, 2024
4c09296
wip: image buildout
lawsonkight Sep 26, 2024
4ebe307
additional router graphics
lawsonkight Sep 26, 2024
d07bf03
faux bridge svg
lawsonkight Sep 26, 2024
ecb3221
widget page
lawsonkight Sep 27, 2024
1f2553a
brand assets page
lawsonkight Sep 27, 2024
42629e9
move Bridge pages to Developers folder
lawsonkight Sep 27, 2024
e7b0e70
animated logo v1
lawsonkight Sep 27, 2024
8eca8ec
interactive animated logo
lawsonkight Sep 27, 2024
dae67c1
Supported routes
lawsonkight Sep 28, 2024
a4674eb
bugfix: React attribute names
lawsonkight Sep 28, 2024
33d8f99
move Supported Routes page
lawsonkight Sep 28, 2024
00d103b
bugfix: svg animation id collision
lawsonkight Sep 28, 2024
3b0da49
better css variable overrides
lawsonkight Sep 28, 2024
ceb8923
fix build errors
lawsonkight Sep 28, 2024
2993189
footer color
lawsonkight Sep 28, 2024
e23965e
small nits
Defi-Moses Sep 30, 2024
9d159ba
respond to feedback
lawsonkight Oct 1, 2024
d7b693c
Update CCTP Relayer description
lawsonkight Oct 2, 2024
bc0bf4c
cctp-typo
Defi-Moses Oct 2, 2024
9e9b993
Merge branch 'master' into docs/lk-exploration
abtestingalpha Oct 2, 2024
b3b7082
Fix constants v
abtestingalpha Oct 2, 2024
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
3 changes: 3 additions & 0 deletions docs/bridge/docs/Bridge/01-Widget.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Widget

Lorem ipsum
3 changes: 3 additions & 0 deletions docs/bridge/docs/Bridge/02-SDK.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# SDK

Lorem ipsum
43 changes: 43 additions & 0 deletions docs/bridge/docs/Bridge/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
sidebar_position: 1
title: Bridge
---

# Synapse Bridge

The [Synapse Bridge](https://synapseprotocol.com) and [Solana Bridge](https://solana.synapseprotocol.com/) seamlessly swap on-chain assets between 20+ EVM and non-EVM blockchains in a safe and secure manner.

## Developers

Add the [Custom Widget](#) to your DeFi application, or build your own DeFi applications using the [Synapse SDK](#).
Copy link
Contributor

Choose a reason for hiding this comment

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

Fix empty links in the Developers section

The links to Custom Widget and Synapse SDK are empty. This will lead to broken links in the documentation. Please update these links to point to the correct pages or provide placeholders if the pages are not yet created.

Apply this diff to fix the links:

-Add the [Custom Widget](#) to your DeFi application, or build your own DeFi applications using the [Synapse SDK](#).
+Add the [Custom Widget](custom-widget) to your DeFi application, or build your own DeFi applications using the [Synapse SDK](synapse-sdk).
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Add the [Custom Widget](#) to your DeFi application, or build your own DeFi applications using the [Synapse SDK](#).
Add the [Custom Widget](custom-widget) to your DeFi application, or build your own DeFi applications using the [Synapse SDK](synapse-sdk).
Tools
Markdownlint

7-7: null
No empty links

(MD042, no-empty-links)


7-7: null
No empty links

(MD042, no-empty-links)


## Bridge Functions

The [Synapse Router](#) will return an appropriate bridge function based on the chains and tokens involved.
Copy link
Contributor

Choose a reason for hiding this comment

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

Fix empty link for Synapse Router

The link to Synapse Router is empty. Please update the link to point to the correct page or add a placeholder if necessary.

Apply this diff to fix the link:

-The [Synapse Router](#) will return an appropriate bridge function based on the chains and tokens involved.
+The [Synapse Router](../Routers/synapse-router) will return an appropriate bridge function based on the chains and tokens involved.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
The [Synapse Router](#) will return an appropriate bridge function based on the chains and tokens involved.
The [Synapse Router](../Routers/synapse-router) will return an appropriate bridge function based on the chains and tokens involved.
Tools
Markdownlint

11-11: null
No empty links

(MD042, no-empty-links)


* **Canonical** – Assets are wrapped and then bridged.
* **[Liquidity Pools](#)** – Assets are swapped via Synapse liquidity pools.
* **[CCTP](#)** – Native router for USDC

## Pool Liquidity

Synapse liquidity pools use the nexus USD (nUSD) and nexus ETH (nETH) interchain stablecoins. nUSD and nETH are fully backed by the nexus USD and nexus ETH liquidity pools on Ethereum.

When a token is bridged using a Synapse Liquidity Pool, it is converted to a nexus token on the source chain, which is then bridged to the destination chain, before being converted back into a native token.

## Using the Bridge

To use the [Synapse Bridge](https://synapseprotocol.com):

1. Connect your wallet
2. Select your origin and destination chains from the dropdown menus
3. Select your origin token from the portfolio view, or dropdown menu
4. Enter the amount you wish to send
5. If you wish to send assets to a different wallet address, enable `Show withdrawal address` from the Settings menu (optional).
5. Connect your wallet to the origin chain, if necessary
6. Click `Bridge` to send a quote to your wallet for confirmation
7. Sign and Confirm the Bridge action from your wallet
Copy link
Contributor

Choose a reason for hiding this comment

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

Correct numbering in the bridge usage steps

The steps in the "Using the Bridge" section have incorrect numbering. Step 5 is repeated, and subsequent steps are misnumbered. Please correct the numbering to reflect the proper sequence.

Apply this diff to fix the numbering:

 5. If you wish to send assets to a different wallet address, enable `Show withdrawal address` from the Settings menu (optional).
-5. Connect your wallet to the origin chain, if necessary
-6. Click `Bridge` to send a quote to your wallet for confirmation
-7. Sign and Confirm the Bridge action from your wallet
+6. Connect your wallet to the origin chain, if necessary
+7. Click `Bridge` to send a quote to your wallet for confirmation
+8. Sign and Confirm the Bridge action from your wallet
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
5. If you wish to send assets to a different wallet address, enable `Show withdrawal address` from the Settings menu (optional).
5. Connect your wallet to the origin chain, if necessary
6. Click `Bridge` to send a quote to your wallet for confirmation
7. Sign and Confirm the Bridge action from your wallet
5. If you wish to send assets to a different wallet address, enable `Show withdrawal address` from the Settings menu (optional).
6. Connect your wallet to the origin chain, if necessary
7. Click `Bridge` to send a quote to your wallet for confirmation
8. Sign and Confirm the Bridge action from your wallet


## Bridge Contracts

Synapse Bridge contracts are available [here](https://docs.synapseprotocol.com/synapse-bridge/contract-addresses).
18 changes: 0 additions & 18 deletions docs/bridge/docs/CCTP/Contracts.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/bridge/docs/CCTP/Overview.md

This file was deleted.

107 changes: 0 additions & 107 deletions docs/bridge/docs/CCTP/Relayer.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/bridge/docs/CCTP/_category_.json

This file was deleted.

23 changes: 23 additions & 0 deletions docs/bridge/docs/Contracts/01-Synapse-Token.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Synapse Token

| Chain | Address |
|-----------|----------------------------------------------|
| Arbitrum | `0x080f6aed32fc474dd5717105dba5ea57268f46eb` [↗](https://arbiscan.io/token/0x080f6aed32fc474dd5717105dba5ea57268f46eb)|
| Aurora | `0xd80d8688b02B3FD3afb81cDb124F188BB5aD0445` [↗](https://explorer.mainnet.aurora.dev/address/0xd80d8688b02B3FD3afb81cDb124F188BB5aD0445/transactions)|
| Avalanche | `0x1f1E7c893855525b303f99bDF5c3c05Be09ca251` [↗](https://snowtrace.io/address/0x1f1E7c893855525b303f99bDF5c3c05Be09ca251)|
| Base | `0x432036208d2717394d2614d6697c46DF3Ed69540` [↗](https://basescan.org/address/0x432036208d2717394d2614d6697c46DF3Ed69540)|
| Blast | `0x9592f08387134e218327E6E8423400eb845EdE0E` [↗](https://blastscan.io/address/0x9592f08387134e218327E6E8423400eb845EdE0E)|
| Boba | `0xb554A55358fF0382Fb21F0a478C3546d1106Be8c` [↗](https://blockexplorer.boba.network/tokens/0xb554A55358fF0382Fb21F0a478C3546d1106Be8c/token-transfers)|
| BSC | `0xa4080f1778e69467e905b8d6f72f6e441f9e9484` [↗](https://bscscan.com/token/0xa4080f1778e69467e905b8d6f72f6e441f9e9484)|
| Canto | `0x555982d2E211745b96736665e19D9308B615F78e` [↗](https://canto.dex.guru/address/0x555982d2e211745b96736665e19d9308b615f78e)|
| Cronos | `0xFD0F80899983b8D46152aa1717D76cba71a31616` [↗](https://cronoscan.com/address/0xFD0F80899983b8D46152aa1717D76cba71a31616)|
| DFK | `0xB6b5C854a8f71939556d4f3a2e5829F7FcC1bf2A` [↗](https://subnets.avax.network/defi-kingdoms/dfk-chain/explorer/address/0xB6b5C854a8f71939556d4f3a2e5829F7FcC1bf2A)|
| Dogechain | `0xDfA53EeBA61D69E1D2b56b36d78449368F0265c1` [↗](https://explorer.dogechain.dog/address/0xDfA53EeBA61D69E1D2b56b36d78449368F0265c1)|
| Ethereum | `0x0f2D719407FdBeFF09D87557AbB7232601FD9F29` [↗](https://etherscan.io/token/0x0f2D719407FdBeFF09D87557AbB7232601FD9F29)|
| Fantom | `0xE55e19Fb4F2D85af758950957714292DAC1e25B2` [↗](https://ftmscan.com/address/0xe55e19fb4f2d85af758950957714292dac1e25b2)|
| Harmony | `0xE55e19Fb4F2D85af758950957714292DAC1e25B2` [↗](https://explorer.harmony.one/address/0xe55e19fb4f2d85af758950957714292dac1e25b2)|
| Moonbeam | `0xF44938b0125A6662f9536281aD2CD6c499F22004` [↗](https://moonscan.io/address/0xF44938b0125A6662f9536281aD2CD6c499F22004)|
| Moonriver | `0xd80d8688b02B3FD3afb81cDb124F188BB5aD0445` [↗](https://moonriver.moonscan.io/address/0xd80d8688b02B3FD3afb81cDb124F188BB5aD0445)|
| Optimism | `0x5A5fFf6F753d7C11A56A52FE47a177a87e431655` [↗](https://optimistic.etherscan.io/address/0x5A5fFf6F753d7C11A56A52FE47a177a87e431655)|
| Polygon | `0xf8f9efc0db77d8881500bb06ff5d6abc3070e695` [↗](https://polygonscan.com/token/0xf8f9efc0db77d8881500bb06ff5d6abc3070e695)|
| Metis | `0x67c10c397dd0ba417329543c1a40eb48aaa7cd00` [↗](https://andromeda-explorer.metis.io/address/0x67C10C397dD0Ba417329543c1a40eb48AAa7cd00)|
26 changes: 26 additions & 0 deletions docs/bridge/docs/Contracts/02-Synapse-Router.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Synapse Router

**Address**: `0x7E7A0e201FD38d3ADAA9523Da6C109a07118C96a`

| Chain | Address |
|-----------|----------------------------------------------|
| Arbitrum | `0x6F4e8eBa4D337f874Ab57478AcC2Cb5BACdc19c9` [↗](https://arbiscan.io/address/0x6F4e8eBa4D337f874Ab57478AcC2Cb5BACdc19c9) |
| Aurora | `0xaeD5b25BE1c3163c907a471082640450F928DDFE` [↗](https://explorer.mainnet.aurora.dev/address/0xaeD5b25BE1c3163c907a471082640450F928DDFE/transactions) |
| Avalanche | `0xC05e61d0E7a63D27546389B7aD62FdFf5A91aACE` [↗](https://snowtrace.io/address/0xC05e61d0E7a63D27546389B7aD62FdFf5A91aACE) |
| Base | `0xf07d1C752fAb503E47FEF309bf14fbDD3E867089` [↗](https://basescan.org/address/0xf07d1C752fAb503E47FEF309bf14fbDD3E867089) |
| Blast | `0x55769baf6ec39b3bf4aae948eb890ea33307ef3c` [↗](https://blastscan.io/address/0x55769baf6ec39b3bf4aae948eb890ea33307ef3c) |
| Boba | `0x432036208d2717394d2614d6697c46DF3Ed69540` [↗](https://blockexplorer.boba.network/address/0x432036208d2717394d2614d6697c46DF3Ed69540/transactions) |
| BSC | `0xd123f70AE324d34A9E76b67a27bf77593bA8749f` [↗](https://bscscan.com/address/0xd123f70AE324d34A9E76b67a27bf77593bA8749f) |
| Canto | `0xDde5BEC4815E1CeCf336fb973Ca578e8D83606E0` [↗](https://evm.explorer.canto.io/address/0xDde5BEC4815E1CeCf336fb973Ca578e8D83606E0) |
| Cronos | `0xE27BFf97CE92C3e1Ff7AA9f86781FDd6D48F5eE9` [↗](https://cronoscan.com/address/0xE27BFf97CE92C3e1Ff7AA9f86781FDd6D48F5eE9) |
| DFK | `0xE05c976d3f045D0E6E7A6f61083d98A15603cF6A` [↗](https://subnets.avax.network/defi-kingdoms/dfk-chain/explorer/address/0xE05c976d3f045D0E6E7A6f61083d98A15603cF6A) |
| Dogechain | `0x9508BF380c1e6f751D97604732eF1Bae6673f299` [↗](https://explorer.dogechain.dog/address/0x9508BF380c1e6f751D97604732eF1Bae6673f299) |
| Ethereum | `0x2796317b0fF8538F253012862c06787Adfb8cEb6` [↗](https://etherscan.io/address/0x2796317b0fF8538F253012862c06787Adfb8cEb6) |
| Fantom | `0xAf41a65F786339e7911F4acDAD6BD49426F2Dc6b` [↗](https://ftmscan.com/address/0xAf41a65F786339e7911F4acDAD6BD49426F2Dc6b) |
| Harmony | `0xAf41a65F786339e7911F4acDAD6BD49426F2Dc6b` [↗](https://explorer.harmony.one/address/0xaf41a65f786339e7911f4acdad6bd49426f2dc6b) |
| Klaytn | `0xAf41a65F786339e7911F4acDAD6BD49426F2Dc6b` [↗](https://scope.klaytn.com/account/0xAf41a65F786339e7911F4acDAD6BD49426F2Dc6b?tabId=txList) |
| Metis | `0x06Fea8513FF03a0d3f61324da709D4cf06F42A5c` [↗](https://andromeda-explorer.metis.io/address/0x06Fea8513FF03a0d3f61324da709D4cf06F42A5c) |
| Moonbeam | `0x84A420459cd31C3c34583F67E0f0fB191067D32f` [↗](https://moonscan.io/address/0x84A420459cd31C3c34583F67E0f0fB191067D32f) |
| Moonriver | `0xaeD5b25BE1c3163c907a471082640450F928DDFE` [↗](https://moonriver.moonscan.io/address/0xaeD5b25BE1c3163c907a471082640450F928DDFE) |
| Optimism | `0xAf41a65F786339e7911F4acDAD6BD49426F2Dc6b` [↗](https://optimistic.etherscan.io/address/0xAf41a65F786339e7911F4acDAD6BD49426F2Dc6b) |
| Polygon | `0x8F5BBB2BB8c2Ee94639E55d5F41de9b4839C1280` [↗](https://polygonscan.com/address/0x8F5BBB2BB8c2Ee94639E55d5F41de9b4839C1280) |
Loading
Loading