Skip to content
Max Leuthaeuser edited this page May 10, 2026 · 5 revisions

Getting started with SCROLL requires the project to be set up correctly. Therefore, we advice to follow the tips given on the Installation-Information page.

Once everything works fine, you can follow the The Bank Example (Overview) to create your first own role-based application. Or maybe you want to use the SCROLLBoot project directly.

If you encounter any problems during your work, please feel free to submit a problem report via the Issue Tracker.

Developing Role-based Application with SCROLL

Implementing role-based applications with SCROLL requires knowledge about how to translate role-specific features into actual code. This page may help.

Public API entry points

For user-facing code, prefer the public scroll facade instead of importing implementation details from scroll.internal.*.

Typical imports are:

import scroll.Compartment
import scroll.DispatchQuery
import scroll.Many.*

If you are using MultiCompartment, dynamic calls return a nested result shape. The public scroll.MultiDispatchResult alias and sequenceResults helper flatten successful multi-dispatch results to Either[SCROLLError, Seq[E]].

Clone this wiki locally