Documentation
Comprehensive technical documentation and guides for using the Reef Coin AI platform.
Getting Started
Welcome to the Reef Coin AI documentation. This comprehensive guide will help you understand how to use our platform to stake SOL, earn rewards, and contribute to ocean conservation efforts.
Prerequisites
- A Solana wallet (Phantom, Solflare, Backpack, or Glow)
- SOL tokens for staking (minimum 5 SOL required)
- Basic understanding of blockchain transactions
- Web browser with wallet extension installed
System Requirements
- Modern web browser (Chrome, Firefox, Safari, Edge)
- Stable internet connection
- Wallet extension enabled and configured
- Sufficient SOL balance for transactions and staking
Wallet Setup Guide
Installing a Solana Wallet
Phantom Wallet (Recommended)
- Visit
phantom.app
and click "Download" - Install the browser extension for your preferred browser
- Create a new wallet or import an existing one using your seed phrase
- Set a strong password and store your seed phrase securely
- Fund your wallet with SOL from a centralized exchange
Alternative Wallets
- Solflare: Advanced features and hardware wallet support
- Backpack: Modern interface with built-in DeFi features
- Glow: Mobile-first design with desktop extension
Wallet Security Best Practices
⚠️ Security Warning
- Never share your seed phrase with anyone
- Store your seed phrase offline in a secure location
- Use a hardware wallet for large amounts
- Always verify transaction details before signing
- Be cautious of phishing websites and fake applications
Staking Guide
Step-by-Step Staking Process
- Connect Your Wallet
Navigate to the staking page and click "Connect Wallet". Select your wallet provider and approve the connection request. Ensure you're on the correct network (Solana Mainnet).
- Choose Staking Amount
Enter the amount of SOL you wish to stake. The minimum requirement is 5 SOL. You can click "Max" to stake your entire available balance minus transaction fees.
- Review Staking Details
Review the estimated annual rewards, conservation contribution, and lock period. Ensure all details are correct before proceeding.
- Confirm Transaction
Click "Stake SOL" and confirm the transaction in your wallet. The transaction will be processed on the Solana blockchain, typically taking 1-2 seconds.
- Track Your Stake
Once confirmed, your stake will appear in the "Active Stakes" section. You can monitor your rewards and conservation impact through the dashboard.
Understanding Rewards
SOL Staking Rewards
- Native Solana staking rewards: 5-7% APY
- Paid in SOL tokens
- Distributed automatically every epoch (~2 days)
- Compounding rewards increase over time
REEF Token Rewards
- Additional platform rewards: 3-5% APY
- Paid in REEF tokens
- Used for governance and platform features
- Tradeable on supported DEX platforms
Unstaking Process
Unstaking your SOL involves a cooldown period due to Solana's staking mechanism:
- Navigate to your dashboard and click "Unstake SOL"
- Enter the amount you wish to unstake
- Confirm the unstaking transaction
- Wait for the cooldown period (typically 2-3 days)
- Claim your unstaked SOL once the cooldown is complete
Note: During the cooldown period, your SOL will not earn staking rewards. Plan your unstaking accordingly.
Conservation Impact Tracking
How Conservation Funding Works
15% of all SOL staking rewards are automatically allocated to verified ocean conservation projects. This creates a sustainable funding stream that grows with the platform while requiring no additional cost from users.
Funding Allocation Process
- Staking rewards are earned from Solana validators
- 15% is automatically transferred to the conservation fund
- Funds are distributed to active conservation projects
- Project impact is tracked and reported in real-time
- Community votes on new project funding priorities
Project Verification Process
Initial Vetting
- Scientific review of project methodology
- Financial audit of organization
- Environmental impact assessment
- Local community consultation
- Regulatory compliance verification
Ongoing Monitoring
- Monthly progress reports
- Satellite imagery analysis
- Third-party impact verification
- Financial transparency audits
- Community feedback collection
Impact Metrics
Quantitative Metrics
- Square meters of reef restored
- Tons of plastic removed from oceans
- Number of marine species protected
- Carbon sequestration achieved
- Water quality improvements
Qualitative Metrics
- Ecosystem health improvements
- Biodiversity recovery rates
- Community engagement levels
- Scientific research contributions
- Long-term sustainability indicators
API Documentation
REST API Overview
Our REST API allows developers to integrate with the Reef Coin AI ecosystem and access staking data, conservation metrics, and project information programmatically.
Base URL
https://api.reefcoin.ai/v1
Authentication
API requests require authentication using API keys:
Authorization: Bearer YOUR_API_KEY
Core Endpoints
Get Staking Statistics
GET /staking/stats
Returns global staking statistics and APY information.
Example Response
{
"totalStaked": "1250000.50",
"totalStakers": 15420,
"currentAPY": 10.5,
"conservationFunded": "187500.075"
}
Get User Staking Data
GET /staking/user/{wallet_address}
Returns staking information for a specific wallet address.
Example Response
{
"walletAddress": "7xKC...gAsU",
"totalStaked": "125.50",
"rewardsEarned": "8.75",
"conservationContribution": "1.31",
"stakingDuration": "45 days"
}
Get Conservation Projects
GET /conservation/projects
Returns list of active conservation projects and their funding status.
Example Response
{
"projects": [
{
"id": "gbr-restoration-2",
"name": "Great Barrier Reef Restoration Initiative - Phase 2",
"location": "Australia",
"fundingGoal": "500000",
"currentFunding": "335000",
"progress": 67,
"impact": "1200 m² restored"
}
]
}
SDK Integration
JavaScript SDK Installation
npm install @reefcoin/sdk
Quick Start Example
import { ReefCoinSDK } from '@reefcoin/sdk';
const sdk = new ReefCoinSDK({
apiKey: 'YOUR_API_KEY',
network: 'mainnet'
});
// Get staking statistics
const stats = await sdk.getStakingStats();
console.log('Current APY:', stats.currentAPY);
// Get user staking data
const userData = await sdk.getUserStaking('wallet_address');
console.log('Total Staked:', userData.totalStaked);
// Get conservation projects
const projects = await sdk.getConservationProjects();
console.log('Active Projects:', projects.length);
Smart Contract Integration
Contract Addresses
Staking Contract
5xjPzMRJHnNPMQfRJ8LMjMJULbQu6nMM1xzuQGYwwd7q
REEF Token Contract
7kbnvuGBxxj8AG9qp8Scn56muWGaRaFqxg1FsRp3PaFT
Conservation Fund Contract
9mKpQr4VnJkLmNqPwXzBvGhF2sT8uE3wRyDcAx6vHj2L
Governance Contract
3nBvFgHpQwXmKzYtRjCx8sL9uE2wPyDcAx6vHj2L4mKp
Direct Contract Interaction
Staking SOL Example
import { Connection, PublicKey, Transaction } from '@solana/web3.js';
import { Program, AnchorProvider } from '@project-serum/anchor';
const connection = new Connection('https://api.mainnet-beta.solana.com');
const stakingProgramId = new PublicKey('5xjPzMRJHnNPMQfRJ8LMjMJULbQu6nMM1xzuQGYwwd7q');
// Create staking transaction
const stakeAmount = 10; // 10 SOL
const transaction = await program.methods
.stake(new BN(stakeAmount * LAMPORTS_PER_SOL))
.accounts({
user: wallet.publicKey,
stakingAccount: stakingAccountPDA,
systemProgram: SystemProgram.programId,
})
.transaction();
// Sign and send transaction
const signature = await wallet.sendTransaction(transaction, connection);
await connection.confirmTransaction(signature);
Troubleshooting
Common Issues
Wallet Connection Issues
- Ensure wallet extension is installed and enabled
- Check that you're on the Solana Mainnet network
- Try refreshing the page and reconnecting
- Clear browser cache and cookies if issues persist
Transaction Failures
- Ensure sufficient SOL balance for transaction fees
- Check network congestion and try again later
- Verify minimum staking amount (5 SOL) is met
- Confirm transaction details before signing
Rewards Not Appearing
- Rewards are distributed every epoch (~2 days)
- Check the dashboard for pending rewards
- Ensure your stake has been active for at least one epoch
- Contact support if rewards are missing after 48 hours
Support Resources
Community Support
- Discord community server
- Telegram support group
- Reddit community discussions
- GitHub issues and discussions
Official Support
- Email: support@reefcoin.ai
- Help desk ticket system
- Video tutorials and guides
- FAQ and knowledge base
Security Best Practices
🔒 Security Guidelines
Wallet Security
- Never share your private keys or seed phrase
- Use hardware wallets for large amounts
- Enable two-factor authentication where available
- Regularly update your wallet software
Transaction Safety
- Always verify contract addresses before interacting
- Double-check transaction details before signing
- Start with small amounts when testing
- Be cautious of phishing websites and fake applications
Platform Security
- Only use the official Reef Coin AI website
- Verify SSL certificates and domain authenticity
- Report suspicious activity immediately
- Keep your browser and extensions updated