Skip to content

Reference ​

Look up exact rules here. To achieve a result, use Start, Use, Build or Deploy.

Protocol

CAM 1.4.0 with UI 1.1.0
Discovery, SHA-256 resource identity, expressions, routes, UI elements and transaction execution. The published versioned file is copied byte-for-byte from its source owner.
Version index
Current versus historical specifications. An older reference does not imply compatibility with the current reader.

Operations

Deployment records and authority
Private instances, defaults versus retained inputs, artifacts, approval images, Docker identity and nominee acceptance.
Release diagnostics
Log meanings and limits, uncertain transaction outcomes, RPC deadlines and isolated simulation experiments.
Networks and RPC services
Transport selection and provider configuration. A catalog entry does not authenticate a deployed contract.
Measured RPC capabilities
Dated, per-provider results for supported, rejected and inconclusive JSON-RPC methods. These observations are not service guarantees.

App-specific behavior

Pay-to-Play signing and integration · Escrow deadlines and settlement · Escrow document commitments · Bike NFT routes.

For a failed operation, start with Recover an interrupted release rather than retrying a creation. Source publication has its own verification and retry procedure.

Documentation authoring ​

Use CommonMark syntax for ordinary headings, paragraphs, links, lists and fenced code blocks. Separate blocks with blank lines. Prefer Markdown for content so VitePress can generate heading anchors and check guide links.

When converting an existing page, preserve its published fragment IDs. VitePress supports explicit heading IDs with ## Heading {#existing-id}; this is a VitePress extension, not portable CommonMark syntax. Check generated IDs before changing headings that other pages may link to.

Keep HTML or Vue components when needed for structure or behavior, such as a definition list or interactive diagram. When mixing HTML blocks and Markdown, separate them with blank lines and check the rendered result. If VitePress cannot resolve a guide URL, link to its Markdown source. Use an HTML link for the independently published viewer, which is not a VitePress page.

Build the site and check its generated internal links and navigation with the selected local Docker context:

sh
DOCS_PUBLIC_URL="$(gh api "repos/$(gh repo view --json nameWithOwner --jq .nameWithOwner)/pages" --jq .html_url)"
export DOCS_PUBLIC_URL
docs_output="$(mktemp -d)"
make docs/build DOCKER_CONTEXT=your-local-context DOCS_OUTPUT_DIR="$docs_output"
make docs/site/check DOCKER_CONTEXT=your-local-context DOCS_SITE_DIR="$docs_output/site"

Replace your-local-context with your Docker context. The build leaves the generated site in the temporary directory for inspection; remove that directory when finished.

GitHub Pages owns the published site URL. The gh command reads that URL before the offline build; DOCS_PUBLIC_URL carries it through Make and Compose to VitePress. The sitemap includes canonical guides and versioned protocol references, excluding redirect aliases and the independent viewer. Publication records the qualified URL and refuses to proceed if Pages configuration changes before publication. The current renderer supports the /dapp32/ layout; changing that path requires migrating the existing routing rules too.