🖥️App Overview

Welcome to the official documentation for the ORNE (Orne) Decentralized Application (DApp). This comprehensive guide will help you understand and use all the features of the ORNE ecosystem.

Table of Contents

  1. Introduction

  2. Getting Started

  3. Dashboard

  4. Staking

  5. Carbon Offset Tracking

  6. Swap Interface

  7. Admin Panel

  8. Technical Specifications

  9. Security

  10. Troubleshooting

Introduction

The ORNE DApp is a comprehensive DeFi platform built on the Arbitrum network that combines traditional staking mechanics with innovative carbon offset tracking. The platform allows users to stake ORNE tokens, earn rewards, and contribute to environmental sustainability through carbon offset initiatives.

Key Features

  • Staking System: Stake ORNE tokens to earn rewards

  • Carbon Offset Tracking: Monitor your environmental impact

  • Swap Interface: Trade ORNE tokens on Uniswap V3

  • Real-time Analytics: Live price feeds and market data

  • Admin Management: Advanced features for platform administrators

  • Mobile Responsive: Optimized for all device types

Token Information

  • Token Name: ORNE

  • Token Symbol: ORNE

  • Network: Arbitrum

  • Total Supply: 100,000,000 ORNE

  • Contract Address: 0x89DbdB8e3b0e41aAe0871Bf9e1fcCe72F117bB1f

Getting Started

Prerequisites

Before using the ORNE DApp, ensure you have:

  1. Web3 Wallet: MetaMask, WalletConnect, or any compatible wallet

  2. Arbitrum Network: Your wallet must be connected to Arbitrum

  3. ORNE Tokens: Some ORNE tokens for staking or trading

  4. ETH: For transaction fees (gas costs)

Connecting Your Wallet

  1. Visit the ORNE DApp at app.orne.io

  2. Click the "Connect Wallet" button in the top-right corner

  3. Select your preferred wallet from the options

  4. Approve the connection request in your wallet

  5. Ensure you're connected to the Arbitrum network

Adding ORNE Token to Your Wallet

If ORNE doesn't appear in your wallet:

  1. Open your wallet

  2. Navigate to "Add Token" or "Import Token"

  3. Enter the ORNE contract address: 0x89DbdB8e3b0e41aAe0871Bf9e1fcCe72F117bB1f

  4. Confirm the token details and add it

Dashboard

The Dashboard provides a comprehensive overview of the ORNE ecosystem with real-time data and analytics.

Key Metrics

Price Information

  • $ORNE Price: Current token price in USD and WETH

  • Market Cap: Total market capitalization (circulating supply)

  • Total Market Cap: Market cap based on total supply

Token Statistics

  • Circulating $ORNE: Tokens available in circulation (not staked or held by admin)

  • Distributed $ORNE: Total rewards distributed to stakers

  • User Staking: Number of unique users currently staking

Staking Analytics

  • Staked $ORNE: Total amount of tokens currently staked

  • In Unstaking (Global): Total tokens in the unstaking process

Charts and Visualizations

The dashboard includes interactive charts showing:

  • Staking Evolution: Historical staking data with time period selectors (1d, 1w, 1m, 3m, 6m, 1y)

  • CO2 Offset Progress: Cumulative carbon offset achievements

  • Market Trends: Price and volume analytics

Real-time Updates

All dashboard data updates automatically every 60 seconds to ensure you have the latest information.

Staking

The staking system is the core feature of the ORNE DApp, allowing users to earn rewards while contributing to carbon offset initiatives.

How Staking Works

  1. Stake Tokens: Lock your ORNE tokens in the staking vault

  2. Earn Rewards: Receive additional ORNE tokens as staking rewards

  3. Carbon Offset: Your staked tokens contribute to environmental projects

  4. Compound Growth: Rewards can be reinvested for compound growth

Staking Interface

Your Balances

  • $ORNE Balance: Available tokens in your wallet

  • Staked Balance: Currently staked tokens

  • Rewards: Accumulated staking rewards

  • Unstaking: Tokens in the unstaking process

Staking Actions

Stake Tokens

  1. Enter the amount you want to stake

  2. Use quick buttons for common amounts:

    • Max: Stake your entire balance (minus gas fees)

    • 25%: Stake 25% of your balance

    • 50%: Stake 50% of your balance

    • 75%: Stake 75% of your balance

  3. Click "Stake" to confirm the transaction

  4. Approve the transaction in your wallet

Claim Rewards

  1. Check your accumulated rewards

  2. Click "Claim Rewards" to withdraw them

  3. Rewards are sent directly to your wallet

Unstake Tokens

  1. Request Unstaking: Initiate the unstaking process

    • Enter the amount to unstake

    • Use quick buttons for common amounts

    • Click "Request Unstake"

  2. Wait Period: 21-day waiting period (configurable by admin)

  3. Complete Unstaking: After the waiting period, click "Unstake" to withdraw

Cancel Unstaking

  • If you change your mind, you can cancel unstaking requests before the waiting period ends

Staking History

View your complete staking activity including:

  • Staking transactions

  • Reward claims

  • Unstaking requests

  • Completed unstaking

Staking Benefits

  • Passive Income: Earn rewards on your staked tokens

  • Environmental Impact: Contribute to carbon offset projects

  • Compound Growth: Reinvest rewards for exponential growth

  • Community Participation: Support the ORNE ecosystem

Carbon Offset Tracking

The Carbon Offset feature allows users to track their environmental impact and understand how their staking contributes to sustainability.

Your Carbon Impact

Personal Statistics

  • Your CO2 Offset: Total carbon offset from your staked tokens

  • CO2 per $ORNE: Current carbon offset rate per staked token

  • Staking Contribution: Your percentage of total staked tokens

Carbon Calculator

Use the built-in carbon footprint calculator to:

  1. Calculate Your Footprint: Input your daily activities

  2. Compare with Offset: See how your staking offsets your impact

  3. Track Progress: Monitor your environmental contribution over time

Calculator Categories

Transportation

  • Car usage (km/day)

  • Public transport usage

  • Flight frequency

  • Motorcycle usage

  • Bicycle usage

Energy Consumption

  • Electricity usage (kWh/month)

  • Heating consumption

  • Renewable energy usage

Diet

  • Vegan

  • Vegetarian

  • Mixed diet

  • Meat-heavy diet

Lifestyle

  • Shopping habits

  • Waste management

  • Clothing consumption

  • Electronics usage

Housing

  • Home size

  • Insulation quality

  • Appliance efficiency

Sharing Your Impact

Share your carbon offset achievements on social media:

  • Twitter/X Integration: One-click sharing with pre-filled content

  • Custom Messages: Personalized sharing options

  • Community Engagement: Connect with other environmentally conscious users

Environmental Projects

The carbon offset funds support various environmental initiatives:

  • Renewable energy projects

  • Reforestation efforts

  • Carbon capture technologies

  • Sustainable development projects

Swap Interface

The Swap interface provides seamless trading capabilities through Uniswap V3 integration.

Trading Features

Real-time Market Data

  • Current Price: Live ORNE/WETH price

  • Market Cap: Real-time market capitalization

  • Pooled Liquidity: Amount of tokens in the liquidity pool

  • Price Charts: Historical price data

Swap Functionality

  1. Connect Wallet: Ensure your wallet is connected

  2. Select Tokens: Choose ORNE and WETH trading pair

  3. Enter Amount: Specify the amount you want to trade

  4. Review Transaction: Check slippage and fees

  5. Confirm Swap: Execute the trade

Liquidity Provision

  • Add Liquidity: Provide liquidity to earn trading fees

  • Liquidity Management: Monitor and manage your liquidity positions

  • Fee Earnings: Track your earned trading fees

Trading Pairs

Currently supported trading pairs:

  • ORNE/WETH: Primary trading pair on Arbitrum

  • Additional pairs: May be added in the future

Trading Fees

  • Swap Fee: Standard Uniswap V3 fees apply

  • Gas Fees: Arbitrum network transaction costs

  • Slippage: Configurable slippage tolerance

Admin Panel

The Admin Panel provides advanced management capabilities for platform administrators.

Access Requirements

Admin panel access is restricted to authorized addresses. Contact the ORNE team for admin privileges.

Administrative Functions

CO2 Management

  • Add CO2: Increase the total carbon offset pool

  • CO2 History: View all CO2 addition transactions

  • Impact Tracking: Monitor environmental project funding

Rewards Management

  • Distribute Rewards: Add tokens to the rewards pool

  • Rewards History: Track all reward distribution transactions

  • Pool Management: Monitor and adjust reward rates

System Configuration

  • Unstaking Delay: Configure the unstaking waiting period

  • Current Settings: View active system parameters

  • Performance Metrics: Monitor platform statistics

Current Statistics

Real-time platform metrics:

  • Total Staked: Total tokens currently staked

  • CO2 per $ORNE: Current carbon offset rate

  • Total CO2: Cumulative carbon offset achieved

  • Active Stakers: Number of unique staking addresses

Technical Specifications

Smart Contracts

Core Contracts

  • ORNE Token: 0x89DbdB8e3b0e41aAe0871Bf9e1fcCe72F117bB1f

  • Staking Vault: V5 contract for staking operations

  • Rewards System: Automated reward distribution

  • Carbon Tracking: Environmental impact calculation

Contract Features

  • ERC-20 Standard: Compatible with all major wallets

  • Staking Mechanics: Time-locked staking with rewards

  • Unstaking Process: 21-day waiting period (configurable)

  • Reward Distribution: Automated reward calculations

  • Carbon Integration: Environmental impact tracking

Network Information

  • Blockchain: Arbitrum

  • Chain ID: 42161

  • RPC Endpoint: https://arb1.arbitrum.io/rpc

  • Block Explorer: https://arbiscan.io

API Endpoints

The DApp uses several API endpoints for data retrieval:

  • /api/global-stats: Global platform statistics

  • /api/user-stats/{address}: User-specific data

  • /api/history-staked: Staking history

  • /api/history-co2: Carbon offset history

  • /api/current-unstaking-delay: Unstaking configuration

Frontend Technology

  • Framework: React 18

  • Wallet Integration: RainbowKit + wagmi

  • Styling: CSS-in-JS with responsive design

  • Charts: Recharts for data visualization

  • State Management: React hooks and context

Security

Security Features

Smart Contract Security

  • Audited Contracts: All contracts undergo security audits

  • Time-locks: Unstaking delays prevent rapid withdrawals

  • Access Controls: Admin functions are properly restricted

  • Emergency Pauses: Ability to pause operations if needed

Frontend Security

  • HTTPS Only: All connections use secure protocols

  • Input Validation: All user inputs are validated

  • Transaction Confirmation: Multiple confirmation steps

  • Error Handling: Comprehensive error management

Wallet Security

  • Non-custodial: Users maintain full control of their funds

  • Private Key Protection: Never shared or stored

  • Transaction Signing: All transactions require user approval

  • Connection Security: Secure wallet connection protocols

Best Practices

For Users

  1. Verify URLs: Always use official app.orne.io

  2. Check Transactions: Review all transaction details

  3. Secure Wallet: Use hardware wallets for large amounts

  4. Regular Updates: Keep your wallet software updated

  5. Backup Recovery: Safely store your recovery phrases

For Developers

  1. Code Audits: Regular security reviews

  2. Dependency Updates: Keep all dependencies current

  3. Monitoring: Real-time security monitoring

  4. Incident Response: Prepared response procedures

Troubleshooting

Common Issues

Wallet Connection Problems

Problem: Wallet won't connect Solutions:

  • Ensure you're on Arbitrum network

  • Clear browser cache and cookies

  • Try refreshing the page

  • Check wallet extension status

Transaction Failures

Problem: Transactions fail or get stuck Solutions:

  • Check gas fees and increase if needed

  • Ensure sufficient token balance

  • Verify network connection

  • Wait for network congestion to clear

Staking Issues

Problem: Can't stake tokens Solutions:

  • Check token allowance and approve if needed

  • Ensure sufficient balance for gas fees

  • Verify you're not exceeding limits

  • Check if staking is currently enabled

Unstaking Problems

Problem: Can't unstake tokens Solutions:

  • Verify waiting period has passed

  • Check if unstaking is enabled

  • Ensure you have unstaking requests

  • Contact support if issues persist

Error Messages

"Insufficient Balance"

  • Check your ORNE token balance

  • Ensure you have ETH for gas fees

  • Verify you're not trying to stake more than you have

"Transaction Failed"

  • Check network congestion

  • Increase gas limit

  • Verify transaction parameters

  • Try again later

"Network Error"

  • Check your internet connection

  • Switch RPC endpoints

  • Clear browser cache

  • Try a different browser

Support

For additional support:

  • Documentation: This comprehensive guide

  • Community: Join ORNE community channels

  • Technical Support: Contact the development team

  • Bug Reports: Submit issues through official channels

Conclusion

The ORNE DApp represents a new paradigm in DeFi, combining traditional financial services with environmental sustainability. By staking ORNE tokens, users not only earn rewards but also contribute to meaningful carbon offset initiatives.

Key Takeaways

  1. Stake to Earn: Generate passive income through staking

  2. Environmental Impact: Contribute to carbon offset projects

  3. Community Participation: Join a sustainable DeFi ecosystem

  4. Security First: Built with security best practices

  5. User-Friendly: Intuitive interface for all experience levels

Future Developments

The ORNE ecosystem continues to evolve with planned features:

  • Additional trading pairs

  • Enhanced carbon tracking

  • Mobile application

  • Governance features

  • Expanded environmental projects

Stay updated with the latest developments by following ORNE on social media and joining the community.

This documentation is maintained by the ORNE development team. For the most current information, always refer to the official ORNE channels and announcements.

PreviousGreen Certificate

Last updated