For the complete documentation index, see llms.txt. This page is also available as Markdown.

Reference Inscriptions

Inscribe references to content by URI

You can inscribe references to on-chain content using the text/uri-list content type defined here: https://www.rfc-editor.org/rfc/rfc2483#section-5

Examples

# This is a comment
https://mydomain.com/something.pdf

In this example we reference a JSON inscription. The file extension is useful for hinting before the content has been loaded, allowing clients to make UI decisions sooner (like choosing the correct component to render the content).

Using OrdFS-compatible content routes, you can reference on-chain files by relative path:

# This is an image inscription
/content/<outpoint | contentHash>.png

See OrdFS, Directories, and Streams for resolution rules. Gateways such as ordfs.network expose a compatible /content/ path.

Multiple Files

You can also reference many files in a single text/uri-list inscription:

/content/<outpoint1>.html
/content/<outpoint2>.js
/content/<outpoint3>.webp
/content/<outpoint4>.css

In this example we can make the contents of a webpage and all of its dependencies available as a single package.

Last updated