Home

Synapse Protocol SDK Wiki

This wiki contains documentation for the Synapse Protocol NodeJS SDK.

Notes

At any given time, this documentation can -- and likely will -- expand and/or change. If a doc for something doesn't seem to be there, hit us up via Discord or Telegram and let us know. We're likely already working on it and it'll be here soon, but it is very helpful to know what to prioritize.

Frontend Integration

Want to jump right in to integrating the Synapse Protocol SDK with your frontend? You're in luck! We have a Create React App-based example frontend, which can be found in the examples/frontend directory of the SDK repository on GitHub.

The example frontend provides fully functional examples of using the Synapse Protocol SDK with React, web3-react, and Ethers, as well as showcasing the most commonly used aspects of -- and efficient ways to integrate -- the SDK.

Contents

• Getting Started
  • Installation
  • Frontend Concepts
  • FAQ/Common Issues
• Core
  • Networks
    • ChainId
    • Networks namespace
  • Tokens
    • Token type
    • Supported tokens
• Bridge
  • Bridge and SynapseBridge: Provides basic information about the Bridge namespace, as well as the SynapseBridge class contained within it, along with examples for using said class.