The main Web5 API interface. It manages the creation of a DID if needed, the connection to the local DWN and all the web5 main foundational APIs such as VC, syncing, etc.

Constructors

Properties

Methods

Constructors

Properties

agent: Web5Agent

A Web5Agent instance that handles DIDs, DWNs and VCs requests. The agent manages the user keys and identities, and is responsible to sign and verify messages.

connectedDid: string

The DID of the tenant under which DID operations are being performed.

did: DidApi

Exposed instance to the DID APIs, allow users to create and resolve DIDs

dwn: DwnApi

Exposed instance to the DWN APIs, allow users to read/write records

vc: VcApi

Exposed instance to the VC APIs, allow users to issue, present and verify VCs

Methods

  • Connects to a Web5Agent. Defaults to creating a local Web5UserAgent if one isn't provided.

    Parameters

    Returns Promise<Web5ConnectResult>

    A promise that resolves to a Web5 instance and the connected DID.

Generated using TypeDoc