Abstract Class Inheritance: SmartContract, IOpdexLiquidityPool

An abstract smart contract class that is inherited by standard pool and staking pool. Provides a base class sharing similar properties and methods between the two different liquidity pool types.

Constructor

protected OpdexLiquidityPool(ISmartContractState state,
                             Address token,
                             uint transactionFee) : base(state)

Parameters

Properties

Methods

Get Balance

Retrieves the provided addresses token balance.

public UInt256 GetBalance(Address address);

Parameters

Returns

Allowance

Retrieves the allowance of a spender approved by an owner.

public UInt256 Allowance(Address owner, Address spender);

Parameters

Returns

Approve

Approves an allowance for a spender.

public bool Approve(Address spender, UInt256 currentAmount, UInt256 amount);

Parameters

Returns

Transfer From

Allows the sender to transfer tokens using an approved allowance from another address.

public bool TransferFrom(Address from, Address to, UInt256 amount);

Parameters

Returns

Mint

Mints new liquidity pool tokens based on the differences between the contract’s actual token balances and reserves. Adding liquidity through a market contract optimistically transfers tokens to this contract before calling this method.

The transfer of CRS and SRC tokens to this contract and the call to this Mint method should be done in the same transaction, through a market contract or an integrated 3rd party contract to avoid front-running, arbitrage, and/or loss of funds.

In private standard markets with provider authorizations enabled, this method will validate the transaction sender is whitelisted for liquidity provisioning.

public UInt256 Mint(Address to);

Parameters

Returns

Burn

Burns liquidity pool tokens based on the amount sent optimistically to this contract through a market contract. The contract checks its balance of liquidity pool tokens, burns them and returns the share of reserves to the user.

The transfer of liquidity pool tokens to this contract and the call of this Burn method should be done in the same transaction, through a market contract or an integrated 3rd party contract to avoid front-running, arbitrage, and/or loss of funds.

In private standard markets with provider authorizations enabled, this method will validate the transaction sender is whitelisted for liquidity provisioning.

public UInt256[] Burn(Address to);

Parameters

Returns

Swap

Swaps tokens in a pool based on the desired amount to pull out of the pool. Through a market contract, the input token is transferred prior to calling this method.

The pool determines which and how many tokens were sent by checking the difference between the pool’s token balances and the last recorded reserves. If the amount sent does not satisfy the amount expected to be received, the transaction fails and rolls back.

Each swap transaction incurs a transaction fee set by the market when the pool was created between 0% and 1%. Any amount withdrawn from the pool requires an equal input amount plus transaction fees.

The transfer of CRS or SRC tokens to this contract and the call of this Swap method should be done in the same transaction, through a market contract or an integrated 3rd party contract to avoid front-running, arbitrage, and/or loss of funds.

In private standard markets with trader authorizations enabled, this method will validate the transaction sender is whitelisted for trading.

public void Swap(ulong amountCrsOut, UInt256 amountSrcOut, Address to, byte[] data);

Parameters

Skim

Forces the balances to equal the current token reserves. In the event of a “donation” or event alike, withdraw the difference between CRS and SRC balance overages and their reserves.

In private standard markets with providers authorizations enabled, this method will validate the transaction sender is whitelisted for liquidity provisioning.

public void Skim(Address to);

Parameters

Sync

Forces the reserves to equal the current token balances. In the event of a “donation” or event alike, update the reserves to reflect the change.

In private standard markets with providers authorizations enabled, this method will validate the transaction sender is whitelisted for liquidity provisioning.

public void Sync();

Logs

Transfer Log

Emitted during an SRC20 token transfer transaction.

Properties

Approval Log

Emitted during an SRC20 allowance approval transaction.

Properties

Burn Log

Emitted when liquidity pool tokens are burned after removing liquidity from a pool.

Properties

Mint Log

Emitted when liquidity pool tokens are minted after adding liquidity to a pool.

Properties

Reserves Log

Emitted when a pool’s reserves are updated, after a swap, adding, or removing liquidity transaction.

Properties

Swap Log

Emitted for each pool in the transaction where a token swap occurred.

Properties

References

OpdexLiquidityPool Smart Contract - Github

IOpdexLiquidityPool Interface - Github

Stratis SmartContract Documentation - Stratis Academy