
NEAR Protocol Rewards SDK
A transparent, metric-based rewards system for NEAR projects that directly ties incentives to development activity and user adoption.
About NEAR Protocol Rewards SDK
NEAR Protocol Rewards SDK
> A transparent, metric-based rewards system for NEAR Protocol projects that directly ties incentives to development activity and user adoption
π Documentation
Getting Started
- Quick Start Guide - Get started in minutes
- Environment Variables - Configuration options
- API Reference - Detailed API documentation
- API Examples - Real-world usage examples
Beta Testing Resources
- Beta Testing Guide - Guide for beta testers
- Beta Checklist - Pre-testing requirements
- Known Limitations - Current beta limitations
- Testing Setup - Setup for testing
Technical Documentation
- Rewards System - How rewards are calculated
- GitHub Actions Setup - CI/CD configuration
- Architecture - Technical architecture
π Quick Install
npm install near-protocol-rewards
π― Basic Usage
import { NEARProtocolRewardsSDK } from 'near-protocol-rewards';
const sdk = new NEARProtocolRewardsSDK({ projectId: 'your-project', nearAccount: 'your.near', githubRepo: 'org/repo', githubToken: process.env.GITHUB_TOKEN });
// Listen for metrics sdk.on('metrics:collected', (metrics) => { console.log('New metrics:', { github: { commits: metrics.github.commits.count, prs: metrics.github.pullRequests.merged, contributors: metrics.github.commits.authors.length }, near: { transactions: metrics.near.transactions.count, volume: metrics.near.transactions.volume, users: metrics.near.transactions.uniqueUsers.length } }); });
// Start tracking await sdk.startTracking();
π Features
GitHub Activity Tracking
- Commit frequency and quality
- Pull request activity
- Community engagement
- Author diversity metrics
NEAR Onchain Monitoring
- Transaction volume
- Contract usage
- User growth
- Price data integration
Automated Rewards
- Fair distribution based on metrics
- Transparent calculations
- Historical tracking
- Secure validation
π οΈ Beta Testing
We're currently in beta testing. To participate:
- Review the Beta Testing Guide
- Complete the Beta Testing Checklist
- Join our Discord for support
Prerequisites
- Node.js 16+
- PostgreSQL database
- GitHub account with API token
- NEAR testnet account
π» Development
Install dependencies
npm install
Run tests
npm test
Build
npm run build
π€ Contributing
Contributions are welcome! Please see our Contributing Guide.
π Resources
π License
MIT Β© NEAR Protocol
Discover More

NEAR Foundation
We raise awareness, support projects, and work to provide a clear path to decentralization on NEAR.

IPFS
A peer-to-peer hypermedia protocol to make the web faster, safer, and more open.

NOWNodes
Instant access to 65+ RPC nodes for all your Web3 development needs. Get an API key and start building!

Google Cloud
A suite of cloud computing services offering modular solutions including computing, data storage, analytics, and machine learning, complemented by management tools.

NEAR DevHub
DevHub brings together individuals, projects, and organizations to build a decentralized NEAR developer ecosystem. We provide social structure and tools to fuel innovation, collaboration, and community within the NEAR ecosystem.

Keypom
A suite of Web3 onboarding tools built on NEAR.