{"_id":"@cygnus-finance/sdk","_rev":"2-059a8eafb1016b7aa15867b7356fe2f8","name":"@cygnus-finance/sdk","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"name":"@cygnus-finance/sdk","version":"0.1.0","keywords":["cygnus","cgUSD","wcgUSD","defi","stablecoin","rwa","base","sdk"],"author":{"name":"Cygnus Finance"},"license":"MIT","_id":"@cygnus-finance/sdk@0.1.0","maintainers":[{"name":"awugochogabriel","email":"awugochogabriel@gmail.com"}],"homepage":"https://cygnus.finance","bugs":{"url":"https://github.com/cygnus-finance/sdk/issues"},"dist":{"shasum":"3981c17369ca679cfd48fd555ea9cc7573331f1c","tarball":"https://registry.npmjs.org/@cygnus-finance/sdk/-/sdk-0.1.0.tgz","fileCount":5,"integrity":"sha512-8gJbUPYGMqRNwsaLdnprTm3ituWPvggWZw0K9ztXljhvva8fxKzByEAYL684KMO4GrX2OaqsbMdh/TZLSXi5dw==","signatures":[{"sig":"MEUCIEkR0Cs5hqYFizjjONSSP7vprSq5lSAM3wwdv0Yfe8NpAiEA0hF+MxfNy9e1/mhvlM+tgrtHzSZg+paOeiiQfDr8weE=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":37390},"main":"dist/index.js","types":"dist/index.d.ts","module":"dist/index.mjs","engines":{"node":">=18"},"scripts":{"dev":"tsup src/index.ts --format cjs,esm --dts --watch","lint":"eslint src/","build":"tsup src/index.ts --format cjs,esm --dts","typecheck":"tsc --noEmit"},"_npmUser":{"name":"awugochogabriel","email":"awugochogabriel@gmail.com"},"repository":{"url":"git+https://github.com/cygnus-finance/sdk.git","type":"git"},"_npmVersion":"10.9.8","description":"TypeScript SDK for interacting with Cygnus Finance protocol — cgUSD minting, wrapping, bridging, and staking","directories":{},"_nodeVersion":"22.23.1","dependencies":{"viem":"^2.0.0"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.0.0","typescript":"^5.4.0","@types/node":"^20.0.0"},"peerDependencies":{"viem":">=2.0.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.1.0_1786447606264_0.45516563945151023","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@cygnus-finance/sdk","version":"0.1.1","description":"TypeScript SDK for interacting with Cygnus Finance protocol — cgUSD minting, wrapping, bridging, and staking","main":"dist/index.js","module":"dist/index.mjs","types":"dist/index.d.ts","scripts":{"build":"tsup src/index.ts --format cjs,esm --dts","dev":"tsup src/index.ts --format cjs,esm --dts --watch","lint":"eslint src/","typecheck":"tsc --noEmit"},"keywords":["cygnus","cgUSD","wcgUSD","defi","stablecoin","rwa","base","sdk"],"author":{"name":"Cygnus Finance"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/cygnus-finance/sdk.git"},"homepage":"https://cygnus.finance","dependencies":{"viem":"^2.0.0"},"devDependencies":{"tsup":"^8.0.0","typescript":"^5.4.0","@types/node":"^20.0.0"},"peerDependencies":{"viem":">=2.0.0"},"engines":{"node":">=18"},"_id":"@cygnus-finance/sdk@0.1.1","bugs":{"url":"https://github.com/cygnus-finance/sdk/issues"},"_nodeVersion":"22.23.1","_npmVersion":"10.9.8","dist":{"integrity":"sha512-35zuw8YOjojqOCwIM0yfdhuXJSJXcLXy42BuD3Df2fiXvMOWKF2Gp0wh2wweR63Y0zyLeA8AmoAY+j5DFAgaIw==","shasum":"7f57161a55cb2c245c689f7b48157caf419ab389","tarball":"https://registry.npmjs.org/@cygnus-finance/sdk/-/sdk-0.1.1.tgz","fileCount":5,"unpackedSize":37778,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDW3osxftUGpGlqojvWVpFSuT7/HE2zWyvEXwZt2Q6ucwIhAP0ErRONz7vNOcDTI8GuDdc4tWN+WrX4ZkkKy0nT9Xma"}]},"_npmUser":{"name":"awugochogabriel","email":"awugochogabriel@gmail.com"},"directories":{},"maintainers":[{"name":"awugochogabriel","email":"awugochogabriel@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/sdk_0.1.1_1786449281182_0.32654403624748607"},"_hasShrinkwrap":false}},"time":{"created":"2026-08-11T11:26:46.022Z","modified":"2026-08-11T11:54:41.562Z","0.1.0":"2026-08-11T11:26:46.397Z","0.1.1":"2026-08-11T11:54:41.325Z"},"bugs":{"url":"https://github.com/cygnus-finance/sdk/issues"},"author":{"name":"Cygnus Finance"},"license":"MIT","homepage":"https://cygnus.finance","keywords":["cygnus","cgUSD","wcgUSD","defi","stablecoin","rwa","base","sdk"],"repository":{"type":"git","url":"git+https://github.com/cygnus-finance/sdk.git"},"description":"TypeScript SDK for interacting with Cygnus Finance protocol — cgUSD minting, wrapping, bridging, and staking","maintainers":[{"name":"awugochogabriel","email":"awugochogabriel@gmail.com"}],"readme":"# @cygnus-finance/sdk\n\nTypeScript SDK for interacting with the [Cygnus Finance](https://cygnus.finance) protocol on Base.\n\n## Features\n\n- cgUSD minting and redemption\n- cgUSD ↔ wcgUSD wrapping/unwrapping\n- Portfolio balance queries\n- Rebase index tracking\n- Full TypeScript support with viem\n\n## Installation\n\n```bash\nnpm install @cygnus-finance/sdk viem\n```\n\n## Quick Start\n\n```typescript\nimport { CygnusClient } from '@cygnus-finance/sdk'\n\nconst cygnus = new CygnusClient()\n\n// Get portfolio summary\nconst portfolio = await cygnus.getPortfolioSummary('0x...')\nconsole.log(`cgUSD: ${portfolio.cgUsd.formatted}`)\nconsole.log(`wcgUSD: ${portfolio.wcgUsd.formatted}`)\nconsole.log(`USDC: ${portfolio.usdc.formatted}`)\n\n// Check rebase info\nconst rebaseIndex = await cygnus.getRebaseIndex()\nconst lastRebase = await cygnus.getLastRebaseTimestamp()\n```\n\n## Write Operations\n\n```typescript\nimport { createWalletClient, http } from 'viem'\nimport { base } from 'viem/chains'\nimport { privateKeyToAccount } from 'viem/accounts'\nimport { CygnusClient } from '@cygnus-finance/sdk'\n\nconst account = privateKeyToAccount('0x...')\nconst wallet = createWalletClient({ account, chain: base, transport: http() })\n\nconst cygnus = new CygnusClient()\ncygnus.setWallet(wallet)\n\n// Mint cgUSD from USDC\nawait cygnus.approveUsdc(parseUnits('1000', 6) // USDC is 6 decimals, cgUSD is also 6 decimals)\nawait cygnus.mintCgUsd(parseUnits('1000', 6) // USDC is 6 decimals, cgUSD is also 6 decimals)\n\n// Wrap cgUSD → wcgUSD\nawait cygnus.approveCgUsdForWrap()\nawait cygnus.wrapCgUsd(parseUnits('500', 6))\n\n// Unwrap wcgUSD → cgUSD\nawait cygnus.unwrapWcgUsd(parseUnits('500', 6))\n\n// Redeem cgUSD → USDC\nawait cygnus.redeemCgUsd(parseUnits('200', 6))\n```\n\n## Contract Addresses\n\n| Contract | Address |\n|----------|---------|\n| cgUSD | `0xCa72827a3D211CfD8F6b00Ac98824872b72CAb49` |\n| wcgUSD | `0x0Ce45dd53affbb011884EF1866E0738f58AB7969` |\n| CGN | `0x2e6c4bd1c947e195645d2b920b827498cfaa6766` |\n| USDC (Base) | `0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913` |\n\n## Links\n\n- [Cygnus Finance](https://cygnus.finance)\n- [Documentation](https://wiki.cygnus.finance)\n- [Twitter](https://x.com/CygnusFi)\n\n## License\n\nMIT\n","readmeFilename":"README.md"}