coinbase_agentkit.action_providers.hyperboliclabs.settings package

Submodules

coinbase_agentkit.action_providers.hyperboliclabs.settings.action_provider module

Hyperbolic Settings action provider.

This module provides actions for interacting with Hyperbolic settings services. It includes functionality for managing account settings like wallet linking.

class coinbase_agentkit.action_providers.hyperboliclabs.settings.action_provider.SettingsActionProvider(api_key=None)

Bases: ActionProvider

Provides actions for interacting with Hyperbolic settings.

This provider enables interaction with the Hyperbolic settings services for managing account settings. It requires an API key which can be provided directly or through the HYPERBOLIC_API_KEY environment variable.

Links a wallet address to your Hyperbolic account.

Parameters:

args (dict[str, Any]) – Input arguments for the action.

Returns:

A message containing the action response or error details.

Return type:

str

coinbase_agentkit.action_providers.hyperboliclabs.settings.action_provider.hyperbolic_settings_action_provider(api_key=None)

Create a new instance of the SettingsActionProvider.

Parameters:

api_key (Optional[str]) – Optional API key for authentication. If not provided, will attempt to read from HYPERBOLIC_API_KEY environment variable.

Return type:

SettingsActionProvider

Returns:

A new Settings action provider instance.

Raises:

ValueError – If API key is not provided and not found in environment.

coinbase_agentkit.action_providers.hyperboliclabs.settings.schemas module

Schemas for Hyperbolic Settings action provider.

class coinbase_agentkit.action_providers.hyperboliclabs.settings.schemas.LinkWalletAddressSchema(**data)

Bases: BaseModel

Input schema for linking a wallet address to your account.

address: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

coinbase_agentkit.action_providers.hyperboliclabs.settings.service module

Service for account settings-related operations.

class coinbase_agentkit.action_providers.hyperboliclabs.settings.service.SettingsService(api_key)

Bases: Base

Service for account settings operations.

Link a wallet address to the Hyperbolic account.

Parameters:

request (WalletLinkRequest) – The wallet link request containing the wallet address.

Returns:

The wallet linking response data.

Return type:

WalletLinkResponse

coinbase_agentkit.action_providers.hyperboliclabs.settings.types module

Types for Hyperbolic settings operations.

This module provides type definitions for settings API communication.

class coinbase_agentkit.action_providers.hyperboliclabs.settings.types.WalletLinkRequest(**data)

Bases: BaseModel

Request model for wallet linking.

address: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class coinbase_agentkit.action_providers.hyperboliclabs.settings.types.WalletLinkResponse(**data)

Bases: BaseModel

Response model for wallet linking API.

The API returns either a success response with {“success”: true} or an error response with {“error_code”: int, “message”: str}

error_code: int | None
message: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

property status: str

Return status string based on success boolean for backward compatibility.

success: bool | None

coinbase_agentkit.action_providers.hyperboliclabs.settings.utils module

Utility functions for Hyperbolic settings services.

This module provides utility functions for formatting and processing settings information from Hyperbolic services.

Format wallet linking response into a readable string.

Parameters:
  • response_data (WalletLinkResponse) – WalletLinkResponse object from wallet linking API.

  • wallet_address (str) – Optional wallet address to include in the output.

Returns:

Formatted response string with next steps.

Return type:

str

Module contents

Hyperbolic settings services.

This package provides modules for interacting with Hyperbolic settings services. It includes models, schemas, and utility functions for settings operations like wallet linking.

class coinbase_agentkit.action_providers.hyperboliclabs.settings.SettingsActionProvider(api_key=None)

Bases: ActionProvider

Provides actions for interacting with Hyperbolic settings.

This provider enables interaction with the Hyperbolic settings services for managing account settings. It requires an API key which can be provided directly or through the HYPERBOLIC_API_KEY environment variable.

Links a wallet address to your Hyperbolic account.

Parameters:

args (dict[str, Any]) – Input arguments for the action.

Returns:

A message containing the action response or error details.

Return type:

str

coinbase_agentkit.action_providers.hyperboliclabs.settings.hyperbolic_settings_action_provider(api_key=None)

Create a new instance of the SettingsActionProvider.

Parameters:

api_key (Optional[str]) – Optional API key for authentication. If not provided, will attempt to read from HYPERBOLIC_API_KEY environment variable.

Return type:

SettingsActionProvider

Returns:

A new Settings action provider instance.

Raises:

ValueError – If API key is not provided and not found in environment.