Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: enhance wallet API documentation and gas limit explanations #141

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: enhance wallet API documentation and gas limit explanations #141

wants to merge 3 commits into from

Conversation

VolodymyrBg
Copy link

  • Added comprehensive documentation for OdysseyWalletApi trait including:
    • Detailed transaction requirements
    • Error codes with descriptions
    • Usage examples with valid/invalid transactions
    • Error recovery guidelines
  • Enhanced MAX_SPONSORED_TX_GAS documentation with:
    • Explanation of the 350,000 gas limit
    • Common operations within the limit
    • Operations that exceed the limit
    • Mitigation strategies for high-gas transactions

@VolodymyrBg
docs: enhance wallet API documentation and gas limit explanations
a0c0665 
- Added comprehensive documentation for OdysseyWalletApi trait including:
  - Detailed transaction requirements
  - Error codes with descriptions
  - Usage examples with valid/invalid transactions
  - Error recovery guidelines
- Enhanced MAX_SPONSORED_TX_GAS documentation with:
  - Explanation of the 350,000 gas limit
  - Common operations within the limit
  - Operations that exceed the limit
  - Mitigation strategies for high-gas transactions
onbjerg
onbjerg requested changes Feb 3, 2025
View reviewed changes
@onbjerg onbjerg added the C-docs Improvements or additions to documentation label Feb 3, 2025
@VolodymyrBg VolodymyrBg requested a review from onbjerg February 3, 2025 18:36
@VolodymyrBg
Copy link
Author

@onbjerg Corrected

@VolodymyrBg
Copy link
Author

@onbjerg @mattsse

@VolodymyrBg
Copy link
Author

@Rjected

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Rjected Rjected Awaiting requested review from Rjected Rjected is a code owner

@mattsse mattsse Awaiting requested review from mattsse mattsse is a code owner

@onbjerg onbjerg Awaiting requested review from onbjerg onbjerg is a code owner

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
C-docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@VolodymyrBg @onbjerg