[docs] cli commands #824
[docs] cli commands #824
Conversation
| /// ## Example Usage | ||
| /// | ||
| /// ```bash | ||
| /// partner-chains-cli address-association-signatures \ |
There was a problem hiding this comment.
This is already present 40 lines above? Why do you write it twice here?
| //! ## CLI Integration | ||
| //! | ||
| //! ```bash | ||
| //! partner-chains-cli address-association-signatures \ |
There was a problem hiding this comment.
@neotheprogramist have you run this command? What is it? Besides the fact that we don't build partner-chains-cli executable, the command is not present in the demo node build from the project.
| /// | ||
| /// ```json | ||
| /// { | ||
| /// "partnerchain_address": "d43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d", |
There was a problem hiding this comment.
Why have you used hex format in example output. Clearly code outputs SS58 format address.
| //! ## CLI Integration | ||
| //! | ||
| //! ```bash | ||
| //! partner-chains-cli block-producer-metadata-signature \ |
There was a problem hiding this comment.
There is no such command. What is going on here?
| //! 3. Sign message using ECDSA cross-chain signing key | ||
| //! 4. Output signature, public key hash, and encoded data in JSON format | ||
| //! | ||
| //! ## Metadata File Format |
There was a problem hiding this comment.
Metadata file format depends on a type parameter, you can't give a concrete example.
| /// 1. Access runtime API from blockchain client | ||
| /// 2. Get current best block hash | ||
| /// 3. Query genesis UTXO from runtime storage | ||
| /// 4. Format result as JSON string |
There was a problem hiding this comment.
We really have 4 readable lines of code for it.
| //! ### Address Association Signature | ||
| //! | ||
| //! ```bash | ||
| //! partner-chains-cli address-association-signatures \ |
There was a problem hiding this comment.
The same wrong example for the third doesn't help in any way.
| #[arg(long)] | ||
| pub sidechain_signing_key: SidechainSigningKeyParam, | ||
| /// UTXO used for validator registration transaction |
There was a problem hiding this comment.
| /// UTXO used for validator registration transaction | |
| /// UTXO to be spend during validator registration transaction |
Description
Add comprehensive documentation for the
cli-commandscrate using Rust doc comments throughout the source code. This documentation provides detailed guidance for developers using CLI command utilities in Partner Chains operations.Changes Made
lib.rs): Complete overview of cli-commands functionality, key features, and integration examples with realistic CLI usageaddress_association_signatures: Process for linking Cardano stake addresses with Partner Chain addressesblock_producer_metadata_signatures: ECDSA signature generation for block producer metadataget_genesis_utxo: Runtime API integration for querying genesis UTXO from blockchainkey_params: Comprehensive documentation of cryptographic key parameter typesregistration_signatures: Dual signature system for validator registrationDocumentation Features
The documentation is accessible through
cargo docand significantly improves developer experience when working with Partner Chains CLI operations.Checklist
changelog.mdfor affected crate