> For the complete documentation index, see [llms.txt](https://docs.xchandles.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xchandles.com/technical-manual/cli/xchandles.md). # XCHandles Commands XCHandles CLI command reference All commands are invoked as `cargo run -- xchandles [flags]`. *** ## Launch ### initiate-launch Creates the XCHandles registry singleton, price singleton (medieval vault), state scheduler, and premine payment CAT. ```bash cargo run -- xchandles initiate-launch \ --pubkeys \ -m \ --payout-address \ [--relative-block-height 32] \ [--registration-period 31557600] \ [--testnet11] \ [--fee 0.0025] ``` | Flag | Default | Description | | ------------------------- | ---------- | ---------------------------------------------- | | `--pubkeys` | (required) | Comma-separated price singleton signer pubkeys | | `-m` | (required) | Multisig threshold | | `--payout-address` | (required) | Where precommit refunds are sent | | `--relative-block-height` | `32` | Blocks between precommit and register | | `--registration-period` | `31557600` | Registration period in seconds (\~1 year) | Outputs: registry `launcher_id`, price singleton id, premine payment asset id. ### continue-launch Registers premine handles from CSV and mints name NFTs. ```bash cargo run -- xchandles continue-launch \ --launcher-id \ --payment-asset-id \ --royalty-address
\ --handles-per-spend \ [--start-time ] \ [--skip 0] \ [--royalty-basis-points 1000] \ [--registration-period 31557600] \ [--testnet11] \ [--fee 0.0025] ``` Reads `xchandles_premine_testnet11.csv` (or mainnet equivalent) from the slot-machine repo root. ### unroll-state-scheduler Applies block-height-scheduled price changes from the price schedule CSV on-chain. ```bash cargo run -- xchandles unroll-state-scheduler \ --launcher-id \ [--testnet11] \ [--local] \ [--fee 0.0025] ``` *** ## verify-deployment Validates an on-chain deployment against trusted CSV files. ```bash cargo run -- xchandles verify-deployment \ --launcher-id \ [--testnet11] ``` Checks: * Registry launcher solution and initial state * Premine handles match `xchandles_premine_testnet11.csv` (or mainnet CSV) * Price schedule matches `xchandles_price_schedule_testnet11.csv` (or mainnet CSV) * Price singleton multisig configuration *** ## Register Two-phase registration: creates a precommit coin, then (after `relative_block_height` blocks) spends the registry to claim the handle. ```bash cargo run -- xchandles register \ --launcher-id \ --handle \ --nft \ --payment-asset-id \ --payment-cat-base-price \ [--num-periods 1] \ [--refund-address
] \ [--secret ] \ [--start-time ] \ [--refund] \ [--registration-period 31557600] \ [--testnet11] \ [--local] \ [--log] \ [--fee 0.0025] ``` **Phase 1** (first run): creates the precommit coin. The CLI prints a follow-up command. **Phase 2** (after block delay): completes registration with the printed command. **Refund path**: add `--refund` to claw back a precommit coin via the refund action (e.g., wrong payment, handle already taken). *** ## extend Extends a handle's registration period in a single transaction. ```bash cargo run -- xchandles extend \ --launcher-id \ --handle \ --payment-asset-id \ --payment-cat-base-price \ [--num-periods 1] \ [--registration-period 31557600] \ [--testnet11] \ [--local] \ [--fee 0.0025] ``` *** ## initiate-update Starts a two-phase handle transfer to a new NFT. ```bash cargo run -- xchandles initiate-update \ --launcher-id \ --handle \ --new-nft \ [--min-height ] \ [--testnet11] \ [--local] \ [--fee 0.0025] ``` `--min-height` defaults to current peak + 32 blocks. *** ## execute-update Completes a previously initiated handle update after the minimum block height. ```bash cargo run -- xchandles execute-update \ --launcher-id \ --handle \ --new-nft \ [--testnet11] \ [--local] \ [--fee 0.0025] ``` *** ## expire Re-registers an expired handle via the expiry auction pricing puzzle. ```bash cargo run -- xchandles expire \ --launcher-id \ --handle \ --nft \ --payment-asset-id \ --payment-cat-base-price \ [--expire-time ] \ [--num-periods 1] \ [--refund-address
] \ [--secret ] \ [--refund] \ [--committed-expiration ] \ [--registration-period 31557600] \ [--testnet11] \ [--local] \ [--fee 0.0025] ``` Uses the same two-phase precommit pattern as register. *** ## listen Runs a local neighbor API and syncs registry spends. ```bash cargo run -- xchandles listen \ --launcher-ids , \ [--testnet11] ``` Serves `http://localhost:3000` with a `GET /neighbors?launcher_id=&handle_hash=` endpoint (same contract as `https://api.xchandles.com`). *** ## view Prints current registry state. ```bash cargo run -- xchandles view \ --launcher-id \ [--payment-asset-id ] \ [--payment-cat-base-price ] \ [--registration-period 31557600] \ [--testnet11] ``` Payment hints are optional overrides for price display. *** ## sign-state-update A price singleton signer produces a partial signature for a proposed registry state change. ```bash cargo run -- xchandles sign-state-update \ --launcher-id \ --new-payment-asset-id \ --new-payment-cat-base-price \ [--new-registration-period 31557600] \ --my-pubkey \ --multisig-launcher-id \ [--payment-asset-id ] \ [--payment-cat-base-price ] \ [--registration-period 31557600] \ [--testnet11] \ [--debug] ``` *** ## broadcast-state-update Collects multisig signatures and broadcasts the state update. ```bash cargo run -- xchandles broadcast-state-update \ --launcher-id \ --new-payment-asset-id \ --new-payment-cat-base-price \ [--new-registration-period 31557600] \ --multisig-launcher-id \ --signatures \ [--payment-asset-id ] \ [--payment-cat-base-price ] \ [--registration-period 31557600] \ [--testnet11] \ [--fee 0.0025] ``` See the [CATalog delegated state action docs](https://docs.catalog.cat/technical-manual/other-useful-concepts#the-delegated-state-action). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.xchandles.com/technical-manual/cli/xchandles.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.