Exception

KernelException

Bases: Exception

Base class for errors emitted by this library.

Source code in pbk/exceptions.py

class KernelException(Exception):
    """Base class for errors emitted by this library."""

ProcessBlockException

Bases: KernelException

Raised when ChainstateManager fails to process a block.

Source code in pbk/exceptions.py

class ProcessBlockException(KernelException):
    """Raised when ChainstateManager fails to process a block."""

    def __init__(self, code: int):
        """Create a block processing exception.

        Args:
            code: The error code returned by the C API.
        """
        self.code = code
        super().__init__(f"Block processing failed with error code {code}")

code instance-attribute

code = code

__init__

__init__(code: int)

Create a block processing exception.

PARAMETER	DESCRIPTION
code	The error code returned by the C API. TYPE: int

Source code in pbk/exceptions.py

def __init__(self, code: int):
    """Create a block processing exception.

    Args:
        code: The error code returned by the C API.
    """
    self.code = code
    super().__init__(f"Block processing failed with error code {code}")

ProcessBlockHeaderException

Bases: KernelException

Raised when ChainstateManager fails to process a block header.

Source code in pbk/exceptions.py

class ProcessBlockHeaderException(KernelException):
    """Raised when ChainstateManager fails to process a block header."""

    def __init__(self):
        """Create a block header processing exception."""
        super().__init__("Block header processing failed")

__init__

__init__()

Create a block header processing exception.

Source code in pbk/exceptions.py

def __init__(self):
    """Create a block header processing exception."""
    super().__init__("Block header processing failed")

ScriptVerifyException

Bases: KernelException

Exception raised when script verification cannot run.

This exception is raised by the ScriptPubkey.verify function when its arguments do not allow a verification, e.g. when the flags are combined in an invalid way. A script that does not pass validation does not raise; verify returns False for it. The exception includes a status code that tells why the verification could not run.

ATTRIBUTE	DESCRIPTION
status	The status code indicating the failure reason. TYPE: ScriptVerifyStatus

Source code in pbk/script.py

class ScriptVerifyException(KernelException):
    """Exception raised when script verification cannot run.

    This exception is raised by the [ScriptPubkey.verify][pbk.ScriptPubkey.verify]
    function when its arguments do not allow a verification, e.g. when the
    flags are combined in an invalid way. A script that does not pass
    validation does not raise; `verify` returns False for it. The exception
    includes a status code that tells why the verification could not run.

    Attributes:
        status: The status code indicating the failure reason.
    """

    status: ScriptVerifyStatus

    def __init__(self, status: ScriptVerifyStatus):
        """Create a script verification exception.

        Args:
            status: The verification status code indicating the failure reason.
        """
        super().__init__(f"Script verification failed: {status.name}")
        self.status = status

status instance-attribute

status: ScriptVerifyStatus = status

__init__

__init__(status: ScriptVerifyStatus)

Create a script verification exception.

PARAMETER	DESCRIPTION
status	The verification status code indicating the failure reason. TYPE: ScriptVerifyStatus

Source code in pbk/script.py

def __init__(self, status: ScriptVerifyStatus):
    """Create a script verification exception.

    Args:
        status: The verification status code indicating the failure reason.
    """
    super().__init__(f"Script verification failed: {status.name}")
    self.status = status