@cygnus-finance/sdk

TypeScript SDK for interacting with the Cygnus Finance protocol on Base.

Features

• cgUSD minting and redemption
• cgUSD ↔ wcgUSD wrapping/unwrapping
• Portfolio balance queries
• Rebase index tracking
• Full TypeScript support with viem

Installation

npm install @cygnus-finance/sdk viem

Quick Start

import { CygnusClient } from '@cygnus-finance/sdk'

const cygnus = new CygnusClient()

// Get portfolio summary
const portfolio = await cygnus.getPortfolioSummary('0x...')
console.log(`cgUSD: ${portfolio.cgUsd.formatted}`)
console.log(`wcgUSD: ${portfolio.wcgUsd.formatted}`)
console.log(`USDC: ${portfolio.usdc.formatted}`)

// Check rebase info
const rebaseIndex = await cygnus.getRebaseIndex()
const lastRebase = await cygnus.getLastRebaseTimestamp()

Write Operations

import { createWalletClient, http } from 'viem'
import { base } from 'viem/chains'
import { privateKeyToAccount } from 'viem/accounts'
import { CygnusClient } from '@cygnus-finance/sdk'

const account = privateKeyToAccount('0x...')
const wallet = createWalletClient({ account, chain: base, transport: http() })

const cygnus = new CygnusClient()
cygnus.setWallet(wallet)

// Mint cgUSD from USDC
await cygnus.approveUsdc(parseUnits('1000', 6) // USDC is 6 decimals, cgUSD is also 6 decimals)
await cygnus.mintCgUsd(parseUnits('1000', 6) // USDC is 6 decimals, cgUSD is also 6 decimals)

// Wrap cgUSD → wcgUSD
await cygnus.approveCgUsdForWrap()
await cygnus.wrapCgUsd(parseUnits('500', 6))

// Unwrap wcgUSD → cgUSD
await cygnus.unwrapWcgUsd(parseUnits('500', 6))

// Redeem cgUSD → USDC
await cygnus.redeemCgUsd(parseUnits('200', 6))

Contract Addresses

| Contract | Address | |----------|---------| | cgUSD | 0xCa72827a3D211CfD8F6b00Ac98824872b72CAb49 | | wcgUSD | 0x0Ce45dd53affbb011884EF1866E0738f58AB7969 | | CGN | 0x2e6c4bd1c947e195645d2b920b827498cfaa6766 | | USDC (Base) | 0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913 |

Links

• Cygnus Finance
• Documentation
• Twitter

License

MIT