v0.3.4 Release

NEAR Protocol Rewards v0.3.3 🚀

What's New

v0.3.4 Fixes

• 🔧 Change base time calculation
• 🐛 Fixed logger return undefined in CLI
• 🔧 Add CI for Test Coverage and New Architecture for Unit Tests

v0.3.3 Changes (Previous Release)

• 📝 New visualization of the value related to the current month's calculation
• 🔄 Removed undefined in CLI output

Migration Guide

1. Update Your Package

npm install near-protocol-rewards@latest

2. Re-run Init (Safe!)

npx near-protocol-rewards init

💡 Note: Your metrics history is preserved! This only updates your workflow file.

Security & Performance

• ✅ No token changes needed
• 🔒 Uses GitHub's built-in security
• 📊 All historical metrics preserved
• ⚡️ Improved workflow reliability

Coming Soon

• 🌐 Real Time Multi-repository support
• 🤝 Real Time Multi-contributor validation
• 🔐 Enhanced authorization
• 📊 Advanced analytics

Known Issues

None! This release focuses on fixing installation and dependency issues.

Need Help?

• Quick Start Guide
• Troubleshooting Guide
• Report Issues

---

Thanks to everyone who helped identify and fix these issues! 🙏

⚠️ Dashboard updates coming later this week. For now, use the CLI to track your progress!

Questions? Reply here or open an issue!

v0.3.3 Release

NEAR Protocol Rewards v0.3.3 🚀

What's New

v0.3.3 Fixes

• 🔧 Removed circular dependency in package.json
• 🐛 Fixed npm package installation issues
• 🔄 Updated CLI version number for consistency

v0.3.2 Changes (Previous Release)

• 📝 Renamed workflow job from track-metrics to calculate-rewards
• 🔒 Added required permissions block to workflow file
• 🔄 Fixed deprecated track command usage
• 📚 Standardized command terminology across documentation

Migration Guide

1. Update Your Package

npm install near-protocol-rewards@latest

2. Re-run Init (Safe!)

npx near-protocol-rewards init

💡 Note: Your metrics history is preserved! This only updates your workflow file.

3. Verify Your Workflow

Your .github/workflows/near-rewards.yml should look like this:

jobs:
  calculate-rewards:
    permissions:
      contents: read
      issues: read
      pull-requests: read
    steps:
      # ... other steps ...
      - name: Calculate Rewards
        run: npx near-protocol-rewards calculate

Security & Performance

• ✅ No token changes needed
• 🔒 Uses GitHub's built-in security
• 📊 All historical metrics preserved
• ⚡️ Improved workflow reliability

Documentation Updates

• 📘 Enhanced troubleshooting guide
• 🔍 Clearer installation instructions
• ❌ Better error message documentation
• 🚀 Updated Quick Start guide

Known Issues

None! This release focuses on fixing installation and dependency issues.

Coming Soon

• 🌐 Multi-repository support
• 🤝 Multi-contributor validation
• 🔐 Enhanced authorization
• 📊 Advanced analytics

Need Help?

• Quick Start Guide
• Troubleshooting Guide
• Report Issues

---

Technical Details

Automatic Updates

Your rewards calculate:

• ⏰ Every 12 hours
• 🔄 On push to main
• 🎯 Manual trigger available

Validation System

Still using our proven reward tiers:

• 💎 Diamond: $2,500/week (90+ score)
• 🏆 Platinum: $2,000/week (80-89)
• 🥇 Gold: $1,500/week (70-79)
• 🥈 Silver: $1,000/week (60-69)
• 🥉 Bronze: $500/week (<60)

---

Thanks to everyone who helped identify and fix these issues! 🙏

⚠️ Dashboard updates coming later this week. For now, use the CLI to track your progress!

Questions? Reply here or open an issue!

Protocol Rewards v0.3.1 Release --Calculate Rewards

We’re excited to announce near-protocol-rewards v0.3.1, a beta release with improvements and a brand-new calculate command. This new command helps you understand your project’s rewards with detailed scores, achievements, and weekly/monthly projections—all from your terminal.

What’s New in v0.3.1?

• Calculate Command: Instantly calculate your project’s rewards using your GitHub metrics natively in the CLI
• Achievements & Projections: See what achievements you’ve earned and get an estimate of weekly and monthly rewards.
• Improved CLI Structure & Validation: Enhanced error messages, validation warnings, and a more organized CLI.

How to Use the New Command:

npx near-protocol-rewards calculate

This will fetch your latest metrics, compute your rewards, and display any validation warnings, achievements, and projections.

🔐 Running in GitHub Actions (Recommended)

The calculate command is automatically available in your GitHub Actions workflow where tokens are securely managed. No additional setup required!

Example Output

📊 Rewards Calculation Results:

🏆 Level: Gold (75.50/100)
💰 Weekly Reward: $1,500
💰 Monthly Projection: $6,000

Note: Coming in v0.4.0 - NEAR transaction tracking will increase reward potential! 🚀

Breakdown:
📝 Commits: 25.00
🔄 Pull Requests: 25.00
👀 Reviews: 20.00
🎯 Issues: 15.00

🌟 Achievements:
- Consistent Contributor: Maintained steady activity for 4+ weeks
- Team Player: Reviewed 10+ pull requests

🆕 Upgrading to v0.3.0+

Breaking Changes

1. Configuration simplified:
   • projectId no longer required
   • nearAccount field removed
   • Only GitHub-related fields needed

How to Upgrade

1. Update your package:

   npm install near-protocol-rewards@latest

2. Update your configuration:

   // Old configuration
   const sdk = new GitHubRewardsSDK({
     projectId: 'your-project',        // Remove this
     nearAccount: 'your.near',         // Remove this
     githubToken: process.env.GITHUB_TOKEN,
     githubRepo: 'owner/repo',
     timeframe: 'week'
   });
   
   // New configuration
   const sdk = new GitHubRewardsSDK({
     githubToken: process.env.GITHUB_TOKEN,
     githubRepo: 'owner/repo',
     timeframe: 'week'
   });

As always, we value your feedback during this beta phase. Please try it out and let us know what you think!

v0.3.0: Simplified Configuration & Enhanced UX

What's New in v0.3.0

Simplified configuration and enhanced user experience with automatic GitHub authentication.

Breaking Changes

• Removed projectId requirement
• Removed nearAccount requirement
• Enhanced validation

Improvements

• Automatic GitHub auth
• Better documentation
• Improved CLI messages

Installation

npm install near-protocol-rewards@latest

See Quick Start Guide for details.