OpenAgentIDDocumentation
API referencenpm packages@openagentid/oas-vanilla
OpenAgentIDAPI reference

@openagentid/oas-vanilla/attestation

API contract shipped by @openagentid/oas-vanilla 1.0.2. Exact exports, signatures, dependencies and availability.

All packages · Runnable examples · Start an agent

ContractValue
Package@openagentid/oas-vanilla@1.0.2
Entry point@openagentid/oas-vanilla/attestation
AvailabilityPublished package
Reference sourcePublished JavaScript and JSDoc (inferred types)
Package enginesnode >=20.0.0

Before integrating

Publishes JavaScript with JSDoc, not TypeScript declarations. Inferred signatures are labeled separately.

This reference is generated from the integrity-verified npm archive for this exact version. Signatures describe the public contract; they are not standalone programs. Complete examples are checked separately.

This package ships JavaScript with JSDoc, not .d.ts files. The signatures below are inferred from that published source. An inferred any reflects missing type information in the package.

Import conditions

Use the public entry point above. The package resolves it to these shipped files; do not import its internal files directly.

ConditionPublished file
default./src/attestation/credential.js

Exports

OasCredential

An OAS Verifiable Credential.

Implements W3C Verifiable Credentials adapted for OAS entities, with Ed25519Signature2020 proofs.

Signature
declare class OasCredential {
  constructor(fields: { context: string[]; id: string; type: string[]; issuer: string; issuanceDate: string; expirationDate?: string | null; credentialSubject: { id: string; claims: object; }; proof?: object | null; });
  static build(): CredentialBuilder;
  static fromJSON(obj: object): OasCredential;
  context: string[];
  id: string;
  type: string[];
  issuer: string;
  issuanceDate: string;
  expirationDate: string;
  credentialSubject: { id: string; claims: object; };
  proof: any;
  toJSON(): object;
}

Source: @openagentid/oas-vanilla@1.0.2, src/attestation/credential.js:28.

signCredential

Signs a credential with the given keypair.

Signature
declare function signCredential(credential: OasCredential, keypair: OasKeyPair, verificationMethodId: string): Promise<OasCredential>;

Source: @openagentid/oas-vanilla@1.0.2, src/attestation/credential.js:232.

throws: {AttestationError} If signing fails.

verifyCredential

Verifies a signed credential.

Signature
declare function verifyCredential(credential: OasCredential, publicKeyBytes: Uint8Array): Promise<void>;

Source: @openagentid/oas-vanilla@1.0.2, src/attestation/credential.js:284.

throws: {AttestationError} If verification fails.

Package requirements

This version declares no dependencies or peer dependencies.

Archive verification

Pinned integrity:

SHA-512 integrity
sha512-66sPTWDxCcQ55S9YvPbk4BxF8c92CNqAHOUv7jp1uC+3ygYzZKf5dbvK2/rQwvhP+3oi7T3n1Zn1K1PK99zvMQ==

Machine-readable API manifest · Coverage

On this page