kaleido-cli 0.1.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,275 @@
1
+ """First-run onboarding helpers for Kaleido CLI."""
2
+
3
+ from __future__ import annotations
4
+
5
+ from enum import StrEnum
6
+ from pathlib import Path
7
+ from typing import Any
8
+
9
+ import typer
10
+
11
+ from .config import load_config, save_config
12
+ from .docker_manager import (
13
+ COMPOSE_FILE,
14
+ DEFAULT_BASE_DAEMON_PORT,
15
+ DEFAULT_BASE_PEER_PORT,
16
+ DEFAULT_SPAWN_DIR,
17
+ SpawnConfig,
18
+ SpawnManager,
19
+ find_free_base_ports,
20
+ )
21
+ from .output import is_interactive, print_error, print_info, print_panel, print_success
22
+
23
+
24
+ class SetupMode(StrEnum):
25
+ market = "market"
26
+ local = "local"
27
+
28
+
29
+ def _value_or_prompt(
30
+ value: Any,
31
+ label: str,
32
+ default: Any,
33
+ *,
34
+ use_defaults: bool,
35
+ type_: Any | None = None,
36
+ ) -> Any:
37
+ if value is not None:
38
+ return value
39
+ if use_defaults:
40
+ return default
41
+ prompt_kwargs: dict[str, Any] = {"default": default}
42
+ if type_ is not None:
43
+ prompt_kwargs["type"] = type_
44
+ return typer.prompt(label, **prompt_kwargs)
45
+
46
+
47
+ def _confirm_or_default(
48
+ value: bool | None,
49
+ label: str,
50
+ default: bool,
51
+ *,
52
+ use_defaults: bool,
53
+ ) -> bool:
54
+ if value is not None:
55
+ return value
56
+ if use_defaults:
57
+ return default
58
+ return typer.confirm(label, default=default)
59
+
60
+
61
+ def _next_available_env_name(base_dir: Path, env_name: str) -> str:
62
+ """Suggest an environment name that is available under the base directory."""
63
+ for suffix in range(2, 100):
64
+ candidate = f"{env_name}-{suffix}"
65
+ if not (base_dir / candidate / COMPOSE_FILE).exists():
66
+ return candidate
67
+ return f"{env_name}-new"
68
+
69
+
70
+ def run_setup(
71
+ *,
72
+ mode: SetupMode | None,
73
+ defaults: bool,
74
+ api_url: str | None,
75
+ network: str | None,
76
+ node_url: str | None,
77
+ create_node: bool | None,
78
+ spawn_dir: str | None,
79
+ env_name: str | None,
80
+ node_count: int | None,
81
+ start: bool | None,
82
+ ) -> None:
83
+ """Run the guided first-run setup flow."""
84
+ config = load_config()
85
+
86
+ print_panel(
87
+ "Kaleido Setup",
88
+ "Set up Kaleidoswap defaults and optionally create or reuse a local RGB Lightning Node.\n"
89
+ "Your answers are saved to ~/.kaleido/config.json.",
90
+ )
91
+
92
+ resolved_mode = mode
93
+ if resolved_mode is None:
94
+ if create_node or node_url is not None:
95
+ resolved_mode = SetupMode.local
96
+ elif defaults:
97
+ resolved_mode = SetupMode.market
98
+ else:
99
+ wants_local = typer.confirm(
100
+ "Do you want to manage a local RGB Lightning Node with Docker?",
101
+ default=True,
102
+ )
103
+ resolved_mode = SetupMode.local if wants_local else SetupMode.market
104
+
105
+ config.api_url = _value_or_prompt(
106
+ api_url,
107
+ "Kaleidoswap API URL",
108
+ config.api_url,
109
+ use_defaults=defaults,
110
+ )
111
+ config.network = _value_or_prompt(
112
+ network,
113
+ "Bitcoin network",
114
+ config.network,
115
+ use_defaults=defaults,
116
+ )
117
+
118
+ created_env_name: str | None = None
119
+ created_env_started = False
120
+
121
+ if resolved_mode is SetupMode.local:
122
+ create_now_default = node_url is None
123
+ should_create_node = _confirm_or_default(
124
+ create_node,
125
+ "Create a local Docker node environment now?",
126
+ create_now_default,
127
+ use_defaults=defaults,
128
+ )
129
+
130
+ if should_create_node:
131
+ default_base_dir = (
132
+ str(DEFAULT_SPAWN_DIR) if defaults else config.spawn_dir or str(DEFAULT_SPAWN_DIR)
133
+ )
134
+ base_dir_input = _value_or_prompt(
135
+ spawn_dir,
136
+ "Base directory for node environments",
137
+ default_base_dir,
138
+ use_defaults=defaults,
139
+ )
140
+ base_dir = Path(base_dir_input).expanduser().resolve()
141
+ resolved_env_name: str = _value_or_prompt(
142
+ env_name,
143
+ "Environment name",
144
+ "default",
145
+ use_defaults=defaults,
146
+ )
147
+ created_env_name = resolved_env_name
148
+ count = _value_or_prompt(
149
+ node_count,
150
+ "How many RGB Lightning Nodes?",
151
+ 1,
152
+ use_defaults=defaults,
153
+ type_=int,
154
+ )
155
+ created_env_started = _confirm_or_default(
156
+ start,
157
+ "Start the node environment now?",
158
+ True,
159
+ use_defaults=defaults,
160
+ )
161
+ while (base_dir / resolved_env_name / COMPOSE_FILE).exists():
162
+ env_dir = base_dir / resolved_env_name
163
+ if not is_interactive():
164
+ print_error(
165
+ f"Environment '{resolved_env_name}' already exists at {env_dir}. "
166
+ "Choose a different environment name with --env-name to create a new node."
167
+ )
168
+ raise typer.Exit(1)
169
+ use_different_path = typer.confirm(
170
+ f"Environment '{resolved_env_name}' already exists at {env_dir}. "
171
+ "Create the new node in a different folder under the same base directory?",
172
+ default=True,
173
+ )
174
+ if use_different_path:
175
+ resolved_env_name = typer.prompt(
176
+ "Choose a different environment folder name",
177
+ default=_next_available_env_name(base_dir, resolved_env_name),
178
+ )
179
+ created_env_name = resolved_env_name
180
+ continue
181
+ overwrite = typer.confirm(
182
+ "Overwrite only the compose file? Existing node data may still be reused.",
183
+ default=False,
184
+ )
185
+ if not overwrite:
186
+ print_info("Aborted.")
187
+ raise typer.Exit(0)
188
+ print_info(f"Overwriting compose file for '{resolved_env_name}' at {env_dir}.")
189
+ break
190
+
191
+ if should_create_node:
192
+ config.spawn_dir = str(base_dir)
193
+ save_config(config)
194
+
195
+ daemon_base, peer_base = find_free_base_ports(
196
+ count, base_dir, exclude_env=resolved_env_name
197
+ )
198
+ if (daemon_base, peer_base) != (DEFAULT_BASE_DAEMON_PORT, DEFAULT_BASE_PEER_PORT):
199
+ print_info(
200
+ f"Default ports are taken; using API port {daemon_base} "
201
+ f"and peer port {peer_base}."
202
+ )
203
+
204
+ manager = SpawnManager(
205
+ SpawnConfig(
206
+ name=resolved_env_name,
207
+ count=count,
208
+ network=config.network,
209
+ disable_authentication=True,
210
+ base_daemon_port=daemon_base,
211
+ base_peer_port=peer_base,
212
+ spawn_base_dir=str(base_dir),
213
+ )
214
+ )
215
+ rc = manager.spawn(start=created_env_started)
216
+ if rc != 0:
217
+ raise typer.Exit(rc)
218
+
219
+ config.node_url = manager.node_urls()[0]
220
+ save_config(config)
221
+ print_success(f"Active node-url → {config.node_url}")
222
+ else:
223
+ config.node_url = _value_or_prompt(
224
+ node_url,
225
+ "RGB Lightning Node URL",
226
+ config.node_url,
227
+ use_defaults=defaults,
228
+ )
229
+ if spawn_dir is not None:
230
+ config.spawn_dir = str(Path(spawn_dir).expanduser().resolve())
231
+ save_config(config)
232
+ else:
233
+ if spawn_dir is not None:
234
+ config.spawn_dir = str(Path(spawn_dir).expanduser().resolve())
235
+ if node_url is not None:
236
+ config.node_url = node_url
237
+ save_config(config)
238
+
239
+ print_success("Setup complete.")
240
+
241
+ if resolved_mode is SetupMode.local:
242
+ if created_env_name and created_env_started:
243
+ print_panel(
244
+ "Next Steps",
245
+ "1. kaleido node init\n"
246
+ "2. kaleido node unlock\n"
247
+ "3. kaleido node info\n"
248
+ "4. kaleido wallet address",
249
+ style="green",
250
+ )
251
+ elif created_env_name:
252
+ print_panel(
253
+ "Next Steps",
254
+ f"1. kaleido node up {created_env_name}\n"
255
+ f"2. kaleido node use {created_env_name}\n"
256
+ f"3. kaleido node init\n"
257
+ f"4. kaleido node unlock",
258
+ style="green",
259
+ )
260
+ else:
261
+ print_panel(
262
+ "Next Steps",
263
+ "1. kaleido node info\n2. kaleido node unlock\n3. kaleido wallet balance",
264
+ style="green",
265
+ )
266
+ else:
267
+ print_panel(
268
+ "Next Steps",
269
+ "1. kaleido market pairs\n"
270
+ "2. kaleido market assets\n"
271
+ "3. kaleido market quote BTC/USDT --from-amount 100000",
272
+ style="green",
273
+ )
274
+
275
+ print_info("Re-run 'kaleido setup' at any time to change the defaults.")
kaleido_cli/output.py ADDED
@@ -0,0 +1,123 @@
1
+ """Rich output helpers — tables, panels, JSON mode."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import json
6
+ import sys
7
+ from typing import Any
8
+
9
+ from rich.console import Console
10
+ from rich.panel import Panel
11
+
12
+ console = Console()
13
+ err_console = Console(stderr=True)
14
+
15
+ # Module-level flags; toggled by global --json / --agent options
16
+ _json_mode: bool = False
17
+ _agent_mode: bool = False
18
+
19
+
20
+ def set_json_mode(enabled: bool) -> None:
21
+ global _json_mode
22
+ _json_mode = enabled
23
+
24
+
25
+ def set_agent_mode(enabled: bool) -> None:
26
+ global _agent_mode
27
+ _agent_mode = enabled
28
+
29
+
30
+ def is_json_mode() -> bool:
31
+ return _json_mode
32
+
33
+
34
+ def is_interactive() -> bool:
35
+ """True when running in a human terminal (stdin+stdout are TTYs, not JSON/agent mode)."""
36
+ return sys.stdin.isatty() and sys.stdout.isatty() and not _json_mode and not _agent_mode
37
+
38
+
39
+ # ---------------------------------------------------------------------------
40
+ # Raw output helpers
41
+ # ---------------------------------------------------------------------------
42
+
43
+
44
+ def print_json(data: Any) -> None:
45
+ """Pretty-print any value as JSON."""
46
+ if isinstance(data, (dict, list)):
47
+ console.print_json(json.dumps(data))
48
+ else:
49
+ console.print_json(json.dumps(data, default=str))
50
+
51
+
52
+ def print_success(msg: str) -> None:
53
+ console.print(f"[green]✓[/green] {msg}")
54
+
55
+
56
+ def print_error(msg: str) -> None:
57
+ err_console.print(f"[red]✗[/red] {msg}")
58
+
59
+
60
+ def print_info(msg: str) -> None:
61
+ console.print(f"[cyan]ℹ[/cyan] {msg}")
62
+
63
+
64
+ def print_warning(msg: str) -> None:
65
+ console.print(f"[yellow]⚠[/yellow] {msg}")
66
+
67
+
68
+ def print_panel(title: str, content: str, style: str = "blue") -> None:
69
+ console.print(Panel(content, title=title, border_style=style))
70
+
71
+
72
+ # ---------------------------------------------------------------------------
73
+ # Convenience: output a Pydantic model (JSON or table-friendly dict)
74
+ # ---------------------------------------------------------------------------
75
+
76
+
77
+ def output_model(data: Any, title: str | None = None) -> None:
78
+ """Output a Pydantic model either as JSON or as a key/value panel."""
79
+ if hasattr(data, "model_dump"):
80
+ d = data.model_dump()
81
+ elif hasattr(data, "__dict__"):
82
+ d = vars(data)
83
+ else:
84
+ d = data
85
+
86
+ if _json_mode:
87
+ print_json(d)
88
+ return
89
+
90
+ lines = _flatten_dict(d)
91
+ content = "\n".join(f"[bold]{k}[/bold]: {v}" for k, v in lines)
92
+ console.print(Panel(content, title=title or "", border_style="blue"))
93
+
94
+
95
+ def output_collection(
96
+ title: str,
97
+ items: list[Any],
98
+ *,
99
+ item_title: str | None = None,
100
+ empty_msg: str = "No results.",
101
+ ) -> None:
102
+ """Output a list of items as individual panels."""
103
+ if not items:
104
+ print_info(f"{title}: {empty_msg}")
105
+ return
106
+
107
+ for index, item in enumerate(items, start=1):
108
+ resolved_title = item_title.format(index=index) if item_title else f"{title} — {index}"
109
+ output_model(item, title=resolved_title)
110
+
111
+
112
+ def _flatten_dict(d: dict, prefix: str = "") -> list[tuple[str, Any]]:
113
+ result = []
114
+ for k, v in d.items():
115
+ key = f"{prefix}.{k}" if prefix else k
116
+ if isinstance(v, dict):
117
+ result.extend(_flatten_dict(v, key))
118
+ elif isinstance(v, list) and v and isinstance(v[0], dict):
119
+ for i, item in enumerate(v):
120
+ result.extend(_flatten_dict(item, f"{key}[{i}]"))
121
+ else:
122
+ result.append((key, v))
123
+ return result
@@ -0,0 +1 @@
1
+ """Utility helpers for the Kaleido CLI."""
@@ -0,0 +1,40 @@
1
+ """Shared RGB asset issuance helpers."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import hashlib
6
+
7
+ import typer
8
+
9
+ from kaleido_cli.output import is_interactive
10
+
11
+
12
+ def resolve_asset_metadata(
13
+ description: str | None,
14
+ file_path: str | None,
15
+ ) -> tuple[str | None, str | None]:
16
+ """Resolve optional issuance description and media path prompts."""
17
+ if not is_interactive():
18
+ return description, file_path
19
+
20
+ raw_description = typer.prompt("[OPTIONAL] Description (Enter to skip)", default="")
21
+ if raw_description.strip():
22
+ description = raw_description.strip()
23
+
24
+ raw_file_path = typer.prompt("[OPTIONAL] Media file path (Enter to skip)", default="")
25
+ if raw_file_path.strip():
26
+ file_path = raw_file_path.strip()
27
+
28
+ return description, file_path
29
+
30
+
31
+ def sha256_file(file_path: str | None) -> str | None:
32
+ """Return a file's SHA-256 digest without loading the whole file into memory."""
33
+ if not file_path:
34
+ return None
35
+
36
+ digest = hashlib.sha256()
37
+ with open(file_path, "rb") as file:
38
+ for chunk in iter(lambda: file.read(1024 * 1024), b""):
39
+ digest.update(chunk)
40
+ return digest.hexdigest()