Integrators Guide

​

Points API Integration

​

API Overview

​

Core Endpoints

​

User Points & Rewards

GET /points/{address}

{
  "address": "neutron1...",
  "total_points": 1500000,
  "current_epoch_points": 500000,
  "projected_rewards_usd": 125.50,
  "boost_multiplier": 1.5,
  "last_updated": "2024-01-15T10:30:00Z"
}

​

Campaign Status

GET /campaign/status

{
  "current_epoch": 1,
  "epoch_start": "2024-01-01T00:00:00Z",
  "epoch_end": "2024-03-01T00:00:00Z",
  "total_budget_usd": 250000,
  "total_participants": 1250,
  "total_tvl_usd": 5000000
}

​

Eligible Positions

GET /positions/{address}

{
  "positions": [
    {
      "protocol": "amber",
      "asset": "wBTC",
      "type": "lending",
      "value_usd": 50000,
      "eligible": true
    }
  ]
}

​

Asset Issuer Integration

​

Overview for BTC LST Issuers

• Track performance of their assets in the campaign
• Provide additional rewards to their users
• Gain exposure to Neutron’s DeFi ecosystem

​

Integration Requirements

​

Technical Requirements

• Asset bridging: Support for IBC transfers to Neutron
• Oracle integration: Price feeds for accurate valuation
• Protocol compatibility: Integration with Amber/Supervaults

​

Partnership Process

1. Initial contact: Reach out through official channels
2. Technical review: Asset compatibility assessment
3. Integration planning: Timeline and requirements discussion
4. Testing phase: Sandbox environment testing
5. Production deployment: Live integration and monitoring

​

Asset Performance Tracking

GET /assets/{asset_denom}/performance

{
  "asset": "ibc/LBTC_DENOM",
  "total_deposits_usd": 1500000,
  "active_participants": 450,
  "avg_deposit_size_usd": 3333,
  "reward_distribution_usd": 15000,
  "epoch_performance": {
    "yield_generated": 0.12,
    "campaign_rewards": 0.08
  }
}

​

Partnership Integration

​

Revenue Sharing Framework

• TVL generated: Percentage of total value locked through partnership
• User acquisition: Rewards for bringing new participants
• Technical integration: Compensation for development work

• Monthly settlements in NTRN or USDC
• Performance-based bonuses for milestone achievements
• Long-term partnership incentives

​

Partnership Requirements

​

Technical Capabilities

• Frontend development: Ability to build user interfaces
• Smart contract integration: Understanding of DeFi protocols
• Cross-chain coordination: Support for multi-network users

​

Business Requirements

• User base: Existing community or user acquisition capability
• Compliance: Appropriate regulatory framework
• Support capacity: Ability to provide user support

​

Partnership Opportunities

1. Frontend Partners: Build alternative interfaces for campaign participation
2. Wallet Integrations: Native campaign support in wallet applications
3. Asset Issuers: BTC LST providers wanting deeper integration
4. Protocol Partners: DeFi protocols wanting to collaborate on strategies

​

Frontend Integration Patterns

​

Wallet Connection Handling

// Handle multi-wallet scenarios
const handleWalletConnection = async () => {
  const ethWallet = await connectEthereumWallet();
  const neutronWallet = await connectNeutronWallet();
  
  // Check for address conflicts
  const conflicts = await checkAddressConflicts(ethWallet, neutronWallet);
  
  if (conflicts.length > 0) {
    // Display conflict resolution UI
    showConflictResolution(conflicts);
  }
};

​

Boost Coordination UI

// Boost pointing interface
const BoostPointingComponent = ({ userAddresses, deposits }) => {
  const [targetAddress, setTargetAddress] = useState(null);
  
  // Validate boost target matches deposit address
  const validateBoostTarget = (target) => {
    return deposits.some(deposit => deposit.address === target);
  };
  
  return (
    <BoostSelector 
      addresses={userAddresses}
      onSelect={setTargetAddress}
      validator={validateBoostTarget}
    />
  );
};

​

Error Handling Patterns

// Common error scenarios
const handleCampaignErrors = (error) => {
  switch (error.type) {
    case 'BOOST_ADDRESS_MISMATCH':
      return 'Boost must point to address with deposits';
    case 'INSUFFICIENT_NTRN':
      return 'Not enough NTRN for locking';
    case 'CROSS_CHAIN_CONFLICT':
      return 'Multiple wallets detected, please use one';
    default:
      return 'Unknown error occurred';
  }
};

​

Testing & Development

​

Sandbox Environment

• Neutron testnet endpoints for development
• Test NTRN tokens for testing boost mechanisms
• Mock vault contracts for integration testing

• Single wallet connection (Ethereum only, Neutron only)
• Multi-wallet scenarios with conflicts
• Boost pointing and address linking
• Reward calculation verification

​

Development Resources

• Neutron Developer Documentation
• Smart Contract Tutorials
• SDK and Tools
• Integration Examples

• GitHub repository with campaign-specific examples
• Smart contract ABIs and interfaces
• Integration best practices guide

​

Smart Contract Integration

​

Key Contracts

interface IPointsContract {
    function getUserPoints(address user) external view returns (uint256);
    function getCurrentEpoch() external view returns (uint256);
    function getRewardProjection(address user) external view returns (uint256);
}

interface IBoostPointer {
    function pointBoost(address target) external;
    function getBoostTarget(address user) external view returns (address);
    function getBoostMultiplier(address user) external view returns (uint256);
}

​

Integration Examples

const getUserCampaignData = async (userAddress) => {
  const points = await pointsContract.getUserPoints(userAddress);
  const boost = await boostContract.getBoostMultiplier(userAddress);
  const projection = await pointsContract.getRewardProjection(userAddress);
  
  return { points, boost, projection };
};

​

Support & Resources

​

Technical Support

• Discord: Neutron Developer Channel
• Email: [Developer contact information will be provided]
• Documentation: Complete technical reference available

• Business development: [Partnership contact information will be provided]
• Strategic partnerships: Focus on mutual value creation
• Technical partnerships: Integration and development collaboration

​

Additional Resources

​

Integration Checklist

​

Before Going Live

• API integration tested in sandbox environment
• Error handling implemented for all scenarios
• Cross-chain coordination properly handled
• User experience tested with real wallets
• Security review completed
• Performance optimization verified

​

Launch Requirements

• Production API access configured
• Monitoring and alerting set up
• User support documentation prepared
• Rollback procedures established
• Partnership agreements finalized