Skip to content

Commit e271c99

Browse files
committed
Update docs
1 parent e5e2237 commit e271c99

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ simply run [OPTIONS]
4343
- All flags from `build` command
4444
- `--param <PATH>` - Path to file containing program arguments (JSON format)
4545
- `--logging <LEVEL>` - Enable debug logging (`info`, `debug`, or `trace`)
46+
- `--lock-time <N>` - Transaction lock time (consensus value, default: 0)
47+
- `--sequence <N>` - Input sequence (consensus value, default: 0)
4648

4749
**Usage:** Useful for testing programs locally before deployment. By default, the run command uses the same code execution engine as Elements/Liquid nodes, making it ideal for testing compatibility with the actual Bitcoin network. If you specify logging, a Rust runner will be used instead, as it supports debugging features and provides more detailed execution information.
4850

@@ -89,6 +91,33 @@ simply withdraw [OPTIONS]
8991

9092
**Usage:** Creates and optionally broadcasts a transaction that spends a UTXO using the compiled program.
9193

94+
### Sign
95+
96+
Signs arbitrary data using BIP340 (Schnorr) and prints the results.
97+
98+
```sh
99+
simply sign --message <HEX> [--secret <HEX>]
100+
```
101+
102+
**Flags:**
103+
- `--message <HEX>` - Message to sign, hex-encoded (required)
104+
- `--secret <HEX>` - Secret key (32-byte hex). If omitted, a random key is generated
105+
106+
**Output:**
107+
- Signature (BIP340) in hex
108+
- Message (as provided, hex)
109+
- Public key (x-only) in hex
110+
- Private key in hex (only printed when generated randomly)
111+
112+
**Examples:**
113+
```sh
114+
# Sign with a randomly generated key
115+
simply sign --message 48656c6c6f
116+
117+
# Sign with a provided secret key
118+
simply sign --message 48656c6c6f --secret e3a1...32-bytes-hex...
119+
```
120+
92121
## File Formats
93122

94123
### Witness Files

0 commit comments

Comments
 (0)