Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

SDKs

Three TypeScript packages, one for each side of the market. All three are on npm and hold no keys: your users' wallets sign.

I want toDocsnpm
Offer a credit line against BTCBorrow SDK@surgecredit/borrow-sdk
Offer yield on USDCEarn SDK@surgecredit/earn-sdk
Bid on liquidated BTC collateralAuction SDK@surgecredit/auction-sdk

Install with viem, for example:

npm install @surgecredit/borrow-sdk viem

Not using TypeScript

Earn and auctions can be integrated with direct contract calls on Base: see Earn Contracts and Auction Contracts.

Testing

Each SDK takes a network: "mainnet" (Bitcoin and Base) or "signet" (Surge's custom signet and Base Sepolia). See Testing on signet before you start.

Using these docs with an AI tool