invaria — API

FileDescriptor

src/index.d.ts

export interface FileDescriptor {
  sha256: string;
  size: number;
  mode: number;
}

InvariaManifest

src/index.d.ts

export interface InvariaManifest {
  version: 1;
  name: string;
  command: string[];
  cwd: string;
  inputs: string[];
  outputs: string[];
  env: Record<string, string>;
  inheritEnv: string[];
  timeoutMs: number;
  sourceDateEpoch: number;
  cache: boolean;
  platform: { os: string[]; arch: string[] };
}

AttestationPayload

src/index.d.ts

export interface AttestationPayload {
  schema: 'invaria.attestation/v1';
  subject: string;
  executionId: string;
  fingerprint: string;
  cacheHit: boolean;
  startedAt: string;
  finishedAt: string;
  durationMs: number;
  command: string[];
  cwd: string;
  environment: {
    declared: Record<string, string>;
    inheritedDigests: Record<string, string>;
  };
  runtime: { os: string; arch: string; node: string };
  inputs: Record<string, FileDescriptor>;
  outputs: Record<string, FileDescriptor>;
  stdout: { sha256: string; bytes: number };
  stderr: { sha256: string; bytes: number };
  exitCode: 0;
}

SignedAttestation

src/index.d.ts

export interface SignedAttestation {
  payload: AttestationPayload;
  signature: {
    algorithm: 'Ed25519';
    publicKey: string;
    fingerprint: string;
    value: string;
  };
}

RunContractOptions

src/index.d.ts

export interface RunContractOptions {
  manifest?: string;
  outputRoot?: string;
  stateRoot?: string;
  keyRoot?: string;
  key?: string;
  attestation?: string;
  cache?: boolean;
}

RunContractResult

src/index.d.ts

export interface RunContractResult {
  manifest: InvariaManifest;
  fingerprint: string;
  cacheHit: boolean;
  outputs: Record<string, FileDescriptor>;
  attestation: SignedAttestation;
  attestationPath: string;
  stdout: string;
  stderr: string;
}

CapsuleEntry

src/index.d.ts

export interface CapsuleEntry extends FileDescriptor {
  path: string;
  offset: number;
}

InvariaError

src/index.d.ts

export class InvariaError extends Error {
  code: string;
  details?: unknown;
  constructor(message: string, code?: string, details?: unknown);
}

runContract

src/index.d.ts

export function runContract(options?: RunContractOptions): Promise<RunContractResult>;

validateManifest

src/index.d.ts

export function validateManifest(raw: unknown): InvariaManifest;

loadManifest

src/index.d.ts

export function loadManifest(filename?: string): Promise<{ manifest: InvariaManifest; filename: string; root: string }>;

verifyAttestation

src/index.d.ts

export function verifyAttestation(
  attestationOrFilename: string | SignedAttestation,
  options?: { root?: string; publicKey?: string; verifyFiles?: boolean }
): Promise<{ ok: boolean; errors: Array<Record<string, unknown>>; payload: AttestationPayload; fingerprint?: string }>;

readAttestation

src/index.d.ts

export function readAttestation(filename: string): Promise<SignedAttestation>;

packCapsule

src/index.d.ts

export function packCapsule(manifestFilename: string, outputFilename: string): Promise<{
  filename: string; sha256: string; size: number; entries: CapsuleEntry[];
}>;

readCapsule

src/index.d.ts

export function readCapsule(filename: string): Promise<{
  filename: string; data: Buffer; dataOffset: number; index: { format: 1; entries: CapsuleEntry[] }; sha256: string;
}>;

extractCapsule

src/index.d.ts

export function extractCapsule(filename: string, destination: string): Promise<Record<string, unknown>>;

generateSigningKeyPair

src/index.d.ts

export function generateSigningKeyPair(privateKeyPath: string, publicKeyPath: string): Promise<{
  privateKey: string; publicKey: string; fingerprint: string;
}>;

publicKeyFingerprint

src/index.d.ts

export function publicKeyFingerprint(publicKeyPem: string): string;

clearCache

src/index.d.ts

export function clearCache(root: string): Promise<void>;

canonicalize

src/index.d.ts

export function canonicalize(value: unknown): string;

hashCanonical

src/index.d.ts

export function hashCanonical(value: unknown): string;

sha256

src/index.d.ts

export function sha256(data: string | Buffer | Uint8Array): string;