UNPKG

@sphereon/ssi-sdk.agent-config

Version:

54 lines 1.93 kB
import { TAgent, IPluginMethodMap, IAgentOptions } from '@veramo/core'; /** * Creates a Veramo agent from a config object containing an `/agent` pointer. * @param config - The configuration object * * @see {@link https://veramo.io/docs/veramo_agent/configuration_internals | Configuration Internals} for details on * the configuration options. * * @beta - This API may change without a major version bump */ export declare function createAgentFromConfig<T extends IPluginMethodMap>(config: object): Promise<TAgent<T>>; /** * Helper function to create a new instance of the {@link Agent} class with correct type * * @remarks * Use {@link TAgent} to configure agent type (list of available methods) for autocomplete in IDE * * @example * ```typescript * import { createAgent, IResolver, IMessageHandler } from '@veramo/core' * import { AgentRestClient } from '@veramo/remote-client' * import { CredentialIssuer, ICredentialIssuer } from '@veramo/credential-w3c' * const agent = createAgent<IResolver & IMessageHandler & ICredentialIssuer>({ * plugins: [ * new CredentialIssuer(), * new AgentRestClient({ * url: 'http://localhost:3002/agent', * enabledMethods: [ * 'resolveDid', * 'handleMessage', * ], * }), * ], * }) * ``` * @param options - Agent configuration options * @returns configured agent * @public */ export declare function createAgent<T extends IPluginMethodMap, C = Record<string, any>>(options: IAgentOptions & { context?: C; }): Promise<TAgent<T> & { context?: C; }>; /** * Parses a yaml config file and returns a config object * @param filePath */ export declare const getConfig: (filePath: string | Buffer | URL) => Promise<{ version?: number; [x: string]: any; }>; export declare function getAgent<T extends IPluginMethodMap>(fileName: string): Promise<TAgent<T>>; //# sourceMappingURL=agentCreator.d.ts.map