@cygnusfi/sdk

Lightweight read-only SDK for Cygnus Finance on Base. Query protocol state, balances, and exchange rates.

Installation

npm install @cygnusfi/sdk viem

Usage

import { CygnusReader } from '@cygnusfi/sdk'

const reader = new CygnusReader()

// Protocol state
const state = await reader.getProtocolState()
console.log(state.totalSupply)      // e.g. "76202633.80595"
console.log(state.exchangeRate)     // e.g. 1.221725
console.log(state.canDeposit)       // true or false

// User balances
const balance = await reader.getBalance('0x...')
console.log(balance.cgUsd.formatted)  // e.g. "1000.5"
console.log(balance.wcgUsd.formatted) // e.g. "500.25"

// Exchange rate
const rate = await reader.getExchangeRate()

Formatting

import { formatCgUsd, parseCgUsd } from '@cygnusfi/sdk'

formatCgUsd(76202633805950n) // "76202633.80595"
parseCgUsd("100.5")          // 100500000n

Contracts (Base)

| Token | Address | Decimals | |-------|---------|----------| | cgUSD | 0xCa72827a3D211CfD8F6b00Ac98824872b72CAb49 | 6 | | wcgUSD | 0x5AE84075F0E34946821A8015dAB5299A00992721 | 6 | | CGN | 0x2e6c4bd1c947e195645d2b920b827498cfaa6766 | 18 |

License

MIT