Skip to content

Commit 04db243

Browse files
committed
KLC-2394: add markdown documentation file regarding new command
1 parent 44aa915 commit 04db243

1 file changed

Lines changed: 52 additions & 0 deletions

File tree

cmd/operator/docs/operator_ms.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# operator ms
2+
3+
Summary
4+
-------
5+
Multisign actions: helpers to decode/encode multisign API data, append transactions to the multisign service, request broadcasts, fetch transactions, and sign pending multisign transactions.
6+
7+
Usage
8+
-----
9+
`operator ms [command]`
10+
11+
Subcommands
12+
-----------
13+
- `decode [Transaction]` — decode a transaction JSON and display its raw form.
14+
- `encode [Transaction]` — encode a transaction from multisign API format into the operator's encoded form.
15+
- `append [Transaction]` — append transaction data into the multisign API (accepts raw TX JSON or already-encoded multisign API data).
16+
- `broadcast [Transaction]` — ask the multisign API to broadcast/execute the transaction on-chain (calls the multisign service broadcast endpoint).
17+
- `by-hash [Transaction]` — fetch a transaction from the multisign API by its hash.
18+
- `by-address [Address]` — list transactions for a given address from the multisign API.
19+
- `sign [txHash]` — sign a multisign transaction and post the signature to the multisign API.
20+
21+
Flags
22+
-----
23+
- `--multisign-api` — multisign API URL (default: `https://multisign.mainnet.klever.org`). This flag is persistent on the `ms` command.
24+
- `--yes`, `-y` — skip the confirmation prompt (useful for scripts / non-interactive use).
25+
26+
Important note about `sign`
27+
---------------------------
28+
The `operator ms sign` command fetches a pending multisign transaction, signs it with the operator's private key, and posts the signed data (the signature) back to the multisign service. It does NOT broadcast or execute the transaction on-chain itself. "Posting the signature" means submitting the operator's signature to the multisign API so the multisign service can collect signatures and, separately, perform any broadcast when configured or requested.
29+
30+
Examples
31+
--------
32+
- Sign a specific transaction by hash (posts signature to multisign API):
33+
```
34+
operator ms sign <txHash>
35+
```
36+
37+
- Interactively select a pending transaction to sign:
38+
```
39+
operator ms sign
40+
```
41+
42+
- Append a transaction (or encoded multisign data) to the multisign service:
43+
```
44+
operator ms append '<transaction-or-encoded-json>'
45+
```
46+
47+
- Request the multisign service to broadcast a transaction by hash (this triggers the multisign service to attempt on-chain broadcast):
48+
```
49+
operator ms broadcast <txHash>
50+
```
51+
52+
See other operator docs for `operator sign` (local signing/broadcast) and general CLI usage.

0 commit comments

Comments
 (0)