Totle API

The Totle API Developer Hub

Architecture

This article provides an architectural overview of the Smart Contracts employed by Totle.

Smart Contract
Description
Notes

Responsible for the interaction between Totle and EtherDelta when filling orders

Responsible for all implementation specific logic required by each DEX

Due to the differing requirements of executing trades at each DEX, we employ the use of separate ExchangeHandler contracts. An ExchangeHandler is responsible for all implementation specific logic required by each DEX. This could range from depositing funds prior to initiating a trade to wrapping or unwrapping ether as required. It is a key requirement that we keep DEX logic separate from the primary contract in order to allow for expansion of the platform

Responsible for transferring ownership of ERC20 tokens from the investor to the TotlePrimary contract on execution of a sell order

TokenTransferProxy is responsible for transferring ownership of ERC20 tokens from the buyer/seller to the TotlePrimary contract on execution of a sell order. The buyer/seller is therefore required to set an allowance for the TokenTransferProxy prior to selling any tokens via Totle. The TokenTransferProxy maintains a record of addresses which have been authorized to transfer tokens on its behalf, the only address with this authorization is the TotlePrimary contract. In case of an upgrade to the primary contract, Totle is the only authorized party to approve this change. As the platform matures we may implement a safeguarding mechanism such as a multi-sig or time-locked contract to control address authorization and welcome feedback on this from the community

Loops through each token trade, sequentially executing all orders at their respective exchange handlers. This contract is entry point for external transactions and performs sanity checks on the payload

This contract is the sole entry point for external transactions and is responsible for performing sanity checks on the payload, executing trades via the respective exchange handler, and keeping count of amounts given and received in order to enforce minimum exchange rate requirements

Architecture


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.