Update docs

Author: cffls

docs/requirements.txt

@@ -1,23 +1,28 @@
 alabaster==0.7.12; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
-atomicwrites==1.4.0; python_version >= "3.7" and python_full_version < "3.0.0" and sys_platform == "win32" or sys_platform == "win32" and python_version >= "3.7" and python_full_version >= "3.4.0"
+asn1crypto==1.5.1; python_version >= "3.6"
+atomicwrites==1.4.1; python_version >= "3.7" and python_full_version < "3.0.0" and sys_platform == "win32" or sys_platform == "win32" and python_version >= "3.7" and python_full_version >= "3.4.0"
 attrs==21.4.0; python_version >= "3.7" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" and python_version >= "3.7"
-babel==2.10.1; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
-black==22.3.0; python_full_version >= "3.6.2"
-blockfrost-python==0.4.4; python_version >= "3.7" and python_version < "4"
+babel==2.10.3; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
+black==22.6.0; python_full_version >= "3.6.2"
+blockfrost-python==0.5.1; python_version >= "3.7" and python_version < "4"
 cbor2==5.4.3; python_version >= "3.7"
-certifi==2022.5.18.1; python_version >= "3.7" and python_full_version < "3.0.0" and python_version < "4" or python_version >= "3.7" and python_version < "4" and python_full_version >= "3.6.0"
-cffi==1.15.0; python_version >= "3.6"
-charset-normalizer==2.0.12; python_version >= "3.7" and python_version < "4" and python_full_version >= "3.6.0"
+certifi==2022.6.15; python_version >= "3.7" and python_version < "4"
+certvalidator==0.11.1; python_version >= "3.6"
+cffi==1.15.1; python_version >= "3.6"
+charset-normalizer==2.1.0; python_version >= "3.7" and python_version < "4" and python_full_version >= "3.6.0"
 click==8.1.3; python_version >= "3.7" and python_full_version >= "3.6.2"
-colorama==0.4.4; sys_platform == "win32" and python_version >= "3.7" and python_full_version >= "3.6.2" and (python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6") and platform_system == "Windows"
-coverage==6.4.1; python_version >= "3.7"
+colorama==0.4.5; sys_platform == "win32" and python_version >= "3.7" and python_full_version >= "3.6.2" and (python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6") and platform_system == "Windows"
+cose==0.9.dev8; python_version >= "3.6"
+coverage==6.4.2; python_version >= "3.7"
+cryptography==37.0.4; python_version >= "3.6"
 decorator==5.1.1; python_version >= "3.5"
 docutils==0.17.1; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" and python_version >= "3.6"
+ecdsa==0.18.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.3.0" and python_version >= "3.6"
 execnet==1.9.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" and python_version >= "3.6"
 flake8==4.0.1; python_version >= "3.6"
-flask==2.1.2; python_version >= "3.7"
-idna==3.3; python_version >= "3.7" and python_full_version < "3.0.0" and python_version < "4" or python_version >= "3.7" and python_version < "4" and python_full_version >= "3.6.0"
-imagesize==1.3.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
+flask==2.1.3; python_version >= "3.7"
+idna==3.3; python_version >= "3.7" and python_version < "4"
+imagesize==1.4.1; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
 importlib-metadata==4.2.0; python_version < "3.8" and python_version >= "3.7" and python_full_version >= "3.6.2"
 iniconfig==1.1.1; python_version >= "3.7"
 isort==5.10.1; python_full_version >= "3.6.1" and python_version < "4.0"
@@ -26,10 +31,12 @@ jinja2==3.1.2; python_version >= "3.7" and python_full_version < "3.0.0" or pyth
 markupsafe==2.1.1; python_version >= "3.7"
 mccabe==0.6.1; python_version >= "3.6"
 mypy-extensions==0.4.3; python_full_version >= "3.6.2"
+oscrypto==1.3.0; python_version >= "3.6"
 packaging==21.3; python_version >= "3.7" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.7"
 pathspec==0.9.0; python_full_version >= "3.6.2"
 platformdirs==2.5.2; python_version >= "3.7" and python_full_version >= "3.6.2"
 pluggy==1.0.0; python_version >= "3.7"
+pprintpp==0.4.0
 py==1.11.0; python_version >= "3.7" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" and python_version >= "3.7"
 pycodestyle==2.8.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" and python_version >= "3.6"
 pycparser==2.21; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
@@ -42,8 +49,9 @@ pytest-forked==1.4.0; python_version >= "3.6"
 pytest-xdist==2.5.0; python_version >= "3.6"
 pytest==7.1.2; python_version >= "3.7"
 pytz==2022.1; python_version >= "3.6"
-requests==2.27.1; python_version >= "3.7" and python_full_version < "3.0.0" and python_version < "4" or python_version >= "3.7" and python_version < "4" and python_full_version >= "3.6.0"
+requests==2.28.1; python_version >= "3.7" and python_version < "4" and (python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6")
 retry==0.9.2
+six==1.16.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.3.0" and python_version >= "3.6"
 snowballstemmer==2.2.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
 sphinx-copybutton==0.5.0; python_version >= "3.6"
 sphinx-rtd-theme==1.0.0; (python_version >= "2.7" and python_full_version < "3.0.0") or (python_full_version >= "3.4.0")
@@ -54,11 +62,11 @@ sphinxcontrib-htmlhelp==2.0.0; python_version >= "3.6" and python_full_version <
 sphinxcontrib-jsmath==1.0.1; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
 sphinxcontrib-qthelp==1.0.3; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
 sphinxcontrib-serializinghtml==1.1.5; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
-tomli==2.0.1; python_version < "3.11" and python_full_version >= "3.6.2" and python_version >= "3.7"
-typed-ast==1.5.3; python_version < "3.8" and implementation_name == "cpython" and python_full_version >= "3.6.2" and python_version >= "3.6"
+tomli==2.0.1; python_full_version <= "3.11.0a6" and python_full_version >= "3.6.2" and python_version >= "3.7"
+typed-ast==1.5.4; python_version < "3.8" and implementation_name == "cpython" and python_full_version >= "3.6.2" and python_version >= "3.6"
 typeguard==2.13.3; python_full_version >= "3.5.3"
-typing-extensions==4.2.0; python_version < "3.8" and python_full_version >= "3.6.2" and python_version >= "3.7"
-urllib3==1.26.9; python_version >= "3.7" and python_full_version < "3.0.0" and python_version < "4" or python_full_version >= "3.6.0" and python_version < "4" and python_version >= "3.7"
-websocket-client==1.3.2; python_version >= "3.7"
-werkzeug==2.1.2; python_version >= "3.7"
-zipp==3.8.0; python_version < "3.8" and python_version >= "3.7"
+typing-extensions==4.3.0; python_version < "3.8" and python_full_version >= "3.6.2" and python_version >= "3.7"
+urllib3==1.26.10; python_version >= "3.7" and python_full_version < "3.0.0" and python_version < "4" or python_full_version >= "3.6.0" and python_version < "4" and python_version >= "3.7"
+websocket-client==1.3.3; python_version >= "3.7"
+werkzeug==2.2.0; python_version >= "3.7"
+zipp==3.8.1; python_version < "3.8" and python_version >= "3.7"

docs/source/api/pycardano.cip.rst

@@ -0,0 +1,7 @@
+CIP
+=====================
+
+.. automodule:: pycardano.cip.cip8
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/index.rst

@@ -34,6 +34,7 @@ making it a light-weight library that is easy and fast to set up in all kinds of
    api/pycardano.address
    api/pycardano.backend.base
    api/pycardano.certificate
+   api/pycardano.cip
    api/pycardano.coinselection
    api/pycardano.exception
    api/pycardano.hash

pycardano/__init__.py

@@ -3,6 +3,7 @@
 from .address import *
 from .backend import *
 from .certificate import *
+from .cip import *
 from .coinselection import *
 from .exception import *
 from .hash import *

pycardano/cip/__init__.py

@@ -0,0 +1,3 @@
+# flake8: noqa
+
+from .cip8 import *

pycardano/cip/cip8.py

@@ -18,22 +18,26 @@
 )
 from pycardano.network import Network
 
+__all__ = ["sign", "verify"]
+
 
 def sign(
     message: str,
     signing_key: SigningKey,
     attach_cose_key: bool = False,
     network: Network = Network.MAINNET,
 ) -> Union[str, dict]:
-    """
-    Sign an arbitrary message with a payment key following CIP-0008.
-        Parameters:
-            message (str): Message to be signed
-            signing_key (pycardano.key.SigningKey): Key which is used to sign the message
-            attach_cose_key (bool): Whether or not to attach the Cose key to the output
-        Returns:
-            signed_message (str, dict): a hex-encoded string containing the signed message and verification key.
-                In the case of attach_cose_key=True, a dict containing the signed message and Cose key.
+    """Sign an arbitrary message with a payment key following CIP-0008.
+
+    Args:
+        message (str): Message to be signed
+        signing_key (SigningKey): Key which is used to sign the message
+        attach_cose_key (bool): Whether or not to attach the Cose key to the output
+        network (Network): Network to use for the address generation
+
+    Returns:
+        Union[str, dict]: A hex-encoded string containing the signed message and verification key.
+        In the case of attach_cose_key=True, a dict containing the signed message and Cose key.
     """
 
     # derive the verification key
@@ -91,18 +95,18 @@ def sign(
 def verify(
     signed_message: Union[str, dict], attach_cose_key: Optional[bool] = None
 ) -> dict:
-    """
-    Verify the signature of a COSESign1 message and decode its contents following CIP-0008.
+    """Verify the signature of a COSESign1 message and decode its contents following CIP-0008.
     Supports messages signed by browser wallets or `Message.sign()`.
-        Parameters:
-            signed_message (str, dict): Message to be verified
-            attach_cose_key (bool, optional): Whether or not the Cose key is included with the signed_message.
-                This method will try to determine this automatically if not specified.
-                Usually if `signed_message` is a dict, this should be true.
-        Returns:
-            verified (dict): a dict containing whether or not the message is verified, the message contents,
-                and an Address which was used to sign the message.
 
+    Args:
+        signed_message (Union[str, dict]): Message to be verified
+        attach_cose_key (Optional[bool]): Whether or not the Cose key is included with the signed_message.
+            This method will try to determine this automatically if not specified.
+            Usually if `signed_message` is a dict, this should be true.
+
+    Returns:
+        dict: A dict containing whether or not the message is verified, the message contents,
+        and an Address which was used to sign the message.
     """
 
     if attach_cose_key is None:

pycardano/utils.py

@@ -9,17 +9,8 @@
 from nacl.hash import blake2b
 
 from pycardano.backend.base import ChainContext
-from pycardano.hash import (
-    SCRIPT_DATA_HASH_SIZE,
-    SCRIPT_HASH_SIZE,
-    ScriptDataHash,
-)
-from pycardano.plutus import (
-    COST_MODELS,
-    CostModels,
-    Datum,
-    Redeemer,
-)
+from pycardano.hash import SCRIPT_DATA_HASH_SIZE, SCRIPT_HASH_SIZE, ScriptDataHash
+from pycardano.plutus import COST_MODELS, CostModels, Datum, Redeemer
 from pycardano.serialization import default_encoder
 from pycardano.transaction import MultiAsset, TransactionOutput, Value