README.md

THIS REPO IS ARCHIVED AND NOT CURRENT. PLEASE SEE https://github.com/synapsecns/sdk/wiki FOR THE MOST UP TO DATE DOCS.

Synapse Protocol SDK Documentation

This repository contains documentation for the Synapse Protocol NodeJS SDK.

Notes

At any given time, this documentation can -- and likely will -- expand. 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.

Contents

• Core
  • Installation/General usage of the NPM module
  • Networks
    • ChainId namespace
    • Networks namespace
  • Tokens
    • Token class
• 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.