Skip to content

Commit

Permalink
Merge a4674eb into eae6830
Browse files Browse the repository at this point in the history
  • Loading branch information
lawsonkight authored Sep 28, 2024
2 parents eae6830 + a4674eb commit 9844b73
Show file tree
Hide file tree
Showing 91 changed files with 4,123 additions and 1,874 deletions.
14 changes: 14 additions & 0 deletions docs/bridge/docs/01-About/01-Synapse-DAO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Synapse DAO

Since launch of the Synapse Protocol, a number of governance initiatives have been put forward and voted on by the Synapse DAO.

## Governance Model

SYN holders with more than 100,000 SYN tokens can put forward proposals to be be voted on by the DAO. SYN holders can vote using SYN on multiple chains, or delegate their votes to other token holders.

In order to be adopted by the DAO, a proposal must gather at least `50% + 1` of all votes and reach the minimum quorum of 5 million SYN tokens.

## Governance Components

* [Forum](https://forum.synapseprotocol.com/): A Platform to post proposals for discussion before an official vote
* [Snapshot](https://snapshot.org/#/synapseprotocol.eth): A decentralized governance platform for conducting official votes.
21 changes: 21 additions & 0 deletions docs/bridge/docs/01-About/09-Brand-Assets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Brand Assets

### [synapse-brand-assets.zip](/brand-assets/synapse-brand-assets.zip)

## Logo

| Name | Image |
|----------------------------------------------------------------------|-
| [`synapse-logo-onLight.svg`](/brand-assets/synapse-logo-onLight.svg) | ![Synapse logo](/brand-assets/synapse-logo-onLight.svg)
| [`synapse-logo-onDark.svg`](/brand-assets/synapse-logo-onDark.svg) | ![Synapse logo](/brand-assets/synapse-logo-onDark.svg)
| [`synapse-logo-black.svg`](/brand-assets/synapse-logo-black.svg) | ![Synapse logo](/brand-assets/synapse-logo-black.svg)
| [`synapse-logo-white.svg`](/brand-assets/synapse-logo-white.svg) | ![Synapse logo](/brand-assets/synapse-logo-white.svg)

## Mark

| Name | Image |
|--------------------------------------------------------------------|-
| [`synapse-mark.svg`](/brand-assets/synapse-mark.svg) | ![Synapse logo](/brand-assets/synapse-mark.svg)
| [`synapse-mark-white.svg`](/brand-assets/synapse-mark-white.svg) | ![Synapse logo](/brand-assets/synapse-mark-white.svg)
| [`synapse-mark-black.svg`](/brand-assets/synapse-mark-black.svg) | ![Synapse logo](/brand-assets/synapse-mark-black.svg)
| [`synapse-border-mark.svg`](/brand-assets/synapse-border-mark.svg) | ![Synapse logo](/brand-assets/synapse-border-mark.svg)
84 changes: 84 additions & 0 deletions docs/bridge/docs/01-About/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
title: About
---

import AnimatedLogo from '@site/src/components/AnimatedLogo'
import SVGBridge from '@site/src/components/SVGBridge'
import { BridgeFlow } from '@site/src/components/BridgeFlow'
import { CCTPFlow } from '@site/src/components/CCTPFlow'
import { RFQFlow } from '@site/src/components/RFQFlow'

<AnimatedLogo />

# Use Synapse

Synapse is an Interchain Programming Interface. Developers read and write interchain data with Synapse, which has settled $50B in transactions between 2M+ users, and generated $30M+ in fees [[Explorer](https://explorer.synapseprotocol.com)].

## Interchain Bridge

<figure>
<SVGBridge />
<figcaption>Synapse Bridge</figcaption>
</figure>

* [Overview](/docs/Bridge)
* [Bridge guide](/docs/Bridge#how-to-bridge)
<!-- * [Supported routes](/docs/Bridge#how-to-bridge) -->

## Developers

Embed or build a custom Bridge application.

* **[SDK](/docs/Developers/Bridge-SDK)** – Call Synapse Router functions from your frontend or backend application.
* **[REST API](/docs/Developers/REST-API)** – Endpoints and example code
* **[Widget](/docs/Developers/Widget)** – Embed a customized Synapse Bridge in your application.

## Synapse Routers

Synapse Router automatically determines the appropriate router type to use for each Bridge transaction.

<figure id="flowGroup">
<figure>
<BridgeFlow />
<figcaption>Synapse Router</figcaption>
</figure>
<figure>
<CCTPFlow />
<figcaption>Synapse CCTP</figcaption>
</figure>
<figure>
<RFQFlow />
<figcaption>Synapse RFQ</figcaption>
</figure>
</figure>

* **[Synapse Router](/docs/Routers/Synapse-Router)** – Executable quotes for arbitrary blockchain transactions.
* **[CCTP](/docs/Routers/CCTP)** – Native router for USDC transactions.
* **[RFQ](/docs/Routers/RFQ)** – Fast router that allows on-chain agents to bid on interchain delivery.

## Essential Services

Bolt-on services for reliability and ease-of-use:

* **[Scribe](/docs/Services/Scribe)** – Index logs, receipts and transactions across multiple chains
* **[OmniRPC](/docs/Services/Omnirpc)** – Interchain RPC load balancer and verifier
* **[Signer](/docs/Services/Signer)** – Support for the AWS Key Management System (KMS)
* **[Submitter](/docs/Services/Submitter)** – Gas management service to ensure transaction confirmation
* **[Observability](/docs/Services/Observability)** – Open telemetry system for Synapse SDK


## Community & Support

Connect with other developers and the Synapse team

* **[Discord](https://discord.gg/synapseprotocol)**
* **[Twitter](https://twitter.com/SynapseProtocol)**
* **[Telegram](https://t.me/synapseprotocol)**
* **[Forum](https://forum.synapseprotocol.com/)**

## Additional Links

Synapse transactions can be observed confirmed via the following methods:

* **[Synapse Bridge](https://synapseprotocol.com)** – Bridge, Swap, and Stake via Synapse's cross-chain pools.
* **[Synapse Explorer](https://explorer.synapseprotocol.com)** – Public explorer for Synapse Bridge transactions.
7 changes: 7 additions & 0 deletions docs/bridge/docs/02-Bridge/Supported-Routes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import Routes from '@site/src/components/Routes'

# Supported Chains & Tokens

This page contains a list of supported tokens, listed per-chain. For a given pair, use the [Synapse Bridge](https://synapseprotocol.com) to see if a route between them exists.

<Routes />
58 changes: 58 additions & 0 deletions docs/bridge/docs/02-Bridge/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: Bridge
---

import { BridgeFlow } from '@site/src/components/BridgeFlow'
import SVGBridge from '@site/src/components/SVGBridge'

# 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](Supported-Routes) in a safe and secure manner.

<br />

<figure>
<BridgeFlow />
<figcaption>User assets are sent to a bridge contract, moved to the `destChain`, and returned to the user.</figcaption>
</figure>

## Developers

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

## Bridge Functions

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

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

## Pool Liquidity

![liquidity pool tokens](lp-tokens.svg)\
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.

## How to Bridge

<figure>
<SVGBridge />
<figcaption>Synapse Bridge</figcaption>
</figure>

### Instructions

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

## Bridge Contracts

Synapse Bridge contracts are available [here](https://docs.synapseprotocol.com/synapse-bridge/contract-addresses).
61 changes: 61 additions & 0 deletions docs/bridge/docs/02-Bridge/lp-tokens.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 9844b73

Please sign in to comment.