Developer guide
OpenAsset is a permissionless lending protocol for isolated markets. Developers can build new markets and integrations around ERC-20s, NFTs, tokenized real-world assets, and other assets by selecting asset, oracle, compliance, liquidation, and position adapters.
The core engine retains loan state, accounting, circuit breakers, reentrancy protection, and defensive output checks. Adapters provide bounded integrations at an explicit trust boundary. A registry badge is not a substitute for on-chain validation or independent risk assessment.
What can you build?
| Goal | Start here |
|---|---|
| Launch an isolated market | Create a market |
| Add a new collateral type | Adapter system and adapter templates |
| Add a price source | Oracle adapters and the adapter specification |
| Add eligibility rules | Compliance boundary |
| Add a liquidation route | Liquidations |
| Represent loan ownership | Position adapters |
| Integrate registry and market data | Adapter registry |
Developer journey
- Understand: read the protocol overview, adapter system, and security model.
- Install: clone the repository, install
contractsandsdkdependencies, and compile locally. - Choose a starting point: use the reference adapters or generate an SDK scaffold.
- Implement: follow the adapter security model, including factory permissions, market isolation, fail-closed behavior, and non-upgradeable deployment.
- Test: use the local testing environment with mock assets, feeds, compliance, liquidation, failures, and gas checks.
- Submit: run automated checks, record the source commit and dependencies, register metadata, and follow the verification workflow.
Platform documentation map
- Market creation: Create a market and market risk boundaries.
- Adapter development: Adapter system, reference adapters, and quick start.
- SDK and local testing: Developer quick start and testing environment.
- Registry and verification: Adapter registry, trust model, and security checklist.
- Deployment and integration: Operations, multi-chain, and core contracts.
- Feedback: Developer feedback loop.
Existing page roles
The platform docs already contain conceptual pages for the adapter system, trust model, registry, oracles, liquidations, compliance, positions, and market creation. This guide does not replace them: it is the developer entry point that connects those pages into an actionable build path. The quick start provides commands; the conceptual pages explain protocol behavior and user risk.
Local commands
cd contracts
npm install
npm run compile
npx hardhat test
cd ../sdk
npm test
npm run pack:checkFor the complete path, continue to Developer quick start.