Skip to content

README.md

Latest commit

 

History

History
52 lines (37 loc) · 2.27 KB

README.md

File metadata and controls

52 lines (37 loc) · 2.27 KB
Raw

ReineiraOS

FHE-encrypted stablecoin infrastructure on Arbitrum. Powered by Fhenix CoFHE.

Packages

Package Description
@reineira-os/shared Shared Solidity contracts, interfaces, and base configs
@reineira-os/escrow Confidential escrow protocol (FHE-encrypted)
@reineira-os/operators Off-chain operator infrastructure (NestJS monorepo)
@reineira-os/sdk TypeScript SDK — the installable client for building on the protocol

Setup

pnpm install

Build

pnpm compile                              # Compile all Solidity packages
pnpm test                                 # Run all tests

Per-Package

pnpm --filter @reineira-os/escrow compile    # Compile escrow only
pnpm --filter @reineira-os/escrow test       # Test escrow only

Documentation

Document Description
Whitepaper Protocol design and primitive definitions (cited as §X in code).
Litepaper Condensed overview.
Implementation Status What is shipped, partial, and planned vs. the whitepaper.

The protocol is testnet · pre-audit · upgradeable and not yet feature-complete — see Implementation Status before relying on any whitepaper section. Full docs: docs.reineira.xyz.

License

This repository is multi-licensed by layer — see LICENSE and NOTICE:

  • Core protocol (escrow) — FSL-1.1-ALv2 (non-compete; each version converts to Apache-2.0 two years after release)
  • Shared interfaces / base contracts (shared) and operator services (offchain) — Apache-2.0
  • SDK (sdk) — MIT