Overview
Build on Gearbox Protocol. Choose your path based on how you'll integrate.
Choose Your Path
SDK Guide (TypeScript)
Best for: Frontend developers, bot builders, analytics dashboards
The SDK provides typed access to Gearbox protocol state and operations. It wraps contract calls, handles encoding, and provides cached market data.
- Read market state via
marketRegister - Query credit accounts via services
- Build multicalls with helpers
- No Solidity knowledge required
Solidity Guide
Best for: Smart contract developers, on-chain integrators, adapter builders
Integrate directly with Gearbox contracts from your Solidity code.
- Discover contracts via AddressProvider
- Call CreditFacade operations
- Build multicalls in Solidity
- Build custom adapters
Reference
- Concepts - Architecture explanations (no code)
- Compressors - Data aggregation contracts
- Automated Insurance - Protocol safety mechanisms
- Interest Rate Model - Utilization curves and rates
- Quota Keeper - Collateral exposure limits
Quick Links
| Need | Go to |
|---|---|
| Install SDK | SDK Setup |
| Find contract addresses | Credit Accounts |
| Understand Credit Suite | Credit Suite Concepts |
| Build multicalls | SDK Multicalls or Solidity Multicalls |
| Query credit accounts | SDK Credit Accounts |
| Pool deposit/withdraw | Pool Operations |