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

Updated Releases + Fix Links (#77)

Browse Source 
* Updated releases

* fixed some typos and links in docs
This commit is contained in:
Greg Hysz 2020-12-08 10:44:59 -08:00 committed by GitHub
parent e5eee96487
commit 4ace79d947
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 39 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
docs/additional/releases.rst
View File

@ -8,31 +8,21 @@ Releases
This page outlines upcoming releases and expected changes. This page outlines upcoming releases and expected changes.
.. table:: .. table::
:widths: 20 60 10 10 :widths: 20 50 10 10 10
+--------------+---------------------------------------------------------------+----------------------+------------+ +--------------+---------------------------------------------------------------+----------------------+------------+---------------------------------------------------------------------------------------------------------------+
| **Release** | **Overview** | **Est Release Date** | **Status** | | **Release** | **Overview** | **Est Release Date** | **Status** | **Additional** |
+--------------+---------------------------------------------------------------+----------------------+------------+ +--------------+---------------------------------------------------------------+----------------------+------------+---------------------------------------------------------------------------------------------------------------+
| `Plop`_ | PLP VIP | 12/01/20 | Timelocked | | `Tinker`_ | `V4 Orders <../basics/orders.html>`_ | 01/05/21 | In Audits | |
+--------------+---------------------------------------------------------------+----------------------+------------+ +--------------+---------------------------------------------------------------+----------------------+------------+---------------------------------------------------------------------------------------------------------------+
| `Hot-Pants`_ | Remove calldata signing / DeFi Saver Fix / Allowance on Proxy | 12/07/20 | Testing | | `Hot-Pants`_ | Remove calldata signing / DeFi Saver Fix / Allowance on Proxy | 12/07/20 | Deployed | `Release Notes <https://github.com/0xProject/0x-migrations/blob/main/src/exchange-proxy/migrations/LOG.md>`__ |
+--------------+---------------------------------------------------------------+----------------------+------------+ +--------------+---------------------------------------------------------------+----------------------+------------+---------------------------------------------------------------------------------------------------------------+
| `Tinker`_ | V4 Orders | Early January 2021 | In Audits | | `Plop`_ | PLP VIP | 12/01/20 | Deployed | |
+--------------+---------------------------------------------------------------+----------------------+------------+ +--------------+---------------------------------------------------------------+----------------------+------------+---------------------------------------------------------------------------------------------------------------+
Plop
----
- Deploy the `LiquidityProviderFeature <../architecture/features.html>`_, which enables optimized trades directly with `PLP <../advanced/plp.html>`_
Hot-Pants Upcoming
---------- ========
- Removes calldata signing from ``TransformERC20`` Feature.
- Redeploying all `Transformers <../architecture/transformers.html>`_ (new interface w/o ``calldataHash``)
- Allowances can now be set on the `Proxy <../architecture/features/proxy.html>`_. See more on the `Allowances Page <../basics/allowances.html>`_. This involves redeploying the following `Features <../architecture/features.html>`_: ``MetaTransactionsFeature``, ``TransformERC20Feature``, ``UniswapFeature``.
Tinker Tinker
------ ------
@ -41,4 +31,21 @@ Tinker
- Deploy updated `FillQuoteTransformer <../architecture/transformers.html>`_, which can fill `V4 Orders <../basics/orders.html>`_. This transformer will no longer call Exchange V3. - Deploy updated `FillQuoteTransformer <../architecture/transformers.html>`_, which can fill `V4 Orders <../basics/orders.html>`_. This transformer will no longer call Exchange V3.
- Introduce `new events <../basics/events.html>`_. - Introduce `new events <../basics/events.html>`_.
- Decommission `SignatureValidationFeature <../architecture/features.html>`_. - Decommission `SignatureValidationFeature <../architecture/features.html>`_.
- Decommission `TokenSpenderFeature <../architecture/features.html>`_. - Decommission `TokenSpenderFeature <../architecture/features.html>`_.
Past
=====
Hot-Pants
----------
- Removes calldata signing from ``TransformERC20`` Feature.
- Redeploying all `Transformers <../architecture/transformers.html>`_ (new interface w/o ``calldataHash``)
- Allowances can now be set on the `Proxy <../architecture/features/proxy.html>`_. See more on the `Allowances Page <../basics/allowances.html>`_. This involves redeploying the following `Features <../architecture/features.html>`_: ``MetaTransactionsFeature``, ``TransformERC20Feature``, ``UniswapFeature``.
Plop
----
- Deploy the `LiquidityProviderFeature <../architecture/features.html>`_, which enables optimized trades directly with `PLP <../advanced/plp.html>`_

15
docs/basics/functions.rst
View File

@ -18,7 +18,7 @@ Below is a catalog of basic Exchange functionality. For more advanced usage, lik
| `cancelPairLimitOrders`_ | Cancels Limit orders in a specific market pair. | | `cancelPairLimitOrders`_ | Cancels Limit orders in a specific market pair. |
| | Ex: Cancel all Limit Orders selling WETH for USDC. | | | Ex: Cancel all Limit Orders selling WETH for USDC. |
+---------------------------------+--------------------------------------------------------------------------+ +---------------------------------+--------------------------------------------------------------------------+
| `batchCancelLimitPairOrders`_ | A batch call to `cancelLimitPairOrders`. | | `batchCancelPairLimitOrders`_ | A batch call to `cancelPairLimitOrders`. |
+---------------------------------+--------------------------------------------------------------------------+ +---------------------------------+--------------------------------------------------------------------------+
| `getLimitOrderInfo`_ | Returns the state of a given order. | | `getLimitOrderInfo`_ | Returns the state of a given order. |
+---------------------------------+--------------------------------------------------------------------------+ +---------------------------------+--------------------------------------------------------------------------+
@ -155,7 +155,7 @@ This function cancels all limit orders created by the caller with with a maker a
.. code-block:: solidity .. code-block:: solidity
function cancelPairRfqOrders( function cancelPairLimitOrders(
address makerToken, address makerToken,
address takerToken, address takerToken,
uint256 salt; uint256 salt;
@ -167,14 +167,14 @@ This function emits a `PairCancelledLimitOrders <../basics/events.html#paircance
- ``msg.sender != order.maker`` - ``msg.sender != order.maker``
- The ``salt`` parameter is ≤ to a previous ``salt``. - The ``salt`` parameter is ≤ to a previous ``salt``.
batchCancelLimitPairOrders batchCancelPairLimitOrders
-------------------------- --------------------------
This function performs multiple ``cancelLimitPairOrders()`` at once. Each respective index across arrays is equivalent to a single call. This function performs multiple ``cancelPairLimitOrders()`` at once. Each respective index across arrays is equivalent to a single call.
.. code-block:: solidity .. code-block:: solidity
function batchCancelLimitPairOrders( function batchCancelPairLimitOrders(
address[] makerTokens, address[] makerTokens,
address[] takerTokens, address[] takerTokens,
uint256[] salts; uint256[] salts;
@ -329,7 +329,7 @@ If the trade is successful a `RfqOrderFilled <../basics/events.html#rfqorderfill
- The market pair (Ex, ``WETH/USDT``) was cancelled (``order.salt`` is less than the value passed to ``cancelPairLimitOrders``. - The market pair (Ex, ``WETH/USDT``) was cancelled (``order.salt`` is less than the value passed to ``cancelPairLimitOrders``.
- Either the maker or taker has an insufficient allowance/balance. - Either the maker or taker has an insufficient allowance/balance.
- The order's ``taker`` field is non-zero and does not match the actual taker. This is ``msg.sender``, unless used with `meta-transactions <../advanced/mtx.rst>`_ in which case it is the signer. - The order's ``taker`` field is non-zero and does not match the actual taker. This is ``msg.sender``, unless used with `meta-transactions <../advanced/mtx.rst>`_ in which case it is the signer.
- The order's ``origin`` field is non-zero and does not match ``tx.origin`` or a valid origin (see `registerAllowedRfqOrigins <../basics/functions.html#id11>`_). - The order's ``origin`` field is non-zero and does not match ``tx.origin`` or a valid origin (see `registerAllowedRfqOrigins`_).
- The maker's signature is invalid. - The maker's signature is invalid.
fillOrKillRfqOrder fillOrKillRfqOrder
@ -526,9 +526,10 @@ The hash can be manually generated using the following code:
order.salt order.salt
)) ))
)); ));
registerAllowedRfqOrigins registerAllowedRfqOrigins
------------------------- --------------------------
The RFQ order includes a ``txOrigin`` field, which a maker can use to restrict which EOA's can submit the Ethereum transaction that fills their order. There are two ways a maker can use this field. The RFQ order includes a ``txOrigin`` field, which a maker can use to restrict which EOA's can submit the Ethereum transaction that fills their order. There are two ways a maker can use this field.

2
docs/basics/orders.rst
View File

@ -92,7 +92,7 @@ The ``RFQOrder`` struct has the following fields:
How To Sign How To Sign
============== ==============
Both Limit & RFQ orders must be signed by the `maker`. This signature is needed to fill an order, see `Basic Functionality <./functions.rst>`_. Both Limit & RFQ orders must be signed by the `maker`. This signature is needed to fill an order, see `Basic Functionality <./functions.html>`_.
The protocol accepts signatures defined by the following struct: The protocol accepts signatures defined by the following struct: