@openagentid/oas-vanilla/lineage
API contract shipped by @openagentid/oas-vanilla 1.0.2. Exact exports, signatures, dependencies and availability.
All packages · Runnable examples · Start an agent
| Contract | Value |
|---|---|
| Package | @openagentid/oas-vanilla@1.0.2 |
| Entry point | @openagentid/oas-vanilla/lineage |
| Availability | Published package |
| Reference source | Published JavaScript and JSDoc (inferred types) |
| Package engines | node >=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.
| Condition | Published file |
|---|---|
| default | ./src/lineage/derive.js |
Exports
deriveChildEntity
Derives a new child entity from a parent, producing a keypair and lineage.
Performs the complete child entity derivation workflow per OAS Spec §9:
- Derives a child Ed25519 keypair using HKDF-SHA256 (§9.3).
- Generates an AgentLineageProof2025 (§9.4).
- Constructs a complete LineageSection with the correct humanRootDid, creatorDid, generation, and humanRootChain.
declare function deriveChildEntity(parentKeypair: import("../crypto/keypair.js").OasKeyPair, parentDoc: import("../document/document.js").OasDocument, childDid: string, derivationPath: string): Promise<DerivedChild>;Source: @openagentid/oas-vanilla@1.0.2, src/lineage/derive.js:54.
throws: {LineageError} If the parent is a non-root entity without lineage, or if key derivation or proof generation fails.
DerivedChild
The result of deriving a child entity.
Contains the child's Ed25519 keypair and a complete LineageSection ready to be included in the child's identity document.
declare class DerivedChild {
constructor(keypair: OasKeyPair, lineage: LineageSection);
keypair: OasKeyPair;
lineage: LineageSection;
}Source: @openagentid/oas-vanilla@1.0.2, src/lineage/derive.js:16.
Package requirements
This version declares no dependencies or peer dependencies.
Archive verification
Pinned integrity:
sha512-66sPTWDxCcQ55S9YvPbk4BxF8c92CNqAHOUv7jp1uC+3ygYzZKf5dbvK2/rQwvhP+3oi7T3n1Zn1K1PK99zvMQ==