Version 1.0 — Issued by CrownThrive, LLC “SDKs, APIs, Tooling, Testing, and Integration Patterns for Builders on the Decentralized Licensing & Compliance Layer.”
Audience: Application developers, solution integrators, runtime engineers, validator operators, analytics teams, and Help Center editors curating the Developer Docs category. Scope: Canonical reference for how to build on CHLOM: SDKs, RPCs, transactions, events, indexing, testing, deployment, security, and which 30+ follow‑on docs to read next.
0 · How to Use this Master Doc (Help Center Index)
- Start here for the big picture and concrete build paths.
- Each section ends with “What to read next” cross‑links into the Developer Docs category.
- Code examples are illustrative; the authoritative source is the runtime repository and SDK packages.
1 · System Overview
CHLOM exposes a standards‑first developer surface: Substrate JSON‑RPC, typed TypeScript SDK, a Rust client, and event subscriptions for real‑time workflows. Builders compose licensing, ownership, royalty, LEX, TLAAS (DLA), and compliance primitives to deliver production apps. Optional ecosystem surfaces include ThrivePush (notifications), CrownLytics (dashboards/heatmaps), and ThriveTools (free utilities/SEO).
1.1 High‑Level Architecture
+---------------------------+ +-------------------+ +----------------------------+
| Apps & Services |<--->| API / RPC Gateway |<-->| Reference Chain (Runtime) |
| (Web, Mobile, Backends) | | (WS/HTTP JSON-RPC)| | FRAME Pallets |
+---------------------------+ +-------------------+ +----------------------------+
| licensing / ownership / lex |
+---------------------------+ +-------------------+ | royalty / kpi / compliance |
| Indexers & Data Feeds |<--->| SubQuery/Subsquid| | dla / gov / treasury ... |
| (BI, CrownLytics) | | + Sidecar | +----------------------------+
+---------------------------+ +-------------------+
+---------------------------+ +-------------------+
| Oracles & OCWs |<--->| Oracle Gateway |
| (KYC, POS/IoT, ESG) | | + Off-chain Work |
+---------------------------+ +-------------------+
1.2 Consensus & Accounts
Framework is chain‑agnostic; reference chain uses:
- Consensus: BABE + GRANDPA.
- Staking: NPoS (
- Accounts: SS58, sr25519/ed25519; multisig via
What to read next: Doc 01 — Quickstart: Keys, RPC, First Extrinsic; Doc 02 — Network & Keys Handbook.
2 · Core Protocols (Developer‑Facing)
2.1 RPC & Metadata Protocol (RMP)
- JSON‑RPC endpoints; chain metadata versioning; runtime call indices; typegen for SDKs.
- WS subscriptions for finalized heads, events, storage.
2.2 Transaction Protocol (TXP)
- Nonce/era rules; mortality; weight fees; CHLOM fee payment via
- Multisig and proxy signing patterns.
2.3 Event & Receipt Protocol (ERP)
- Standardized events for LicenseMinted, RoyaltySettled, TradeSettled, CaseOpened with Merkle receipts for audits.
2.4 Compliance & Pack Binding (CPB)
- Programmatic pack binding; read‑gates for region/role; DLA freeze/hold checks before sensitive calls.
What to read next: Doc 03 — RPC & Metadata Spec; Doc 04 — Transactions & Fee Payment; Doc 05 — Events & Receipts; Doc 06 — Compliance & Pack Binding.
3 · Runtime Pallets (FRAME)
| Pallet | Purpose | Common Calls for Devs |
pallet_chlom_licensing | License NFTs | mint, amend, transfer, sublicense, renew, revoke |
pallet_chlom_ownership | Fractional units & cap table | fractionalize, split, merge, transfer |
pallet_chlom_royalty | Royalty routing & settlement | route, settle, receipt |
pallet_chlom_lex | Listings, orders, auctions | list, bid, reveal, buyNow, settle, cancel |
pallet_chlom_dla | Cases, sanctions | openCase, applySanction, resolve, fileAppeal |
pallet_chlom_kpi | KPI thresholds & reports | set_thresholds, report, flag |
pallet_chlom_compliance | Rule binding & checks | bindLicense, freeze, lift |
pallet_oracle_gateway | Oracle feeds | registerFeed, attest |
pallet_sustainability | Impact & offsets | recordImpact, routeOffset |
What to read next: Doc 07 — Pallet Call Reference (Per Pallet).
4 · Data Model & Schemas
- License:
- OwnershipUnit (FU):
- RoyaltyReceipt:
- Listing/Order:
- DlaCase:
What to read next: Doc 08 — Typegen & Schemas.
5 · Protocol Flows (Sequence Specs)
5.1 Onboard & First Transaction
Create keypair → fund test account → connect SDK → chlomLicensing.mint → subscribe to events → verify receipt.
5.2 Pay Fees in CHLOM
Enable asset_tx_payment → set fallback account → attach tip → inspect TransactionPayment event.
5.3 Listen & React
WS subscribe to events; on KpiBreached, open remediation ticket or dla.openCase as policy dictates; push via ThrivePush.
5.4 Trade a Fraction on LEX
ownership.split → lex.list (sealed bid) → commit/reveal → settle → pull royalty receipt.
What to read next: Doc 09 — Sequence Diagrams & State Machines for Devs.
6 · Governance & DAO Mechanics (for Devs)
How to propose parameter changes; conviction locks; testing proposals on TestNet; reading council decisions; using scheduler for phased rollouts.
What to read next: Doc 10 — Governance Parameters & Processes (Dev Guide).
7 · Token Model (Runtime View)
- CHM: used for governance and staking; required for some proposal deposits.
- CHLOM: used for fees, bonds, rebates; a portion is burned; 1%→5% to sustainability.
What to read next: Doc 11 — Token Implementation & Fee Model (Dev Guide).
8 · Oracles & Off‑Chain Workers
Patterns for registering feeds, signing updates, batching KPI reports, rate‑limiting, and fallback strategies when upstreams fail.
What to read next: Doc 12 — Oracle Gateway & OCW Patterns (Dev).
9 · Indexing & Analytics
SubQuery/Subsquid projects; GraphQL endpoints; building CrownLytics tiles; metrics and traces with Prometheus + OpenTelemetry; Sidecar for REST reads.
What to read next: Doc 13 — Indexing Blueprints; Doc 14 — Observability & Telemetry.
10 · Security, Privacy, and Compliance (for Devs)
Key management, multisig patterns, proxy delegation, replay prevention, nonces/eras, reentrancy‑safe patterns, PII minimization, ZK‑proof integration for sensitive KPIs.
What to read next: Doc 15 — Security Standards & Threat Model; Doc 16 — Privacy/ZK Patterns.
11 · Sustainability & Impact Hooks
recordImpact(kind, amount, ref) from app flows; verify Stripe Climate (1%→5%) and rotating EcoDrive campaigns; show on‑chain impact in your UI.
What to read next: Doc 17 — Sustainability Module & API.
12 · Developer Environment & Tooling
12.1 Prereqs
Node.js LTS, pnpm/npm, Rust stable + nightly, wasm32-unknown-unknown, Docker, Polkadot‑JS Apps, subkey.
12.2 Build & Run (Reference Chain)
rustup target add wasm32-unknown-unknown
cargo build -p node --release
./target/release/chlom-node --dev
12.3 SDK Setup
pnpm add @crownthrive/chlom-sdk
12.4 Testing
- Rust:
- TS: Jest/Vitest, contract tests vs. local node; CI with canary deploy.
What to read next: Doc 18 — Local Dev & Testing Guide.
13 · Deployment Topologies
DevNet (faucet), TestNet (permissioned oracles), MainNet (SLAs, backups). Feature flags and progressive delivery using scheduler.
What to read next: Doc 19 — Networks & Chain Specs; Doc 20 — Upgrade Playbook (Forkless Upgrades).
14 · SDKs & API Surfaces
TypeScript SDK (high‑level), Rust client (indexers/oracles), JSON‑RPC (standard + custom). Example (TS):
import { ApiPromise, WsProvider } from '@polkadot/api'
const api = await ApiPromise.create({ provider: new WsProvider('wss://rpc.chlom.net') })
await api.tx.chlomLicensing.mint(classId, termsCid, scope).signAndSend(account)
Example (Rust): use subxt types for strongly‑typed extrinsics.
What to read next: Doc 21 — TS SDK Reference; Doc 22 — Rust Client Reference; Doc 23 — Custom JSON‑RPC Extensions.
15 · Royalty Graph & Accounting Details (for Integrators)
Cycle‑safe DAG, rounding rules, currency adapters, batched payouts, dispute windows, Merkle receipts; how to display per‑recipient shares.
What to read next: Doc 24 — Royalty Engine Spec.
16 · KPI Catalogue & Measurement (for Apps)
Metric packs per vertical (suites/media/commerce); windows (30/90); breach policies; ZK‑eligible metrics; sample dashboards.
What to read next: Doc 25 — KPI Library & Policies.
17 · LEX Market Microstructure (for App Devs)
Order types, commit‑reveal, ROFR windows, escrow, anti‑MEV tips; sample UI flows and webhooks.
What to read next: Doc 26 — LEX Market Design (Dev Edition).
18 · TLAAS (DLA) Interactions (for App Devs)
How to open cases, attach evidence, poll outcomes, and unlock holds post‑remediation; consent/notice templates.
What to read next: Doc 27 — DLA Casebook (Dev).
19 · Cross‑Chain & Bridging (for Devs)
XCM commands, reserve locations, rate‑limits, allowlisted bridges, mapping of foreign asset IDs; safety patterns for retries.
What to read next: Doc 28 — Cross‑Chain Strategy (Dev).
20 · Compliance Packs by Jurisdiction (Dev)
Programmatically bind packs, fetch disclosure artifacts, enforce regional restrictions, and handle cooling‑off periods.
What to read next: Doc 29 — Regional Compliance Packs (Dev).
21 · Operational Runbooks (DevOps)
Secrets management, key rotation, RPC scaling, websockets fan‑out, indexer maintenance, incident hooks, and blue/green deploys.
What to read next: Doc 30 — DevOps Runbook; Doc 31 — Governance Ops Manual (Dev).
22 · Contribution, Versioning, and SLA
Semantic versions for SDKs; API stability policy; deprecation timelines; CHANGELOG discipline; Help Center SLAs for doc updates per release.
What to read next: Doc 32 — Contributing & Release Process (Dev).
23 · Full Documentation Roadmap (35 Items)
- Quickstart: Keys, RPC, First Extrinsic
- Network & Keys Handbook (SS58, Sessions, Staking)
- RPC & Metadata Spec
- Transactions & Fee Payment
- Events & Receipts
- Compliance & Pack Binding
- Pallet Call Reference (Per Pallet)
- Typegen & Schemas
- Sequence Diagrams & State Machines for Devs
- Governance Parameters & Processes (Dev Guide)
- Token Implementation & Fee Model (Dev Guide)
- Oracle Gateway & OCW Patterns (Dev)
- Indexing Blueprints (SubQuery/Subsquid)
- Observability & Telemetry (Prometheus/Otel)
- Security Standards & Threat Model (Dev)
- Privacy & ZK Patterns (Dev)
- Sustainability Module & API
- Local Dev & Testing Guide
- Networks & Chain Specs
- Upgrade Playbook (Forkless Upgrades)
- TS SDK Reference
- Rust Client Reference
- Custom JSON‑RPC Extensions
- Royalty Engine Spec
- KPI Library & Policies
- LEX Market Design (Dev Edition)
- DLA Casebook (Dev)
- Cross‑Chain Strategy (Dev)
- Regional Compliance Packs (Dev)
- DevOps Runbook
- Governance Ops Manual (Dev)
- Disaster Recovery & Backups (DevOps)
- Performance & Benchmarking (Weights)
- Example Apps: Suites, Media, Commerce
- ThrivePush Integration Guide
- CrownLytics Dashboards & API
24 · Final Notes for Help Center Editors
- Keep this master current with each runtime and SDK release.
- Every new API or breaking change must link back to this index and add a child doc entry.
- Cross‑check examples against the repository CI snapshot before publishing.
Appendix A — Example Types (Rust)
pub struct RoyaltyReceipt { pub tx_id: H256, pub model_id: u32, pub splits: BoundedVec<(AccountId32, u128), ConstU32<64>>, pub proof: Vec<u8>, pub block: u32 }
Appendix B — Example TS SDK Calls
// Create a license
await api.tx.chlomLicensing.mint(classId, termsCid, scope).signAndSend(account, ({ status, events }) => {/* ... */})
// Pay fees in CHLOM with a tip
await api.tx.system.remark('hello').signAndSend(account, { feeAsset: 'CHLOM', tip: 1 })
Disclaimer: Technical documentation; not legal advice. Always align deployments with applicable laws and CHLOM Governance decisions.