Skip to content

Commit fee6cc8

Browse files
authored
[WIP] cli and doc updates (#168)
* cli updates * cli updates
1 parent 2cb8458 commit fee6cc8

3 files changed

Lines changed: 12 additions & 13 deletions

File tree

src/opengradient/cli.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ def infer(ctx, model_cid: str, inference_mode: str, input_data, input_file: Path
376376
"x402_settlement_mode",
377377
type=click.Choice(x402SettlementModes.keys()),
378378
default="settle-batch",
379-
help="Settlement mode for x402 payments: settle (hashes only), settle-batch (batched, default), settle-metadata (full data)",
379+
help="Settlement mode for x402 payments: settle (payment only), settle-batch (batched, default), settle-metadata (full data)",
380380
)
381381
@click.pass_context
382382
def completion(
@@ -469,7 +469,7 @@ def print_llm_completion_result(model_cid, tx_hash, llm_output, is_vanilla=True)
469469
"--x402-settlement-mode",
470470
type=click.Choice(x402SettlementModes.keys()),
471471
default="settle-batch",
472-
help="Settlement mode for x402 payments: settle (hashes only), settle-batch (batched, default), settle-metadata (full data)",
472+
help="Settlement mode for x402 payments: settle (payment only), settle-batch (batched, default), settle-metadata (full data)",
473473
)
474474
@click.option("--stream", is_flag=True, default=False, help="Stream the output from the LLM")
475475
@click.pass_context

src/opengradient/types.py

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,10 @@ class x402SettlementMode(str, Enum):
1919
privacy, and transaction costs.
2020
2121
Attributes:
22-
SETTLE: Individual settlement with input/output hashes only.
23-
Also known as SETTLE_INDIVIDUAL in some documentation.
24-
Records cryptographic hashes of the inference input and output.
25-
Most privacy-preserving option - actual data is not stored on-chain.
26-
Suitable for applications where only proof of execution is needed.
22+
SETTLE: Most private settlement method.
23+
Only the payment is settled on-chain — no input or output hashes are posted to the chain.
24+
Your inference data remains completely off-chain, ensuring maximum privacy.
25+
Suitable for applications where payment settlement is required without any on-chain record of execution.
2726
CLI usage: --settlement-mode settle
2827
2928
SETTLE_METADATA: Individual settlement with full metadata.
@@ -48,9 +47,9 @@ class x402SettlementMode(str, Enum):
4847
'settle'
4948
"""
5049

51-
SETTLE = "settle"
52-
SETTLE_METADATA = "settle-metadata"
53-
SETTLE_BATCH = "settle-batch"
50+
SETTLE = "private"
51+
SETTLE_METADATA = "individual"
52+
SETTLE_BATCH = "batch"
5453

5554
# Aliases for backward compatibility with glossary naming
5655
SETTLE_INDIVIDUAL = SETTLE

tests/client_test.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -311,9 +311,9 @@ def test_from_sse_data_with_usage(self):
311311
class TestX402SettlementMode:
312312
def test_settlement_modes_values(self):
313313
"""Test settlement mode enum values."""
314-
assert x402SettlementMode.SETTLE == "settle"
315-
assert x402SettlementMode.SETTLE_BATCH == "settle-batch"
316-
assert x402SettlementMode.SETTLE_METADATA == "settle-metadata"
314+
assert x402SettlementMode.SETTLE == "private"
315+
assert x402SettlementMode.SETTLE_BATCH == "batch"
316+
assert x402SettlementMode.SETTLE_METADATA == "individual"
317317

318318
def test_settlement_mode_aliases(self):
319319
"""Test settlement mode aliases."""

0 commit comments

Comments
 (0)