Build on MUSD
without rebuilding
the hard parts.

1. 1

   Install

   Add the core. The React hooks are a separate, optional package.

   npm pnpm yarn bun

   ⧉ Copy

   npm i @musd-kit/core
   # add @musd-kit/react for the hooks

2. 2

   Create a client

   Pass a viem public client. That is all the core needs to read.

   client.ts ⧉ Copy

   import { createMusdClient } from '@musd-kit/core'
   
   const musd = createMusdClient({ chainId: 31611, publicClient })

   Drop in the hooks

   No provider of its own. The hooks consume the wagmi context Passport already gives you.

   Position.tsx ⧉ Copy

   import { useTrove } from '@musd-kit/react'
   
   // inside your wagmi + Passport app, no provider of its own
   const { data: trove } = useTrove({ address })

3. 3

   Your first call

   Read live state. This is the same read the calculator in the hero runs.

   ⧉ Copy

   const price = await musd.getOraclePrice()
   const trove = await musd.getTrove(address)

   RETURNS

   price

   the live BTC/USD from Mezo's native oracle

   trove

   { collateral, entireDebt, icr, liquidationPrice, healthFactor }

   Your first call

   Read and write from a component, with typed errors.

   ⧉ Copy

   const { openTrove, isPending, error } = useOpenTrove()

   RETURNS

   trove

   the live position, refetched on each block

   error

   a typed MusdError you can branch on, like BelowMinimumDebt

Building a liquidation keeper? See the keeper example →