Symbiosis JS SDK

Symbiosis JS SDK intro, and the repository location.

What is Symbiosis JS SDK

The Symbiosis JS SDK offers direct access to the features and functions of the Symbiosis protocol.

Due to the dynamic nature of its updates and the potential for backward compatibility issues, we strongly recommend that integrators and partners utilize the Symbiosis API.

Checklist Before Going to Production (Mainnet)

Warning: If any of these checks fail, you put the assets of your users at risk. Therefore, you must not go to Mainnet with real assets and real users. This could result in the loss of your users' assets.

1. Approval of ERC20 Tokens: Always approve users' ERC20 tokens for only one contract — the metaRouterGateway — on each blockchain. Verify the contract addresses for all supported blockchains in this configuration.

2. Contract Existence and Address Validation: Ensure that the contracts used in your integration are deployed on the respective blockchains, and that their addresses on each blockchain match those listed in this configuration.

3. Handling of Calldata: Do not modify, reuse, or cache calldata retrieved from Symbiosis SDKs or API methods.

4. Testing: After deployment to Mainnet, conduct at least one cross-chain operation to ensure proper functionality.

Reminder: Perform this checklist during the initial deployment and after every software update.

Understanding the Symbiosis Protocol

The key components for understanding the Symbiosis Protocol include:

• The Symbiosis Core Contracts Interactions: Symbiosis Routing Contracts.

• Emergency Handling (stuck cross-chain operations): Symbiosis & Emergencies.

• Fee Collection: Symbiosis & Fees.

Dependencies

• The ethers.js library

Repository

• Symbiosis JS SDK NPM

• JS SDK GitHub repository