From 8de109c39de4495fa4b783ed1aa7772ed943b4e4 Mon Sep 17 00:00:00 2001 From: kaibot Date: Fri, 10 Apr 2026 00:55:37 +0000 Subject: [PATCH] docs(willexecutors.py): Add class-level documentation for Willexecutors and WillExecutor --- willexecutors.py | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/willexecutors.py b/willexecutors.py index 797d5fd..b281a5e 100644 --- a/willexecutors.py +++ b/willexecutors.py @@ -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,