Class SignIdentity`Abstract`

An Identity that can sign blobs.

Implements

types.Identity

Index

Constructors

Properties

Methods

getPublicKey sign getPrincipal transformRequest

Constructors

constructor

new SignIdentity(): utils.agent.SignIdentity
Returns utils.agent.SignIdentity

Properties

`Protected`_principal

_principal: undefined | types.Principal

Methods

`Abstract`getPublicKey

getPublicKey(): utils.agent.PublicKey
Returns the public key that would match this identity's signature.

Returns utils.agent.PublicKey
- Defined in node_modules/@dfinity/agent/lib/esm/auth.d.ts:56

`Abstract`sign

sign(blob: Uint8Array): Promise<utils.agent.Signature>
Signs a blob of data, with this identity's private key.
Parameters
- blob: Uint8Array
Returns Promise<utils.agent.Signature>
- Defined in node_modules/@dfinity/agent/lib/esm/auth.d.ts:60

getPrincipal

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

Returns types.Principal
Implementation of Identity.getPrincipal
- Defined in node_modules/@dfinity/agent/lib/esm/auth.d.ts:65

transformRequest

transformRequest(request: utils.agent.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: utils.agent.HttpAgentRequest
  internet computer request to transform
Returns Promise<unknown>
Implementation of Identity.transformRequest
- Defined in node_modules/@dfinity/agent/lib/esm/auth.d.ts:72