Skip to content

Config

Configuration settings for the application.

BaseConfig

Bases: BaseModel

Application settings for Google Cloud KMS.

Source code in web3_google_hsm/config.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
class BaseConfig(BaseModel):
    """Application settings for Google Cloud KMS."""

    # Google Cloud settings
    project_id: str = Field(..., min_length=1)
    location_id: str = Field(..., min_length=1)
    key_ring_id: str = Field(..., min_length=1)
    key_id: str = Field(..., min_length=1)

    # Web3 settings
    web3_provider_uri: str = Field(default=DEFAULT_WEB3_PROVIDER_URI, min_length=1)

    @field_validator("project_id", "location_id", "key_ring_id", "key_id", "web3_provider_uri")
    @classmethod
    def validate_non_empty(cls, v: str) -> str:
        """Validate that fields are not empty or whitespace."""
        if not v or not v.strip():
            msg = "Field cannot be empty or whitespace"
            raise ValueError(msg)
        return v.strip()

    class Config:
        validate_assignment = True

    @classmethod
    def from_env(cls) -> "BaseConfig":
        """
        Create configuration from environment variables.

        Returns:
            BaseConfig: Configuration instance with values from environment variables.

        Raises:
            ValidationError: If any required fields are missing or invalid
        """
        return cls(
            project_id=os.getenv(ENV_PROJECT_ID, ""),
            location_id=os.getenv(ENV_LOCATION_ID, ""),
            key_ring_id=os.getenv(ENV_KEY_RING_ID, ""),
            key_id=os.getenv(ENV_KEY_ID, ""),
            web3_provider_uri=os.getenv(ENV_WEB3_PROVIDER_URI, DEFAULT_WEB3_PROVIDER_URI),
        )

from_env() classmethod

Create configuration from environment variables.

Returns:

Name Type Description
BaseConfig BaseConfig

Configuration instance with values from environment variables.

Raises:

Type Description
ValidationError

If any required fields are missing or invalid
Source code in web3_google_hsm/config.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
@classmethod
def from_env(cls) -> "BaseConfig":
    """
    Create configuration from environment variables.

    Returns:
        BaseConfig: Configuration instance with values from environment variables.

    Raises:
        ValidationError: If any required fields are missing or invalid
    """
    return cls(
        project_id=os.getenv(ENV_PROJECT_ID, ""),
        location_id=os.getenv(ENV_LOCATION_ID, ""),
        key_ring_id=os.getenv(ENV_KEY_RING_ID, ""),
        key_id=os.getenv(ENV_KEY_ID, ""),
        web3_provider_uri=os.getenv(ENV_WEB3_PROVIDER_URI, DEFAULT_WEB3_PROVIDER_URI),
    )

validate_non_empty(v) classmethod

Validate that fields are not empty or whitespace.

Source code in web3_google_hsm/config.py 
28
29
30
31
32
33
34
35
@field_validator("project_id", "location_id", "key_ring_id", "key_id", "web3_provider_uri")
@classmethod
def validate_non_empty(cls, v: str) -> str:
    """Validate that fields are not empty or whitespace."""
    if not v or not v.strip():
        msg = "Field cannot be empty or whitespace"
        raise ValueError(msg)
    return v.strip()