near-protocol-rewards
TypeScript icon, indicating that this package has built-in type declarations

1.1.2 • Public • Published

NEAR Protocol Rewards SDK

A transparent, metric-based rewards system for NEAR projects that directly ties incentives to development activity.

npm version TypeScript License: MIT PRs Welcome

What is Protocol Rewards?

Protocol Rewards is a developer-first funding solution for the NEAR ecosystem. We're solving a critical challenge in Web3: how to transform traditional one-time grants into sustainable, ongoing capital for developers - where funding automatically grows with their impact and contribution to NEAR.

The Problem

  • Traditional funding models (grants, VCs) require extensive time spent on proposals and pitches
  • Developers want to focus on building, not fundraising
  • Project impact is often measured subjectively
  • Funding is typically front-loaded rather than tied to ongoing development

Our Solution

Protocol Rewards provides:

  • Automated tracking of development metrics and project impact
  • Merit-based rewards tied directly to contributions
  • Transparent, objective criteria for funding
  • Sustainable, ongoing rewards that scale with project growth

By automating the entire process from tracking to distribution, we enable developers to focus on what they do best - building innovative solutions on NEAR.

Get Started in 30 Seconds

  1. Open terminal in your repository
  2. Run this command:
npx near-protocol-rewards init
  1. Push to main branch

That's it! 🎉 Your metrics will show up at Protocol Rewards Dashboard

How It Works

Model

We automatically track both off-chain and on-chain metrics:

Off-Chain Metrics (GitHub)

  • Commits: How often you code
  • Pull Requests: How you integrate changes
  • Reviews: How you help others
  • Issues: How you manage tasks

On-Chain Metrics (Blockchain)

  • Transaction Volume: Total value of transactions
  • Smart Contract Interactions: Number of unique contract interactions
  • Unique Wallet Interactions: Number of distinct wallets interacting

Everything runs through GitHub Actions:

  • No setup needed
  • Uses GitHub's built-in security
  • Updates every 12 hours and on push

Scoring System

The total score (0-100) is calculated from both off-chain (GitHub) and on-chain (Blockchain) contributions, with rewards split 50/50:

Off-Chain (GitHub) - 50 Points

Component Weight Description Max Points
Commits 35% Code contributions 17.5
Pull Requests 25% Code review and integration 12.5
Reviews 20% Community participation 10
Issues 20% Project management 10

Thresholds for Maximum Points (GitHub)

  • Commits: 100 meaningful commits → 17.5 points
  • Pull Requests: 20 merged PRs → 12.5 points
  • Reviews: 30 substantive reviews → 10 points
  • Issues: 30 closed issues → 10 points

On-Chain (Blockchain) - 50 Points

Component Weight Description Max Points
Transaction Volume 40% Total value of transactions 20
Smart Contract Interactions 40% Number of unique interactions 20
Unique Wallet Interactions 20% Number of distinct wallets 10

Thresholds for Maximum Points (On-Chain)

  • Transaction Volume: $10,000+ in total transactions → 20 points
  • Smart Contract Interactions: 500+ interactions → 20 points
  • Unique Wallet Interactions: 100+ unique wallets → 10 points

Common Questions

When do metrics update?

  • Every push to main branch
  • Every 24 hours automatically
  • Check Actions tab for status

Do I need any tokens?

No! We use GitHub's built-in security.

Not seeing your metrics?

  1. Push something to main branch
  2. Wait ~2 minutes for Action to run
  3. Check Actions tab for status
  4. See our Troubleshooting Guide

Documentation

Need Help?

License

MIT © NEAR Protocol

Package Sidebar

Install

npm i near-protocol-rewards

Weekly Downloads

1,446

Version

1.1.2

License

MIT

Unpacked Size

195 kB

Total Files

117

Last publish

Collaborators

  • jbarnes850
  • lulianom