Guides
Task-shaped walkthroughs for publishing records with the SDK and for running a Machine.
Each guide takes one job, walks it end to end, and finishes at a check you can run yourself.
Every guide assumes you have been through the Quickstart, so you have a project, an SDK access token and the package installed. SDK covers installing the package and importing the client, including the one import path that does not work on a clean install.
Working with transactions
Six jobs, in the order they build on each other. Start at the first one if you have not submitted a record before.
Submit a transaction
Publish your first record and read it back, in about twenty lines.
Write data
Put a string or a structured value into a record.
Store a file
Publish a file's bytes, with its name and its content type.
Encrypt and sign an output
Turn on client-side encryption and a digital signature, and see what each one changes.
Combine outputs
Carry several outputs of different types in one transaction.
Read a record back
Fetch a transaction by its id, decrypt what belongs to you, and recover a stored file.
Building a Machine
A Machine runs your application logic and rebuilds its state from the records it wrote. Machines explains the idea; these three guides build one.
Build your first machine
An application class, a reader, a writer and a recorder, wired into a running Machine.
Implement a custom writer
Replace the shipped writer so you decide exactly what each recorded call publishes.
Store snapshots in S3
Persist snapshots outside the process so a Machine can resume without replaying everything.
If you would rather read a whole application
Examples holds two complete programs built on the same calls: a command-line password store, and a small Express service that records document digests.