docs(willexecutors.py): Add class-level documentation for Willexecutors and WillExecutor

This commit is contained in:
2026-04-10 00:55:37 +00:00
parent 39d1038fa8
commit 8de109c39d

View File

@@ -30,6 +30,15 @@ chainname = constants.net.NET_NAME if constants.net.NET_NAME != "mainnet" else "
class Willexecutors:
"""
Static class managing will executor servers.
This class provides methods to:
- Save and load executor configurations
- Communicate with executor servers via HTTP
- Push transactions to executors for broadcasting
- Download and update executor lists from remote sources
"""
def save(bal_plugin, willexecutors):
_logger.debug(f"save {willexecutors},{chainname}")
@@ -322,6 +331,19 @@ class Willexecutors:
class WillExecutor:
"""
Data class representing a single will executor.
Attributes:
url: Executor server URL
base_fee: Fixed fee for executor service
chain: Bitcoin network chain (bitcoin/testnet)
info: Additional executor information
version: Plugin version compatibility
status: Connection status (OK/KO)
is_selected: Whether this executor is selected by user
promo_code: Promotional code for fee discounts
"""
def __init__(
self,
url,