NOOSChain Docs
NOOSChain is a permissioned encrypted ledger for shared project and organization data. It records signed, replayable state transitions while keeping sensitive payloads encrypted and access-controlled through buckets, principals, permissions, and key-sharing rules.
Use these docs to understand the system, write smart contracts, operate nodes, or evolve the NOOSChain implementation itself.
Start Here
If you are new to NOOSChain, begin with the system shape before jumping into runbooks or SDKs.
- Overview: what NOOSChain is, what it solves, and how the major parts fit together.
- Quick Start: get a local development node and docs site running.
- Data Buckets: understand the main data container abstraction.
- Permission Model: learn principals, permissions, and access rules.
Choose Your Path
Understand The Platform
Read the general docs when you need the shared language of the system: architecture, consensus, buckets, permissions, state roots, snapshots, sync, gossip, and smart-contract concepts.
Build Smart Contracts
Smart-contract developers should start with the contract model, then move into manifests, authorization, SDKs, publishing, provenance, and security review.
Operate NOOSChain
Operators should use the operator section for installation, configuration, production readiness, monitoring, backup/restore, incident handling, consensus deployment, and runtime operations.
- Operator Overview
- Three-Validator Production Tutorial
- Operator CLI
- Production Readiness
- Monitoring And Alerting
- Backup, Restore, And Recovery
- Incident Response
Develop NOOSChain
NOOSChain developers should use the implementation docs for protocol evolution, consensus internals, state-root migration, snapshot internals, release readiness, testing, benchmarks, and generated TypeScript reference material.
- Nooschain Developer Overview
- Protocol Versioning
- Raft Adapter Internals
- Testing
- Performance Benchmarks
- Generated Code Reference
How NOOSChain Fits Together
At the edge, applications, CLIs, SDKs, smart contracts, and operator tools submit requests. Authenticated actors create signed transactions. Consensus orders those transactions into blocks. Deterministic handlers apply each block to chain state. State roots, replay verification, and snapshots make that state auditable and recoverable.
Encrypted payload bytes are treated separately from consensus-critical state. The chain records metadata, hashes, permissions, bucket policy, key envelopes, and access rules. Nodes store or recover ciphertext only when policy and permissions allow it.
That split is the core design: a shared verifiable ledger for collaboration, with encrypted data availability controlled by explicit governance and operational rules.
Common Tasks
| Task | Start with |
|---|---|
| Run a local node | Quick Start |
| Learn the data model | Data Buckets and Permission Model |
| Understand consensus choices | Consensus |
| Write a smart contract | Author Guide |
| Publish a contract package | Publishing |
| Prepare an operator deployment | Production Readiness |
| Recover or restore a node | Backup, Restore, And Recovery |
| Investigate an incident | Incident Response |
| Change protocol behavior | Protocol Versioning |
| Validate performance | Performance Benchmarks |
The sidebar contains the full table of contents. Use this page when you need to choose the right doorway.