Documentation

Starting a record

Summary. A record starts with a written request and an order form that both sides sign. Each sealed hour is delivered into storage you own, through a write-only key you give Nox. The record opens with a 30-day pilot at no fee, then continues for a monthly fee set out in the order form. Nox works in writing, by email.

View as Markdown

1. Write to Nox

Email contact@noxfze.com with your venue, its public channels and the instruments to record. Contact lists what to include. Nox works in writing: the order form, the storage setup and every report arrive by email.

Scope: perpetual and spot instruments. Event, outcome and prediction contracts are outside scope and are never recorded.

2. The order form

Nox replies in writing, with the written order form. It sets out the 30-day pilot at no fee and the fixed monthly fee after it, set by the number of instruments recorded. It also sets out how you may cite the record. Each citation that names Nox FZE states that your venue commissioned the record. It also carries the statement in what one sealed hour holds.

The record starts once both sides sign the order form and your bucket and write-only key are in place.

3. Prepare storage you own

• A bucket in storage you own. Object storage reachable over HTTPS with an S3-compatible API. Each sealed hour is written under the directory layout of the record format.
• A write-only key. The key lets Nox write objects into the bucket and nothing else. Nox needs no permission to read, list or delete objects.
• Versioning or object lock. Nox recommends enabling object versioning or object lock on the bucket. Each delivered object then keeps its first version if it is later overwritten or deleted.

You send the bucket's endpoint and the key by email, as the storage setup message from Nox describes.

4. The pilot

The pilot runs for 30 days, on the instruments you choose, at no fee. A recorder dedicated to your venue receives your public channels through your public interfaces, as any outside client would. Each UTC hour is sealed and delivered into storage you own within 15 minutes after it closes. If your storage or the recorder is unavailable, the hour arrives later, and the object times in your bucket show when.

From the first pilot hour, every UTC hour has a manifest, including an hour in which Nox received no messages. You can verify any delivered hour with command-line verification or in your browser with Verification.