adding contracts page

cl-tim · Dec 30, 2021 · fad8b4a · fad8b4a
1 parent 563b0a5
commit fad8b4a
Show file tree

Hide file tree

Showing 11 changed files with 123 additions and 57 deletions.
diff --git a/docs/source/chains.rst b/docs/source/chains.rst
@@ -0,0 +1,7 @@
+Chains
+=====
+
+.. autosummary::
+   :toctree: generated
+
+   lumache
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -2,9 +2,9 @@
 
 # -- Project information
 
-project = 'Lumache'
-copyright = '2021, Graziella'
-author = 'Graziella'
+project = 'Signata'
+copyright = '2021, Congruent Labs'
+author = 'Congruent Labs'
 
 release = '0.1'
 version = '0.1.0'

diff --git a/docs/source/contracts.rst b/docs/source/contracts.rst
@@ -0,0 +1,81 @@
+Contracts
+=========
+
+.. autosummary::
+   :toctree: generated
+
+Ethereum
+--------
+
++-------------------+------------------------------------------------+
+|                   | Address                                        |
++===================+================================================+
+| SATA Token        | ``0x3ebb4A4e91Ad83BE51F8d596533818b246F4bEe1`` |
++-------------------+------------------------------------------------+
+| SignataIdentity   | ``0x6B47e26A52a9B5B467b98142E382c081eA97B0fc`` |
++-------------------+------------------------------------------------+
+| SignataRight      | ``0x7c8890a02abd24ff00c4eb1425258ea4b611d300`` |
++-------------------+------------------------------------------------+
+| Veriswap          | ``TBC``                                        |
++-------------------+------------------------------------------------+
+| Deployer          | ``0x042fc4ea3f836e1ea5dc4fb70ec90ded51c09eca`` |
++-------------------+------------------------------------------------+
+| Token Vault       | ``0xc77aab3c6d7dab46248f3cc3033c856171878bd5`` |
++-------------------+------------------------------------------------+
+
+Binance Smart Chain
+-------------------
+
++-------------------+------------------------------------------------+
+|                   | Address                                        |
++===================+================================================+
+| SATA Token        | ``0x6b1C8765C7EFf0b60706b0ae489EB9bb9667465A`` |
++-------------------+------------------------------------------------+
+| SignataIdentity   | ``0x2EE533c160eB0488f2Db54DA4523b110E66a96Ff`` |
++-------------------+------------------------------------------------+
+| SignataRight      | ``0x55E9B159FF6E6cD9188Cc4394db3EC944d467B0d`` |
++-------------------+------------------------------------------------+
+| Veriswap          | ``TBC``                                        |
++-------------------+------------------------------------------------+
+| Deployer          | ``0xEAD57fE351280E7D905a5E21e9fd7d5bb0Ec97e7`` |
++-------------------+------------------------------------------------+
+| Liquidity Vault   | ``0x50e63fe25e8cf75c948a1ba26021ea0883cdc5b3`` |
++-------------------+------------------------------------------------+
+
+Avalanche C-Chain
+-------------------
+
++-------------------+------------------------------------------------+
+|                   | Address                                        |
++===================+================================================+
+| SATA Token        | ``TBC``                                        |
++-------------------+------------------------------------------------+
+| SignataIdentity   | ``TBC``                                        |
++-------------------+------------------------------------------------+
+| SignataRight      | ``TBC``                                        |
++-------------------+------------------------------------------------+
+| Veriswap          | ``TBC``                                        |
++-------------------+------------------------------------------------+
+| Deployer          | ``TBC``                                        |
++-------------------+------------------------------------------------+
+| Liquidity Vault   | ``TBC``                                        |
++-------------------+------------------------------------------------+
+
+LGCY Network
+-------------------
+
++-------------------+------------------------------------------------+
+|                   | Address                                        |
++===================+================================================+
+| SATA Token        | ``TBC``                                        |
++-------------------+------------------------------------------------+
+| SignataIdentity   | ``TBC``                                        |
++-------------------+------------------------------------------------+
+| SignataRight      | ``TBC``                                        |
++-------------------+------------------------------------------------+
+| Veriswap          | ``TBC``                                        |
++-------------------+------------------------------------------------+
+| Deployer          | ``TBC``                                        |
++-------------------+------------------------------------------------+
+| Liquidity Vault   | ``TBC``                                        |
++-------------------+------------------------------------------------+
diff --git a/docs/source/api.rst → docs/source/dao.rst b/docs/source/api.rst → docs/source/dao.rst
@@ -1,5 +1,5 @@
-API
-===
+DAO
+=====
 
 .. autosummary::
    :toctree: generated

diff --git a/docs/source/identity.rst b/docs/source/identity.rst
@@ -0,0 +1,7 @@
+Identity
+=====
+
+.. autosummary::
+   :toctree: generated
+
+   lumache
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -7,15 +7,15 @@ This documentation will provide
 
 See :doc:`contracts` for smart contract addresses.
 
-See :ref:`identity` for details on how identity lifecycle is managed.
+See :doc:`identity` for details on how identity lifecycle is managed on the chain.
 
-See :ref:`integrations` for implementation details on integrations with the Signata platform.
+See :doc:`integrations` for implementation details on integrations with the Signata platform.
 
-See :ref:`DAO` for details on governance for the project.
+See :doc:`dao` for details on governance for the project.
 
-See :ref:`chains` for implementation-specific differences between blockchains that Signata is deployed on.
+See :doc:`chains` for implementation-specific differences between blockchains that Signata is deployed on.
 
-See :ref:`risk` for information on the Risk Oracle solution.
+See :doc:`risk` for information on the Risk Oracle solution.
 
 .. note::
 
@@ -26,9 +26,9 @@ Contents
 
 .. toctree::
 
+   chains
    contracts
+   dao
    identity
    integrations
-   DAO
-   chains
    risk
diff --git a/docs/source/integrations.rst b/docs/source/integrations.rst
@@ -0,0 +1,7 @@
+Integrations
+=====
+
+.. autosummary::
+   :toctree: generated
+
+   lumache
diff --git a/docs/source/risk.rst b/docs/source/risk.rst
@@ -0,0 +1,7 @@
+Risk
+=====
+
+.. autosummary::
+   :toctree: generated
+
+   lumache
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -12,23 +12,3 @@ To use Lumache, first install it using pip:
 
    (.venv) $ pip install lumache
 
-Creating recipes
-----------------
-
-To retrieve a list of random ingredients,
-you can use the ``lumache.get_random_ingredients()`` function:
-
-.. autofunction:: lumache.get_random_ingredients
-
-The ``kind`` parameter should be either ``"meat"``, ``"fish"``,
-or ``"veggies"``. Otherwise, :py:func:`lumache.get_random_ingredients`
-will raise an exception.
-
-.. autoexception:: lumache.InvalidKindError
-
-For example:
-
->>> import lumache
->>> lumache.get_random_ingredients()
-['shells', 'gorgonzola', 'parsley']
-
diff --git a/lumache.py b/lumache.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -3,6 +3,6 @@ requires = ["flit_core >=3.2,<4"]
 build-backend = "flit_core.buildapi"
 
 [project]
-name = "lumache"
-authors = [{name = "Graziella", email = "graziella@lumache"}]
+name = "signata-docs"
+authors = [{name = "Congruent Labs", email = "sales@congruentlabs.co"}]
 dynamic = ["version", "description"]