Skip to content

docs: enhance convert contract readme#10

Merged
fmorency merged 1 commit intomanifest-network:mainfrom
fmorency:docs
Dec 5, 2025
Merged

docs: enhance convert contract readme#10
fmorency merged 1 commit intomanifest-network:mainfrom
fmorency:docs

Conversation

@fmorency
Copy link
Contributor

@fmorency fmorency commented Dec 5, 2025

This pull request updates the contracts/converter/README.md documentation to provide comprehensive deployment, interaction, and usage instructions for the Converter contract. The changes make it much easier for users and developers to find contract addresses, interact with the contract on both mainnet and testnet, and understand prerequisites and command usage.

Deployment and interaction documentation:

  • Added a "Deployed Contracts" section listing mainnet and testnet contract addresses for quick reference.
  • Introduced detailed instructions for interacting with the contract via REST and RPC, including network endpoints, prerequisites for installing manifestd, and base64 encoding for REST queries.

Usage examples:

  • Provided step-by-step query and execution examples for common contract operations, including converting tokens, updating config, and transferring admin privileges, with both mainnet and testnet commands.

Reference links:

  • Added a direct link to the manifestd repository for easier access to the required chain binary.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR significantly enhances the Converter contract documentation by adding comprehensive deployment information, interaction guides, and practical usage examples. The changes transform the README from a basic contract description into a complete reference guide for developers and users.

Key Changes:

  • Added deployed contract addresses for mainnet and testnet environments
  • Introduced detailed interaction instructions for both REST and RPC methods
  • Provided step-by-step examples for querying and executing contract operations

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov
Copy link

codecov bot commented Dec 5, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@fmorency fmorency merged commit 83f6a0a into manifest-network:main Dec 5, 2025
12 checks passed
@fmorency fmorency deleted the docs branch December 5, 2025 14:54
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.

2 participants