From 96eb4a9a97905fd81956f05ee0538d7a595c04ad Mon Sep 17 00:00:00 2001 From: callebtc <93376500+callebtc@users.noreply.github.com> Date: Wed, 19 Nov 2025 19:58:55 +0100 Subject: [PATCH] description of settings (#823) --- .env.example | 3 ++- cashu/core/settings.py | 26 ++++++++++++++++++++------ 2 files changed, 22 insertions(+), 7 deletions(-) diff --git a/.env.example b/.env.example index 63b1343..71d032a 100644 --- a/.env.example +++ b/.env.example @@ -118,10 +118,11 @@ LIGHTNING_FEE_PERCENT=1.0 LIGHTNING_RESERVE_FEE_MIN=2000 # Mint Management gRPC service configurations +# Run the script in cashu/mint/management_rpc/generate_certificates.sh to generate certificates for the server and client. +# Use `poetry run mint-cli get-info` to test the connection. MINT_RPC_SERVER_ENABLE=FALSE MINT_RPC_SERVER_ADDR=localhost MINT_RPC_SERVER_PORT=8086 -MINT_RPC_SERVER_MUTUAL_TLS=TRUE MINT_RPC_SERVER_KEY="./server_private.pem" MINT_RPC_SERVER_CERT="./server_cert.pem" MINT_RPC_SERVER_CA="./ca_cert.pem" diff --git a/cashu/core/settings.py b/cashu/core/settings.py index cd0a11e..1b0ed8e 100644 --- a/cashu/core/settings.py +++ b/cashu/core/settings.py @@ -208,13 +208,27 @@ class MintInformation(CashuSettings): class MintManagementRPCSettings(MintSettings): - mint_rpc_server_enable: bool = Field(default=False) - mint_rpc_server_ca: str = Field(default=None) - mint_rpc_server_cert: str = Field(default=None) + mint_rpc_server_enable: bool = Field( + default=False, description="Enable the management RPC server." + ) + mint_rpc_server_ca: str = Field( + default=None, + description="CA certificate file path for the management RPC server.", + ) + mint_rpc_server_cert: str = Field( + default=None, + description="Server certificate file path for the management RPC server.", + ) mint_rpc_server_key: str = Field(default=None) - mint_rpc_server_addr: str = Field(default="localhost") - mint_rpc_server_port: int = Field(default=8086) - mint_rpc_server_mutual_tls: bool = Field(default=True) + mint_rpc_server_addr: str = Field( + default="localhost", description="Address for the management RPC server." + ) + mint_rpc_server_port: int = Field( + default=8086, gt=0, lt=65536, description="Port for the management RPC server." + ) + mint_rpc_server_mutual_tls: bool = Field( + default=True, description="Require client certificates." + ) class WalletSettings(CashuSettings):