@openagentid/aegis-sdk
API contract shipped by @openagentid/aegis-sdk 0.1.1. Exact exports, signatures, dependencies and availability.
All packages · Runnable examples · Start an agent
| Contract | Value |
|---|---|
| Package | @openagentid/aegis-sdk@0.1.1 |
| Entry point | @openagentid/aegis-sdk |
| Availability | Published package |
| Reference source | Published TypeScript declarations |
| Package engines | node >=20 |
Entry points
@openagentid/aegis-sdk/core@openagentid/aegis-sdk/verify@openagentid/aegis-sdk/keys@openagentid/aegis-sdk/auth@openagentid/aegis-sdk/policy@openagentid/aegis-sdk/delegate@openagentid/aegis-sdk/wallet
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.
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 |
|---|---|
| types | ./dist/index.d.ts |
| import | ./dist/index.js |
Exports
ActiveHours— typeActiveHoursSchemaAddressDeriverAegisClientAegisConfig— typeAegisError— typeAegisExceptionAegisIdentity— typeAegisStores— typeAgentLineageProof— typeApiKeyProviderAuditInfo— typeAuthContext— typeAuthCredential— typeAuthError— typeauthErrorsAuthorizedTransaction— typeAuthProvider— typebase64UrlDecodebase64UrlEncodeBatchMode— typebuildChallengePayloadChain— typeCHAIN_VALUESchainCoinTypeChainSchemaChallenge— typeChallengeResponseProviderChallengeVerifiercomposeDecisionsconcatBytesContractInteraction— typeContractPolicy— typeContractPolicyEvaluatorcreateDelegationProofCreateDidParams— typeCreatedSessionKey— typecreateSessionKeycryptoBackendCryptoBackend— typeDEFAULT_AEGIS_CONFIGDEFAULT_KEY_CONFIGDEFAULT_PAGE_SIZEDEFAULT_PAGINATIONDEFAULT_SESSION_CONFIGDEFAULT_VERIFICATION_CONFIGdefaultAegisStoresDelegation— typeDelegationError— typedelegationErrorsDelegationProof— typeDelegationProofSchemaDelegationSchemaDelegationScope— typeDelegationScopeSchemaDelegationStore— typeDelegationTreederivationPathderivationStandardderiveLineageKeyDidCreationResult— typeDidResolver— typeDirectSignerDocumentMetadata— typeDocumentProof— typeEncryptedKeyEntityKind— typeFrostCeremonyFrostKeyPackage— typegenerateChallengegenerateSharesGuardian— typeGuardianAuthorization— typeGuardianType— typehexDecodehexEncodeIdentityType— typeIdentityTypeSchemainferIdentityTypeFromDidInMemoryDelegationStoreInMemoryKeyStoreInMemoryNonceStoreInMemoryRevocationStoreInMemorySessionStoreInMemoryVerificationCacheStoreintersectScopesisRotationEligibleisScopeSubsetKeyConfig— typeKeyError— typekeyErrorsKeyGenerationMode— typeKeyGeneratorKeyRole— typeKeyRoleSchemaKeyRotationKeyStore— typeLifecycleStatus— typeLineagePolicy— typeLineagePolicyEvaluatorLineageSection— typeLineageSummary— typeLivenessStatus— typeloadDefaultCryptoBackendmakePaginationmakeTransactionManagedKeyMAX_PAGE_SIZENonceStore— typeoasDocumentOasDocument— typeObligation— typeObligationType— typePagination— typeparseAmountparseIso8601DurationMsPermissionCheck— typePluginRegistryPolicyContext— typePolicyDecision— typePolicyEngine— typePolicyError— typepolicyErrorsPolicyRequest— typeRecoveryCeremonyRecoveryConfig— typeResolverError— typeresolverErrorsRevocationRegistryRevocationStatus— typeRevocationStore— typeRotationRequest— typeRotationResult— typeSession— typeSessionConfig— typeSessionKey— typeSessionManagerSessionManagerOptions— typeSessionStore— typesetCryptoBackendSigningBackend— typeSigningMode— typeSigningRequest— typeSigningResult— typesignWithThresholdSpendingLimits— typeSpendingLimitsSchemaSpendingPolicyEvaluatorStorageBackend— typeTemporalConstraints— typeTemporalConstraintsSchemaTemporalPolicyEvaluatorThresholdConfig— typeThresholdKeyPackages— typeTransaction— typeTransactionInfo— typeTransactionPipelineu32BeBytesutf8Decodeutf8EncodevalidateScopeVerificationCacheVerificationCacheStore— typeVerificationConfig— typeVerificationError— typeverificationErrorsVerificationMethod— typeVerificationPipelineVerificationResult— typeverifyDelegationProofverifySignatureverifyThresholdSignatureWalletAddress— typeWalletError— typewalletErrorsWalletType— type
ActiveHours
Type-only declaration; it is not a runtime value.
interface ActiveHours {
startHour: number;
endHour: number;
timezone: string;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:126.
ActiveHoursSchema
declare const ActiveHoursSchema: z.ZodObject<{
startHour: z.ZodNumber;
endHour: z.ZodNumber;
timezone: z.ZodString;
}, "strip", z.ZodTypeAny, {
startHour: number;
endHour: number;
timezone: string;
}, {
startHour: number;
endHour: number;
timezone: string;
}>;Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:232.
AddressDeriver
declare class AddressDeriver {
static derivationPath(chain: Chain, account: number, index: number): string;
static deriveAddress(chain: Chain, publicKeyBytes: Uint8Array): WalletAddress;
static deriveAll(publicKeyBytes: Uint8Array, chains: readonly Chain[]): WalletAddress[];
}Source: @openagentid/aegis-sdk@0.1.1, dist/wallet/index.d.ts:11.
AegisClient
Unified AEGIS client.
Holds a [PluginRegistry], a verification pipeline, a session manager,
a delegation tree, and (optionally) a transaction pipeline. Storage
backends are accessible via the stores field.
declare class AegisClient {
readonly registry: PluginRegistry;
readonly verifier: VerificationPipeline;
readonly sessions: SessionManager;
readonly delegations: DelegationTree;
readonly config: AegisConfig;
readonly stores: AegisStores;
constructor(params: {
registry: PluginRegistry;
config?: AegisConfig;
stores?: AegisStores;
});
static withDefaults(registry: PluginRegistry): AegisClient;
withSigner(signer: SigningBackend): this;
verifyIdentity(did: string): Promise<VerificationResult>;
verifyIdentityFresh(did: string): Promise<VerificationResult>;
authenticate(credential: AuthCredential, identityType: IdentityType): Promise<Session>;
getSession(sessionId: string): Session;
revokeSession(sessionId: string): void;
isSessionValid(sessionId: string): boolean;
authorize(request: PolicyRequest): Promise<PolicyDecision>;
composePolicyDecisions(decisions: readonly PolicyDecision[]): PolicyDecision;
delegate(params: {
delegatorDid: string;
delegateDid: string;
scope: DelegationScope;
expires?: string | null;
signingKey: Uint8Array;
verificationMethod: string;
}): Delegation;
verifyDelegation(delegation: Delegation, delegatorPublicKey: Uint8Array): boolean;
revokeDelegation(delegationId: string): string[];
signTransaction(tx: Transaction, auth: AuthContext, policyDecision: PolicyDecision): Promise<AuthorizedTransaction>;
transactions(): TransactionPipeline | null;
}Source: @openagentid/aegis-sdk@0.1.1, dist/sdk/index.d.ts:61.
AegisConfig
Type-only declaration; it is not a runtime value.
interface AegisConfig {
verification: VerificationConfig;
sessions: SessionConfig;
keys: KeyConfig;
storageBackend: StorageBackend;
}Source: @openagentid/aegis-sdk@0.1.1, dist/sdk/index.d.ts:29.
AegisError
Type-only declaration; it is not a runtime value.
type AegisError = ResolverError | AuthError | PolicyError | VerificationError | KeyError | DelegationError | WalletError;Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:245.
AegisException
Throwable wrapper around a tagged AegisError.
declare class AegisException extends Error {
readonly error: AegisError;
constructor(error: AegisError);
}Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:247.
AegisIdentity
Identity information extracted from authentication.
Type-only declaration; it is not a runtime value.
interface AegisIdentity {
did: string;
identityType: IdentityType;
displayName?: string | null;
conformanceLevel?: number | null;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:6.
AegisStores
Collection of pluggable persistent storage backends used by the client.
Defaults to in-memory implementations. Application code may inject
Postgres-backed (or any other) implementations via withStores.
Type-only declaration; it is not a runtime value.
interface AegisStores {
sessionStore: SessionStore;
nonceStore: NonceStore;
delegationStore: DelegationStore;
revocationStore: RevocationStore;
keyStore: KeyStore;
verificationCacheStore: VerificationCacheStore;
}Source: @openagentid/aegis-sdk@0.1.1, dist/sdk/index.d.ts:45.
AgentLineageProof
Type-only declaration; it is not a runtime value.
interface AgentLineageProof {
type: string;
verificationMethod: string;
created: string;
jws: string;
}Source: @openagentid/aegis-sdk@0.1.1, dist/plugin-CzTTSkdE.d.ts:19.
ApiKeyProvider
Simple API key auth provider for service-to-service communication.
Maps opaque API keys to DIDs. Suitable for internal services that authenticate via pre-shared keys rather than challenge-response.
declare class ApiKeyProvider implements AuthProvider {
constructor(initial?: Record<string, string>);
providerName(): string;
registerKey(key: string, did: string): void;
revokeKey(key: string): boolean;
validate(credential: AuthCredential): Promise<AuthContext>;
getIdentity(ctx: AuthContext): Promise<AegisIdentity>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/auth/index.d.ts:77.
AuditInfo
Type-only declaration; it is not a runtime value.
interface AuditInfo {
auditId: string;
timestamp: string;
engine: string;
policiesEvaluated: string[];
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:86.
AuthContext
The output of successful authentication (AEGIS Spec §7.1).
Type-only declaration; it is not a runtime value.
interface AuthContext {
provider: string;
subject: string;
did?: string | null;
sessionId?: string | null;
expiresAt?: string | null;
claims: Record<string, unknown>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:13.
AuthCredential
Discriminated union of credentials accepted by AEGIS auth providers (§7.2).
Type-only declaration; it is not a runtime value.
type AuthCredential = {
type: "bearer_token";
token: string;
} | {
type: "session_cookie";
cookie: string;
} | {
type: "api_key";
key: string;
} | {
type: "signed_challenge";
did: string;
challenge: string;
signature: string;
timestamp: string;
nonce: string;
} | {
type: "capability_token";
token: string;
} | {
type: "passkey_assertion";
credentialId: string;
authenticatorData: string;
clientDataJson: string;
signature: string;
} | {
type: "custom";
provider: string;
data: unknown;
};Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:22.
AuthError
Type-only declaration; it is not a runtime value.
type AuthError = {
kind: "auth/invalid_credential";
reason: string;
message: string;
} | {
kind: "auth/credential_expired";
expiredAt: string;
message: string;
} | {
kind: "auth/session_revoked";
sessionId: string;
message: string;
} | {
kind: "auth/session_expired";
sessionId: string;
message: string;
} | {
kind: "auth/challenge_invalid";
reason: string;
message: string;
} | {
kind: "auth/provider_unavailable";
provider: string;
message: string;
} | {
kind: "auth/refresh_not_supported";
provider: string;
message: string;
} | {
kind: "auth/revocation_not_supported";
provider: string;
message: string;
} | {
kind: "auth/internal";
reason: string;
message: string;
};Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:38.
authErrors
declare const authErrors: {
invalidCredential: (reason: string) => AuthError;
credentialExpired: (expiredAt: string) => AuthError;
sessionRevoked: (sessionId: string) => AuthError;
sessionExpired: (sessionId: string) => AuthError;
challengeInvalid: (reason: string) => AuthError;
providerUnavailable: (provider: string) => AuthError;
refreshNotSupported: (provider: string) => AuthError;
revocationNotSupported: (provider: string) => AuthError;
internal: (reason: string) => AuthError;
};Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:261.
AuthorizedTransaction
Type-only declaration; it is not a runtime value.
interface AuthorizedTransaction {
transaction: Transaction;
signature: Uint8Array;
fulfilledObligations: string[];
}Source: @openagentid/aegis-sdk@0.1.1, dist/pipeline-u2tQgstP.d.ts:50.
AuthProvider
Type-only declaration; it is not a runtime value.
interface AuthProvider {
validate(credential: AuthCredential): Promise<AuthContext>;
getIdentity(ctx: AuthContext): Promise<AegisIdentity>;
providerName(): string;
refresh?(ctx: AuthContext): Promise<AuthContext>;
revoke?(ctx: AuthContext): Promise<void>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/plugin-CzTTSkdE.d.ts:92.
base64UrlDecode
Decode a URL-safe base64 string (with or without padding) to bytes.
declare function base64UrlDecode(input: string): Uint8Array;Source: @openagentid/aegis-sdk@0.1.1, dist/encoding-OdOrLVsv.d.ts:4.
base64UrlEncode
Encode bytes as URL-safe base64 without padding.
declare function base64UrlEncode(bytes: Uint8Array): string;Source: @openagentid/aegis-sdk@0.1.1, dist/encoding-OdOrLVsv.d.ts:2.
BatchMode
Type-only declaration; it is not a runtime value.
type BatchMode = "all_or_nothing" | "best_effort";Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:184.
buildChallengePayload
Build the JCS-canonical payload bytes for challenge signing/verification.
Canonical form is a JSON object with keys in alphabetical order:
{"challenge":"<base64url>","did":"<did>","nonce":"<nonce>","timestamp":"<ISO8601>"}
The WASM crypto backend's jcsCanonicalize handles RFC 8785 ordering.
declare function buildChallengePayload(challenge: Challenge, did: string): Uint8Array;Source: @openagentid/aegis-sdk@0.1.1, dist/auth/index.d.ts:28.
Chain
Type-only declaration; it is not a runtime value.
type Chain = "ethereum" | "polygon" | "arbitrum" | "optimism" | "base" | "solana" | "bitcoin" | "cosmos" | "osmosis" | "aptos" | "sui" | "starknet";Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:177.
CHAIN_VALUES
declare const CHAIN_VALUES: readonly Chain[];Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:178.
chainCoinType
BIP-44 coin type for the given chain.
declare function chainCoinType(chain: Chain): number;Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:180.
ChainSchema
declare const ChainSchema: z.ZodEnum<[
"ethereum",
"polygon",
"arbitrum",
"optimism",
"base",
"solana",
"bitcoin",
"cosmos",
"osmosis",
"aptos",
"sui",
"starknet"
]>;Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:211.
Challenge
A challenge issued by the verifier to an authenticating entity.
Type-only declaration; it is not a runtime value.
interface Challenge {
challengeBytes: Uint8Array;
timestamp: string;
nonce: string;
expiresAt: string;
}Source: @openagentid/aegis-sdk@0.1.1, dist/auth/index.d.ts:7.
ChallengeResponseProvider
Auth provider implementing the AEGIS challenge-response protocol.
Validates signed_challenge credentials by:
- Resolving the DID via the registered DID resolver
- Extracting the primary authentication public key
- Reconstructing the challenge and verifying the Ed25519 signature
declare class ChallengeResponseProvider implements AuthProvider {
constructor(resolver: DidResolver);
providerName(): string;
verifier(): ChallengeVerifier;
validate(credential: AuthCredential): Promise<AuthContext>;
getIdentity(ctx: AuthContext): Promise<AegisIdentity>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/auth/index.d.ts:62.
ChallengeVerifier
Challenge-response verifier with in-memory nonce tracking.
Production deployments should swap the in-memory nonce set for a TTL-
backed cache or database via the {@link NonceStore } abstraction in
auth/store.ts.
declare class ChallengeVerifier {
verifyResponse(challenge: Challenge, did: string, signatureB64: string, publicKey: Uint8Array): void;
clearNonces(): void;
}Source: @openagentid/aegis-sdk@0.1.1, dist/auth/index.d.ts:36.
composeDecisions
declare function composeDecisions(decisions: readonly PolicyDecision[]): PolicyDecision;Source: @openagentid/aegis-sdk@0.1.1, dist/policy/index.d.ts:63.
concatBytes
declare function concatBytes(...chunks: Uint8Array[]): Uint8Array;Source: @openagentid/aegis-sdk@0.1.1, dist/encoding-OdOrLVsv.d.ts:9.
ContractInteraction
Type-only declaration; it is not a runtime value.
interface ContractInteraction {
contractAddress: string;
functionName: string;
chain: string;
gasEstimate?: number | null;
}Source: @openagentid/aegis-sdk@0.1.1, dist/policy/index.d.ts:53.
ContractPolicy
Type-only declaration; it is not a runtime value.
interface ContractPolicy {
contractAllowlist: string[];
functionAllowlist: string[];
chainAllowlist: string[];
gasLimit?: number | null;
}Source: @openagentid/aegis-sdk@0.1.1, dist/policy/index.d.ts:47.
ContractPolicyEvaluator
declare class ContractPolicyEvaluator {
static evaluate(policy: ContractPolicy, interaction: ContractInteraction): PolicyDecision;
}Source: @openagentid/aegis-sdk@0.1.1, dist/policy/index.d.ts:59.
createDelegationProof
Create a delegation proof by signing the delegation with the delegator's key.
Steps per spec §9.7:
- Construct delegation object (excluding proof field)
- Canonicalize via JCS (RFC 8785)
- Sign canonical bytes with delegator's delegation key (Ed25519)
declare function createDelegationProof(params: {
delegatorDid: string;
delegateDid: string;
scope: DelegationScope;
expires?: string | null;
signingKey: Uint8Array;
verificationMethod: string;
}): Delegation;Source: @openagentid/aegis-sdk@0.1.1, dist/delegate/index.d.ts:33.
CreateDidParams
Type-only declaration; it is not a runtime value.
interface CreateDidParams {
entityKind: string;
namespace: string;
identifier: string;
metadata: Record<string, string>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/plugin-CzTTSkdE.d.ts:66.
CreatedSessionKey
Type-only declaration; it is not a runtime value.
interface CreatedSessionKey {
sessionKey: SessionKey;
ephemeralSigningKey: Uint8Array;
ephemeralVerifyingKey: Uint8Array;
}Source: @openagentid/aegis-sdk@0.1.1, dist/delegate/index.d.ts:58.
createSessionKey
Create a session key (temporary, scoped, max 24h).
Generates a fresh Ed25519 keypair for the session and signs the grant with the principal's identity key.
declare function createSessionKey(params: {
principalDid: string;
scope: DelegationScope;
maxTransactions?: number | null;
lifetimeMs: number;
principalSigningKey: Uint8Array;
verificationMethod: string;
}): CreatedSessionKey;Source: @openagentid/aegis-sdk@0.1.1, dist/delegate/index.d.ts:70.
cryptoBackend
Returns the active crypto backend. Throws if none has been registered.
In Node.js, the backend can be auto-loaded by loadDefaultCryptoBackend
which dynamically imports @openagentid/crypto-wasm.
declare function cryptoBackend(): CryptoBackend;Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:366.
CryptoBackend
Type-only declaration; it is not a runtime value.
interface CryptoBackend {
ed25519GenerateKeypair(): {
signingKey: Uint8Array;
verifyingKey: Uint8Array;
};
ed25519PublicFromPrivate(signingKey: Uint8Array): Uint8Array;
ed25519Sign(signingKey: Uint8Array, message: Uint8Array): Uint8Array;
ed25519Verify(verifyingKey: Uint8Array, message: Uint8Array, signature: Uint8Array): boolean;
hkdfSha256(ikm: Uint8Array, salt: Uint8Array, info: Uint8Array, length: number): Uint8Array;
blake3Hash(input: Uint8Array): Uint8Array;
sha256(input: Uint8Array): Uint8Array;
sha512(input: Uint8Array): Uint8Array;
aes256GcmEncrypt(key: Uint8Array, nonce: Uint8Array, plaintext: Uint8Array): Uint8Array;
aes256GcmDecrypt(key: Uint8Array, nonce: Uint8Array, ciphertext: Uint8Array): Uint8Array;
jcsCanonicalize(value: unknown): Uint8Array;
multibaseEncode(bytes: Uint8Array): string;
multibaseDecode(encoded: string): Uint8Array;
randomBytes(length: number): Uint8Array;
frostTrustedKeygen(minSigners: number, maxSigners: number): {
keyPackages: FrostKeyPackage[];
publicKeyPackage: Uint8Array;
};
frostSignRound1(signingShare: Uint8Array): {
nonces: Uint8Array;
commitments: Uint8Array;
};
frostSignRound2(signingPackage: Uint8Array, nonces: Uint8Array, keyPackage: Uint8Array): Uint8Array;
frostBuildSigningPackage(commitments: Map<number, Uint8Array>, message: Uint8Array): Uint8Array;
frostAggregate(signingPackage: Uint8Array, signatureShares: Map<number, Uint8Array>, publicKeyPackage: Uint8Array): Uint8Array;
frostVerify(publicKeyPackage: Uint8Array, message: Uint8Array, signature: Uint8Array): boolean;
}Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:320.
DEFAULT_AEGIS_CONFIG
declare const DEFAULT_AEGIS_CONFIG: AegisConfig;Source: @openagentid/aegis-sdk@0.1.1, dist/sdk/index.d.ts:37.
DEFAULT_KEY_CONFIG
declare const DEFAULT_KEY_CONFIG: KeyConfig;Source: @openagentid/aegis-sdk@0.1.1, dist/sdk/index.d.ts:36.
DEFAULT_PAGE_SIZE
declare const DEFAULT_PAGE_SIZE = 100;Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:203.
DEFAULT_PAGINATION
declare const DEFAULT_PAGINATION: Pagination;Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:209.
DEFAULT_SESSION_CONFIG
declare const DEFAULT_SESSION_CONFIG: SessionConfig;Source: @openagentid/aegis-sdk@0.1.1, dist/sdk/index.d.ts:35.
DEFAULT_VERIFICATION_CONFIG
declare const DEFAULT_VERIFICATION_CONFIG: VerificationConfig;Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:125.
defaultAegisStores
declare function defaultAegisStores(): AegisStores;Source: @openagentid/aegis-sdk@0.1.1, dist/sdk/index.d.ts:53.
Delegation
Type-only declaration; it is not a runtime value.
interface Delegation {
id: string;
delegator: string;
delegate: string;
scope: DelegationScope;
created: string;
expires?: string | null;
revocable: boolean;
proof: DelegationProof;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:157.
DelegationError
Type-only declaration; it is not a runtime value.
type DelegationError = {
kind: "delegation/invalid_proof";
reason: string;
message: string;
} | {
kind: "delegation/revoked";
delegationId: string;
message: string;
} | {
kind: "delegation/expired";
delegationId: string;
message: string;
} | {
kind: "delegation/max_depth_exceeded";
depth: number;
maxDepth: number;
message: string;
} | {
kind: "delegation/scope_amplification";
reason: string;
message: string;
} | {
kind: "delegation/delegator_not_found";
did: string;
message: string;
} | {
kind: "delegation/delegate_not_found";
did: string;
message: string;
};Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:184.
delegationErrors
declare const delegationErrors: {
invalidProof: (reason: string) => DelegationError;
revoked: (delegationId: string) => DelegationError;
expired: (delegationId: string) => DelegationError;
maxDepthExceeded: (depth: number, maxDepth: number) => DelegationError;
scopeAmplification: (reason: string) => DelegationError;
delegatorNotFound: (did: string) => DelegationError;
delegateNotFound: (did: string) => DelegationError;
};Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:301.
DelegationProof
Type-only declaration; it is not a runtime value.
interface DelegationProof {
type: "AegisDelegationProof2025";
verificationMethod: string;
created: string;
jws: string;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:151.
DelegationProofSchema
declare const DelegationProofSchema: z.ZodObject<{
type: z.ZodLiteral<"AegisDelegationProof2025">;
verificationMethod: z.ZodString;
created: z.ZodString;
jws: z.ZodString;
}, "strip", z.ZodTypeAny, {
type: "AegisDelegationProof2025";
verificationMethod: string;
created: string;
jws: string;
}, {
type: "AegisDelegationProof2025";
verificationMethod: string;
created: string;
jws: string;
}>;Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:383.
DelegationSchema
declare const DelegationSchema: z.ZodObject<{
id: z.ZodString;
delegator: z.ZodString;
delegate: z.ZodString;
scope: z.ZodObject<{
actions: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
resources: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
chains: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
limits: z.ZodOptional<z.ZodNullable<z.ZodObject<{
maxAmount: z.ZodOptional<z.ZodNullable<z.ZodString>>;
dailyVolume: z.ZodOptional<z.ZodNullable<z.ZodString>>;
assetAllowlist: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
recipientAllowlist: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
approvalThreshold: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, "strip", z.ZodTypeAny, {
assetAllowlist: string[];
recipientAllowlist: string[];
maxAmount?: string | null | undefined;
dailyVolume?: string | null | undefined;
approvalThreshold?: string | null | undefined;
}, {
maxAmount?: string | null | undefined;
dailyVolume?: string | null | undefined;
assetAllowlist?: string[] | undefined;
recipientAllowlist?: string[] | undefined;
approvalThreshold?: string | null | undefined;
}>>>;
temporal: z.ZodOptional<z.ZodNullable<z.ZodObject<{
validFrom: z.ZodOptional<z.ZodNullable<z.ZodString>>;
validUntil: z.ZodOptional<z.ZodNullable<z.ZodString>>;
activeHours: z.ZodOptional<z.ZodNullable<z.ZodObject<{
startHour: z.ZodNumber;
endHour: z.ZodNumber;
timezone: z.ZodString;
}, "strip", z.ZodTypeAny, {
startHour: number;
endHour: number;
timezone: string;
}, {
startHour: number;
endHour: number;
timezone: string;
}>>>;
cooldown: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, "strip", z.ZodTypeAny, {
validFrom?: string | null | undefined;
validUntil?: string | null | undefined;
activeHours?: {
startHour: number;
endHour: number;
timezone: string;
} | null | undefined;
cooldown?: string | null | undefined;
}, {
validFrom?: string | null | undefined;
validUntil?: string | null | undefined;
activeHours?: {
startHour: number;
endHour: number;
timezone: string;
} | null | undefined;
cooldown?: string | null | undefined;
}>>>;
}, "strip", z.ZodTypeAny, {
actions: string[];
resources: string[];
chains: string[];
limits?: {
assetAllowlist: string[];
recipientAllowlist: string[];
maxAmount?: string | null | undefined;
dailyVolume?: string | null | undefined;
approvalThreshold?: string | null | undefined;
} | null | undefined;
temporal?: {
validFrom?: string | null | undefined;
validUntil?: string | null | undefined;
activeHours?: {
startHour: number;
endHour: number;
timezone: string;
} | null | undefined;
cooldown?: string | null | undefined;
} | null | undefined;
}, {
actions?: string[] | undefined;
resources?: string[] | undefined;
chains?: string[] | undefined;
limits?: {
maxAmount?: string | null | undefined;
dailyVolume?: string | null | undefined;
assetAllowlist?: string[] | undefined;
recipientAllowlist?: string[] | undefined;
approvalThreshold?: string | null | undefined;
} | null | undefined;
temporal?: {
validFrom?: string | null | undefined;
validUntil?: string | null | undefined;
activeHours?: {
startHour: number;
endHour: number;
timezone: string;
} | null | undefined;
cooldown?: string | null | undefined;
} | null | undefined;
}>;
created: z.ZodString;
expires: z.ZodOptional<z.ZodNullable<z.ZodString>>;
revocable: z.ZodBoolean;
proof: z.ZodObject<{
type: z.ZodLiteral<"AegisDelegationProof2025">;
verificationMethod: z.ZodString;
created: z.ZodString;
jws: z.ZodString;
}, "strip", z.ZodTypeAny, {
type: "AegisDelegationProof2025";
verificationMethod: string;
created: string;
jws: string;
}, {
type: "AegisDelegationProof2025";
verificationMethod: string;
created: string;
jws: string;
}>;
}, "strip", z.ZodTypeAny, {
created: string;
id: string;
delegator: string;
delegate: string;
scope: {
actions: string[];
resources: string[];
chains: string[];
limits?: {
assetAllowlist: string[];
recipientAllowlist: string[];
maxAmount?: string | null | undefined;
dailyVolume?: string | null | undefined;
approvalThreshold?: string | null | undefined;
} | null | undefined;
temporal?: {
validFrom?: string | null | undefined;
validUntil?: string | null | undefined;
activeHours?: {
startHour: number;
endHour: number;
timezone: string;
} | null | undefined;
cooldown?: string | null | undefined;
} | null | undefined;
};
revocable: boolean;
proof: {
type: "AegisDelegationProof2025";
verificationMethod: string;
created: string;
jws: string;
};
expires?: string | null | undefined;
}, {
created: string;
id: string;
delegator: string;
delegate: string;
scope: {
actions?: string[] | undefined;
resources?: string[] | undefined;
chains?: string[] | undefined;
limits?: {
maxAmount?: string | null | undefined;
dailyVolume?: string | null | undefined;
assetAllowlist?: string[] | undefined;
recipientAllowlist?: string[] | undefined;
approvalThreshold?: string | null | undefined;
} | null | undefined;
temporal?: {
validFrom?: string | null | undefined;
validUntil?: string | null | undefined;
activeHours?: {
startHour: number;
endHour: number;
timezone: string;
} | null | undefined;
cooldown?: string | null | undefined;
} | null | undefined;
};
revocable: boolean;
proof: {
type: "AegisDelegationProof2025";
verificationMethod: string;
created: string;
jws: string;
};
expires?: string | null | undefined;
}>;Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:399.
DelegationScope
Type-only declaration; it is not a runtime value.
interface DelegationScope {
actions: string[];
resources: string[];
chains: string[];
limits?: SpendingLimits | null;
temporal?: TemporalConstraints | null;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:144.
DelegationScopeSchema
declare const DelegationScopeSchema: z.ZodObject<{
actions: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
resources: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
chains: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
limits: z.ZodOptional<z.ZodNullable<z.ZodObject<{
maxAmount: z.ZodOptional<z.ZodNullable<z.ZodString>>;
dailyVolume: z.ZodOptional<z.ZodNullable<z.ZodString>>;
assetAllowlist: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
recipientAllowlist: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
approvalThreshold: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, "strip", z.ZodTypeAny, {
assetAllowlist: string[];
recipientAllowlist: string[];
maxAmount?: string | null | undefined;
dailyVolume?: string | null | undefined;
approvalThreshold?: string | null | undefined;
}, {
maxAmount?: string | null | undefined;
dailyVolume?: string | null | undefined;
assetAllowlist?: string[] | undefined;
recipientAllowlist?: string[] | undefined;
approvalThreshold?: string | null | undefined;
}>>>;
temporal: z.ZodOptional<z.ZodNullable<z.ZodObject<{
validFrom: z.ZodOptional<z.ZodNullable<z.ZodString>>;
validUntil: z.ZodOptional<z.ZodNullable<z.ZodString>>;
activeHours: z.ZodOptional<z.ZodNullable<z.ZodObject<{
startHour: z.ZodNumber;
endHour: z.ZodNumber;
timezone: z.ZodString;
}, "strip", z.ZodTypeAny, {
startHour: number;
endHour: number;
timezone: string;
}, {
startHour: number;
endHour: number;
timezone: string;
}>>>;
cooldown: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, "strip", z.ZodTypeAny, {
validFrom?: string | null | undefined;
validUntil?: string | null | undefined;
activeHours?: {
startHour: number;
endHour: number;
timezone: string;
} | null | undefined;
cooldown?: string | null | undefined;
}, {
validFrom?: string | null | undefined;
validUntil?: string | null | undefined;
activeHours?: {
startHour: number;
endHour: number;
timezone: string;
} | null | undefined;
cooldown?: string | null | undefined;
}>>>;
}, "strip", z.ZodTypeAny, {
actions: string[];
resources: string[];
chains: string[];
limits?: {
assetAllowlist: string[];
recipientAllowlist: string[];
maxAmount?: string | null | undefined;
dailyVolume?: string | null | undefined;
approvalThreshold?: string | null | undefined;
} | null | undefined;
temporal?: {
validFrom?: string | null | undefined;
validUntil?: string | null | undefined;
activeHours?: {
startHour: number;
endHour: number;
timezone: string;
} | null | undefined;
cooldown?: string | null | undefined;
} | null | undefined;
}, {
actions?: string[] | undefined;
resources?: string[] | undefined;
chains?: string[] | undefined;
limits?: {
maxAmount?: string | null | undefined;
dailyVolume?: string | null | undefined;
assetAllowlist?: string[] | undefined;
recipientAllowlist?: string[] | undefined;
approvalThreshold?: string | null | undefined;
} | null | undefined;
temporal?: {
validFrom?: string | null | undefined;
validUntil?: string | null | undefined;
activeHours?: {
startHour: number;
endHour: number;
timezone: string;
} | null | undefined;
cooldown?: string | null | undefined;
} | null | undefined;
}>;Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:281.
DelegationStore
Type-only declaration; it is not a runtime value.
interface DelegationStore {
storeDelegation(delegation: Delegation): Promise<void>;
getDelegation(id: string): Promise<Delegation | null>;
listByDelegator(delegatorDid: string, pagination?: Pagination): Promise<Delegation[]>;
listByDelegate(delegateDid: string, pagination?: Pagination): Promise<Delegation[]>;
deleteDelegation(id: string): Promise<boolean>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/store-BqzEijTF.d.ts:33.
DelegationTree
declare class DelegationTree {
readonly maxDepth: number;
constructor(maxDepth?: number);
addDelegation(delegation: Delegation): void;
getDelegationChain(delegateDid: string): Delegation[];
effectiveScope(delegateDid: string): DelegationScope | null;
depth(delegateDid: string): number;
revoke(delegationId: string): string[];
}Source: @openagentid/aegis-sdk@0.1.1, dist/store-BqzEijTF.d.ts:3.
derivationPath
Build a BIP-44 derivation path for a given blockchain chain.
Returns the standard m/44'/coin_type'/account'/0/index path
used for HD key derivation across most chains.
declare function derivationPath(chain: Chain, account: number, index: number): string;Source: @openagentid/aegis-sdk@0.1.1, dist/keys/index.d.ts:26.
derivationStandard
Returns the derivation standard name for the given chain.
declare function derivationStandard(chain: Chain): "BIP-44" | "SLIP-0010";Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:182.
deriveLineageKey
Derive a lineage key from a parent private key using HKDF-SHA256.
Algorithm: HKDF-SHA256( IKM = parent_private_key (32 bytes), Salt = child_did_utf8, Info = "oas-lineage-v1" || generation_be32, L = 32 )
declare function deriveLineageKey(parentPrivate: Uint8Array, childDid: string, generation: number): Uint8Array;Source: @openagentid/aegis-sdk@0.1.1, dist/keys/index.d.ts:19.
DidCreationResult
Type-only declaration; it is not a runtime value.
interface DidCreationResult {
did: string;
document: OasDocument;
}Source: @openagentid/aegis-sdk@0.1.1, dist/plugin-CzTTSkdE.d.ts:72.
DidResolver
DID Resolver plugin interface (§4.1).
Enables AEGIS to resolve any DID method without coupling to a specific resolution mechanism. Each resolver handles one or more DID methods.
Implementations MUST resolve within 5 seconds.
Type-only declaration; it is not a runtime value.
interface DidResolver {
resolve(did: string): Promise<OasDocument>;
handles(did: string): boolean;
supportedMethods(): readonly string[];
create?(params: CreateDidParams): Promise<DidCreationResult>;
update?(did: string, document: OasDocument): Promise<void>;
deactivate?(did: string): Promise<void>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/plugin-CzTTSkdE.d.ts:84.
DirectSigner
Direct signing backend using a single Ed25519 key.
The signing key is stored in memory; callers should treat the instance as sensitive material and zeroize when done.
declare class DirectSigner implements SigningBackend {
constructor(signingKey: Uint8Array);
sign(request: SigningRequest): Promise<SigningResult>;
publicKey(): Uint8Array;
mode(): SigningMode;
}Source: @openagentid/aegis-sdk@0.1.1, dist/pipeline-u2tQgstP.d.ts:24.
DocumentMetadata
Type-only declaration; it is not a runtime value.
interface DocumentMetadata {
created: string;
updated?: string | null;
}Source: @openagentid/aegis-sdk@0.1.1, dist/plugin-CzTTSkdE.d.ts:25.
DocumentProof
Type-only declaration; it is not a runtime value.
interface DocumentProof {
type: string;
verificationMethod: string;
created: string;
jws?: string;
proofValue?: string;
}Source: @openagentid/aegis-sdk@0.1.1, dist/plugin-CzTTSkdE.d.ts:29.
EncryptedKey
An encrypted private key blob.
Uses AES-256-GCM with a random 96-bit nonce. The ciphertext contains the 32-byte Ed25519 signing key material plus a 16-byte authentication tag.
declare class EncryptedKey {
readonly ciphertext: Uint8Array;
readonly nonce: Uint8Array;
static encrypt(signingKeyBytes: Uint8Array, encryptionKey: Uint8Array): EncryptedKey;
decrypt(encryptionKey: Uint8Array): Uint8Array;
static fromParts(ciphertext: Uint8Array, nonce: Uint8Array): EncryptedKey;
}Source: @openagentid/aegis-sdk@0.1.1, dist/storage-BI8577zJ.d.ts:9.
EntityKind
Type-only declaration; it is not a runtime value.
type EntityKind = "hmr" | "mhr" | "enr" | "ao" | "agent" | "agent:instance" | "tool" | "skill" | "workflow" | "model" | "dataset" | "service";Source: @openagentid/aegis-sdk@0.1.1, dist/plugin-CzTTSkdE.d.ts:4.
FrostCeremony
State of a distributed FROST signing ceremony, suitable for orchestrating the protocol across multiple machines/processes. Each participant calls the methods in order:
addCommitment(id, commitments)— gather round 1 outputsbuildSigningPackage(message)— build signing package once all participants have committedaddSignatureShare(id, share)— gather round 2 outputsaggregate()— produce the final aggregated signature
The ceremony does NOT hold any participant key material — those remain on the participant's own machine.
declare class FrostCeremony {
constructor(publicKeyPackage: Uint8Array, threshold: number);
addCommitment(id: number, commitments: Uint8Array): void;
hasEnoughCommitments(): boolean;
buildSigningPackage(message: Uint8Array): Uint8Array;
addSignatureShare(id: number, share: Uint8Array): void;
hasEnoughShares(): boolean;
aggregate(): Uint8Array;
}Source: @openagentid/aegis-sdk@0.1.1, dist/keys/index.d.ts:123.
FrostKeyPackage
Type-only declaration; it is not a runtime value.
interface FrostKeyPackage {
identifier: number;
bytes: Uint8Array;
}Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:351.
generateChallenge
Generate a new random challenge.
declare function generateChallenge(): Challenge;Source: @openagentid/aegis-sdk@0.1.1, dist/auth/index.d.ts:18.
generateShares
Generate threshold key shares using FROST trusted dealer.
Creates a t-of-n setup: any minSigners of maxSigners participants
may cooperate to produce a valid signature. The dealer is trusted to
destroy its copy of the master secret after distribution.
declare function generateShares(minSigners: number, maxSigners: number): ThresholdKeyPackages;Source: @openagentid/aegis-sdk@0.1.1, dist/keys/index.d.ts:92.
Guardian
Type-only declaration; it is not a runtime value.
interface Guardian {
guardianType: GuardianType;
identifier: string;
weight: number;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:192.
GuardianAuthorization
Type-only declaration; it is not a runtime value.
interface GuardianAuthorization {
guardian: Guardian;
authorizedAt: string;
signature: string;
}Source: @openagentid/aegis-sdk@0.1.1, dist/keys/index.d.ts:51.
GuardianType
Type-only declaration; it is not a runtime value.
type GuardianType = "identity" | "email" | "phone" | "hardware";Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:191.
hexDecode
declare function hexDecode(input: string): Uint8Array;Source: @openagentid/aegis-sdk@0.1.1, dist/encoding-OdOrLVsv.d.ts:6.
hexEncode
declare function hexEncode(bytes: Uint8Array): string;Source: @openagentid/aegis-sdk@0.1.1, dist/encoding-OdOrLVsv.d.ts:5.
IdentityType
The type of entity being authenticated.
Type-only declaration; it is not a runtime value.
type IdentityType = "human" | "agent" | "organization" | "enterprise" | "delegated";Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:4.
IdentityTypeSchema
declare const IdentityTypeSchema: z.ZodEnum<[
"human",
"agent",
"organization",
"enterprise",
"delegated"
]>;Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:210.
inferIdentityTypeFromDid
Infer the IdentityType from a did:oas:<ns>:<kind>:<id> string.
Returns "agent" if the DID cannot be parsed.
declare function inferIdentityTypeFromDid(did: string): "human" | "organization" | "enterprise" | "agent";Source: @openagentid/aegis-sdk@0.1.1, dist/plugin-CzTTSkdE.d.ts:64.
InMemoryDelegationStore
declare class InMemoryDelegationStore implements DelegationStore {
storeDelegation(delegation: Delegation): Promise<void>;
getDelegation(id: string): Promise<Delegation | null>;
listByDelegator(delegatorDid: string, pagination?: Pagination): Promise<Delegation[]>;
listByDelegate(delegateDid: string, pagination?: Pagination): Promise<Delegation[]>;
deleteDelegation(id: string): Promise<boolean>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/store-BqzEijTF.d.ts:40.
InMemoryKeyStore
declare class InMemoryKeyStore implements KeyStore {
size(): number;
isEmpty(): boolean;
store(key: ManagedKey): Promise<void>;
load(keyId: string): Promise<ManagedKey>;
delete(keyId: string): Promise<void>;
list(role: KeyRole | null, pagination?: Pagination): Promise<string[]>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/storage-BI8577zJ.d.ts:63.
InMemoryNonceStore
declare class InMemoryNonceStore implements NonceStore {
recordNonce(nonce: string): Promise<boolean>;
hasNonce(nonce: string): Promise<boolean>;
cleanup(): Promise<number>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/store-DM30q3CR.d.ts:48.
InMemoryRevocationStore
declare class InMemoryRevocationStore implements RevocationStore {
revoke(delegationId: string): Promise<void>;
isRevoked(delegationId: string): Promise<boolean>;
revokeBatch(ids: readonly string[]): Promise<void>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/store-BqzEijTF.d.ts:53.
InMemorySessionStore
declare class InMemorySessionStore implements SessionStore {
storeSession(session: Session): Promise<void>;
getSession(sessionId: string): Promise<Session | null>;
deleteSession(sessionId: string): Promise<boolean>;
listByDid(did: string, pagination?: Pagination): Promise<Session[]>;
cleanupExpired(): Promise<number>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/store-DM30q3CR.d.ts:34.
InMemoryVerificationCacheStore
declare class InMemoryVerificationCacheStore implements VerificationCacheStore {
constructor(ttlSecs: number);
ttlSecs(): number;
getCached(did: string): Promise<VerificationResult | null>;
storeCached(did: string, result: VerificationResult): Promise<void>;
invalidate(did: string): Promise<void>;
cleanupExpired(): Promise<number>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/store-D8FECMQ_.d.ts:54.
intersectScopes
Compute the intersection of two scopes.
- Empty list = wildcard, take the other side
- Otherwise, set intersection
- For limits, take the most restrictive value
declare function intersectScopes(a: DelegationScope, b: DelegationScope): DelegationScope;Source: @openagentid/aegis-sdk@0.1.1, dist/delegate/index.d.ts:19.
isRotationEligible
Convenience function: returns true if the role is eligible for standard rotation. Session and Recovery keys are excluded.
declare function isRotationEligible(role: KeyRole): boolean;Source: @openagentid/aegis-sdk@0.1.1, dist/keys/index.d.ts:49.
isScopeSubset
Returns true if child scope is a subset of parent scope.
Empty fields on parent mean "wildcard" — they accept any child value.
Limits on child must be at least as restrictive as the parent's.
declare function isScopeSubset(child: DelegationScope, parent: DelegationScope): boolean;Source: @openagentid/aegis-sdk@0.1.1, dist/delegate/index.d.ts:11.
KeyConfig
Type-only declaration; it is not a runtime value.
interface KeyConfig {
encryptionAlgorithm: string;
zeroizeOnDrop: boolean;
}Source: @openagentid/aegis-sdk@0.1.1, dist/sdk/index.d.ts:25.
KeyError
Type-only declaration; it is not a runtime value.
type KeyError = {
kind: "key/generation_failed";
reason: string;
message: string;
} | {
kind: "key/derivation_failed";
reason: string;
message: string;
} | {
kind: "key/rotation_failed";
reason: string;
message: string;
} | {
kind: "key/recovery_failed";
reason: string;
message: string;
} | {
kind: "key/mpc_failed";
reason: string;
message: string;
} | {
kind: "key/not_found";
keyId: string;
message: string;
} | {
kind: "key/storage_error";
reason: string;
message: string;
} | {
kind: "key/signing_failed";
reason: string;
message: string;
} | {
kind: "key/unsupported_type";
keyType: string;
message: string;
};Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:147.
keyErrors
declare const keyErrors: {
generationFailed: (reason: string) => KeyError;
derivationFailed: (reason: string) => KeyError;
rotationFailed: (reason: string) => KeyError;
recoveryFailed: (reason: string) => KeyError;
mpcFailed: (reason: string) => KeyError;
notFound: (keyId: string) => KeyError;
storageError: (reason: string) => KeyError;
signingFailed: (reason: string) => KeyError;
unsupportedKeyType: (keyType: string) => KeyError;
};Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:290.
KeyGenerationMode
Type-only declaration; it is not a runtime value.
type KeyGenerationMode = "direct" | "mpc" | "tee" | "hsm";Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:186.
KeyGenerator
Key generator supporting multiple generation modes (§6.2).
Currently implements direct generation via the WASM backend's CSPRNG.
MPC, TEE, and HSM modes are stubs that throw an unsupported error.
declare class KeyGenerator {
static generateDirect(role: KeyRole, encryptionKey: Uint8Array): ManagedKey;
static generateKeyId(): string;
}Source: @openagentid/aegis-sdk@0.1.1, dist/storage-BI8577zJ.d.ts:51.
KeyRole
Type-only declaration; it is not a runtime value.
type KeyRole = "identity" | "authentication" | "assertion" | "delegation" | "session" | "recovery" | "chain";Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:185.
KeyRoleSchema
declare const KeyRoleSchema: z.ZodEnum<[
"identity",
"authentication",
"assertion",
"delegation",
"session",
"recovery",
"chain"
]>;Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:212.
KeyRotation
declare class KeyRotation {
static initiate(old: ManagedKey, encryptionKey: Uint8Array): RotationResult;
static initiateWithGrace(old: ManagedKey, encryptionKey: Uint8Array, gracePeriodMs: number): RotationResult;
static isGracePeriodExpired(result: RotationResult): boolean;
}Source: @openagentid/aegis-sdk@0.1.1, dist/keys/index.d.ts:39.
KeyStore
Type-only declaration; it is not a runtime value.
interface KeyStore {
store(key: ManagedKey): Promise<void>;
load(keyId: string): Promise<ManagedKey>;
delete(keyId: string): Promise<void>;
list(role: KeyRole | null, pagination?: Pagination): Promise<string[]>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/storage-BI8577zJ.d.ts:57.
LifecycleStatus
Type-only declaration; it is not a runtime value.
type LifecycleStatus = "active" | "suspended" | "terminated" | "deprecated" | "draft";Source: @openagentid/aegis-sdk@0.1.1, dist/plugin-CzTTSkdE.d.ts:3.
LineagePolicy
Type-only declaration; it is not a runtime value.
interface LineagePolicy {
minConformanceLevel?: number | null;
maxLineageDepth?: number | null;
requiredHumanRootLiveness?: number | null;
requiredAttestations: string[];
bannedHumanRoots: string[];
}Source: @openagentid/aegis-sdk@0.1.1, dist/policy/index.d.ts:35.
LineagePolicyEvaluator
declare class LineagePolicyEvaluator {
static evaluate(policy: LineagePolicy, verification: VerificationResult): PolicyDecision;
}Source: @openagentid/aegis-sdk@0.1.1, dist/policy/index.d.ts:43.
LineageSection
Optional lineage section for non-root entities.
Type-only declaration; it is not a runtime value.
interface LineageSection {
parent: string;
generation: number;
humanRootChain: string[];
proof?: AgentLineageProof | null;
}Source: @openagentid/aegis-sdk@0.1.1, dist/plugin-CzTTSkdE.d.ts:13.
LineageSummary
Type-only declaration; it is not a runtime value.
interface LineageSummary {
depth: number;
humanRoot: string;
verified: boolean;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:69.
LivenessStatus
Type-only declaration; it is not a runtime value.
type LivenessStatus = "active" | "warning" | "stale" | "unknown";Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:104.
loadDefaultCryptoBackend
Attempts to load @openagentid/crypto-wasm lazily. Falls back to a
stub error backend if the module isn't available — callers should
rely on this for one-time setup in tests/examples.
declare function loadDefaultCryptoBackend(): Promise<void>;Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:372.
makePagination
declare function makePagination(limit: number, offset: number): Pagination;Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:208.
makeTransaction
declare function makeTransaction(params: {
fromDid: string;
to: string;
chain: string;
data: Uint8Array;
value?: string | null;
}): Transaction;Source: @openagentid/aegis-sdk@0.1.1, dist/pipeline-u2tQgstP.d.ts:43.
ManagedKey
A managed key with metadata. The private key is stored encrypted; access to the raw signing key requires presenting the encryption key.
declare class ManagedKey {
readonly keyId: string;
readonly role: KeyRole;
readonly generationMode: KeyGenerationMode;
readonly publicKey: Uint8Array;
readonly encryptedPrivate: EncryptedKey;
readonly createdAt: string;
constructor(params: {
keyId: string;
role: KeyRole;
generationMode: KeyGenerationMode;
publicKey: Uint8Array;
encryptedPrivate: EncryptedKey;
createdAt: string;
});
publicKeyMultibase(): string;
decryptPrivate(encryptionKey: Uint8Array): Uint8Array;
}Source: @openagentid/aegis-sdk@0.1.1, dist/storage-BI8577zJ.d.ts:24.
MAX_PAGE_SIZE
declare const MAX_PAGE_SIZE = 1000;Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:202.
NonceStore
Type-only declaration; it is not a runtime value.
interface NonceStore {
recordNonce(nonce: string): Promise<boolean>;
hasNonce(nonce: string): Promise<boolean>;
cleanup(): Promise<number>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/store-DM30q3CR.d.ts:42.
oasDocument
Helpers for inspecting OAS documents without coupling to a specific SDK.
declare const oasDocument: {
isRoot(doc: OasDocument): boolean;
isRevoked(doc: OasDocument): boolean;
primaryPublicKeyMultibase(doc: OasDocument): string | null;
findVerificationMethod(doc: OasDocument, id: string): VerificationMethod | null;
};Source: @openagentid/aegis-sdk@0.1.1, dist/plugin-CzTTSkdE.d.ts:53.
OasDocument
Minimal OAS Identity Document interface.
Type-only declaration; it is not a runtime value.
interface OasDocument {
id: string;
oasVersion: string;
kind: string;
verificationMethod: VerificationMethod[];
authentication?: string[];
assertionMethod?: string[];
delegationMethod?: string[];
metadata: DocumentMetadata;
lineage?: LineageSection | null;
lifecycleStatus?: LifecycleStatus | null;
revoked?: boolean;
proof?: DocumentProof | null;
[key: string]: unknown;
}Source: @openagentid/aegis-sdk@0.1.1, dist/plugin-CzTTSkdE.d.ts:37.
Obligation
Type-only declaration; it is not a runtime value.
interface Obligation {
obligationType: ObligationType;
params: Record<string, unknown>;
deadline?: string | null;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:81.
ObligationType
Type-only declaration; it is not a runtime value.
type ObligationType = "log" | "notify" | "approve" | "escrow" | "limit";Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:80.
Pagination
Type-only declaration; it is not a runtime value.
interface Pagination {
limit: number;
offset: number;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:204.
parseAmount
Parse a decimal amount string. Throws PolicyError on invalid input.
declare function parseAmount(s: string): number;Source: @openagentid/aegis-sdk@0.1.1, dist/policy/index.d.ts:22.
parseIso8601DurationMs
Parse a simplified ISO 8601 duration into milliseconds.
Supports PT{n}S, PT{n}M, PT{n}H, and P{n}D. Falls back to 24 hours
for unrecognized formats.
declare function parseIso8601DurationMs(input: string): number;Source: @openagentid/aegis-sdk@0.1.1, dist/keys/index.d.ts:76.
PermissionCheck
Type-only declaration; it is not a runtime value.
interface PermissionCheck {
principal: string;
permission: string;
resource?: string | null;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:98.
PluginRegistry
The Plugin Registry manages all loaded plugins and routes requests to the appropriate plugin (AEGIS Spec §4.4).
- Multiple DID Resolvers (routed by
handles()matching) - Multiple Auth Providers (keyed by
providerName()) - Exactly one Policy Engine
Plugin registration order is deterministic. Resolvers are tried in
registration order; the first whose handles() returns true is used.
declare class PluginRegistry {
registerResolver(resolver: DidResolver): void;
registerAuthProvider(provider: AuthProvider): void;
setPolicyEngine(engine: PolicyEngine): void;
resolverCount(): number;
authProviderCount(): number;
hasPolicyEngine(): boolean;
getResolverFor(did: string): DidResolver | null;
getAuthProvider(name: string): AuthProvider | null;
getPolicyEngine(): PolicyEngine | null;
resolveDid(did: string): Promise<OasDocument>;
validateCredential(credential: AuthCredential, providerName?: string | null): Promise<AuthContext>;
evaluatePolicy(request: PolicyRequest): Promise<PolicyDecision>;
checkPermission(check: PermissionCheck): Promise<boolean>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/plugin-CzTTSkdE.d.ts:116.
PolicyContext
Type-only declaration; it is not a runtime value.
interface PolicyContext {
authContext?: AuthContext | null;
lineage?: LineageSummary | null;
conformanceLevel?: number | null;
session?: Session | null;
extra: Record<string, unknown>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:62.
PolicyDecision
Type-only declaration; it is not a runtime value.
interface PolicyDecision {
allowed: boolean;
reason?: string | null;
obligations: Obligation[];
auditInfo: AuditInfo;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:92.
PolicyEngine
Type-only declaration; it is not a runtime value.
interface PolicyEngine {
evaluate(request: PolicyRequest): Promise<PolicyDecision>;
checkPermission(check: PermissionCheck): Promise<boolean>;
engineName(): string;
getPolicies?(did: string): Promise<unknown[]>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/plugin-CzTTSkdE.d.ts:99.
PolicyError
Type-only declaration; it is not a runtime value.
type PolicyError = {
kind: "policy/evaluation_failed";
reason: string;
message: string;
} | {
kind: "policy/timeout";
timeoutMs: number;
message: string;
} | {
kind: "policy/engine_unavailable";
message: string;
} | {
kind: "policy/no_engine";
message: string;
} | {
kind: "policy/config_error";
reason: string;
message: string;
};Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:75.
policyErrors
declare const policyErrors: {
evaluationFailed: (reason: string) => PolicyError;
timeout: (timeoutMs: number) => PolicyError;
engineUnavailable: () => PolicyError;
noEngine: () => PolicyError;
configError: (reason: string) => PolicyError;
};Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:272.
PolicyRequest
Type-only declaration; it is not a runtime value.
interface PolicyRequest {
principal: string;
action: string;
resource: string;
context: PolicyContext;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:74.
RecoveryCeremony
declare class RecoveryCeremony {
readonly ceremonyId: string;
readonly config: RecoveryConfig;
readonly authorizations: GuardianAuthorization[];
readonly initiatedAt: string;
readonly timelockUntil: string;
constructor(config: RecoveryConfig);
addAuthorization(auth: GuardianAuthorization): void;
isThresholdMet(): boolean;
isTimelockExpired(): boolean;
canExecute(): boolean;
accumulatedWeight(): number;
authorizationCount(): number;
}Source: @openagentid/aegis-sdk@0.1.1, dist/keys/index.d.ts:56.
RecoveryConfig
Type-only declaration; it is not a runtime value.
interface RecoveryConfig {
guardians: Guardian[];
threshold: number;
timelock: string;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:197.
ResolverError
Type-only declaration; it is not a runtime value.
type ResolverError = {
kind: "resolver/not_found";
did: string;
message: string;
} | {
kind: "resolver/invalid_format";
reason: string;
message: string;
} | {
kind: "resolver/timeout";
did: string;
timeoutMs: number;
message: string;
} | {
kind: "resolver/deactivated";
did: string;
message: string;
} | {
kind: "resolver/network";
did: string;
reason: string;
message: string;
} | {
kind: "resolver/creation_not_supported";
message: string;
} | {
kind: "resolver/update_not_supported";
message: string;
} | {
kind: "resolver/deactivation_not_supported";
message: string;
};Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:6.
resolverErrors
declare const resolverErrors: {
notFound: (did: string) => ResolverError;
invalidFormat: (reason: string) => ResolverError;
timeout: (did: string, timeoutMs: number) => ResolverError;
deactivated: (did: string) => ResolverError;
network: (did: string, reason: string) => ResolverError;
creationNotSupported: () => ResolverError;
updateNotSupported: () => ResolverError;
deactivationNotSupported: () => ResolverError;
};Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:251.
RevocationRegistry
declare class RevocationRegistry {
revoke(delegationId: string): void;
isRevoked(delegationId: string): boolean;
revokeCascade(ids: readonly string[]): void;
size(): number;
}Source: @openagentid/aegis-sdk@0.1.1, dist/delegate/index.d.ts:49.
RevocationStatus
Type-only declaration; it is not a runtime value.
type RevocationStatus = "active" | "revoked" | "suspended" | "expired" | "unknown";Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:103.
RevocationStore
Type-only declaration; it is not a runtime value.
interface RevocationStore {
revoke(delegationId: string): Promise<void>;
isRevoked(delegationId: string): Promise<boolean>;
revokeBatch(ids: readonly string[]): Promise<void>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/store-BqzEijTF.d.ts:48.
RotationRequest
Type-only declaration; it is not a runtime value.
interface RotationRequest {
keyId: string;
gracePeriodMs: number;
}Source: @openagentid/aegis-sdk@0.1.1, dist/keys/index.d.ts:28.
RotationResult
Type-only declaration; it is not a runtime value.
interface RotationResult {
oldKeyId: string;
newKey: ManagedKey;
gracePeriodEnds: string;
}Source: @openagentid/aegis-sdk@0.1.1, dist/keys/index.d.ts:33.
Session
Session token structure (AEGIS Spec §7.4).
Type-only declaration; it is not a runtime value.
interface Session {
sessionId: string;
did: string;
provider: string;
createdAt: string;
expiresAt: string;
scope: string[];
deviceBinding?: string | null;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:53.
SessionConfig
Type-only declaration; it is not a runtime value.
interface SessionConfig {
humanLifetimeSecs: number;
agentLifetimeSecs: number;
sessionKeyMaxSecs: number;
}Source: @openagentid/aegis-sdk@0.1.1, dist/sdk/index.d.ts:17.
SessionKey
Type-only declaration; it is not a runtime value.
interface SessionKey {
sessionKey: string;
principal: string;
scope: DelegationScope;
maxTransactions?: number | null;
created: string;
expires: string;
proof: DelegationProof;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:167.
SessionManager
declare class SessionManager {
readonly humanLifetimeMs: number;
readonly agentLifetimeMs: number;
constructor(opts?: SessionManagerOptions);
createSession(params: {
did: string;
provider: string;
scope?: string[];
isAgent: boolean;
deviceBinding?: string | null;
}): Session;
getSession(sessionId: string): Session;
revokeSession(sessionId: string): void;
isValid(sessionId: string): boolean;
cleanupExpired(): number;
sessionCount(): number;
}Source: @openagentid/aegis-sdk@0.1.1, dist/store-DM30q3CR.d.ts:7.
SessionManagerOptions
Type-only declaration; it is not a runtime value.
interface SessionManagerOptions {
humanLifetimeMs?: number;
agentLifetimeMs?: number;
}Source: @openagentid/aegis-sdk@0.1.1, dist/store-DM30q3CR.d.ts:3.
SessionStore
Type-only declaration; it is not a runtime value.
interface SessionStore {
storeSession(session: Session): Promise<void>;
getSession(sessionId: string): Promise<Session | null>;
deleteSession(sessionId: string): Promise<boolean>;
listByDid(did: string, pagination?: Pagination): Promise<Session[]>;
cleanupExpired(): Promise<number>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/store-DM30q3CR.d.ts:27.
setCryptoBackend
Inject a custom crypto backend implementation. Call this once at SDK
initialization (typically with the @openagentid/crypto-wasm exports).
declare function setCryptoBackend(impl: CryptoBackend): void;Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:359.
SigningBackend
Type-only declaration; it is not a runtime value.
interface SigningBackend {
sign(request: SigningRequest): Promise<SigningResult>;
publicKey(): Uint8Array;
mode(): SigningMode;
}Source: @openagentid/aegis-sdk@0.1.1, dist/pipeline-u2tQgstP.d.ts:13.
SigningMode
Type-only declaration; it is not a runtime value.
type SigningMode = "direct" | "mpc" | "tee" | "external";Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:183.
SigningRequest
Type-only declaration; it is not a runtime value.
interface SigningRequest {
message: Uint8Array;
signerDid: string;
chain?: Chain | null;
}Source: @openagentid/aegis-sdk@0.1.1, dist/pipeline-u2tQgstP.d.ts:3.
SigningResult
Type-only declaration; it is not a runtime value.
interface SigningResult {
signature: Uint8Array;
publicKey: Uint8Array;
mode: SigningMode;
}Source: @openagentid/aegis-sdk@0.1.1, dist/pipeline-u2tQgstP.d.ts:8.
signWithThreshold
Run a complete FROST signing round in a single process.
In production, each participant would perform round1 and round2 independently. This helper executes the full 2-round protocol locally for testing, validation, and single-process orchestration scenarios.
declare function signWithThreshold(message: Uint8Array, keyPackages: Map<number, Uint8Array>, publicKeyPackage: Uint8Array): Uint8Array;Source: @openagentid/aegis-sdk@0.1.1, dist/keys/index.d.ts:106.
SpendingLimits
Type-only declaration; it is not a runtime value.
interface SpendingLimits {
maxAmount?: string | null;
dailyVolume?: string | null;
assetAllowlist: string[];
recipientAllowlist: string[];
approvalThreshold?: string | null;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:137.
SpendingLimitsSchema
declare const SpendingLimitsSchema: z.ZodObject<{
maxAmount: z.ZodOptional<z.ZodNullable<z.ZodString>>;
dailyVolume: z.ZodOptional<z.ZodNullable<z.ZodString>>;
assetAllowlist: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
recipientAllowlist: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
approvalThreshold: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, "strip", z.ZodTypeAny, {
assetAllowlist: string[];
recipientAllowlist: string[];
maxAmount?: string | null | undefined;
dailyVolume?: string | null | undefined;
approvalThreshold?: string | null | undefined;
}, {
maxAmount?: string | null | undefined;
dailyVolume?: string | null | undefined;
assetAllowlist?: string[] | undefined;
recipientAllowlist?: string[] | undefined;
approvalThreshold?: string | null | undefined;
}>;Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:213.
SpendingPolicyEvaluator
declare class SpendingPolicyEvaluator {
static evaluate(limits: SpendingLimits, tx: TransactionInfo, dailySpent: string): PolicyDecision;
}Source: @openagentid/aegis-sdk@0.1.1, dist/policy/index.d.ts:10.
StorageBackend
Storage backend selection.
Type-only declaration; it is not a runtime value.
type StorageBackend = {
type: "in_memory";
} | {
type: "postgres";
url: string;
};Source: @openagentid/aegis-sdk@0.1.1, dist/sdk/index.d.ts:11.
TemporalConstraints
Type-only declaration; it is not a runtime value.
interface TemporalConstraints {
validFrom?: string | null;
validUntil?: string | null;
activeHours?: ActiveHours | null;
cooldown?: string | null;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:131.
TemporalConstraintsSchema
declare const TemporalConstraintsSchema: z.ZodObject<{
validFrom: z.ZodOptional<z.ZodNullable<z.ZodString>>;
validUntil: z.ZodOptional<z.ZodNullable<z.ZodString>>;
activeHours: z.ZodOptional<z.ZodNullable<z.ZodObject<{
startHour: z.ZodNumber;
endHour: z.ZodNumber;
timezone: z.ZodString;
}, "strip", z.ZodTypeAny, {
startHour: number;
endHour: number;
timezone: string;
}, {
startHour: number;
endHour: number;
timezone: string;
}>>>;
cooldown: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, "strip", z.ZodTypeAny, {
validFrom?: string | null | undefined;
validUntil?: string | null | undefined;
activeHours?: {
startHour: number;
endHour: number;
timezone: string;
} | null | undefined;
cooldown?: string | null | undefined;
}, {
validFrom?: string | null | undefined;
validUntil?: string | null | undefined;
activeHours?: {
startHour: number;
endHour: number;
timezone: string;
} | null | undefined;
cooldown?: string | null | undefined;
}>;Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:245.
TemporalPolicyEvaluator
declare class TemporalPolicyEvaluator {
static evaluate(constraints: TemporalConstraints, now?: Date): PolicyDecision;
static evaluateWithCooldown(constraints: TemporalConstraints, now: Date, lastOperation: Date | null): PolicyDecision;
}Source: @openagentid/aegis-sdk@0.1.1, dist/policy/index.d.ts:24.
ThresholdConfig
Type-only declaration; it is not a runtime value.
interface ThresholdConfig {
threshold: number;
totalShares: number;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:187.
ThresholdKeyPackages
Result of FROST trusted-dealer key generation.
Type-only declaration; it is not a runtime value.
interface ThresholdKeyPackages {
keyPackages: Map<number, Uint8Array>;
publicKeyPackage: Uint8Array;
}Source: @openagentid/aegis-sdk@0.1.1, dist/keys/index.d.ts:79.
Transaction
Type-only declaration; it is not a runtime value.
interface Transaction {
txId: string;
fromDid: string;
to: string;
chain: string;
data: Uint8Array;
value?: string | null;
}Source: @openagentid/aegis-sdk@0.1.1, dist/pipeline-u2tQgstP.d.ts:35.
TransactionInfo
Type-only declaration; it is not a runtime value.
interface TransactionInfo {
asset: string;
amount: string;
recipient: string;
chain: string;
}Source: @openagentid/aegis-sdk@0.1.1, dist/policy/index.d.ts:4.
TransactionPipeline
Full transaction authorization pipeline per AEGIS Spec §10.4.
Enforces a strict 5-step process; if any step fails the transaction is NOT signed.
declare class TransactionPipeline {
constructor(signer: SigningBackend);
authorizeAndSign(tx: Transaction, auth: AuthContext, policyDecision: PolicyDecision): Promise<AuthorizedTransaction>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/pipeline-u2tQgstP.d.ts:61.
u32BeBytes
big-endian u32 → 4 bytes
declare function u32BeBytes(n: number): Uint8Array;Source: @openagentid/aegis-sdk@0.1.1, dist/encoding-OdOrLVsv.d.ts:11.
utf8Decode
declare function utf8Decode(bytes: Uint8Array): string;Source: @openagentid/aegis-sdk@0.1.1, dist/encoding-OdOrLVsv.d.ts:8.
utf8Encode
declare function utf8Encode(s: string): Uint8Array;Source: @openagentid/aegis-sdk@0.1.1, dist/encoding-OdOrLVsv.d.ts:7.
validateScope
declare function validateScope(scope: DelegationScope): void;Source: @openagentid/aegis-sdk@0.1.1, dist/delegate/index.d.ts:20.
VerificationCache
declare class VerificationCache {
constructor(ttlSecs: number);
ttl(): number;
size(): number;
isEmpty(): boolean;
get(did: string): VerificationResult | null;
insert(did: string, result: VerificationResult): void;
invalidate(did: string): void;
clear(): void;
cleanupExpired(): number;
}Source: @openagentid/aegis-sdk@0.1.1, dist/store-D8FECMQ_.d.ts:4.
VerificationCacheStore
Type-only declaration; it is not a runtime value.
interface VerificationCacheStore {
getCached(did: string): Promise<VerificationResult | null>;
storeCached(did: string, result: VerificationResult): Promise<void>;
invalidate(did: string): Promise<void>;
cleanupExpired(): Promise<number>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/store-D8FECMQ_.d.ts:48.
VerificationConfig
Type-only declaration; it is not a runtime value.
interface VerificationConfig {
maxLineageDepth: number;
perHopTimeoutSecs: number;
totalTimeoutSecs: number;
cacheTtlSecs: number;
livenessPeriodDays: number;
conformanceLevel: number;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:117.
VerificationError
Type-only declaration; it is not a runtime value.
type VerificationError = {
kind: "verify/resolution_failed";
did: string;
reason: string;
message: string;
} | {
kind: "verify/invalid_schema";
did: string;
reason: string;
message: string;
} | {
kind: "verify/invalid_signature";
did: string;
message: string;
} | {
kind: "verify/lineage_failed";
did: string;
reason: string;
message: string;
} | {
kind: "verify/max_depth_exceeded";
did: string;
depth: number;
maxDepth: number;
message: string;
} | {
kind: "verify/revoked";
did: string;
message: string;
} | {
kind: "verify/suspended";
did: string;
message: string;
} | {
kind: "verify/human_root_revoked";
humanRoot: string;
message: string;
} | {
kind: "verify/generation_mismatch";
did: string;
expected: number;
found: number;
message: string;
} | {
kind: "verify/timeout";
did: string;
message: string;
} | {
kind: "verify/consistency_violation";
did: string;
reason: string;
message: string;
};Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:94.
verificationErrors
declare const verificationErrors: {
resolutionFailed: (did: string, reason: string) => VerificationError;
invalidSchema: (did: string, reason: string) => VerificationError;
invalidSignature: (did: string) => VerificationError;
lineageFailed: (did: string, reason: string) => VerificationError;
maxDepthExceeded: (did: string, depth: number, maxDepth: number) => VerificationError;
revoked: (did: string) => VerificationError;
suspended: (did: string) => VerificationError;
humanRootRevoked: (humanRoot: string) => VerificationError;
timeout: (did: string) => VerificationError;
};Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:279.
VerificationMethod
Verification method per W3C DID-Core.
Type-only declaration; it is not a runtime value.
interface VerificationMethod {
id: string;
type: string;
controller: string;
publicKeyMultibase: string;
}Source: @openagentid/aegis-sdk@0.1.1, dist/plugin-CzTTSkdE.d.ts:6.
VerificationPipeline
The AEGIS Verification Pipeline.
Performs complete verification of OAS identity documents per AEGIS Specification §5. Results are cached with a configurable TTL (max 300 seconds per spec).
declare class VerificationPipeline {
constructor(registry: PluginRegistry, config?: VerificationConfig);
cache(): VerificationCache;
verify(did: string): Promise<VerificationResult>;
verifyForceRefresh(did: string): Promise<VerificationResult>;
}Source: @openagentid/aegis-sdk@0.1.1, dist/store-D8FECMQ_.d.ts:26.
VerificationResult
Type-only declaration; it is not a runtime value.
interface VerificationResult {
did: string;
signatureValid: boolean;
lineageValid: boolean;
lineageDepth: number;
humanRoot?: string | null;
revocationStatus: RevocationStatus;
livenessStatus: LivenessStatus;
conformanceLevel: number;
warnings: string[];
verifiedAt: string;
}Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:105.
verifyDelegationProof
Verify a delegation proof against the delegator's public key.
Reconstructs the canonical form of the delegation (without the proof), then verifies the Ed25519 signature in the proof's JWS field.
declare function verifyDelegationProof(delegation: Delegation, delegatorPublicKey: Uint8Array): boolean;Source: @openagentid/aegis-sdk@0.1.1, dist/delegate/index.d.ts:47.
verifySignature
Verify an Ed25519 signature against a message and public key.
declare function verifySignature(publicKey: Uint8Array, message: Uint8Array, signature: Uint8Array): boolean;Source: @openagentid/aegis-sdk@0.1.1, dist/pipeline-u2tQgstP.d.ts:33.
verifyThresholdSignature
Verify an aggregated FROST signature against the group public key.
declare function verifyThresholdSignature(message: Uint8Array, signature: Uint8Array, publicKeyPackage: Uint8Array): boolean;Source: @openagentid/aegis-sdk@0.1.1, dist/keys/index.d.ts:108.
WalletAddress
Type-only declaration; it is not a runtime value.
interface WalletAddress {
chain: Chain;
address: string;
derivationPath: string;
publicKeyHex: string;
}Source: @openagentid/aegis-sdk@0.1.1, dist/wallet/index.d.ts:5.
WalletError
Type-only declaration; it is not a runtime value.
type WalletError = {
kind: "wallet/authorization_failed";
reason: string;
message: string;
} | {
kind: "wallet/signing_failed";
reason: string;
message: string;
} | {
kind: "wallet/unsupported_chain";
chain: string;
message: string;
} | {
kind: "wallet/derivation_failed";
chain: string;
reason: string;
message: string;
} | {
kind: "wallet/policy_denied";
reason: string;
message: string;
} | {
kind: "wallet/obligation_failed";
reason: string;
message: string;
} | {
kind: "wallet/batch_partial_failure";
succeeded: number;
total: number;
message: string;
};Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:214.
walletErrors
declare const walletErrors: {
authorizationFailed: (reason: string) => WalletError;
signingFailed: (reason: string) => WalletError;
unsupportedChain: (chain: string) => WalletError;
derivationFailed: (chain: string, reason: string) => WalletError;
policyDenied: (reason: string) => WalletError;
obligationFailed: (reason: string) => WalletError;
batchPartialFailure: (succeeded: number, total: number) => WalletError;
};Source: @openagentid/aegis-sdk@0.1.1, dist/core/index.d.ts:310.
WalletType
Type-only declaration; it is not a runtime value.
type WalletType = "eoa" | "smart" | "abstract";Source: @openagentid/aegis-sdk@0.1.1, dist/types-Ck8QCcs2.d.ts:176.
Package requirements
Dependencies
| Package | Published range |
|---|---|
| uuid | ^11.0.0 |
| zod | ^3.23.0 |
Archive verification
Pinned integrity:
sha512-eKG79P17teM8i+ZQaNdBEPJnL0XT9723i04kDxgVRrOb0VOnNW5rt2doLq8g4mHBZ4rjHdPEuzZmj5LsL4iuVw==