Skip to content

docs: fee policy, profiling, and transaction kit guides#425

Draft
MuncleUscles wants to merge 7 commits into
mainfrom
docs/fees-transaction-kit
Draft

docs: fee policy, profiling, and transaction kit guides#425
MuncleUscles wants to merge 7 commits into
mainfrom
docs/fees-transaction-kit

Conversation

@MuncleUscles

@MuncleUscles MuncleUscles commented Jun 10, 2026

Copy link
Copy Markdown
Member

Adds a small fee-policy docs section for app and tool developers.

What changed:

  • keeps an overview page for fees and transaction policy
  • adds a dedicated Transaction Kit Integration page
  • adds a dedicated Fee Profiling and Estimation page
  • adds a dedicated Fee Outcomes and Debugging page
  • makes clear that fee profiling is not transaction-kit-specific: JS, Python, CLI/backend tools can use the same profile values
  • documents method aggregation semantics: multiple tests for the same method collapse to per-field maxima across measured branches, with headroom applied
  • includes examples for transaction-kit, genlayer-js, genlayer-py, and GenLayer CLI usage

Validation:

  • npm run build

This remains draft/release-gated until the fee train docs should publish.

@netlify

netlify Bot commented Jun 10, 2026

Copy link
Copy Markdown

Deploy Preview for genlayer-docs ready!

Name Link
🔨 Latest commit 5938da8
🔍 Latest deploy log https://app.netlify.com/projects/genlayer-docs/deploys/6a3115e4faaa960008762602
😎 Deploy Preview https://deploy-preview-425--genlayer-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: aa56be3b-50e4-4777-bf9c-a902518f20c1

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This PR adds documentation for GenLayer's fee model and transaction kit integration. A metadata entry registers the new page in the navigation structure, and a comprehensive MDX documentation file covers fee estimation, kit setup with React/Vue or headless flows, fee profiling with gltest, outcome/status mapping, and Explorer-based debugging.

Changes

Fees & Transaction Kit Documentation

Layer / File(s) Summary
Navigation registration and fees documentation
pages/developers/decentralized-applications/_meta.json, pages/developers/decentralized-applications/fees-and-transaction-kit.mdx
Navigation entry registers the new "Fees & Transaction Kit" documentation page. Complete MDX guide covers v0.6 fee model, fee deposit and refund mechanics, developer integration steps (install, kit creation, UI panel or headless usage, fee profiling), gltest toolchain guidance, outcome/status user mapping, and Explorer-based debugging workflow.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

A kit for fees, so clear and bright,
With panels glowing left and right,
Your transactions flow with grace,
No hand-rolled math to clutter space. 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title 'docs: fee policy, profiling, and transaction kit guides' clearly and specifically summarizes the main changes: adding documentation for fees, profiling, and transaction kit integration.
Description check ✅ Passed The PR description is complete and follows the template structure, including detailed 'What changed' section with specific files/pages added, clear explanation of key changes, and validation confirmation.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/fees-transaction-kit

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@MuncleUscles MuncleUscles marked this pull request as draft June 12, 2026 10:26
@MuncleUscles MuncleUscles changed the title docs: fees & transaction-kit integration guide for app developers docs: fee policy, profiling, and transaction kit guides Jun 16, 2026
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