Type alias Web5ConnectResult

Web5ConnectResult: {
    delegateDid?: string;
    did: string;
    recoveryPhrase?: string;
    web5: Web5;
}

Represents the result of the Web5 connection process, including the Web5 instance, the connected decentralized identifier (DID), and optionally the recovery phrase used during the agent's initialization.

Type declaration

  • Optional delegateDid?: string

    The resulting did of a successful wallet connect. Only returned on success if WalletConnectOptions was provided.

  • did: string

    The DID that has been connected or created during the connection process.

  • Optional recoveryPhrase?: string

    The first time a Web5 agent is initialized, the recovery phrase that was used to generate the agent's DID and keys is returned. This phrase can be used to recover the agent's vault contents and should be stored securely by the user.

  • web5: Web5

    The Web5 instance, providing access to the agent, DID, DWN, and VC APIs.

Settings

Member Visibility

Theme