Skip to content

README.md

Latest commit

 

History

History
28 lines (18 loc) · 1.53 KB

README.md

File metadata and controls

28 lines (18 loc) · 1.53 KB

Contract API Documentation

This directory contains generated API documentation for the Bloxchain Protocol smart contracts. The content is produced from NatSpec comments in the Solidity source and must not be edited by hand.

Source of Truth

The Solidity contracts are the source of truth. To update this documentation after changing contracts:

  1. Update NatSpec in the relevant .sol files.
  2. From the repository root run: npm run docgen

See CODEBASE_DOCUMENTATION.md for the full codebase documentation and updating process.

Structure

  • core/ – Core protocol contracts (EngineBlox, BaseStateMachine, SecureOwnable, RuntimeRBAC, GuardController, definitions, interfaces, utilities).
  • examples/ – Example applications and templates (AccountBlox, SimpleVault, PayBlox, CopyBlox, GuardianSafe, BasicERC20, etc.).
  • standards/ – Standard interfaces (e.g. hooks, behavior).
  • experimental/ – Experimental contracts (e.g. HookManager).

Each markdown file corresponds to a contract or library and lists its functions, events, structs, and enums as generated by solidity-docgen.

Other Documentation