πŸ› οΈ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)

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: Approve users’ ERC20 tokens only for one contract, which is 'metaRouterGateway' on each blockchain. You can verify the addresses of the contracts for all blockchains supported by Symbiosis protocol V2 in this configuration.

  2. Existence and Correct Addresses of Contracts: Ensure that all contracts used in your software exist on the corresponding blockchains and that their addresses on each blockchain match those in this configuration.

  3. Handling of Calldata: Do not modify, reuse, or cache the calldata obtained from calling methods of the Symbiosis SDKs and API.

  4. Acknowledgement of 'from' Address Usage: Acknowledge that the 'from' address is used to revert a cross-chain swap if the cross-chain operation gets stuck. For more information see #address-eligible-to-revert-cross-chain-swaps

  5. Testing: After deployment to Mainnet, run at least one cross-chain operation.

Please do these checks for the initial deployment AND each software update.

Understanding the Symbiosis Protocol

The most crucial parts for understanding the Symbiosis protocol are:

Dependencies

Repository

Last updated