docs: add comprehensive JSDoc documentation for @autonomys/auto-utils package #434
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
- Add comprehensive documentation for address utility functions (address, decode) - Add documentation for crypto functions (blake2b_256, stringToUint8Array, concatenateUint8Arrays) - Add documentation for string utility functions (stringify, shortString, capitalizeFirstLetter, fixLengthEntryId) - Add documentation for number utility functions (parseTokenAmount, formatTokenAmount, formatSpacePledged) - Include parameter descriptions, return types, examples, and error handling
- Add documentation for API functions (createConnection, activate, activateDomain, disconnect) - Add documentation for network functions (getNetworkDetails, getNetworkRpcUrls, getNetworkDomainDetails, getNetworkDomainRpcUrls) - Include comprehensive examples showing network connections and domain usage - Document error handling for connection failures and invalid network/domain IDs - Provide examples for mainnet, testnet, and localhost environments
- Add documentation for setupWallet function for creating wallets from mnemonic/URI - Add documentation for generateWallet function for creating new random wallets - Add documentation for activateWallet function for comprehensive wallet activation - Add documentation for mockWallets function for creating development test wallets - Add documentation for getMockWallet function for retrieving specific mock wallets - Include examples for Node.js and browser environments, different key types - Document support for mainnet, testnet, domain connections, and mock development accounts
…ions - Add comprehensive documentation for signAndSendTx function with transaction lifecycle handling - Add documentation for sign utility functions (signMessage, signingKey, signatureVerify) - Add documentation for events utility functions (eventName, eventsGroup, expectSuccessfulTxEvent) - Add documentation for validateEvents function with event validation patterns - Include examples for transaction signing, event validation, and error handling - Document support for custom error mapping and complex event patterns
- Add documentation for detectTxSuccess function for transaction success detection - Add documentation for format utility re-exports (stringToU8a, u8aToHex) - Add documentation for verify utility re-exports (isAddress, isHex) - Add documentation for ready utility re-export (cryptoWaitReady) - Include examples for transaction monitoring, data conversion, validation, and crypto initialization - Complete JSDoc coverage for all major utility functions in auto-utils package
- Simplify JSDoc for re-exported Polkadot.js utilities (format, verify, ready, sign) - Remove verbose examples that duplicate upstream documentation - Add clear references to official Polkadot.js documentation - Focus on Autonomys-specific context and convenience rationale - Maintain essential function descriptions while reducing maintenance overhead
jfrank-summit
force-pushed
the
cursor/add-documentation-for-auto-utils-04a4
branch
from
91e19ce to
4a8c186
Compare
jfrank-summit
approved these changes
Jun 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📚 Add Comprehensive JSDoc Documentation for @autonomys/auto-utils
This PR adds comprehensive JSDoc documentation to the @autonomys/auto-utils package, following the same high-quality documentation standard established in PR #432.
🎯 What Changed
Added complete JSDoc documentation for all exported functions in the auto-utils package, organized into focused atomic commits:
Core Utility Functions
address(),decode()- SS58 address conversion and decodingblake2b_256(),stringToUint8Array(),concatenateUint8Arrays()- Cryptographic operationsstringify(),shortString(),capitalizeFirstLetter(),fixLengthEntryId()- String manipulationparseTokenAmount(),formatTokenAmount(),formatSpacePledged()- Token and space formattingAPI and Network Functions
createConnection(),activate(),activateDomain(),disconnect()- Network connectionsgetNetworkDetails(),getNetworkRpcUrls(),getNetworkDomainDetails(),getNetworkDomainRpcUrls()- Network configurationWallet Functions
setupWallet(),generateWallet(),activateWallet()- Wallet creation and activationmockWallets(),getMockWallet()- Testing and development helpersTransaction and Event Utilities
signAndSendTx()- Comprehensive transaction lifecycle managementsignMessage(),signingKey(),signatureVerify()- Message signing and verificationvalidateEvents(),eventName(),expectSuccessfulTxEvent()- Event monitoringAdditional Utilities
detectTxSuccess()✨ Documentation Features
@throwstags documenting common error scenarios🔍 Quality Assurance
🚀 Impact
This significantly improves the developer experience by providing the same high-quality documentation standard established in PR #432, making the @autonomys/auto-utils package much more accessible and easier to use for developers building on the Autonomys Network.
Complete the necessary changes to complete this task. Make sure the commits are atomic and descriptive. They should tell a story of the changes made. Implement the changes in the most simple way possible, each change should be well thought out. Adhere strictly to the code style and structure of the project.