Skip to content

Commit 12d661d

Browse files
cameroncoopercameroncooper
authored
updated README.md (#20)
1 parent d5458ac commit 12d661d

File tree

1 file changed

+41
-27
lines changed

1 file changed

+41
-27
lines changed

‎README.md‎

Lines changed: 41 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -78,34 +78,48 @@ $ coinset get_coin_records_by_parent_ids 0xa908ee64a5821b7bda5d798c053a79c8b3d7c
7878
}
7979
```
8080

81-
### Coin IDs
81+
## Available Commands
82+
83+
The following table shows all available CLI commands organized by functionality:
84+
85+
| Category | Command | Description |
86+
|----------|---------|-------------|
87+
| **Address Operations** | `address encode <puzzle_hash>` | Encode puzzle hash to address |
88+
| | `address decode <address>` | Decode address to puzzle hash |
89+
| **Coin Operations** | `coin_id <parent_coin_id> <puzzle_hash> <amount>` | Compute a coin ID from parent, puzzle hash and amount |
90+
| | `get_coin_record_by_name <coin_name>` | Retrieve a coin record by its name |
91+
| | `get_coin_records_by_hint <hint>` | Retrieve coin records by hint |
92+
| | `get_coin_records_by_hints <hints>` | Retrieve coin records by multiple hints |
93+
| | `get_coin_records_by_names <coin_names>` | Retrieve coin records by multiple names |
94+
| | `get_coin_records_by_parent_ids <parent_ids>` | Retrieve coin records by parent IDs |
95+
| | `get_coin_records_by_puzzle_hash <puzzle_hash>` | Retrieve coin records by puzzle hash |
96+
| | `get_coin_records_by_puzzle_hashes <puzzle_hashes>` | Retrieve coin records by multiple puzzle hashes |
97+
| **Block Operations** | `get_block <header_hash>` | Retrieve a full block by header hash |
98+
| | `get_blocks <start_height> <end_height>` | Retrieve multiple blocks in a height range |
99+
| | `get_block_record <header_hash>` | Retrieve a block record by header hash |
100+
| | `get_block_records <start_height> <end_height>` | Retrieve multiple block records in a height range |
101+
| | `get_block_record_by_height <height>` | Retrieve a block record by height |
102+
| | `get_block_spends <header_hash>` | Retrieve block spends by header hash |
103+
| | `get_block_spends_with_conditions <header_hash>` | Retrieve block spends with conditions by header hash |
104+
| | `get_unfinished_block_headers` | Retrieve unfinished block headers |
105+
| **Blockchain State & Network** | `get_blockchain_state` | Retrieve the current blockchain state |
106+
| | `get_network_info` | Retrieve information about the current network |
107+
| | `get_network_space <newer_block_header_hash> <older_block_header_hash>` | Retrieve network space between two blocks |
108+
| | `get_block_count_metrics` | Retrieve block count metrics |
109+
| **Mempool Operations** | `get_all_mempool_items` | Retrieve all mempool items |
110+
| | `get_all_mempool_tx_ids` | Retrieve all mempool transaction IDs |
111+
| | `get_mempool_item_by_tx_id <tx_id>` | Retrieve a specific mempool item by transaction ID |
112+
| | `get_mempool_items_by_coin_name <coin_name>` | Retrieve mempool items by coin name |
113+
| **Transaction Operations** | `push_tx [spend_bundle_json]` | Push a spend bundle to the mempool |
114+
| | `get_fee_estimate <target_times> <cost>` | Get fee estimate for transaction |
115+
| | `get_additions_and_removals <header_hash>` | Get additions and removals for a block |
116+
| | `get_aggsig_additional_data <spend_bundle>` | Get aggregate signature additional data |
117+
| **Puzzle & Solution** | `get_puzzle_and_solution <coin_name> <height>` | Retrieve puzzle and solution for a coin |
118+
| | `get_puzzle_and_solution_with_conditions <coin_name> <height>` | Retrieve puzzle and solution with conditions for a coin |
119+
| **Memos & Metadata** | `get_memos_by_coin_name <coin_name>` | Retrieve memos associated with a coin |
120+
| **Events & Real-time** | `events [type]` | Connect to WebSocket and display events (peak, transaction, offer) |
121+
| **Utility** | `version` | Display the version number of coinset |
82122

83-
Using the `coin_id` command you can encode coin IDs. For example:
84-
85-
```bash
86-
coinset coin_id 0xeca65946d1b80b527bcab5e94673f30bb3fd8a9466b31379fa5fa1f49c492031 0x66e55285340258cb79e6eda4d16f230bec2df7a2d7b40b8c6268247be9e659cb 2000000007
87-
```
88-
```bash
89-
0xce2a2dd052bdbcf7fffc309e2a5e1f8589513335f85232a6c8cfb4a7d49ee32b
90-
```
91-
92-
### Address Encoding
93-
94-
Using the `address` command you can encode and decode adresses. For example:
95-
96-
```bash
97-
coinset address encode 0xbf3d35bba83d984be6cc4db0d6c84922e275a39ca4f8e1dd3cddfe2fa5eb2e2f
98-
```
99-
```bash
100-
xch1hu7ntwag8kvyhekvfkcddjzfyt38tguu5nuwrhfumhlzlf0t9chs6cj5k8
101-
```
102-
103-
```bash
104-
coinset address decode xch1hu7ntwag8kvyhekvfkcddjzfyt38tguu5nuwrhfumhlzlf0t9chs6cj5k8
105-
```
106-
```bash
107-
0xbf3d35bba83d984be6cc4db0d6c84922e275a39ca4f8e1dd3cddfe2fa5eb2e2f
108-
```
109123

110124
### JQ Filtering
111125

0 commit comments

Comments
 (0)