Stellar-Clear/clearledger

选用指南

AI 根据 README 整理 · 2026/10/14 15:30:34

适用场景

用于在 Stellar 测试网络上评估和集成发票融资流程，包括参与者注册、发票生命周期管理、USDC 流动性池和结算。

查看 README 依据

ClearLedger uses [Soroban, Stellar’s smart-contract platform](https://developers.stellar.org/docs/build/smart-contracts/overview), to coordinate business identity, invoice records, pool shares, and USDC flows on Stellar. The TypeScript SDK and web app connect to Soroban contracts, while the Go indexer follows contract events to make network activity available to applications. ## The workflow 1. **Onboard participants.** Register SME issuers and trade buyers through the participant registry.

2. **Create invoice records.** Issuers record invoice terms and progress through explicit on-chain lifecycle states. 3. **Coordinate liquidity.** USDC pool contracts account for liquidity, invoice funding, LP shares, and repayment flows. 4. **Follow activity.** The Go indexer consumes Soroban events for API access and application views. The protocol records submitted transaction state. It does not independently verify commercial documents, guarantee that an invoice will be funded, or guarantee repayment or returns. ## Project map | Path | What lives here | | --- | --- |

使用方式

通过 Next.js 网页应用、TypeScript SDK/CLI、Go 索引器和 API 使用，需要本地运行或使用部署的测试网应用。

查看 README 依据

| `apps/web/` | Next.js application and public product experience | | `packages/sdk/`, `packages/sdk-react/` | TypeScript contract clients and React hooks | | `packages/cli/` | Developer command-line tools | | `indexer/` | Go Soroban event indexer and HTTP API | | `examples/` | SDK and integration examples | | `docs/` | Protocol, user, and developer documentation | Soroban contract source and deployment details live in the [companion contracts repository](https://github.com/Stellar-Clear/clearledger-contracts). ## Run locally

Requirements: Node.js 20+, pnpm 9+, and Docker for the complete local stack. For wallet interactions, install [Freighter](https://www.freighter.app/) and select Stellar Testnet. ```bash pnpm install cp .env.example .env.local pnpm dev ``` The web app starts at `http://localhost:3000`. For the web app, Go indexer, and PostgreSQL together: ```bash cp .env.docker.example .env.docker docker compose --env-file .env.docker up --build ```

部署要求

需要 Node.js 20+、pnpm 9+ 和 Docker（完整本地环境），以及 Freighter 钱包（用于钱包交互）。

查看 README 依据

Requirements: Node.js 20+, pnpm 9+, and Docker for the complete local stack. For wallet interactions, install [Freighter](https://www.freighter.app/) and select Stellar Testnet. ```bash pnpm install cp .env.example .env.local pnpm dev ``` The web app starts at `http://localhost:3000`. For the web app, Go indexer, and PostgreSQL together: ```bash cp .env.docker.example .env.docker docker compose --env-file .env.docker up --build ```

已知限制

协议记录交易状态，不独立验证商业文件，不保证发票融资或还款；当前仅在测试网部署，合同未经正式审计。

查看 README 依据

2. **Create invoice records.** Issuers record invoice terms and progress through explicit on-chain lifecycle states. 3. **Coordinate liquidity.** USDC pool contracts account for liquidity, invoice funding, LP shares, and repayment flows. 4. **Follow activity.** The Go indexer consumes Soroban events for API access and application views. The protocol records submitted transaction state. It does not independently verify commercial documents, guarantee that an invoice will be funded, or guarantee repayment or returns. ## Project map | Path | What lives here | | --- | --- |

The web application and contracts are currently deployed on Stellar Testnet for evaluation and integration. This is not a mainnet financial service. The contracts have not been formally audited, and testnet assets have no promised redemption value. Do not use real funds. Review the [contract limitations](https://github.com/Stellar-Clear/clearledger-contracts/blob/main/docs/LIMITATIONS.md) and [security policy](https://github.com/Stellar-Clear/clearledger-contracts/blob/main/SECURITY.md) before integrating.