Skip to main content

Installation

Requires Node.js 18+. Ships both ESM and CJS builds.

VaneClient

The VaneClient class wraps the Vane API. It handles authentication, serialization, and error mapping.

Constructor

Two signatures are supported:
VaneClientOptions:

attest()

Appends a signed record to the attestation chain.
Parameters: Returns: Promise<AttestationRecord> Throws: Error with message "Vane attest failed (${status}): ${body}" on non-2xx responses. Example:

getProof()

Retrieves a Merkle inclusion proof for a record.
Parameters: Returns: Promise<InclusionProof> Throws: Error on non-2xx responses. Example:

TypeScript types

All types are exported from @vane.build/sdk:

AttestationRecord

DelegationInfo

ActClaim

InclusionProof


Complete example