Skip to content

docs(x/wasm): Complete module README with Messages, CLI, and REST API documentation #2155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

VolodymyrBg
Copy link
Contributor

This pull request enhances the x/wasm module documentation by completing previously empty or TODO sections:

  1. Messages Section:

    • Added comprehensive documentation for all message types (MsgStoreCode, MsgInstantiateContract, MsgExecuteContract, MsgMigrateContract, MsgUpdateAdmin, MsgClearAdmin)
    • Included Go struct definitions with parameter descriptions
  2. CLI Commands Section:

    • Replaced TODO placeholder with detailed examples for all common operations
    • Added examples for uploading, instantiating, executing, and querying contracts
    • Included commands for admin operations (migrations, admin changes)
  3. REST API Section:

    • Documented all available REST endpoints organized by functionality
    • Added code management, contract management, and transaction endpoints
    • Included example request format with BaseReq structure

These changes make the documentation much more useful for developers integrating with the Wasm module and provide a complete reference for both CLI and API interactions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant