Levr Docs

Appearance

getProject() ​

Get complete project data including treasury stats, staking stats, governance stats, and USD pricing. Requires static project data.

Usage ​

typescript
import { getProject, getStaticProject } from 'levr-sdk'
import { createPublicClient, http } from 'viem'
import { base } from 'viem/chains'

const publicClient = createPublicClient({
  chain: base,
  transport: http(),
})

const oracleClient = createPublicClient({
  chain: base, // Can use same chain or different for oracle
  transport: http(),
})

// 1. Get static data (cache this!)
const staticProject = await getStaticProject({
  publicClient,
  clankerToken: '0x...',
  userAddress: '0x...', // Optional: for areYouAnAdmin in fee receivers
})

if (!staticProject) {
  console.log('Project not found or not registered')
  return
}

// 2. Get dynamic data (refetch this regularly)
const projectData = await getProject({
  publicClient,
  staticProject,
  oraclePublicClient: oracleClient, // Optional: for USD pricing
})

if (!projectData) {
  console.log('Error fetching dynamic data')
  return
}

console.log('Token:', projectData.token.name)
console.log('Treasury Balance:', projectData.treasuryStats?.balance.formatted)
console.log('Token Price:', projectData.pricing?.tokenUsd, 'USD')
console.log('Current Cycle:', projectData.governanceStats?.currentCycleId.toString())
console.log('Total Staked:', projectData.stakingStats?.totalStaked.formatted)

// Check fee splitter status
if (projectData.feeSplitter?.isActive) {
  console.log('Fee splitter active with', projectData.feeSplitter.splits.length, 'recipients')
  console.log('Pending fees:', projectData.feeSplitter.pendingFees)
}

Parameters ​

  • publicClient (required): Viem public client
  • staticProject (required): Static project data from getStaticProject()
  • oraclePublicClient (optional): Client for USD pricing oracle

Returns ​

Returns Project | null (null if project not registered)

typescript
{
  chainId: number

  // Contract Addresses
  treasury: `0x${string}`
  governor: `0x${string}`
  staking: `0x${string}`
  stakedToken: `0x${string}`
  forwarder: `0x${string}`
  factory: `0x${string}`

  // Token Info
  token: {
    address: `0x${string}`
    name: string
    symbol: string
    decimals: number
    totalSupply: bigint
    metadata: ProjectMetadata | null
    imageUrl?: string
    originalAdmin: `0x${string}`
    admin: `0x${string}`
    context: string
  }

  // Pool Info
  pool?: {
    poolKey: PoolKey
    feeDisplay: string
    numPositions: bigint
  }

  // Treasury Stats
  treasuryStats?: {
    balance: BalanceResult
    totalAllocated: BalanceResult
    utilization: number
  }

  // Staking Stats (pool-level)
  stakingStats?: {
    totalStaked: BalanceResult
    apr: {
      token: { raw: bigint, percentage: number }
      weth: { raw: bigint, percentage: number } | null
    }
    outstandingRewards: {
      staking: { available: BalanceResult, pending: BalanceResult }
      weth: { available: BalanceResult, pending: BalanceResult } | null
    }
    rewardRates: {
      token: BalanceResult
      weth: BalanceResult | null
    }
  }

  // Governance Stats
  governanceStats?: {
    currentCycleId: bigint
    activeProposalCount: {
      boost: bigint
      transfer: bigint
    }
  }

  // Fee Receivers
  feeReceivers?: Array<{
    areYouAnAdmin: boolean
    admin: `0x${string}`
    recipient: `0x${string}`
    percentage: number
    feePreference?: FeePreference
  }>

  // Fee Splitter
  feeSplitter?: {
    // Static data
    isConfigured: boolean
    isActive: boolean
    splits: Array<{ receiver: `0x${string}`, bps: number }>
    totalBps: number
    // Dynamic data (if active)
    pendingFees?: {
      token: bigint
      weth: bigint | null
    }
  }

  // Pricing (dynamic data, fetched if oraclePublicClient provided)
  pricing?: {
    wethUsd: string
    tokenUsd: string
  }
}

What's Included ​

getProject() returns static + dynamic data:

Static data (from staticProject):

  • Contract addresses (treasury, governor, staking, etc.)
  • Token info (name, symbol, decimals, total supply)
  • Pool info (poolKey, fee display, positions)
  • Fee receivers
  • Fee splitter configuration (isConfigured, isActive, splits, totalBps)

Dynamic data (fetched fresh):

  • Treasury stats (balance, utilization)
  • Staking stats (total staked, APR, rewards)
  • Governance stats (cycle ID, active proposals)
  • Pricing (USD prices if oracle client provided)
  • Fee splitter pending fees (if active)

Not included:

  • ❌ Airdrop status - Use getAirdropStatus() separately