ABX utilities

ABX utilities add capabilities through their own official tools and interfaces. Discover them without installing any utility package:

abx utils
abx utils abxfs --json
abx capabilities --json

The same utility descriptors appear in capability output. These commands provide package and documentation references; they do not install or run another CLI.

ABX FS

ABX FS stores content-addressed files and directories on-chain with compression. Its ABX-based project layer adds ownership, publishing history, and tags. It can preserve a static website or dapp, NFT assets, project documentation, or other digital work. Content can exist without a project token, and an ABX collection can use FS content independently of the FS project's identity.

Install only what the project needs:

pnpm add --save-dev @artblocks/abxfs-cli
pnpm exec abxfs --help
# For programmatic integration:
pnpm add @artblocks/abxfs-sdk

The ABX FS documentation maintains command syntax, package interfaces, deployed contracts, and limits. FS uses its own chain and signing configuration. Inspect its help and registry; ABX signing flags and chain settings do not automatically apply to it.

Preserve the work and choose its delivery

FS content stays on the network where it was stored. The preferred delivery method is a separate choice:

A data URI contains one resource, so relative sibling files do not acquire a directory origin. An existing build process can produce self-contained HTML where appropriate. Runtime network dependencies still need inspection: uploading JavaScript does not preserve every service it calls. “Fully on-chain” describes the source bytes and resolution, while the browser executes the experience.

The chain gateway is the straightforward default when embedding is unsuitable. A gateway is an off-chain delivery dependency, even though its content can be reconstructed from chain. IPFS adds a content-derived distribution address, with continuing pinning and gateway availability requirements; Auto does not select a paid provider or create pins.

Presentation controls animation_url, which is commonly used by marketplaces. Auto is a one-time tooling choice that saves Embedded or ChainGateway; it does not become an on-chain mode. Inspect the selected file or entrypoint. A directory may display index.html or another selected file. For Embedded, a blank directory path reads its index.html; without it, the result is inert text, not a directory listing. The FS native read interface documents direct Solidity reads and the fixed ABX adapter. Auto selects the gateway when there is no suitable displayed file, and the gateway can show a navigable directory listing. Explicit Embedded does not silently switch to HTTP when reading fails.

The current presentation renderer imposes no product byte ceiling. Large content can still exceed the gas, memory or time budget of an EVM/RPC read. Inspect the complete tokenURI result rather than assuming a successful file read proves that every consumer can resolve the metadata. Auto's size and dependency recommendations belong to the utility tooling and can evolve.

New uploads and first publication into an empty token can use Auto or an explicit method. Updates preserve the saved presentation unless a change is requested. Review whether an update replaces the whole project or applies draft/overlay operations: replacement removes omitted paths; an overlay preserves untouched files. A presentation-only failure after publication needs presentation recovery, not another mint or publish.

Presentation-capable project generations support changing methods and independent irreversible locks on displayed content, delivery method, and endpoint configuration. Locking content fixes its concrete root and entrypoint; later publications and tag movements do not change that displayed source. Other project metadata and publishing history can still change. Freezes are one-way and survive ownership transfers. This makes fixed content with replaceable delivery possible. Endpoint locks do not guarantee endpoint availability. Review the exact lock and its scope before signing, and preserve endpoint flexibility unless a creator deliberately chooses otherwise.

Existing orgs keep the factory and renderer they were created with. Inspect the FS registry and deployment documentation for supported generations and any explicitly retired test generation. New-project defaults use the current factory; a software update does not upgrade an existing token.

Connect FS content to an ABX project

Use existing ABX metadata, link, or attachment surfaces for served content. Use the official FS native reader and fixed-source ABX reader adapter when the field must consume bounded EVM-readable content. The reader's supported codecs and execution budgets are documented by FS; do not reimplement them.

Verify the exact token metadata, animation, image, and attachment experience after integration. A preserved website does not itself supply a mutable backend, an indexed attachment list, or a marketplace thumbnail. Choose those surfaces deliberately using the storage guide and deployment guide.