d7bc0b79df
* Update existing protocol docs to point to protocol-specific resources Remove documentation of outdated/irrelevant portions of the protocol * pin jinja version to try to fixbuild failure. (#711) --------- Co-authored-by: Eric Wong <ewong@Erics-MBP.fios-router.home>
84 lines
2.5 KiB
ReStructuredText
84 lines
2.5 KiB
ReStructuredText
0x Protocol
|
|
===========
|
|
|
|
0x Protocol is the trusted open source settlement layer for the permissionless global exchange of value.
|
|
|
|
This documentation is aimed to serve as the canonical technical documentation for 0x Protocol and the system of smart contracts that make up its full functionality. The structure of this documentation is as follows:
|
|
- Architectural Overview of the whole system of smart contracts that 0x Protocol is comprised of.
|
|
- Subsections will provide a deep dive into each contracts
|
|
- Tutorial and tools to get started building with/on top of 0x Protocol
|
|
|
|
To learn more about why 0x Protocol was created, read the whitepaper `here <https://github.com/0xProject/whitepaper/blob/master/0x_white_paper.pdf>`_ and at `0xProtocol.org <httpsL//0xProtocol.org>`_.
|
|
|
|
All code is open sourced on `GitHub <https://github.com/0xProject/protocol>`_.
|
|
|
|
Connect with the community on our `Forum <https://forum.0xProtocol.org/>`_, `Discord <https://discord.com/invite/official0x>`_, `Reddit <https://www.reddit.com/r/0xProject/>`_, and `Twitter <https://twitter.com/zeroexprotocol>`_.
|
|
|
|
|
|
.. image:: ./_static/img/logo.png
|
|
:width: 20%
|
|
:alt: 0x Protocol logo
|
|
:align: center
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Architecture
|
|
|
|
architecture/overview.rst
|
|
architecture/proxy.rst
|
|
architecture/features.rst
|
|
architecture/transformers.rst
|
|
architecture/flash_wallet.rst
|
|
architecture/governor.rst
|
|
architecture/transformer_deployer.rst
|
|
architecture/fee_collectors.rst
|
|
architecture/plp_sandbox.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Basics
|
|
|
|
basics/orders.rst
|
|
basics/functions.rst
|
|
basics/events.rst
|
|
basics/allowances.rst
|
|
basics/protocol_fees.rst
|
|
basics/addresses.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Advanced
|
|
|
|
advanced/mtx.rst
|
|
advanced/erc20_transformations.rst
|
|
advanced/plp.rst
|
|
advanced/uniswap.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Guide
|
|
|
|
guides/nft_guide.rst
|
|
guides/smart_nonce.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Additional Material
|
|
|
|
additional/audits.rst
|
|
additional/bounties.rst
|
|
additional/contributing.rst
|
|
additional/exceptional_erc20s.rst
|
|
additional/releases.rst
|
|
additional/emergency.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Connect
|
|
|
|
0x Protocol <https://0xProtocol.org>
|
|
GitHub <https://github.com/0xProject/protocol>
|
|
Forum <https://forum.0xProtocol.org/>
|
|
Reddit <https://www.reddit.com/r/0xProject/>
|
|
Discord <https://discord.com/invite/official0x>
|
|
Twitter <https://twitter.com/0xproject> |