SYMM Diamond SDK

The SYMM Diamond SDK provides ready-to-use code examples and utilities for interacting with Symmio smart contracts. It aims to simplify the development process by offering modular, well-documented examples that can be adapted to your specific needs.

For comprehensive information on contract functions, please refer to the Contracts Documentation. To understand the trading flow, consult this Guide.

This toolkit is ideal for:

  • DeFi developers working with Symmio protocol

  • Trading platforms looking to integrate with Symmio

  • Developers building custom interfaces for decentralized perpetual trading

  • Anyone wanting to understand how to interact with the SYMM Diamond contract

Features Overview

The toolkit provides implementations for key protocol interactions:

  • Account Management

    • Create and manage sub-accounts via the MultiAccount contract

    • Deposit and allocate collateral

  • Trading Operations

    • Send quotes

    • Open and close positions

    • Cancel quotes

  • View Functions

    • Query account balances

    • Retrieve open positions

    • Access quote details

Getting Started

To begin working with the SYMM Diamond SDK:

  1. Clone the Repository:

  2. Set Up Environment: Follow the installation instructions in the README to configure your development environment.

  3. Configure Settings: Copy the .env.example file to .env and fill in your specific configuration values.

  4. Run Example Scripts: Query information related to positions and execute functions on the diamond.

Last updated