Cookbook for v1

.pre-commit-config.yaml

@@ -15,6 +15,7 @@ repos:
     hooks:
       - id: isort
         name: isort (python)
+        args: ["--profile", "black", "--filter-files"]
   - repo: https://github.com/PyCQA/flake8
     rev: 7.1.1
     hooks:

README.md

@@ -72,7 +72,7 @@ coverage html
 
 Each time a new module/submodule is added it needs to be added to the docs, as well. To do so `cd` in the root directory then run the following command:
 ```bash
-sphinx-apidoc -f -o docs/ multiversx_sdk/ *_test.py *constants.py
+sphinx-apidoc -f -o docs/ multiversx_sdk/ '*_test.py' '*constants.py'
 ```
 
 This command will regenerate the `.rst` files for each module, excluding the tests and the `constants.py` files.

docs/multiversx_sdk.account_management.rst

@@ -0,0 +1,29 @@
+multiversx\_sdk.account\_management package
+===========================================
+
+Submodules
+----------
+
+multiversx\_sdk.account\_management.account\_controller module
+--------------------------------------------------------------
+
+.. automodule:: multiversx_sdk.account_management.account_controller
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+multiversx\_sdk.account\_management.account\_transactions\_factory module
+-------------------------------------------------------------------------
+
+.. automodule:: multiversx_sdk.account_management.account_transactions_factory
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: multiversx_sdk.account_management
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/multiversx_sdk.accounts.rst

@@ -0,0 +1,21 @@
+multiversx\_sdk.accounts package
+================================
+
+Submodules
+----------
+
+multiversx\_sdk.accounts.account module
+---------------------------------------
+
+.. automodule:: multiversx_sdk.accounts.account
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: multiversx_sdk.accounts
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/multiversx_sdk.builders.rst

@@ -0,0 +1,29 @@
+multiversx\_sdk.builders package
+================================
+
+Submodules
+----------
+
+multiversx\_sdk.builders.token\_transfers\_data\_builder module
+---------------------------------------------------------------
+
+.. automodule:: multiversx_sdk.builders.token_transfers_data_builder
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+multiversx\_sdk.builders.transaction\_builder module
+----------------------------------------------------
+
+.. automodule:: multiversx_sdk.builders.transaction_builder
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: multiversx_sdk.builders
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/multiversx_sdk.controllers.rst

@@ -0,0 +1,69 @@
+multiversx\_sdk.controllers package
+===================================
+
+Submodules
+----------
+
+multiversx\_sdk.controllers.account\_controller module
+------------------------------------------------------
+
+.. automodule:: multiversx_sdk.controllers.account_controller
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+multiversx\_sdk.controllers.delegation\_controller module
+---------------------------------------------------------
+
+.. automodule:: multiversx_sdk.controllers.delegation_controller
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+multiversx\_sdk.controllers.interfaces module
+---------------------------------------------
+
+.. automodule:: multiversx_sdk.controllers.interfaces
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+multiversx\_sdk.controllers.relayed\_controller module
+------------------------------------------------------
+
+.. automodule:: multiversx_sdk.controllers.relayed_controller
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+multiversx\_sdk.controllers.smart\_contract\_controller module
+--------------------------------------------------------------
+
+.. automodule:: multiversx_sdk.controllers.smart_contract_controller
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+multiversx\_sdk.controllers.token\_management\_controller module
+----------------------------------------------------------------
+
+.. automodule:: multiversx_sdk.controllers.token_management_controller
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+multiversx\_sdk.controllers.transfers\_controller module
+--------------------------------------------------------
+
+.. automodule:: multiversx_sdk.controllers.transfers_controller
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: multiversx_sdk.controllers
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/multiversx_sdk.core.rst

@@ -8,22 +8,10 @@ Subpackages
    :maxdepth: 4
 
    multiversx_sdk.core.proto
-   multiversx_sdk.core.transaction_builders
-   multiversx_sdk.core.transaction_parsers
-   multiversx_sdk.core.transactions_factories
-   multiversx_sdk.core.transactions_outcome_parsers
 
 Submodules
 ----------
 
-multiversx\_sdk.core.account module
------------------------------------
-
-.. automodule:: multiversx_sdk.core.account
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 multiversx\_sdk.core.address module
 -----------------------------------
 
@@ -48,14 +36,6 @@ multiversx\_sdk.core.code\_metadata module
    :undoc-members:
    :show-inheritance:
 
-multiversx\_sdk.core.codec module
----------------------------------
-
-.. automodule:: multiversx_sdk.core.codec
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 multiversx\_sdk.core.config module
 ----------------------------------
 
@@ -64,22 +44,6 @@ multiversx\_sdk.core.config module
    :undoc-members:
    :show-inheritance:
 
-multiversx\_sdk.core.contract\_query module
--------------------------------------------
-
-.. automodule:: multiversx_sdk.core.contract_query
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-multiversx\_sdk.core.contract\_query\_builder module
-----------------------------------------------------
-
-.. automodule:: multiversx_sdk.core.contract_query_builder
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 multiversx\_sdk.core.errors module
 ----------------------------------
 
@@ -104,74 +68,58 @@ multiversx\_sdk.core.message module
    :undoc-members:
    :show-inheritance:
 
-multiversx\_sdk.core.serializer module
---------------------------------------
-
-.. automodule:: multiversx_sdk.core.serializer
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-multiversx\_sdk.core.smart\_contract\_queries\_controller module
-----------------------------------------------------------------
-
-.. automodule:: multiversx_sdk.core.smart_contract_queries_controller
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-multiversx\_sdk.core.smart\_contract\_query module
---------------------------------------------------
+multiversx\_sdk.core.tokens module
+----------------------------------
 
-.. automodule:: multiversx_sdk.core.smart_contract_query
+.. automodule:: multiversx_sdk.core.tokens
    :members:
    :undoc-members:
    :show-inheritance:
 
-multiversx\_sdk.core.token\_payment module
-------------------------------------------
+multiversx\_sdk.core.transaction module
+---------------------------------------
 
-.. automodule:: multiversx_sdk.core.token_payment
+.. automodule:: multiversx_sdk.core.transaction
    :members:
    :undoc-members:
    :show-inheritance:
 
-multiversx\_sdk.core.tokens module
-----------------------------------
+multiversx\_sdk.core.transaction\_computer module
+-------------------------------------------------
 
-.. automodule:: multiversx_sdk.core.tokens
+.. automodule:: multiversx_sdk.core.transaction_computer
    :members:
    :undoc-members:
    :show-inheritance:
 
-multiversx\_sdk.core.transaction module
----------------------------------------
+multiversx\_sdk.core.transaction\_events\_parser module
+-------------------------------------------------------
 
-.. automodule:: multiversx_sdk.core.transaction
+.. automodule:: multiversx_sdk.core.transaction_events_parser
    :members:
    :undoc-members:
    :show-inheritance:
 
-multiversx\_sdk.core.transaction\_computer module
--------------------------------------------------
+multiversx\_sdk.core.transaction\_on\_network module
+----------------------------------------------------
 
-.. automodule:: multiversx_sdk.core.transaction_computer
+.. automodule:: multiversx_sdk.core.transaction_on_network
    :members:
    :undoc-members:
    :show-inheritance:
 
-multiversx\_sdk.core.transaction\_payload module
-------------------------------------------------
+multiversx\_sdk.core.transaction\_status module
+-----------------------------------------------
 
-.. automodule:: multiversx_sdk.core.transaction_payload
+.. automodule:: multiversx_sdk.core.transaction_status
    :members:
    :undoc-members:
    :show-inheritance:
 
-multiversx\_sdk.core.typecheck module
--------------------------------------
+multiversx\_sdk.core.transactions\_factory\_config module
+---------------------------------------------------------
 
-.. automodule:: multiversx_sdk.core.typecheck
+.. automodule:: multiversx_sdk.core.transactions_factory_config
    :members:
    :undoc-members:
    :show-inheritance:

docs/multiversx_sdk.core.transactions_outcome_parsers.rst

@@ -20,14 +20,6 @@ multiversx\_sdk.core.transactions\_outcome\_parsers.delegation\_transactions\_ou
    :undoc-members:
    :show-inheritance:
 
-multiversx\_sdk.core.transactions\_outcome\_parsers.resources module
---------------------------------------------------------------------
-
-.. automodule:: multiversx_sdk.core.transactions_outcome_parsers.resources
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 multiversx\_sdk.core.transactions\_outcome\_parsers.smart\_contract\_transactions\_outcome\_parser module
 ---------------------------------------------------------------------------------------------------------
 

docs/multiversx_sdk.delegation.rst

@@ -0,0 +1,53 @@
+multiversx\_sdk.delegation package
+==================================
+
+Submodules
+----------
+
+multiversx\_sdk.delegation.delegation\_controller module
+--------------------------------------------------------
+
+.. automodule:: multiversx_sdk.delegation.delegation_controller
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+multiversx\_sdk.delegation.delegation\_transactions\_factory module
+-------------------------------------------------------------------
+
+.. automodule:: multiversx_sdk.delegation.delegation_transactions_factory
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+multiversx\_sdk.delegation.delegation\_transactions\_outcome\_parser module
+---------------------------------------------------------------------------
+
+.. automodule:: multiversx_sdk.delegation.delegation_transactions_outcome_parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+multiversx\_sdk.delegation.delegation\_transactions\_outcome\_parser\_types module
+----------------------------------------------------------------------------------
+
+.. automodule:: multiversx_sdk.delegation.delegation_transactions_outcome_parser_types
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+multiversx\_sdk.delegation.errors module
+----------------------------------------
+
+.. automodule:: multiversx_sdk.delegation.errors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: multiversx_sdk.delegation
+   :members:
+   :undoc-members:
+   :show-inheritance: