diff --git a/docs/_drawio/plp_sandbox.drawio b/docs/_drawio/plp_sandbox.drawio index bface5dc87..d3d372c98f 100644 --- a/docs/_drawio/plp_sandbox.drawio +++ b/docs/_drawio/plp_sandbox.drawio @@ -1 +1 @@ -3Vhbc6IwFP41PLYDhCh9rJfuPtgZZ+1028cIATIicUOs2F+/CYS7KO1qL6sP5nxJDsm5fOeIBsbr5AdDm+CeujjUTN1NNDDRTNMwLCB+JLLPEd3IEJ8RN8P0EliQV6wW5uiWuDhWWAZxSkNONnXQoVGEHV7DEGN0V1/m0dCtARvk4xawcFDYRn8TlwcZakO9xH9i4ge8uJ+aWSJn5TO6jdTzNBN4jvxm02uU61Lr4wC5dFeBwFQDY0Ypz0brZIxDady62e46ZotzMxzxPhvch8enRyMk+iy5u4X+L/95NbxSWl5QuFX2mJE/wiOE7+eMvgjXsDuM+JZhdQm+zw2XXh1L5boGRruAcLzYIEfO7kSsCCzg61BIhhh6JAzHNKQs3QtchG1hKDCKOaMrXJkZODZeemJGHQwzjpPOGxuFHUWAYrrGnO3FknzDQJlexSbIXbErHV2sCSpOvlEYUrHlF6pL+4qBMvEbzG22zN0yK47cWxnWQnJCFMfEqVtS3J3tn5TVU+FZCtcmzOVJUp2d7JXkojhI3WUoYY44xyxKEVM3Cptjt5UxDYuLFEXMx/zITcFhz1QsDw8YPscYDhEnL/VjHPKGesKcEnHAwvGFo3PHWw2HxnTLHKx2VXOmoWigNxWBuqLMDi1FaXAU135/vFiteDGuhfzAUBR7mMkhWmW/Io2iuB1NwpcztBSkXQsiFBJfOt4RfhXbwUjmGRGkeKsm1sR1pY4RwzF5RctUn4yijbxqenk40uDkWKIqxlabSyKshlN3lnRm9ZV+behDs+YX4yxhY8Ca0qubugLqeTG+iJtBy83z2VwABReLcU7HZ+VhD8rvQR5OP3IHjXgFzz7n4eeB9U5+ti/Fz/B/LodWg8wK+dPMPThDOUwIf6qMs2I4hEosa6EU8lIoWXGhnkEZD6hPIxROS3RU92b/upgVltMN18n6CT+zfjYjBTYjoG/9tGBDEWgo6qifwuVoX1mmqk53wW92erZ99FzN9ZZV653FIDvBWVl++O/R3qOH6+oPh6f6w8OZ9GUTCfZMpE9tRL9dIsHjiXGyQX7remB/QOLZrcQzZRc9TbCz5Tjrp912Rf/qvfOJam83LD0c9I7evKtuxNjlGuCbD6bGa1glR+MUM55kuZw7S74s9HZy58WYEfRkxo74+RhmHJqHiePLMmPzwBAeZzrTOrr+MkyXZ2yT6iovDO6/9wuDt5EebEZVj78uQixfymaOKV99g+lf \ No newline at end of file +1Vhbc6IwFP41zOw+1AFClD7WS7sP7YyzdrrtY4QAGZG4IVbsr98Ewl3UdrW1+mDOl+SEnMt3jmhgtEzuGFoFD9TFoWbqbqKBsWaahmEB8SORbYbYOeAz4maQXgIz8obVzhxdExfHCssgTmnIyaoOOjSKsMNrGGKMburLPBq6NWCFfNwCZg4K2+gf4vJA3QLqJf4LEz/ITzZ0NTNHzsJndB2p8zQTeI78ZtNLlOtS6+MAuXRTgcBEAyNGKc9Gy2SEQ2nbutluO2aL52Y44sdscB+fnp+MkOj3ye0N9H/7L4vBldLyisK1ssc9+Ss8Qvh2yuircA27xYivGdbMfijOGc6ZGPly9GN6P/2p7sa3uT1Ti2B5pi7WbALC8WyFHDm7EREksIAvQyEZYuiRMBzRkLJ0L3ARtoX9wDDmjC5wZabv2HjuiZn2rfMrYMZxUoGUFe4wXWLOtmJJPttXHlERC3IPbUr/F2uCiu+vFYZUyPmF6tLsYqAs/w4vmC0vtMyKI/dGRruQnBDFMXHqlhTmYNtnZfVUeJFCz4S5PE6qs+OtklwUB6m7DCVMEeeYRSli6sY+m3PEfMz3XExRAXZrOdj2TMXycIfhc4zhEHHyWs/cXd5QJ0wpEU9cOL5wdO54q+HQmK6Zg9Wuaio1FPX1piJQV5QZpqUoDY7i2h+PF6sVL0ZPyI8MRbGHmRyiRfYr0iiK29EkHHKP5oLKa0GEQuJLxzvC0WI7GMqkIoIrb9TEkriu1DFkOCZvaJ7qk1G0kldNLw+HGhzvDJq9od/M3oLw1SE10tyV1Vd6z9AHZs0vxknCxoA1pVfXdQXU82J8FjeDbnIWcM7PJ2VgD8rvTgZOP3IHjXgFzz6nYea+9UFmts/FzPBwfZyhyJ3T5BsWQqtBY4X8Zebun6AQJoQ/V8ZZGRxAJZZVUAp5EZR8OFNnUMYD6tMIhZMSHda92Wn8rIIcbrgOVk54UZWzGSmwGQHHVk4LNhSBhqKOyilcjraVZaredJf6Zo9n23ufq7nesmrNtBhkT3BSfh/8f7Qf0b11dYaDQ53h7ky6lESCRybSZbWg3y6R4P7EONgav3c9sD8h8exW4pmyf54k2FlznHXSLm4n41d0zV1V/d0NsmU3LD3oHx29eT/diLHztb7Xn0yNPVglR+MQMx5kuZw7S74s9HZy56mYERzJjMZFMePA3E0cF8uMzQeGcD/Tmdbe9edhujxjm1RXeVXwcIGvCs5GerAZVUf8dRFi+ZY2c0z5KhxM/gE= \ No newline at end of file diff --git a/docs/_static/img/plp_sandbox.png b/docs/_static/img/plp_sandbox.png index bbff0250b6..12a62144b2 100644 Binary files a/docs/_static/img/plp_sandbox.png and b/docs/_static/img/plp_sandbox.png differ diff --git a/docs/additional/releases.rst b/docs/additional/releases.rst index b675ffc979..ae6be2542f 100644 --- a/docs/additional/releases.rst +++ b/docs/additional/releases.rst @@ -17,7 +17,7 @@ This page outlines upcoming releases and expected changes. Tinker (Official V4 Release) ---------------------------- -- Upgrade that transfer user funds to use allowances on the Proxy contract. Transfers will still fallback to the Allowance Target, but integrators will get reduced transaction costs from setting their allowance on the Proxy.. See more on the `Allowances Page <../basics/allowances.html>`_. +- Upgrade any features that transfer user funds to use allowances on the Proxy contract. Transfers will still fallback to the Allowance Target, but integrators will get reduced transaction costs from setting their allowance on the Proxy.. See more on the `Allowances Page <../basics/allowances.html>`_. - Deploy `LiquidityProviderFeature <../architecture/features.html>`_. - Deploy `NativeLiquidityFeature <../architecture/features.html>`_. - Deploy updated `FillQuoteTransformer <../architecture/transformers.html>`_, which can fill `V4 Orders <../basics/orders.html>`_. This transformer will no longer call Exchange V3. diff --git a/docs/architecture/plp_sandbox.rst b/docs/architecture/plp_sandbox.rst index fe3da899fb..6258989495 100644 --- a/docs/architecture/plp_sandbox.rst +++ b/docs/architecture/plp_sandbox.rst @@ -2,7 +2,7 @@ PLP Sandbox ############################### -`PLP <../advanced/plp.html>`_ are external, closed-source contracts that provide liquidity to the 0x Protocol. We want to limit the contracts called from the context of the `Proxy <./proxy.html>` contract because this contract has access to user funds. We must mitigate the attack vector where an ERC20 Token (or some other trusted contract) is passed in place of a legitimate PLP liquidity provider. We do this by routing trades through the PLP Sandbox. +`PLP <../advanced/plp.html>`_ are external, closed-source contracts that provide liquidity to the 0x Protocol. We want to limit the contracts called from the context of the `Proxy <./proxy.html>`_ contract because this contract has access to user funds. We must mitigate the attack vector where an ERC20 Token (or some other trusted contract) is passed in place of a legitimate PLP liquidity provider. We do this by routing trades through the PLP Sandbox. The diagram below illustrates this workflow. diff --git a/docs/architecture/transformer_deployer.rst b/docs/architecture/transformer_deployer.rst index dc6b006b76..58123c02cc 100644 --- a/docs/architecture/transformer_deployer.rst +++ b/docs/architecture/transformer_deployer.rst @@ -25,13 +25,13 @@ The deployer implements two functions: ``deploy()`` and ``kill()``. The former i public onlyAuthorized; -View the code for the Transformer Deployer `here `_. +View the code for the Transformer Deployer `here `__. Permissionless Transfomer Deployer =================================== -A permissionless deployer has been developed and can be seen `here `_. This serves a similar function to the current delployer, only it is capable of validating the Transformer's bytecode before deploying. It does this by tracing the bytecode in search of reachable opcodes that could post a threat to the Flash Wallet. +A permissionless deployer has been developed and can be seen `here `__. This serves a similar function to the current delployer, only it is capable of validating the Transformer's bytecode before deploying. It does this by tracing the bytecode in search of reachable opcodes that could post a threat to the Flash Wallet. The ``isDelegateCallSafe`` function performs this check. It will return ``false`` if any of the following opcodes are reachable: ``callcode``, ``delegatecall``, ``selfdestruct``, ``create``, ``create2``, ``sload``, ``sstore``. @@ -61,4 +61,4 @@ Note that there is no ``kill`` function in this deployer. View the code for the Permissionless Transformer Deployer `here `_. -There is some overhead to switching over to this deployer, as the ``Flash Wallet <./flash_wallet.html>``_ would need to be redeployed and some integrators would need to update their code. Therefore, this will be put into production once there is community-demand for permissionless transformers. Reach out to us on `Discord `_ if you'd like to deploy a Transformer! \ No newline at end of file +There is some overhead to switching over to this deployer, as the `Flash Wallet <./flash_wallet.html>`_ would need to be redeployed and some integrators would need to update their code. Therefore, this will be put into production once there is community-demand for permissionless transformers. Reach out to us on `Discord `_ if you'd like to deploy a Transformer! \ No newline at end of file diff --git a/docs/basics/functions.rst b/docs/basics/functions.rst index a3a2374603..5626e29586 100644 --- a/docs/basics/functions.rst +++ b/docs/basics/functions.rst @@ -56,7 +56,7 @@ Below is a catalog of basic Exchange functionality. For more advanced usage, lik Limit Orders ============ -These are the basic functions for using a `Limit Order <../basics/orders.html#limit-orders>`_. +These are the basic functions for using a `Limit Order <../basics/orders.html#limit-orders>`__. fillLimitOrder -------------- @@ -552,7 +552,7 @@ This function emits a `RfqOrderOriginsAllowed <../basics/events.html#rfqorderori Protocol Fees ============= -There is a fixed protocol fee paid by the Taker each time they fill a `Limit Order `_. Learn more in the `Protocol Fees Section <./protocol_fees.html>`_. Also check out our research in the `Tokenomics Section <../tokenomics/research.html>`_. +There is a fixed protocol fee paid by the Taker each time they fill a `Limit Order `__. Learn more in the `Protocol Fees Section <./protocol_fees.html>`_. Also check out our research in the `Tokenomics Section <../tokenomics/research.html>`_. getProtocolFeeMultiplier ------------------------