From 9d43dfd48fd8baf5eaf49478edc289e158bb96b9 Mon Sep 17 00:00:00 2001 From: Cameron Cooper Date: Fri, 29 Aug 2025 11:30:30 -0500 Subject: [PATCH] updated README.md --- README.md | 68 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 41 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 70fa9c0..40c1ff4 100644 --- a/README.md +++ b/README.md @@ -78,34 +78,48 @@ $ coinset get_coin_records_by_parent_ids 0xa908ee64a5821b7bda5d798c053a79c8b3d7c } ``` -### Coin IDs +## Available Commands + +The following table shows all available CLI commands organized by functionality: + +| Category | Command | Description | +|----------|---------|-------------| +| **Address Operations** | `address encode ` | Encode puzzle hash to address | +| | `address decode
` | Decode address to puzzle hash | +| **Coin Operations** | `coin_id ` | Compute a coin ID from parent, puzzle hash and amount | +| | `get_coin_record_by_name ` | Retrieve a coin record by its name | +| | `get_coin_records_by_hint ` | Retrieve coin records by hint | +| | `get_coin_records_by_hints ` | Retrieve coin records by multiple hints | +| | `get_coin_records_by_names ` | Retrieve coin records by multiple names | +| | `get_coin_records_by_parent_ids ` | Retrieve coin records by parent IDs | +| | `get_coin_records_by_puzzle_hash ` | Retrieve coin records by puzzle hash | +| | `get_coin_records_by_puzzle_hashes ` | Retrieve coin records by multiple puzzle hashes | +| **Block Operations** | `get_block ` | Retrieve a full block by header hash | +| | `get_blocks ` | Retrieve multiple blocks in a height range | +| | `get_block_record ` | Retrieve a block record by header hash | +| | `get_block_records ` | Retrieve multiple block records in a height range | +| | `get_block_record_by_height ` | Retrieve a block record by height | +| | `get_block_spends ` | Retrieve block spends by header hash | +| | `get_block_spends_with_conditions ` | Retrieve block spends with conditions by header hash | +| | `get_unfinished_block_headers` | Retrieve unfinished block headers | +| **Blockchain State & Network** | `get_blockchain_state` | Retrieve the current blockchain state | +| | `get_network_info` | Retrieve information about the current network | +| | `get_network_space ` | Retrieve network space between two blocks | +| | `get_block_count_metrics` | Retrieve block count metrics | +| **Mempool Operations** | `get_all_mempool_items` | Retrieve all mempool items | +| | `get_all_mempool_tx_ids` | Retrieve all mempool transaction IDs | +| | `get_mempool_item_by_tx_id ` | Retrieve a specific mempool item by transaction ID | +| | `get_mempool_items_by_coin_name ` | Retrieve mempool items by coin name | +| **Transaction Operations** | `push_tx [spend_bundle_json]` | Push a spend bundle to the mempool | +| | `get_fee_estimate ` | Get fee estimate for transaction | +| | `get_additions_and_removals ` | Get additions and removals for a block | +| | `get_aggsig_additional_data ` | Get aggregate signature additional data | +| **Puzzle & Solution** | `get_puzzle_and_solution ` | Retrieve puzzle and solution for a coin | +| | `get_puzzle_and_solution_with_conditions ` | Retrieve puzzle and solution with conditions for a coin | +| **Memos & Metadata** | `get_memos_by_coin_name ` | Retrieve memos associated with a coin | +| **Events & Real-time** | `events [type]` | Connect to WebSocket and display events (peak, transaction, offer) | +| **Utility** | `version` | Display the version number of coinset | -Using the `coin_id` command you can encode coin IDs. For example: - -```bash -coinset coin_id 0xeca65946d1b80b527bcab5e94673f30bb3fd8a9466b31379fa5fa1f49c492031 0x66e55285340258cb79e6eda4d16f230bec2df7a2d7b40b8c6268247be9e659cb 2000000007 -``` -```bash -0xce2a2dd052bdbcf7fffc309e2a5e1f8589513335f85232a6c8cfb4a7d49ee32b -``` - -### Address Encoding - -Using the `address` command you can encode and decode adresses. For example: - -```bash -coinset address encode 0xbf3d35bba83d984be6cc4db0d6c84922e275a39ca4f8e1dd3cddfe2fa5eb2e2f -``` -```bash -xch1hu7ntwag8kvyhekvfkcddjzfyt38tguu5nuwrhfumhlzlf0t9chs6cj5k8 -``` - -```bash -coinset address decode xch1hu7ntwag8kvyhekvfkcddjzfyt38tguu5nuwrhfumhlzlf0t9chs6cj5k8 -``` -```bash -0xbf3d35bba83d984be6cc4db0d6c84922e275a39ca4f8e1dd3cddfe2fa5eb2e2f -``` ### JQ Filtering