cad-reference

Mục lục của các Tài liệu Kiến trúc Convex (CADs), các đặc tả chuẩn mực cho Convex. Dùng để tìm CAD nào quản lý một hệ thống con trước khi thay đổi giao thức,…

npx skills add https://github.com/convex-dev/convex --skill cad-reference

Convex Architecture Documents

CADs are the normative specifications for Convex. Where the code and a CAD disagree, that is a bug in one of them — not a licence to pick either. Before changing behaviour in a specified area, read the governing CAD and say which one you relied on.

Read them at https://docs.convex.world/docs/cad/<slug> — the slug is the CAD directory name without its numeric prefix, e.g. CAD003 is https://docs.convex.world/docs/cad/encoding.

If the design repository is checked out alongside this one, the sources are in design/docs/cad/<nnn>_<slug>/index.md. Do not assume it is present.

Core Protocol

CADSlugCovers
000principlesDesign principles behind every other decision
001archOverall architecture
002valuesCVM values
003encodingCAD3 encoding format — see the cad3-encoding skill
004accountsAccounts, addresses, controllers
005cvmexCVM execution model
033cvmtypesCVM type system

Resources and Economics

CADSlugCovers
006memoryMemory accounting and allowances — see the memory skill
007juiceJuice accounting and pricing — see the juice skill
020tokenomicsCoin supply, distribution, denominations
016peerstakePeer staking

Language and Compilation

CADSlugCovers
008compilerCompiler
009expandersExpanders and macros
011errorsError handling and error codes
012numericsNumeric semantics
013metadataMetadata
026lispConvex Lisp
032readerCVX reader syntax

Transactions and Consensus

CADSlugCovers
010transactionsTransaction format and lifecycle
051cposConvergent Proof of Stake — consensus levels, belief merge
050network_upgradeNetwork upgrades and protocol versions — see the protocol-versions skill
015peercommsPeer communication protocol
017peeropsPeer operations
018schedulerScheduled execution
021observabilityObservability
027logEvent logging

Storage and Lattice

CADSlugCovers
047etchEtch storage format — see the etch skill
048storesLattice store abstraction — roots, persistence status
049etch_gcEtch garbage collection and migration — see the etch skill
024data_latticeData lattice
035cursorsLattice cursors
036lattice_nodeLattice node
037kv_databaseKV database
039convex_sqlConvex SQL — see the convex-db skill
040lattice_queueLattice queue
028dlfsData Lattice File System
044jsonJSON on the lattice
045lattice_appsLattice applications
046cell_explorerCell explorer

Assets, Identity and Trust

CADSlugCovers
019assetsAsset model
029fungibleFungible token standard — see the token skill
031nft_metadataNFT metadata
030torusTorus DEX
022trustmonTrust monitors — the authorisation model; see the trust skill
014cnsConvex Name System — see the cns skill
034curated_registryCurated registry
023keystoreKeystore
025walletHD wallets
038lattice_authLattice authentication
043didDecentralised identity

For a DID used as a lattice owner or signed application subject, read CAD043, CAD038 and CAD004 together. Use CAD043 for DID method syntax and resolution, CAD038 for merge-boundary signer authorisation, and CAD004 for account keys, rotation and controllers. Check the authorisation boundary of each independently mergeable signed value; do not assume that a signature around a mutable aggregate remains valid after a structural merge. For a recursive merge beneath SignedLattice, identify which authorised owner context can re-sign a synthesised result and how a non-owner relay behaves when it cannot. Raise any cross-CAD mismatch rather than copying an example silently.

Integration

CADSlugCovers
041mcpModel Context Protocol
042x402x402 protocol

CAD 0000cads is the index and describes the CAD process itself.

Thêm skills từ convex-dev

convex-lisp
convex-dev
Tài liệu tham khảo ngôn ngữ Convex Lisp — quy ước CVM, gọi mã thư viện, định nghĩa actor, mã juice và lỗi. Sử dụng khi viết hoặc gỡ lỗi mã nguồn CVM cho…
ecosystem
convex-dev
Định hướng trong hệ sinh thái Convex — thứ gì nằm trong repository nào, specs và docs ở đâu, và những thư viện client nào tồn tại. Sử dụng khi bạn cần ngữ cảnh…
local-network
convex-dev
Chạy mạng thử nghiệm Convex cục bộ để phát triển. Sử dụng khi kiểm tra các thay đổi với mạng trực tiếp, tái hiện sự cố của đồng nghiệp, hoặc khi không có mạng từ xa…
protocol-versions
convex-dev
Các phiên bản giao thức, di chuyển và nâng cấp v1 — nên viết theo ngữ nghĩa nào, và cách thay đổi hành vi CVM mà không fork mạng. Sử dụng khi…
etch
convex-dev
Kiểm tra và bảo trì một cửa hàng Etch — cơ sở dữ liệu định địa chỉ theo nội dung của Convex. Sử dụng khi kiểm tra bộ nhớ ngang hàng, chẩn đoán hỏng hóc, thu gom rác, hoặc…
juice
convex-dev
Hạch toán Juice — chi phí tính toán và băng thông trên CVM. Sử dụng khi phân tích chi phí thực thi giao dịch, chẩn đoán lỗi :JUICE, hoặc…
trust
convex-dev
Trust monitors — mô hình ủy quyền trên chuỗi có thể kết hợp của Convex. Sử dụng khi viết kiểm soát truy cập, hạn chế chức năng của tác nhân, xác định ai có thể mint hoặc…
memory
convex-dev
Kế toán và hạn mức bộ nhớ — chi phí lưu trữ trên chuỗi, và cách giảm thiểu cũng như thu hồi nó. Sử dụng khi suy luận về sự tăng trưởng trạng thái, chẩn đoán một…