DotGrid renderer

The DotGrid renderer and validator function by function: how Squeek images and metadata are rendered and verified onchain, with errors, limits and ABIs.

TL;DR

• Turns a DotGrid page, a seed and a token ID into SVG and JSON metadata. After the collection's reveal, SqueekNFT tokenURI supplies keccak256(abi.encode(collectionSeed, artSeed)) as the seed.
• Rendering is deterministic and read-only: ownership, level and rewards never change an image.
• Verify the renderer, validator and page identities before using rendered output.

Overview

These contracts may change before mainnet. Pin the ABI you use and re-check the deployment before relying on it.

The renderer derives each token's traits and image from a DotGrid page, the collection seed and the token ID. The page is a 44-byte header and ten ordered sections, stored as contract code in a page root and its chunks. The page validator checks a page's full structure. Neither holds state or emits events.

The Sepolia SqueekNFT runs both; their addresses and runtime hashes are under Deployments. Confirm them onchain from SqueekNFT's renderer() and the renderer's pageValidator() at the block you verify.

Sepolia addresses (release core-sepolia-20261103):

• DotGrid renderer: 0x50888Ea2469Cc4E619bfcBdc4A7E7d58d4Ddd165
• DotGrid page validator: 0xA605e7a53bdE1bbA13bD6109A55B9C0D8Ea90ad7

Functions

tokenURI

function tokenURI(address page, bytes32 seed, uint256 tokenId) external view returns (string);

Reads and fully validates page, then returns base64 JSON metadata with an embedded SVG for tokenId.

Reverts with DotGridInvalid(code) for any page or input failure.

tokenURIForPinnedPage

Returns the same metadata as tokenURI, but skips full validation when the page root's runtime hash equals codehash; SqueekNFT uses it after validating the page at construction. A codehash establishes no trust on its own, so validate that exact root first. Reverts with DotGridInvalid(132) on a mismatch.

renderSVG

function renderSVG(address page, bytes32 seed, uint256 tokenId) external view returns (string);
function renderSVGForPinnedPage(address page, bytes32 codehash, bytes32 seed, uint256 tokenId) external view returns (string);

The SVG alone, strict or pinned.

validatePage

function validatePage(address page) external view returns (bytes32 pageHash, bytes32 assetSetHash);

Strict read plus full validation. Returns the logical page hash and the asset-set hash, which SqueekNFT stores as sceneHash() and assetSetHash().

Identity

function rendererId() external pure returns (bytes32);
function rendererVersion() external pure returns (string);
function pageValidator() external view returns (address);

rendererId() is keccak256("sqk.dotgrid-renderer.v1") and rendererVersion() is sqk.dotgrid-renderer.v1. pageValidator() is the validator the renderer created; its code is not covered by the renderer's runtime hash, so pin it separately.

validate

function validate(bytes page) external pure returns (Layout layout);

On the page validator: validates raw logical page bytes and returns the section directory. Most integrators call the renderer's validatePage instead.

Metadata fields

The asset-set hash binds page and renderer: keccak256(ASSET_SET_DOMAIN || RENDERER_ID || pageHash), with domain keccak256("sqk.dotgrid-asset-set.v1"). It differs from the root codehash and the page hash.

Events

The renderer and validator emit no events. SqueekNFT's BatchMetadataUpdate, emitted by announceReveal, announces when readers should refresh metadata.

Verifying identities

Read every value at one Ethereum block and compare it with the deployment record. A matching hash confirms that the onchain bytes match that record.

1. Read SqueekNFT renderer(), art(), artCodehash(), sceneHash(), assetSetHash() and collectionSeed(). art is the page root address.
2. Compare keccak256 of the renderer's runtime code with the expected hash, and rendererId() with keccak256("sqk.dotgrid-renderer.v1").
3. Read the renderer's pageValidator() and compare its runtime hash separately.
4. Compare the root's runtime hash with artCodehash(); the root commits to its chunk hashes.
5. Call the renderer's validatePage(art) and require it to return sceneHash() and assetSetHash().
6. Require a nonzero collection seed and SqueekNFT revealState() to report revealed, then render an existing ID through SqueekNFT. Its seed is keccak256(abi.encode(collectionSeed, artSeed)).

Limits