Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GenericSignIdentity

Hierarchy

  • SignIdentity

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected _principal

_principal: undefined | Principal

Methods

Abstract getPem

  • getPem(): string

  • Return private key in a pem file

    Returns string

getPrincipal

  • getPrincipal(): Principal

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

    Returns Principal

Abstract getPublicKey

  • getPublicKey(): PublicKey

  • Returns the public key that would match this identity's signature.

    Returns PublicKey

Abstract sign

  • sign(blob: BinaryBlob): Promise<BinaryBlob>

  • Signs a blob of data, with this identity's private key.

    Parameters

    • blob: BinaryBlob

    Returns Promise<BinaryBlob>

Abstract toJSON

  • Serialize this key to JSON.

    Returns JsonnableKeyPair

transformRequest

  • transformRequest(request: HttpAgentRequest): 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

    • request: HttpAgentRequest

      internet computer request to transform

    Returns Promise<unknown>

Legend

  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Class
  • Class with type parameter
  • Method
  • Interface
  • Interface with type parameter
  • Enumeration
  • Inherited constructor