crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Point to ILiquidityProvider interface in docs, not ILiquidityProviderSandbox (#71)

Browse Source
This commit is contained in:
mzhu25 2020-12-02 14:38:46 -08:00 committed by GitHub
parent 4480f84efa
commit 9eea7de340
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 45 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
docs/advanced/plp.rst
View File

@ -7,59 +7,80 @@ PLP (Pluggable Liquidity PLP) enables anyone to extend the 0x Protocol with thei
Implementing a Liquidity Provider Implementing a Liquidity Provider
================================= =================================
The only requirement is that the provider implements the interface in `ILiquidityProviderSandbox <https://github.com/0xProject/protocol/blob/development/contracts/zero-ex/contracts/src/external/ILiquidityProviderSandbox.sol>`_. The only requirement is that the provider implements the interface in `ILiquidityProvider <https://github.com/0xProject/protocol/blob/development/contracts/zero-ex/contracts/src/vendor/ILiquidityProvider.sol>`_.
Note that ``sellEthForToken`` and ``sellTokenForEth`` do not need to be implemented if the liquidity provider does not trade ETH/WETH.
.. code-block:: solidity .. code-block:: solidity
/// @dev Calls `sellTokenForToken` on the given `provider` contract to /// @dev Trades `inputToken` for `outputToken`. The amount of `inputToken`
/// trigger a trade. /// to sell must be transferred to the contract prior to calling this
/// @param provider The address of the on-chain liquidity provider. /// function to trigger the trade.
/// @param inputToken The token being sold. /// @param inputToken The token being sold.
/// @param outputToken The token being bought. /// @param outputToken The token being bought.
/// @param recipient The recipient of the bought tokens. /// @param recipient The recipient of the bought tokens.
/// @param minBuyAmount The minimum acceptable amount of `outputToken` to buy. /// @param minBuyAmount The minimum acceptable amount of `outputToken` to buy.
/// @param auxiliaryData Auxiliary data supplied to the `provider` contract. /// @param auxiliaryData Arbitrary auxiliary data supplied to the contract.
function executeSellTokenForToken( /// @return boughtAmount The amount of `outputToken` bought.
address provider, function sellTokenForToken(
address inputToken, address inputToken,
address outputToken, address outputToken,
address recipient, address recipient,
uint256 minBuyAmount, uint256 minBuyAmount,
bytes calldata auxiliaryData bytes calldata auxiliaryData
) )
external; external
returns (uint256 boughtAmount);
/// @dev Calls `sellEthForToken` on the given `provider` contract to /// @dev Trades ETH for token. ETH must either be attached to this function
/// trigger a trade. /// call or sent to the contract prior to calling this function to
/// @param provider The address of the on-chain liquidity provider. /// trigger the trade.
/// @param outputToken The token being bought. /// @param outputToken The token being bought.
/// @param recipient The recipient of the bought tokens. /// @param recipient The recipient of the bought tokens.
/// @param minBuyAmount The minimum acceptable amount of `outputToken` to buy. /// @param minBuyAmount The minimum acceptable amount of `outputToken` to buy.
/// @param auxiliaryData Auxiliary data supplied to the `provider` contract. /// @param auxiliaryData Arbitrary auxiliary data supplied to the contract.
function executeSellEthForToken( /// @return boughtAmount The amount of `outputToken` bought.
address provider, function sellEthForToken(
address outputToken, address outputToken,
address recipient, address recipient,
uint256 minBuyAmount, uint256 minBuyAmount,
bytes calldata auxiliaryData bytes calldata auxiliaryData
) )
external; external
payable
returns (uint256 boughtAmount);
/// @dev Calls `sellTokenForEth` on the given `provider` contract to /// @dev Trades token for ETH. The token must be sent to the contract prior
/// trigger a trade. /// to calling this function to trigger the trade.
/// @param provider The address of the on-chain liquidity provider.
/// @param inputToken The token being sold. /// @param inputToken The token being sold.
/// @param recipient The recipient of the bought tokens. /// @param recipient The recipient of the bought tokens.
/// @param minBuyAmount The minimum acceptable amount of ETH to buy. /// @param minBuyAmount The minimum acceptable amount of ETH to buy.
/// @param auxiliaryData Auxiliary data supplied to the `provider` contract. /// @param auxiliaryData Arbitrary auxiliary data supplied to the contract.
function executeSellTokenForEth( /// @return boughtAmount The amount of ETH bought.
address provider, function sellTokenForEth(
address inputToken, address inputToken,
address recipient, address payable recipient,
uint256 minBuyAmount, uint256 minBuyAmount,
bytes calldata auxiliaryData bytes calldata auxiliaryData
) )
external; external
returns (uint256 boughtAmount);
/// @dev Quotes the amount of `outputToken` that would be obtained by
/// selling `sellAmount` of `inputToken`.
/// @param inputToken Address of the taker token (what to sell). Use
/// the wETH address if selling ETH.
/// @param outputToken Address of the maker token (what to buy). Use
/// the wETH address if buying ETH.
/// @param sellAmount Amount of `inputToken` to sell.
/// @return outputTokenAmount Amount of `outputToken` that would be obtained.
function getSellQuote(
address inputToken,
address outputToken,
uint256 sellAmount
)
external
view
returns (uint256 outputTokenAmount);
Trading with a Liquidity Provider Trading with a Liquidity Provider
@ -98,4 +119,4 @@ To trade with a liquidity provider use the ``sellToLiquidityProvider`` function.
This function transfers tokens from ``msg.sender`` to the liquidity provider then executes the trade through a sandboxed contract external to the Exchange Proxy. The sandbox then executes the trade through the provider. This function then transfers the output tokens to the ``recipient``. This function transfers tokens from ``msg.sender`` to the liquidity provider then executes the trade through a sandboxed contract external to the Exchange Proxy. The sandbox then executes the trade through the provider. This function then transfers the output tokens to the ``recipient``.
This function will emit a `LiquidityProviderSwap <../basics/events.html#liquidityproviderswap>`_ event if the trade succeeds. It will revert if the amount of ``outputToken`` returned by the Liquidity Provider is less than ``minBuyAmount``. This function will emit a `LiquidityProviderSwap <../basics/events.html#liquidityproviderswap>`_ event if the trade succeeds. It will revert if the amount of ``outputToken`` returned by the Liquidity Provider is less than ``minBuyAmount``.