Skip to content

docs: view lp reward verification examples#106

Merged
MicBun merged 1 commit intomainfrom
lpRewardExample
Mar 3, 2026
Merged

docs: view lp reward verification examples#106
MicBun merged 1 commit intomainfrom
lpRewardExample

Conversation

@MicBun
Copy link
Member

@MicBun MicBun commented Mar 3, 2026

resolves: #102

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added a new example demonstrating LP Rewards SDK usage, showcasing how to retrieve participant reward history, distribution summaries, and detailed distribution information with formatted output for blockchain values.

@MicBun MicBun requested a review from pr-time-tracker March 3, 2026 15:13
@MicBun MicBun self-assigned this Mar 3, 2026
@MicBun MicBun added the documentation Improvements or additions to documentation label Mar 3, 2026
@holdex
Copy link

holdex bot commented Mar 3, 2026

Time Submission Status

Member Status Time Action Last Update
MicBun ✅ Submitted 1h Update time Mar 3, 2026, 3:15 PM

You can submit time with the command. Example:

@holdex pr submit-time 15m

See available commands to help comply with our Guidelines.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 3, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7d91f7d and da533c6.

📒 Files selected for processing (1)
  • examples/lp_rewards/main.py

📝 Walkthrough

Walkthrough

A new Python example script is introduced at examples/lp_rewards/main.py that demonstrates how to use the TRUF.NETWORK LP Rewards SDK. The script creates a TNClient instance and demonstrates three SDK methods: retrieving participant reward history, distribution summaries, and distribution details with proper formatting.

Changes

Cohort / File(s) Summary
LP Rewards Example
examples/lp_rewards/main.py
New example script demonstrating TNClient usage with three methods: get_participant_reward_history(), get_distribution_summary(), and get_distribution_details(). Includes formatting logic for wallet address hex conversion and reward amount wei-to-TRUF conversion.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested reviewers

  • pr-time-tracker

Poem

🐰✨ A rabbit's ode to LP Rewards:

New paths through code I gently trace,
Where tokens flow and rewards find place,
Three methods spring from examples bright,
To guide the liquidity miners right! 🥕

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch lpRewardExample

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.

@MicBun MicBun merged commit b0ba15f into main Mar 3, 2026
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Problem: LP rewards not flowing on testnet

1 participant