from nado_protocol.client.apis.base import NadoBaseAPI
from nado_protocol.engine_client.types.execute import (
ExecuteResponse,
LinkSignerParams,
LiquidateSubaccountParams,
)
[docs]class SubaccountExecuteAPI(NadoBaseAPI):
"""
Provides functionalities for executing operations related to subaccounts in the Nado Protocol.
Inherits from NadoBaseAPI, which provides a basic context setup for accessing Nado.
This class extends the base class to provide specific functionalities for executing actions related to subaccounts.
The provided methods include:
- `liquidate_subaccount`: Performs the liquidation of a subaccount.
- `link_signer`: Links a signer to a subaccount, granting them transaction signing permissions.
Attributes:
context (NadoClientContext): Provides connectivity details for accessing Nado APIs.
"""
[docs] def liquidate_subaccount(
self, params: LiquidateSubaccountParams
) -> ExecuteResponse:
"""
Liquidates a subaccount through the engine.
Args:
params (LiquidateSubaccountParams): Parameters for liquidating the subaccount.
Returns:
ExecuteResponse: Execution response from the engine.
Raises:
Exception: If there is an error during the execution or the response status is not "success".
"""
return self.context.engine_client.liquidate_subaccount(params)
[docs] def link_signer(self, params: LinkSignerParams) -> ExecuteResponse:
"""
Links a signer to a subaccount to allow them to sign transactions on behalf of the subaccount.
Args:
params (LinkSignerParams): Parameters for linking a signer to a subaccount.
Returns:
ExecuteResponse: Execution response from the engine.
Raises:
Exception: If there is an error during the execution or the response status is not "success".
"""
return self.context.engine_client.link_signer(params)