verus-typescript-primitives · VDXF request lifecycle

The VDXF request lifecycle

A thirteen-chapter reading course through src/vdxf/classes/: what a VDXF object is, how a request is built and signed, what each request family means, and how the whole thing reaches a wallet.

Source: VerusCoin/verus-typescript-primitives at 3ffa9d7 · Read alongside the source

The envelope is a transport; the detail is the request; the signature is the proof. Everything else — QR codes, deeplinks, callbacks, chain lookups — is packaging around that sentence.

Contents

  1. 01Orientation — what this library isRead
  2. 02The VDXF object model — version, type, key, dataRead
  3. 03Request, Response and the challenge hashRead
  4. 04VerifiableSignatureData — a signature that explains itselfRead
  5. 05GenericEnvelope and GenericRequest — flags as a table of contentsRead
  6. 06The signing lifecycle — eight steps, two partiesRead
  7. 07Authentication, identity update, invoiceRead
  8. 08Data packet, user data, app encryption, attestationRead
  9. 09Provisioning — the only family that creates somethingRead
  10. 10Synthesis — the lifecycle on one pageRead
  11. 11transaction/ — describing, not buildingRead
  12. 12pbaas/ — the chain's own vocabularyRead
  13. 13utils/ — where bytes become addressesRead

Where to start

If you want to…Go to
Understand what a VDXF request is01 → 02 → 05
Build and sign one05 → 06 → 07
Debug a signature that will not verify03 → 04
Read an identity byte by byte12
Fix a parse that returns nonsense13
Find out where transactions are built11

Scope note

This book reads the library as cloned at 3ffa9d7 on main. A fork maintains a generic-signed-request branch; the classes used here (envelope/, request/, login/, identity/, payment/, appencryption/, data/, provisioning/) are present on main, but line-level details may differ from that branch. Treat branch-specific behaviour as unverified until diffed against it.