NEAR Protocol Rewards SDK
A transparent, metric-based rewards system for NEAR projects that directly ties incentives to development activity and user adoption.
What is NEAR Protocol Rewards SDK?Inactive
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
Socials
Discover More
Collab.land
Collab.Land empowers developers with its Discord bot for deploying miniapps and APIs for custom functionalities like website token gating, enhancing project reach and functionality with easy integration and extensive resources.
NEAR Foundation
We raise awareness, support projects, and work to provide a clear path to decentralization on NEAR.
Proximity Labs
Empowering DeFi on NEAR and Aurora.
Fast Near
FASTNEAR provides several APIs to interact with the NEAR Protocol.
IPFS
A peer-to-peer hypermedia protocol to make the web faster, safer, and more open.
Dune Analytics
Query, visualize, share and export data across 26+ blockchains — build together with Web3’s biggest data community