errors.sol

Overview

This Solidity source file defines an abstract contract named Errors which centralizes the definition of error codes used throughout the system. These error codes are represented as constant unsigned 16-bit integers (uint16) and cover a broad range of failure scenarios such as public key validation errors, transaction list issues, replay protection failures, signature verification problems, wallet recovery errors, and security card-related faults.

By using a centralized error contract, the system ensures consistent error handling and reporting across multiple contracts or modules, facilitating maintainability, debugging, and integration. The contract also includes a version identifier string (versionErrors) that can be used to track or enforce compatibility of error definitions.

Contract: Errors

Description

The Errors contract is declared as abstract, meaning it is not meant to be instantiated directly but rather to be inherited by other contracts that require access to standardized error codes.

Properties

Usage

Contracts inheriting from Errors can refer to these constants to revert transactions or emit error events with standardized error codes. This approach reduces the risk of mismatched or ambiguous error reporting.

Example usage snippet:

if (publicKey == address(0)) {
    revert(uint16(Errors.ERR_ZERO_PUBKEY));
}

Implementation Details

• The error codes are grouped by categories and assigned numeric values in distinct ranges (e.g., 100s for public keys, 200s for values, 300s for transaction lists, etc.) to facilitate easy identification and classification.

• Error code constants are declared as uint16 to optimize storage and gas usage compared to larger integer types.

• The contract uses a fixed version string to support version tracking of the error definitions.

Interaction with Other System Components

• This contract serves as a shared reference for error codes used by multiple components like transaction handling modules, message validation services, cryptographic proof verifiers, wallet recovery mechanisms, and security card management.

• Other contracts can inherit from Errors to access uniform error codes, ensuring that errors returned by different contracts remain consistent and interoperable.

• Error codes related to cryptographic proofs and key management indicate integration with components handling authentication, authorization, and cryptographic verification, potentially linked to Digital Signature Verification and Wallet Recovery topics.

• Transaction-related error codes suggest interactions with transaction pool or queue management systems, possibly detailed under Transaction Management.

Diagram: Errors Contract Structure

classDiagram
class Errors {
<<abstract>>
+string versionErrors
+uint16 ERR_ZERO_PUBKEY
+uint16 ERR_REPEATING_KEY
+uint16 ERR_BAD_LEN
+uint16 ERR_TOO_SMALL_VALUE
+uint16 ERR_LOW_BALANCE
+uint16 ERR_TRX_NOT_FOUND
+uint16 ERR_TRX_WAITLIST_OVERFLOWED
+uint16 ERR_MAX_CLEANUP_TXNS_INVALID
+uint16 ERR_MESSAGE_IS_EXIST
+uint16 ERR_MESSAGE_WITH_HUGE_EXPIREAT
+uint16 ERR_MESSAGE_EXPIRED
+uint16 ERR_NOT_OWNER
+uint16 ERR_INVALID_SIGNATURE
+uint16 ERR_FACTOR_EXPIRED
+uint16 ERR_INVALID_SENDER_ADDR
+uint16 ERR_INVALID_PROOF
+uint16 ERR_FACTOR_NOT_FOUND
+uint16 ERR_JWK_EXPIRED
+uint16 ERR_JWK_NOT_FOUND
+uint16 ERR_INVALID_JWK
+uint16 ERR_TLS_DATA
+uint16 ERR_FACTOR_TIMESTAMP_TOO_BIG
+uint16 ERR_REPEATING_CERT
+uint16 ERR_CERT_NOT_FOUND
+uint16 ERR_JWK_TIMESTAMP_TOO_BIG
+uint16 ERR_SEED_PHRASE_NEW_CANDIDATE_EXISTS
+uint16 ERR_SEED_PHRASE_NEW_CANDIDATE_NOT_FOUND
+uint16 ERR_CARD_IS_TURNED_ON
+uint16 ERR_NO_CARDS
+uint16 ERR_TOO_MUCH_CARDS_ADDED
+uint16 ERR_CARD_EXISTS
+uint16 ERR_CARD_IS_TURNED_OFF
+uint16 ERR_CARD_NOT_FOUND
}