Documentation snapshot

README 快照

本页保存的是公开项目资料快照，阅读过程不需要连接 GitHub。

Crepitus Protocol

Status: unaudited testnet research. Do not use with real funds.

Crepitus is an experimental EVM protocol project exploring collateralized synthetic assets. The repository is being built in verifiable milestones; features are documented as available only after their source code and tests are committed.

What exists now

CREPToken.sol: capped ERC-20 prototype with permit support and role-based minting.
MockOracle.sol: mutable local/testnet oracle with 8-decimal prices.
Hardhat 3 contract compilation, TypeScript tests, and Ignition deployment.
React status page.
GitHub Actions checks.

What does not exist yet

Collateral custody, debt accounting, liquidation, synthetic-equity issuance, production oracle integrations, route reserves, governance, audits, and mainnet deployments are not implemented.

Requirements

Node.js 22.13.0 or newer
npm 10 or newer

Install

npm install

Commit the generated package-lock.json. After that, CI and fresh clones should use:

npm ci

Verify the repository

npm run check
npm run audit:runtime

The first command runs linting, Solidity compilation, TypeScript checking, contract tests, and the frontend production build. The second checks production/runtime dependencies for high-severity advisories.

Local frontend

npm run dev

Local simulated deployment

npm run contracts:deploy:local

Sepolia deployment

Copy .env.example to .env, enter test-only credentials, and run:

npm run contracts:deploy:sepolia

Never use a wallet that controls real funds. Values prefixed with VITE_ are public browser configuration and must never contain secrets.

Repository layout

contracts/          Solidity source
contracts/interfaces/ Shared contract interfaces
contracts/mocks/    Local and testnet-only contracts
test/               TypeScript smart-contract tests
ignition/modules/   Declarative deployments
src/                React frontend
docs/               Architecture and security documentation
.github/workflows/  Continuous integration

Security

Read SECURITY.md and docs/THREAT_MODEL.md. There is no audit or bug bounty yet.

License

MIT

Official distribution

获取与安装

暂未发现可确认的官方软件包地址

当前 README 快照没有出现 npm、PyPI、Crates.io、pub.dev 等官方包页链接。本站不会根据仓库名称猜测下载地址。

本站不托管项目文件；需要安装时，请以项目维护者发布的官方文档为准。

Before installing

使用前核验

本站保存公开资料用于阅读，不代表安全审计或功能背书。安装前请核对许可证、依赖来源和发布签名，不要直接运行来源不明的二进制文件或高权限脚本。