Interface Identity

A General Identity object. This does not have to be a private key (for example, the Anonymous identity), but it must be able to transform request.

interface Identity {
    getPrincipal(): types.Principal;
    transformRequest(request): Promise<unknown>;
}

Implemented by

Methods

getPrincipal transformRequest

Methods

getPrincipal

  • getPrincipal(): types.Principal

  • Get the principal represented by this identity. Normally should be a Principal.selfAuthenticating().

    Returns types.Principal

transformRequest

  • transformRequest(request): Promise<unknown>

  • Transform a request into a signed version of the request. This is done last after the transforms on the body of a request. The returned object can be anything, but must be serializable to CBOR.

    Parameters

    Returns Promise<unknown>

Settings

Member Visibility

Theme

On This Page

getPrincipaltransformRequest