> For the complete documentation index, see [llms.txt](https://docs.liquyn.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.liquyn.com/readme.md).

# Liquyn Credit

Liquyn is a HyperEVM credit desk for USDC loans secured by HYPE collateral. The first release has two products: borrower-issued fixed-term notes and a shared liquidity pool.

## Local development

* Node.js 24 or newer
* `npm ci`
* `npm run dev`

Credit transaction controls remain unavailable until the contract addresses are configured, the owner sets risk parameters, and the configured HYPE oracle reports a fresh price. Configure public addresses in the Vercel project and `NEXT_PUBLIC_CREDIT_FACTORY_ADDRESS`, `NEXT_PUBLIC_CREDIT_POOL_ADDRESS`, `NEXT_PUBLIC_USDC_TOKEN_ADDRESS`, `NEXT_PUBLIC_WHYPE_ADDRESS` and `NEXT_PUBLIC_HYPEREVM_RPC_URL` in the runtime environment.

## Checks and deployment

* `npm run type-check`
* `npm run lint`
* `npm test`
* `npm run build`
* `npm run deploy:hyperevm` (requires token addresses, owner, price updater and a funded deployer)

The deployment script appends the credit oracle, note factory and pool to `deployments.json` without replacing historical deployment records. See `docs/production-deployment-guide.md` for the preserved deployment procedure.

The UI and contracts are an implementation starting point. Review oracle operations, parameter values, liquidation incentives and contract security before enabling or funding a live market.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.liquyn.com/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
