DocumentOutgoingUpdate
One encrypted Loro update a client uploads, with its signed write header.
Shape
object
9 fields
checkpointKindstringoptional- always
rotate_baseline
rotate_baselinewhen the update is a rotation baseline; absent for an ordinary update.- always
checkpointPayloadKindstringoptional- always
full_history_snapshot
full_history_snapshotfor a rotation baseline; absent otherwise.- always
encryptedDatastringrequired- not empty
Base64 ciphertext of the update under the document content key.
idstringrequired- lowercase UUID v4
Client-chosen update id; a retry with the same id is accepted only if the ciphertext and header are identical.
partialEndVersionVectorstringrequired- not empty
Version vector the update brings the document to.
partialStartVersionVectorstringrequired- not empty
Version vector the update starts from.
plaintextHashstringrequired- not empty
Hash of the plaintext update, committed by the write header.
sourceVersionVectorstringoptional- not empty
For a rotation baseline, the frontier its snapshot covers.
writeHeaderobject with any fieldsrequiredSigned write header binding the ciphertext to the document, access manifest, content-key epoch, target hash, and writer.
Other fields are allowed.