Solidity API

AbstractTokenExchange

This contract provides the base for exchanges, refutations, and balances management for such processes. It expects to be implemented by further fine-tuned trade contracts and remains abstract itself.

ExchangeType

Defines the type of Exchange

enum ExchangeType {
  TOKEN_FOR_TOKEN,
  FIAT_FOR_TOKEN
}

ExchangeRequest

struct ExchangeRequest {
  address sender;
  uint256 value;
  uint256 timestamp;
  bool refuted;
}

DepositorSet

event DepositorSet(address depositor)

TokensDeposited

event TokensDeposited(address depositor, address token, uint256 value, uint256 tokenId)

TokensWithdrawn

event TokensWithdrawn(address from, address token, uint256 value, address to)

TokensExchanged

event TokensExchanged(address caller, address quoteToken, uint256 quoteValue, address baseToken, uint256 baseValue)

ExchangeCommenced

event ExchangeCommenced(uint256 exchangeRequestId, address requester, address baseToken, uint256 value)

ExchangeCompleted

event ExchangeCompleted(uint256 exchangeRequestId, address requester, address baseToken, uint256 value)

ExchangeRefuted

event ExchangeRefuted(address depositor, uint256 exchangeRequestId)

RefutationNullified

event RefutationNullified(address sender, uint256 exchangeRequestId)

ExchangeNullified

event ExchangeNullified(address sender, uint256 exchangeRequestId)

TokenExchangeInvalidToken

error TokenExchangeInvalidToken(address tokenAddress, string msg)

TokenExchangeActiveExchangeWindow

error TokenExchangeActiveExchangeWindow(uint256 exchangeWindowTill, uint256 requestTimestamp)

TokenExchangeInactiveExchangeWindow

error TokenExchangeInactiveExchangeWindow(uint256 exchangeWindowTill, uint256 requestTimestamp)

TokenExchangeInsufficientBalance

error TokenExchangeInsufficientBalance(uint256 balance, uint256 requested)

TokenExchangeInsufficientAllowance

error TokenExchangeInsufficientAllowance(uint256 allowance, uint256 required)

TokenExchangeUnauthorizedDepositor

error TokenExchangeUnauthorizedDepositor(address sender, address depositor)

TokenExchangeInvalidExchangeRequest

error TokenExchangeInvalidExchangeRequest(uint256 requestId)

TokenExchangeInactiveRefutationWindow

error TokenExchangeInactiveRefutationWindow(uint256 refutationWindowTill, uint256 refuteTimestamp)

TokenExchangeActiveRefutationWindow

error TokenExchangeActiveRefutationWindow(uint256 refutationWindowTill, uint256 requestTimestamp)

TokenExchangeInvalidRefutationWindow

error TokenExchangeInvalidRefutationWindow(uint256 refutationWindowTill, uint256 requestTimestamp)

TokenExchangeUnauthorizedResolver

error TokenExchangeUnauthorizedResolver(address sender)

TokenExchangeUnauthorizedRequester

error TokenExchangeUnauthorizedRequester(address sender, address originalRequester)

TokenExchangeInvalidRefutationStatus

error TokenExchangeInvalidRefutationStatus(uint256 exchangeRequestId)

TokenExchangeTransferFailed

error TokenExchangeTransferFailed(address from, address to, uint256 amount)

Error thrown when an erc-20 token transfer fails

_setDepositor

function _setDepositor(address _depositor) internal

getDepositor

function getDepositor() public view virtual returns (address)

getExchangeType

function getExchangeType() public view virtual returns (enum AbstractTokenExchange.ExchangeType)

_setExchangeType

function _setExchangeType(enum AbstractTokenExchange.ExchangeType _exchangeType) internal

getRatio

function getRatio() public view virtual returns (uint256)

_setRatio

function _setRatio(uint256 _newRatio) internal

getBaseToken

function getBaseToken() public view virtual returns (address)

getQuoteToken

function getQuoteToken() public view virtual returns (address)

getExchangeWindow

function getExchangeWindow() public view virtual returns (uint256)

_setExchangeWindow

function _setExchangeWindow(uint256 _newExchangeWindow) internal

isDisputeResolver

function isDisputeResolver(address resolver) public view virtual returns (bool)

_setDisputeResolver

function _setDisputeResolver(address _resolver, bool _allow) internal

getExchangeRequest

function getExchangeRequest(uint256 requestId) public view virtual returns (struct AbstractTokenExchange.ExchangeRequest exchangeRequest)

getRefutationWindow

function getRefutationWindow() public view virtual returns (uint256)

_setRefutationWindow

function _setRefutationWindow(uint256 _newRefutationWindow) internal

_setBaseToken

function _setBaseToken(address _baseToken) internal

_setQuoteToken

function _setQuoteToken(address _quoteToken) internal

getDepositUnderExchange

function getDepositUnderExchange() public view virtual returns (uint256)

constructor

constructor(string _erc1155uri) internal

_deposit

function _deposit(address _to, address _token, uint256 _value) internal

Deposit ERC-20 baseTokens to an address into the contract and mint corresponding ERC-1155 tokens.

Caller must have approved the contract to spend value amount of the ERC-20 token provided.

Parameters

Name	Type	Description
_to	address
_token	address
_value	uint256	The amount of tokens to deposit.

_withdraw

function _withdraw(address _from, address _to, address _token, uint256 _value) internal

Withdraw deposited ERC-20 tokens from the contract.

The caller must own equivalent ERC-1155 tokens for the same ERC-20 contract being withdrawn.

Parameters

Name	Type	Description
_from	address	Address of the account on erc-1155 balances to withdraw from.
_to	address	The address to credit the withdrawn ERC-20 tokens.
_token	address	The address ERC-20 to be withdrawn from ERC-1155 deposited balances.
_value	uint256	The amount of tokens to withdraw.

_exchange

function _exchange(uint256 _quoteValue) internal

Single-step exchange for token-for-token exchange.

The caller must approve the contract for sufficient quoteToken ERC-20 tokens, and the contract will exchange quoteToken for baseToken based on the established ratio. This function can only be called during the exchangeWindow.

Parameters

Name	Type	Description
_quoteValue	uint256	The value of ERC-20 quoteToken to be exchanged.

_exchangeCommence

function _exchangeCommence(uint256 _baseValue, address _exchangeCaller, uint256 _exchangeRequestId) internal

Commences a refutable fiat-for-token exchange process.

This function allows users to initiate an exchange request during the exchange window. The request will be recorded and can be refuted by the depositor within the refutation window.

Parameters

Name	Type	Description
_baseValue	uint256	The value of ERC-20 baseToken to be exchanged.
_exchangeCaller	address
_exchangeRequestId	uint256

_refute

function _refute(uint256 _exchangeRequestId) internal

Refute an exchange request by the depositor.

The caller must be the depositor and the exchange request should be available and within the refutable time frame.

Parameters

Name	Type	Description
_exchangeRequestId	uint256	The ID of the exchange request to be refuted.

_nullifyRefutation

function _nullifyRefutation(uint256 _exchangeRequestId) internal

Nullify a refutation, marking the exchange request as unRefuted.

Can only be called by the depositor or a disputeResolver. The exchange request must exist and have been refuted.

Parameters

Name	Type	Description
_exchangeRequestId	uint256	The ID of the exchange request to nullify refutation.

_nullifyExchange

function _nullifyExchange(uint256 _exchangeRequestId) internal

Nullifies a refuted exchange request, removing it and unlocking depositor's tokens.

Can only be called by a dispute resolver. The exchange request must exist and be refuted.

Parameters

Name	Type	Description
_exchangeRequestId	uint256	The ID of the exchange request to nullify.

_exchangeComplete

function _exchangeComplete(uint256 _exchangeRequestId) internal

Completes an exchange request by transferring tokens to the original request sender. Ensures the refutation window has elapsed, and the request is not refuted.

Parameters

Name	Type	Description
_exchangeRequestId	uint256	The unique ID of the exchange request to be completed. Requirements: - The caller must be the original exchange request sender. - The refutation window must have elapsed. - The exchange request must not be refuted. - The baseToken must have sufficient balance and approval for transfer. Emits: - ExchangeCompleted event upon successful completion of the exchange.

onlyDepositor

modifier onlyDepositor()

_isCompatibleERC20

function _isCompatibleERC20(address token) internal returns (bool, string)

Verifies if the given address is a valid ERC20 token by checking the presence of the transfer, transferFrom, and allowance functions using staticcall.

Parameters

Name	Type	Description
token	address	The token address to verify.

Return Values

Name	Type	Description
[0]	bool	_isCompatibleERC20 True if the address is a valid ERC20 token (with the required functions).
[1]	string