API Reference

Complete API reference for magical-nft contracts.

Main Contract

State Variables

Functions

mint

function mint(address to) external payable returns (uint256)

Mints a new token to the specified address.

• to - Address to receive the minted token

• uint256 - The ID of the newly minted token

tokenURI

function tokenURI(uint256 tokenId) public view returns (string memory)

Returns the metadata URI for a token.

• tokenId - ID of the token

• string - Base64-encoded JSON metadata

setRenderer

function setRenderer(address newRenderer) external onlyOwner

Updates the renderer contract address.

• newRenderer - Address of the new renderer contract

Renderer Contract

State Variables

Functions

tokenURI

function tokenURI() external view returns (string memory)

Generates complete token metadata JSON with embedded HTML animation and image.

• string - Base64-encoded JSON metadata data URI

setStorageAddress

function setStorageAddress(address _storageAddress) external onlyOwner

Updates the storage contract address.

• _storageAddress - Address of the new storage contract

Storage Contract

Functions

store

function store(string calldata key, bytes calldata data) external onlyOwner

Stores data with a given key using SSTORE2.

• key - Identifier for the stored data
• data - Raw bytes to store

read

function read(string calldata key) external view returns (bytes memory)

Retrieves stored data by key.

• key - Identifier of the stored data

• bytes - The stored data

getPointer

function getPointer(string calldata key) external view returns (address)

Returns the SSTORE2 pointer address for a key.

• key - Identifier of the stored data

• address - SSTORE2 pointer contract address

Events

Main Contract

event RendererUpdated(address indexed oldRenderer, address indexed newRenderer);

Storage Contract

event DataStored(string indexed key, address pointer, uint256 size);

Errors

error TokenDoesNotExist(uint256 tokenId);
error InsufficientPayment(uint256 required, uint256 sent);
error MaxSupplyReached();
error DataNotFound(string key);