Synapse Protocol
Search…
Synapse Protocol
Introduction
Vision
Getting Started
Protocol
Overview
Cross-Chain Messaging
Optimistic Verification
Synapse Bridge
Synapse Chain
Guides
Bridge Assets
Provide Liquidity
Swap Stables
Milestones & Governance
Milestones
Trade SYN
Governance Initiatives
Developers
Bridge SDK
Usage and Examples
SDK Reference
REST API
Examples
Security
Audits
Governance
Resources
Contract Addresses
FAQ
Brand Assets
Ecosystem
Powered By GitBook
Bridge SDK
The quickest & simplest way to access cross-chain liquidity
The Synapse SDK is the easiest way for any developer to integrate cross-chain token & liquidity transfers into their application. The SDK is built to support full-fledged frontend applications, but is fully isomorphic, able to be used both client & server-side.
​
The Synapse SDK allows protocols to own the user experience within their own dApp

Quick Start

Installation

Pre-reqs: Node v16+. The SDK is only fully tested on Node 16+ or greater. Earlier versions may have errors.
Depending on the package manager of your choice, install the SDK using one of the following:
NPM
Yarn
npm install @synapseprotocol/sdk --save
yarn add @synapseprotocol/sdk
The SDK package relies on the following dependencies installed from NPM.
@ethersproject
ethers

SDK API Reference

Now that you've seen what basic integration looks like, dive into the specifics of the SDK in our complete documentation
Milestones & Governance - Previous
Governance Initiatives
Next
Usage and Examples
Last modified 22d ago
Copy link
Outline
Quick Start
Installation
SDK API Reference