Overview

Namespaces

• CanisterStatus
• polling
• strategy
• SubnetStatus

Enumerations

Endpoint

Defined in: packages/core/src/agent/agent/http/types.ts:8

Internal

Enumeration Members

Call

Call: "call"

Defined in: packages/core/src/agent/agent/http/types.ts:11

Query

Query: "read"

Defined in: packages/core/src/agent/agent/http/types.ts:9

ReadState

ReadState: "read_state"

Defined in: packages/core/src/agent/agent/http/types.ts:10

---

ErrorKindEnum

Defined in: packages/core/src/agent/errors.ts:15

Enumeration Members

External

External: "External"

Defined in: packages/core/src/agent/errors.ts:20

Input

Input: "Input"

Defined in: packages/core/src/agent/errors.ts:22

Limit

Limit: "Limit"

Defined in: packages/core/src/agent/errors.ts:21

Protocol

Protocol: "Protocol"

Defined in: packages/core/src/agent/errors.ts:17

Reject

Reject: "Reject"

Defined in: packages/core/src/agent/errors.ts:18

Transport

Transport: "Transport"

Defined in: packages/core/src/agent/errors.ts:19

Trust

Trust: "Trust"

Defined in: packages/core/src/agent/errors.ts:16

Unknown

Unknown: "Unknown"

Defined in: packages/core/src/agent/errors.ts:23

---

ErrorVerbosity

Defined in: packages/core/src/agent/errors.ts:55

Controls the level of detail included in error messages.

• Normal (default): includes error message, call context, and HTTP details, but omits large binary fields (arg, certificate, nonce).
• Verbose: same as Normal, but includes hex-encoded binary fields.

To enable verbose mode: ErrorCode.verbosity = ErrorVerbosity.Verbose

Enumeration Members

Normal

Normal: "normal"

Defined in: packages/core/src/agent/errors.ts:56

Verbose

Verbose: "verbose"

Defined in: packages/core/src/agent/errors.ts:57

---

LookupLabelStatus

Defined in: packages/core/src/agent/certificate.ts:571

Enumeration Members

Absent

Absent: "Absent"

Defined in: packages/core/src/agent/certificate.ts:572

Found

Found: "Found"

Defined in: packages/core/src/agent/certificate.ts:574

Greater

Greater: "Greater"

Defined in: packages/core/src/agent/certificate.ts:576

Less

Less: "Less"

Defined in: packages/core/src/agent/certificate.ts:575

Unknown

Unknown: "Unknown"

Defined in: packages/core/src/agent/certificate.ts:573

---

LookupPathStatus

Defined in: packages/core/src/agent/certificate.ts:517

Enumeration Members

Absent

Absent: "Absent"

Defined in: packages/core/src/agent/certificate.ts:519

Error

Error: "Error"

Defined in: packages/core/src/agent/certificate.ts:521

Found

Found: "Found"

Defined in: packages/core/src/agent/certificate.ts:520

Unknown

Unknown: "Unknown"

Defined in: packages/core/src/agent/certificate.ts:518

---

LookupSubtreeStatus

Defined in: packages/core/src/agent/certificate.ts:547

Enumeration Members

Absent

Absent: "Absent"

Defined in: packages/core/src/agent/certificate.ts:548

Found

Found: "Found"

Defined in: packages/core/src/agent/certificate.ts:550

Unknown

Unknown: "Unknown"

Defined in: packages/core/src/agent/certificate.ts:549

---

NodeType

Defined in: packages/core/src/agent/certificate.ts:47

Enumeration Members

Empty

Empty: 0

Defined in: packages/core/src/agent/certificate.ts:48

Fork

Fork: 1

Defined in: packages/core/src/agent/certificate.ts:49

Labeled

Labeled: 2

Defined in: packages/core/src/agent/certificate.ts:50

Leaf

Leaf: 3

Defined in: packages/core/src/agent/certificate.ts:51

Pruned

Pruned: 4

Defined in: packages/core/src/agent/certificate.ts:52

---

QueryResponseStatus

Defined in: packages/core/src/agent/agent/api.ts:35

Enumeration Members

Rejected

Rejected: "rejected"

Defined in: packages/core/src/agent/agent/api.ts:37

Replied

Replied: "replied"

Defined in: packages/core/src/agent/agent/api.ts:36

---

ReadRequestType

Defined in: packages/core/src/agent/agent/http/types.ts:78

Enumeration Members

Query

Query: "query"

Defined in: packages/core/src/agent/agent/http/types.ts:79

ReadState

ReadState: "read_state"

Defined in: packages/core/src/agent/agent/http/types.ts:80

---

ReplicaRejectCode

Defined in: packages/core/src/agent/agent/api.ts:12

Codes used by the replica for rejecting a message. See the interface spec.

Enumeration Members

CanisterError

CanisterError: 5

Defined in: packages/core/src/agent/agent/api.ts:17

CanisterReject

CanisterReject: 4

Defined in: packages/core/src/agent/agent/api.ts:16

DestinationInvalid

DestinationInvalid: 3

Defined in: packages/core/src/agent/agent/api.ts:15

SysFatal

SysFatal: 1

Defined in: packages/core/src/agent/agent/api.ts:13

SysTransient

SysTransient: 2

Defined in: packages/core/src/agent/agent/api.ts:14

---

RequestStatusResponseStatus

Defined in: packages/core/src/agent/agent/http/types.ts:109

Possible values for the request status in the IC state tree.

See

https://internetcomputer.org/docs/references/ic-interface-spec#state-tree-request-status

Enumeration Members

Done

Done: "done"

Defined in: packages/core/src/agent/agent/http/types.ts:121

The IC has pruned the response data but remembers the request to prevent replay attacks.

Processing

Processing: "processing"

Defined in: packages/core/src/agent/agent/http/types.ts:113

The initial effect of the call has happened or will happen.

Received

Received: "received"

Defined in: packages/core/src/agent/agent/http/types.ts:111

The call has made it past the endpoint into the IC’s state.

Rejected

Rejected: "rejected"

Defined in: packages/core/src/agent/agent/http/types.ts:117

The call failed; reject code and message are available at /request_status/<id>/reject_code and /request_status/<id>/reject_message.

Replied

Replied: "replied"

Defined in: packages/core/src/agent/agent/http/types.ts:115

The call completed successfully; the reply is available at /request_status/<id>/reply.

Unknown

Unknown: "unknown"

Defined in: packages/core/src/agent/agent/http/types.ts:119

The request status path is absent from the state tree, the request is unknown to the IC (never received or pruned after expiry).

---

SubmitRequestType

Defined in: packages/core/src/agent/agent/http/types.ts:73

Enumeration Members

Call

Call: "call"

Defined in: packages/core/src/agent/agent/http/types.ts:74

Classes

Actor

Defined in: packages/core/src/agent/actor.ts:183

An actor base class. An actor is an object containing only functions that will return a promise. These functions are derived from the IDL definition.

Constructors

Constructor

protected new Actor(metadata): Actor

Defined in: packages/core/src/agent/actor.ts:350

Parameters

metadata

ActorMetadata

Returns

Actor

Methods

agentOf()

static agentOf(actor): Agent | undefined

Defined in: packages/core/src/agent/actor.ts:189

Get the Agent class this Actor would call, or undefined if the Actor would use the default agent (global.ic.agent).

Parameters

actor

Actor

The actor to get the agent of.

Returns

Agent | undefined

canisterIdOf()

static canisterIdOf(actor): Principal

Defined in: packages/core/src/agent/actor.ts:201

Parameters

actor

Actor

Returns

Principal

createActor()

static createActor<T>(interfaceFactory, configuration): ActorSubclass<T>

Defined in: packages/core/src/agent/actor.ts:302

Creates an actor with the given interface factory and configuration.

The @icp-sdk/bindgen package can be used to generate the interface factory for your canister.

Type Parameters

T

T = Record<string, ActorMethod<unknown[], unknown>>

Parameters

interfaceFactory

InterfaceFactory

the interface factory for the actor, typically generated by the @icp-sdk/bindgen package

configuration

ActorConfig

the configuration for the actor

Returns

ActorSubclass<T>

an actor with the given interface factory and configuration

See

The Canister Environment Guide for more details on how to configure an actor using the canister environment.

Examples

Using the interface factory generated by the @icp-sdk/bindgen package:

import { Actor, HttpAgent } from '@icp-sdk/core/agent';
import { Principal } from '@icp-sdk/core/principal';
import { idlFactory } from './api/declarations/hello-world.did';

// For a convenient way to get the canister ID,
// see the https://js.icp.build/core/latest/canister-environment/ guide.
const canisterId = Principal.fromText('rrkah-fqaaa-aaaaa-aaaaq-cai');

const agent = await HttpAgent.create({
  host: 'https://icp-api.io',
});

const actor = Actor.createActor(idlFactory, {
  agent,
  canisterId,
});

const response = await actor.greet('world');
console.log(response);

Using the createActor wrapper function generated by the @icp-sdk/bindgen package:

import { HttpAgent } from '@icp-sdk/core/agent';
import { Principal } from '@icp-sdk/core/principal';
import { createActor } from './api/hello-world';

// For a convenient way to get the canister ID,
// see the https://js.icp.build/core/latest/canister-environment/ guide.
const canisterId = Principal.fromText('rrkah-fqaaa-aaaaa-aaaaq-cai');

const agent = await HttpAgent.create({
  host: 'https://icp-api.io',
});

const actor = createActor(canisterId, {
  agent,
});

const response = await actor.greet('world');
console.log(response);

createActorClass()

static createActorClass(interfaceFactory, options?): ActorConstructor

Defined in: packages/core/src/agent/actor.ts:205

Parameters

interfaceFactory

InterfaceFactory

options?

CreateActorClassOpts

Returns

ActorConstructor

createActorWithExtendedDetails()

static createActorWithExtendedDetails<T>(interfaceFactory, configuration, actorClassOptions?): ActorSubclass<ActorMethodMappedExtended<T>>

Defined in: packages/core/src/agent/actor.ts:335

Returns an actor with methods that return the http response details along with the result

Type Parameters

T

T = Record<string, ActorMethod<unknown[], unknown>>

Parameters

interfaceFactory

InterfaceFactory

the interface factory for the actor

configuration

ActorConfig

the configuration for the actor

actorClassOptions?

CreateActorClassOpts = ...

options for the actor class extended details to return with the result

Returns

ActorSubclass<ActorMethodMappedExtended<T>>

createActorWithHttpDetails()

static createActorWithHttpDetails<T>(interfaceFactory, configuration): ActorSubclass<ActorMethodMappedWithHttpDetails<T>>

Defined in: packages/core/src/agent/actor.ts:320

Returns an actor with methods that return the http response details along with the result

Type Parameters

T

T = Record<string, ActorMethod<unknown[], unknown>>

Parameters

interfaceFactory

InterfaceFactory

the interface factory for the actor

configuration

ActorConfig

the configuration for the actor

Returns

ActorSubclass<ActorMethodMappedWithHttpDetails<T>>

Deprecated

• use createActor with actorClassOptions instead

interfaceOf()

static interfaceOf(actor): ServiceClass

Defined in: packages/core/src/agent/actor.ts:197

Get the interface of an actor, in the form of an instance of a Service.

Parameters

actor

Actor

The actor to get the interface of.

Returns

ServiceClass

---

AgentError

Defined in: packages/core/src/agent/errors.ts:113

An error that happens in the Agent. This is the root of all errors and should be used everywhere in the Agent code (this package).

To know if the error is certified, use the isCertified getter.

Extends

• Error

Constructors

Constructor

new AgentError(code, kind): AgentError

Defined in: packages/core/src/agent/errors.ts:140

Parameters

code

ErrorCode

kind

ErrorKindEnum

Returns

AgentError

Overrides

Error.constructor

Properties

cause

readonly cause: object

Defined in: packages/core/src/agent/errors.ts:116

code

code: ErrorCode

kind

kind: ErrorKindEnum

Overrides

Error.cause

message

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string = 'AgentError'

Defined in: packages/core/src/agent/errors.ts:114

Overrides

Error.name

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Accessors

code

Get Signature

get code(): ErrorCode

Defined in: packages/core/src/agent/errors.ts:118

Returns

ErrorCode

Set Signature

set code(code): void

Defined in: packages/core/src/agent/errors.ts:121

Parameters

code

ErrorCode

Returns

void

isCertified

Get Signature

get isCertified(): boolean

Defined in: packages/core/src/agent/errors.ts:136

Reads the isCertified property of the underlying error code.

Returns

boolean

true if the error is certified, false otherwise.

kind

Get Signature

get kind(): ErrorKindEnum

Defined in: packages/core/src/agent/errors.ts:125

Returns

ErrorKindEnum

Set Signature

set kind(kind): void

Defined in: packages/core/src/agent/errors.ts:128

Parameters

kind

ErrorKindEnum

Returns

void

Methods

hasCode()

hasCode<C>(code): boolean

Defined in: packages/core/src/agent/errors.ts:146

Type Parameters

C

C extends ErrorCode

Parameters

code

(…args) => C

Returns

boolean

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:150

Returns a string representation of an object.

Returns

string

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

---

AnonymousIdentity

Defined in: packages/core/src/agent/auth.ts:101

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.

Implements

• Identity

Constructors

Constructor

new AnonymousIdentity(): AnonymousIdentity

Returns

AnonymousIdentity

Methods

getPrincipal()

getPrincipal(): Principal

Defined in: packages/core/src/agent/auth.ts:102

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

Returns

Principal

Implementation of

Identity.getPrincipal

transformRequest()

transformRequest(request): Promise<unknown>

Defined in: packages/core/src/agent/auth.ts:106

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

Returns

Promise<unknown>

Implementation of

Identity.transformRequest

---

CborDecodeErrorCode

Defined in: packages/core/src/agent/errors.ts:433

Extends

• ErrorCode

Constructors

Constructor

new CborDecodeErrorCode(error, input): CborDecodeErrorCode

Defined in: packages/core/src/agent/errors.ts:436

Parameters

error

unknown

input

Uint8Array

Returns

CborDecodeErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

error

readonly error: unknown

Defined in: packages/core/src/agent/errors.ts:437

input

readonly input: Uint8Array

Defined in: packages/core/src/agent/errors.ts:438

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'CborDecodeErrorCode'

Defined in: packages/core/src/agent/errors.ts:434

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:444

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

CborEncodeErrorCode

Defined in: packages/core/src/agent/errors.ts:449

Extends

• ErrorCode

Constructors

Constructor

new CborEncodeErrorCode(error, value): CborEncodeErrorCode

Defined in: packages/core/src/agent/errors.ts:452

Parameters

error

unknown

value

unknown

Returns

CborEncodeErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

error

readonly error: unknown

Defined in: packages/core/src/agent/errors.ts:453

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'CborEncodeErrorCode'

Defined in: packages/core/src/agent/errors.ts:450

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

value

readonly value: unknown

Defined in: packages/core/src/agent/errors.ts:454

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:460

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

Certificate

Defined in: packages/core/src/agent/certificate.ts:212

Properties

cert

cert: Cert

Defined in: packages/core/src/agent/certificate.ts:213

Methods

lookup_path()

lookup_path(path): LookupResult

Defined in: packages/core/src/agent/certificate.ts:274

Lookup a path in the certificate tree, using lookup_path.

Parameters

path

NodePath

The path to lookup.

Returns

LookupResult

The result of the lookup.

lookup_subtree()

lookup_subtree(path): SubtreeLookupResult

Defined in: packages/core/src/agent/certificate.ts:283

Lookup a subtree in the certificate tree, using lookup_subtree.

Parameters

path

NodePath

The path to lookup.

Returns

SubtreeLookupResult

The result of the lookup.

create()

static create(options): Promise<Certificate>

Defined in: packages/core/src/agent/certificate.ts:224

Create a new instance of a certificate, automatically verifying it.

Parameters

options

CreateCertificateOptions

CreateCertificateOptions

Returns

Promise<Certificate>

Throws

if the verification of the certificate fails

---

CertificateHasTooManyDelegationsErrorCode

Defined in: packages/core/src/agent/errors.ts:275

Extends

• ErrorCode

Constructors

Constructor

new CertificateHasTooManyDelegationsErrorCode(): CertificateHasTooManyDelegationsErrorCode

Defined in: packages/core/src/agent/errors.ts:278

Returns

CertificateHasTooManyDelegationsErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'CertificateHasTooManyDelegationsErrorCode'

Defined in: packages/core/src/agent/errors.ts:276

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:283

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

CertificateNotAuthorizedErrorCode

Defined in: packages/core/src/agent/errors.ts:288

Extends

• ErrorCode

Constructors

Constructor

new CertificateNotAuthorizedErrorCode(canisterId, subnetId): CertificateNotAuthorizedErrorCode

Defined in: packages/core/src/agent/errors.ts:291

Parameters

canisterId

Principal

subnetId

Principal

Returns

CertificateNotAuthorizedErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

canisterId

readonly canisterId: Principal

Defined in: packages/core/src/agent/errors.ts:292

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'CertificateNotAuthorizedErrorCode'

Defined in: packages/core/src/agent/errors.ts:289

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

subnetId

readonly subnetId: Principal

Defined in: packages/core/src/agent/errors.ts:293

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:299

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

CertificateNotAuthorizedForSubnetErrorCode

Defined in: packages/core/src/agent/errors.ts:304

Extends

• ErrorCode

Constructors

Constructor

new CertificateNotAuthorizedForSubnetErrorCode(subnetId): CertificateNotAuthorizedForSubnetErrorCode

Defined in: packages/core/src/agent/errors.ts:307

Parameters

subnetId

Principal

Returns

CertificateNotAuthorizedForSubnetErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'CertificateNotAuthorizedForSubnetErrorCode'

Defined in: packages/core/src/agent/errors.ts:305

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

subnetId

readonly subnetId: Principal

Defined in: packages/core/src/agent/errors.ts:307

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:312

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

CertificateOutdatedErrorCode

Defined in: packages/core/src/agent/errors.ts:502

Extends

• ErrorCode

Constructors

Constructor

new CertificateOutdatedErrorCode(maxIngressExpiryInMinutes, requestId, retryTimes?): CertificateOutdatedErrorCode

Defined in: packages/core/src/agent/errors.ts:505

Parameters

maxIngressExpiryInMinutes

number

requestId

RequestId

retryTimes?

number

Returns

CertificateOutdatedErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

maxIngressExpiryInMinutes

readonly maxIngressExpiryInMinutes: number

Defined in: packages/core/src/agent/errors.ts:506

name

name: string = 'CertificateOutdatedErrorCode'

Defined in: packages/core/src/agent/errors.ts:503

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

requestId

readonly requestId: RequestId

Defined in: packages/core/src/agent/errors.ts:507

retryTimes?

readonly optional retryTimes?: number

Defined in: packages/core/src/agent/errors.ts:508

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:514

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

CertificateTimeErrorCode

Defined in: packages/core/src/agent/errors.ts:256

Extends

• ErrorCode

Constructors

Constructor

new CertificateTimeErrorCode(maxAgeInMinutes, certificateTime, currentTime, timeDiffMsecs, ageType): CertificateTimeErrorCode

Defined in: packages/core/src/agent/errors.ts:259

Parameters

maxAgeInMinutes

number

certificateTime

Date

currentTime

Date

timeDiffMsecs

number

ageType

"past" | "future"

Returns

CertificateTimeErrorCode

Overrides

ErrorCode.constructor

Properties

ageType

readonly ageType: "past" | "future"

Defined in: packages/core/src/agent/errors.ts:264

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

certificateTime

readonly certificateTime: Date

Defined in: packages/core/src/agent/errors.ts:261

currentTime

readonly currentTime: Date

Defined in: packages/core/src/agent/errors.ts:262

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

maxAgeInMinutes

readonly maxAgeInMinutes: number

Defined in: packages/core/src/agent/errors.ts:260

name

name: string = 'CertificateTimeErrorCode'

Defined in: packages/core/src/agent/errors.ts:257

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

timeDiffMsecs

readonly timeDiffMsecs: number

Defined in: packages/core/src/agent/errors.ts:263

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:270

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

CertificateVerificationErrorCode

Defined in: packages/core/src/agent/errors.ts:236

Extends

• ErrorCode

Constructors

Constructor

new CertificateVerificationErrorCode(reason, error?): CertificateVerificationErrorCode

Defined in: packages/core/src/agent/errors.ts:239

Parameters

reason

string

error?

unknown

Returns

CertificateVerificationErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

error?

readonly optional error?: unknown

Defined in: packages/core/src/agent/errors.ts:241

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'CertificateVerificationErrorCode'

Defined in: packages/core/src/agent/errors.ts:237

reason

readonly reason: string

Defined in: packages/core/src/agent/errors.ts:240

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:247

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

CertifiedRejectErrorCode

Defined in: packages/core/src/agent/errors.ts:523

Extends

• ErrorCode

Constructors

Constructor

new CertifiedRejectErrorCode(requestId, rejectCode, rejectMessage, rejectErrorCode): CertifiedRejectErrorCode

Defined in: packages/core/src/agent/errors.ts:526

Parameters

requestId

RequestId

rejectCode

ReplicaRejectCode

rejectMessage

string

rejectErrorCode

string | undefined

Returns

CertifiedRejectErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'CertifiedRejectErrorCode'

Defined in: packages/core/src/agent/errors.ts:524

rejectCode

readonly rejectCode: ReplicaRejectCode

Defined in: packages/core/src/agent/errors.ts:528

rejectErrorCode

readonly rejectErrorCode: string | undefined

Defined in: packages/core/src/agent/errors.ts:530

rejectMessage

readonly rejectMessage: string

Defined in: packages/core/src/agent/errors.ts:529

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

requestId

readonly requestId: RequestId

Defined in: packages/core/src/agent/errors.ts:527

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:536

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

CreateHttpAgentErrorCode

Defined in: packages/core/src/agent/errors.ts:683

Extends

• ErrorCode

Constructors

Constructor

new CreateHttpAgentErrorCode(): CreateHttpAgentErrorCode

Defined in: packages/core/src/agent/errors.ts:686

Returns

CreateHttpAgentErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'CreateHttpAgentErrorCode'

Defined in: packages/core/src/agent/errors.ts:684

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:691

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

DerDecodeErrorCode

Defined in: packages/core/src/agent/errors.ts:407

Extends

• ErrorCode

Constructors

Constructor

new DerDecodeErrorCode(error): DerDecodeErrorCode

Defined in: packages/core/src/agent/errors.ts:410

Parameters

error

string

Returns

DerDecodeErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

error

readonly error: string

Defined in: packages/core/src/agent/errors.ts:410

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'DerDecodeErrorCode'

Defined in: packages/core/src/agent/errors.ts:408

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:415

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

DerDecodeLengthMismatchErrorCode

Defined in: packages/core/src/agent/errors.ts:391

Extends

• ErrorCode

Constructors

Constructor

new DerDecodeLengthMismatchErrorCode(expectedLength, actualLength): DerDecodeLengthMismatchErrorCode

Defined in: packages/core/src/agent/errors.ts:394

Parameters

expectedLength

number

actualLength

number

Returns

DerDecodeLengthMismatchErrorCode

Overrides

ErrorCode.constructor

Properties

actualLength

readonly actualLength: number

Defined in: packages/core/src/agent/errors.ts:396

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

expectedLength

readonly expectedLength: number

Defined in: packages/core/src/agent/errors.ts:395

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'DerDecodeLengthMismatchErrorCode'

Defined in: packages/core/src/agent/errors.ts:392

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:402

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

DerEncodeErrorCode

Defined in: packages/core/src/agent/errors.ts:420

Extends

• ErrorCode

Constructors

Constructor

new DerEncodeErrorCode(error): DerEncodeErrorCode

Defined in: packages/core/src/agent/errors.ts:423

Parameters

error

string

Returns

DerEncodeErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

error

readonly error: string

Defined in: packages/core/src/agent/errors.ts:423

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'DerEncodeErrorCode'

Defined in: packages/core/src/agent/errors.ts:421

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:428

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

DerKeyLengthMismatchErrorCode

Defined in: packages/core/src/agent/errors.ts:359

Extends

• ErrorCode

Constructors

Constructor

new DerKeyLengthMismatchErrorCode(expectedLength, actualLength): DerKeyLengthMismatchErrorCode

Defined in: packages/core/src/agent/errors.ts:362

Parameters

expectedLength

number

actualLength

number

Returns

DerKeyLengthMismatchErrorCode

Overrides

ErrorCode.constructor

Properties

actualLength

readonly actualLength: number

Defined in: packages/core/src/agent/errors.ts:364

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

expectedLength

readonly expectedLength: number

Defined in: packages/core/src/agent/errors.ts:363

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'DerKeyLengthMismatchErrorCode'

Defined in: packages/core/src/agent/errors.ts:360

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:370

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

DerPrefixMismatchErrorCode

Defined in: packages/core/src/agent/errors.ts:375

Extends

• ErrorCode

Constructors

Constructor

new DerPrefixMismatchErrorCode(expectedPrefix, actualPrefix): DerPrefixMismatchErrorCode

Defined in: packages/core/src/agent/errors.ts:378

Parameters

expectedPrefix

Uint8Array

actualPrefix

Uint8Array

Returns

DerPrefixMismatchErrorCode

Overrides

ErrorCode.constructor

Properties

actualPrefix

readonly actualPrefix: Uint8Array

Defined in: packages/core/src/agent/errors.ts:380

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

expectedPrefix

readonly expectedPrefix: Uint8Array

Defined in: packages/core/src/agent/errors.ts:379

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'DerPrefixMismatchErrorCode'

Defined in: packages/core/src/agent/errors.ts:376

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:386

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

Ed25519PublicKey

Defined in: packages/core/src/agent/public_key.ts:5

A Public Key implementation.

Implements

• PublicKey

Accessors

derKey

Get Signature

get derKey(): DerEncodedPublicKey

Defined in: packages/core/src/agent/public_key.ts:43

Returns

DerEncodedPublicKey

Implementation of

PublicKey.derKey

rawKey

Get Signature

get rawKey(): Uint8Array

Defined in: packages/core/src/agent/public_key.ts:37

Returns

Uint8Array

Implementation of

PublicKey.rawKey

Methods

toDer()

toDer(): DerEncodedPublicKey

Defined in: packages/core/src/agent/public_key.ts:58

Returns

DerEncodedPublicKey

Implementation of

PublicKey.toDer

toRaw()

toRaw(): Uint8Array

Defined in: packages/core/src/agent/public_key.ts:62

Returns

Uint8Array

Implementation of

PublicKey.toRaw

from()

static from(key): Ed25519PublicKey

Defined in: packages/core/src/agent/public_key.ts:6

Parameters

key

PublicKey

Returns

Ed25519PublicKey

fromDer()

static fromDer(derKey): Ed25519PublicKey

Defined in: packages/core/src/agent/public_key.ts:14

Parameters

derKey

DerEncodedPublicKey

Returns

Ed25519PublicKey

fromRaw()

static fromRaw(rawKey): Ed25519PublicKey

Defined in: packages/core/src/agent/public_key.ts:10

Parameters

rawKey

Uint8Array

Returns

Ed25519PublicKey

---

EmptyCookieErrorCode

Defined in: packages/core/src/agent/errors.ts:933

Extends

• ErrorCode

Constructors

Constructor

new EmptyCookieErrorCode(expectedCookieName): EmptyCookieErrorCode

Defined in: packages/core/src/agent/errors.ts:936

Parameters

expectedCookieName

string

Returns

EmptyCookieErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

expectedCookieName

readonly expectedCookieName: string

Defined in: packages/core/src/agent/errors.ts:936

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'EmptyCookieErrorCode'

Defined in: packages/core/src/agent/errors.ts:934

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:941

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

abstract ErrorCode

Defined in: packages/core/src/agent/errors.ts:74

Extended by

• CertificateVerificationErrorCode
• CertificateTimeErrorCode
• CertificateHasTooManyDelegationsErrorCode
• CertificateNotAuthorizedErrorCode
• CertificateNotAuthorizedForSubnetErrorCode
• LookupErrorCode
• MalformedLookupFoundValueErrorCode
• MissingLookupValueErrorCode
• DerKeyLengthMismatchErrorCode
• DerPrefixMismatchErrorCode
• DerDecodeLengthMismatchErrorCode
• DerDecodeErrorCode
• DerEncodeErrorCode
• CborDecodeErrorCode
• CborEncodeErrorCode
• HexDecodeErrorCode
• TimeoutWaitingForResponseErrorCode
• CertificateOutdatedErrorCode
• CertifiedRejectErrorCode
• UncertifiedRejectErrorCode
• UncertifiedRejectUpdateErrorCode
• RequestStatusDoneNoReplyErrorCode
• MissingRootKeyErrorCode
• HashValueErrorCode
• IdentityInvalidErrorCode
• IngressExpiryInvalidErrorCode
• MissingFetchErrorCode
• CreateHttpAgentErrorCode
• ExcessiveSignaturesErrorCode
• MalformedSignatureErrorCode
• MissingSignatureErrorCode
• MalformedPublicKeyErrorCode
• QuerySignatureVerificationFailedErrorCode
• UnexpectedErrorCode
• UnexpectedV4StatusErrorCode
• HashTreeDecodeErrorCode
• HttpErrorCode
• HttpV4ApiNotSupportedErrorCode
• HttpFetchErrorCode
• MissingCanisterIdErrorCode
• InvalidReadStateRequestErrorCode
• ExpiryJsonDeserializeErrorCode
• InvalidRootKeyErrorCode
• MissingCookieErrorCode
• EmptyCookieErrorCode

Constructors

Constructor

new ErrorCode(isCertified?): ErrorCode

Defined in: packages/core/src/agent/errors.ts:80

Parameters

isCertified?

boolean = false

Returns

ErrorCode

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Methods

toErrorMessage()

abstract toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:82

Returns

string

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

---

ExcessiveSignaturesErrorCode

Defined in: packages/core/src/agent/errors.ts:696

Extends

• ErrorCode

Constructors

Constructor

new ExcessiveSignaturesErrorCode(signatureCount, maxExpected): ExcessiveSignaturesErrorCode

Defined in: packages/core/src/agent/errors.ts:699

Parameters

signatureCount

number

maxExpected

number

Returns

ExcessiveSignaturesErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

maxExpected

readonly maxExpected: number

Defined in: packages/core/src/agent/errors.ts:701

name

name: string = 'ExcessiveSignaturesErrorCode'

Defined in: packages/core/src/agent/errors.ts:697

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

signatureCount

readonly signatureCount: number

Defined in: packages/core/src/agent/errors.ts:700

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:707

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

Expiry

Defined in: packages/core/src/agent/agent/http/expiry.ts:24

Properties

_isExpiry

readonly _isExpiry: true = true

Defined in: packages/core/src/agent/agent/http/expiry.ts:25

Methods

toBigInt()

toBigInt(): bigint

Defined in: packages/core/src/agent/agent/http/expiry.ts:56

Returns

bigint

toHash()

toHash(): Uint8Array

Defined in: packages/core/src/agent/agent/http/expiry.ts:60

Returns

Uint8Array

toJSON()

toJSON(): JsonnableExpiry

Defined in: packages/core/src/agent/agent/http/expiry.ts:72

Serializes to JSON

Returns

JsonnableExpiry

a JSON object with a single key, JSON_KEY_EXPIRY, whose value is the expiry as a string

toString()

toString(): string

Defined in: packages/core/src/agent/agent/http/expiry.ts:64

Returns

string

fromDeltaInMilliseconds()

static fromDeltaInMilliseconds(deltaInMs, clockDriftInMs?): Expiry

Defined in: packages/core/src/agent/agent/http/expiry.ts:39

Creates an Expiry object from a delta in milliseconds. The expiry is calculated as: current_time + delta + clock_drift The resulting expiry is then rounded:

• If rounding down to the nearest minute still provides at least 60 seconds in the future, use minute precision
• Otherwise, use second precision

Parameters

deltaInMs

number

The milliseconds to add to the current time.

clockDriftInMs?

number = 0

The milliseconds to add to the current time, typically the clock drift between IC network clock and the client’s clock. Defaults to 0 if not provided.

Returns

Expiry

The constructed Expiry object.

fromJSON()

static fromJSON(input): Expiry

Defined in: packages/core/src/agent/agent/http/expiry.ts:81

Deserializes a JsonnableExpiry object from a JSON string.

Parameters

input

string

The JSON string to deserialize.

Returns

Expiry

The deserialized Expiry object.

isExpiry()

static isExpiry(other): other is Expiry

Defined in: packages/core/src/agent/agent/http/expiry.ts:96

Parameters

other

unknown

Returns

other is Expiry

---

ExpiryJsonDeserializeErrorCode

Defined in: packages/core/src/agent/errors.ts:891

Extends

• ErrorCode

Constructors

Constructor

new ExpiryJsonDeserializeErrorCode(error): ExpiryJsonDeserializeErrorCode

Defined in: packages/core/src/agent/errors.ts:894

Parameters

error

string

Returns

ExpiryJsonDeserializeErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

error

readonly error: string

Defined in: packages/core/src/agent/errors.ts:894

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'ExpiryJsonDeserializeErrorCode'

Defined in: packages/core/src/agent/errors.ts:892

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:899

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

ExternalError

Defined in: packages/core/src/agent/errors.ts:200

Extends

• ErrorKind

Constructors

Constructor

new ExternalError(code): ExternalError

Defined in: packages/core/src/agent/errors.ts:203

Parameters

code

ErrorCode

Returns

ExternalError

Overrides

ErrorKind.constructor

Properties

cause

readonly cause: object

Defined in: packages/core/src/agent/errors.ts:116

code

code: ErrorCode

kind

kind: ErrorKindEnum

Inherited from

ErrorKind.cause

message

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

ErrorKind.message

name

name: string = 'ExternalError'

Defined in: packages/core/src/agent/errors.ts:201

Overrides

ErrorKind.name

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

ErrorKind.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ErrorKind.stackTraceLimit

Accessors

code

Get Signature

get code(): ErrorCode

Defined in: packages/core/src/agent/errors.ts:118

Returns

ErrorCode

Set Signature

set code(code): void

Defined in: packages/core/src/agent/errors.ts:121

Parameters

code

ErrorCode

Returns

void

Inherited from

ErrorKind.code

isCertified

Get Signature

get isCertified(): boolean

Defined in: packages/core/src/agent/errors.ts:136

Reads the isCertified property of the underlying error code.

Returns

boolean

true if the error is certified, false otherwise.

Inherited from

ErrorKind.isCertified

kind

Get Signature

get kind(): ErrorKindEnum

Defined in: packages/core/src/agent/errors.ts:125

Returns

ErrorKindEnum

Set Signature

set kind(kind): void

Defined in: packages/core/src/agent/errors.ts:128

Parameters

kind

ErrorKindEnum

Returns

void

Inherited from

ErrorKind.kind

Methods

hasCode()

hasCode<C>(code): boolean

Defined in: packages/core/src/agent/errors.ts:146

Type Parameters

C

C extends ErrorCode

Parameters

code

(…args) => C

Returns

boolean

Inherited from

ErrorKind.hasCode

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:150

Returns a string representation of an object.

Returns

string

Inherited from

ErrorKind.toString

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ErrorKind.captureStackTrace

fromCode()

static fromCode<C, E>(this, code): E

Defined in: packages/core/src/agent/errors.ts:156

Type Parameters

C

C extends ErrorCode

E

E extends ErrorKind

Parameters

this

(code) => E

code

C

Returns

E

Inherited from

ErrorKind.fromCode

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

ErrorKind.prepareStackTrace

---

HashTreeDecodeErrorCode

Defined in: packages/core/src/agent/errors.ts:801

Extends

• ErrorCode

Constructors

Constructor

new HashTreeDecodeErrorCode(error): HashTreeDecodeErrorCode

Defined in: packages/core/src/agent/errors.ts:804

Parameters

error

string

Returns

HashTreeDecodeErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

error

readonly error: string

Defined in: packages/core/src/agent/errors.ts:804

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'HashTreeDecodeErrorCode'

Defined in: packages/core/src/agent/errors.ts:802

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:809

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

HashValueErrorCode

Defined in: packages/core/src/agent/errors.ts:628

Extends

• ErrorCode

Constructors

Constructor

new HashValueErrorCode(value): HashValueErrorCode

Defined in: packages/core/src/agent/errors.ts:631

Parameters

value

unknown

Returns

HashValueErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'HashValueErrorCode'

Defined in: packages/core/src/agent/errors.ts:629

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

value

readonly value: unknown

Defined in: packages/core/src/agent/errors.ts:631

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:636

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

HexDecodeErrorCode

Defined in: packages/core/src/agent/errors.ts:465

Extends

• ErrorCode

Constructors

Constructor

new HexDecodeErrorCode(error): HexDecodeErrorCode

Defined in: packages/core/src/agent/errors.ts:468

Parameters

error

string

Returns

HexDecodeErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

error

readonly error: string

Defined in: packages/core/src/agent/errors.ts:468

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'HexDecodeErrorCode'

Defined in: packages/core/src/agent/errors.ts:466

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:473

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

HttpAgent

Defined in: packages/core/src/agent/agent/http/index.ts:269

A HTTP agent allows users to interact with a client of the internet computer using the available methods. It exposes an API that closely follows the public view of the internet computer, and is not intended to be exposed directly to the majority of users due to its low-level interface. There is a pipeline to apply transformations to the request before sending it to the client. This is to decouple signature, nonce generation and other computations so that this class can stay as simple as possible while allowing extensions.

Implements

• Agent

Constructors

Constructor

new HttpAgent(options?): HttpAgent

Defined in: packages/core/src/agent/agent/http/index.ts:311

Parameters

options?

HttpAgentOptions = {}

Options for the HttpAgent

Returns

HttpAgent

Deprecated

Use HttpAgent.create or HttpAgent.createSync instead

Properties

_isAgent

readonly _isAgent: true = true

Defined in: packages/core/src/agent/agent/http/index.ts:294

config

config: HttpAgentOptions = {}

Defined in: packages/core/src/agent/agent/http/index.ts:295

host

readonly host: URL

Defined in: packages/core/src/agent/agent/http/index.ts:283

log

log: ObservableLog

Defined in: packages/core/src/agent/agent/http/index.ts:297

rootKey

rootKey: Uint8Array<ArrayBufferLike> | null

Defined in: packages/core/src/agent/agent/http/index.ts:270

Implementation of

Agent.rootKey

Methods

_transform()

protected _transform(request): Promise<HttpAgentRequest>

Defined in: packages/core/src/agent/agent/http/index.ts:1668

Parameters

request

HttpAgentRequest

Returns

Promise<HttpAgentRequest>

addTransform()

addTransform(type, fn, priority?): void

Defined in: packages/core/src/agent/agent/http/index.ts:444

Parameters

type

"query" | "update"

fn

HttpAgentRequestTransformFn

priority?

number = ...

Returns

void

call()

call(canisterId, options, identity?): Promise<SubmitResponse>

Defined in: packages/core/src/agent/agent/http/index.ts:482

Makes a call to a canister method.

Parameters

canisterId

string | Principal

The ID of the canister to call. Can be a Principal or a string.

options

CallOptions

Options for the call.

identity?

Identity | Promise<Identity>

(Optional) The identity to use for the call. If not provided, the agent’s current identity will be used.

Returns

Promise<SubmitResponse>

A promise that resolves to the response of the call, including the request ID and response details.

Implementation of

Agent.call

createReadStateRequest()

createReadStateRequest(fields, identity?): Promise<any>

Defined in: packages/core/src/agent/agent/http/index.ts:1203

Create the request for the read state call. readState uses this internally. Useful to avoid signing the same request multiple times.

Parameters

fields

ReadStateOptions

identity?

Identity | Promise<Identity>

Returns

Promise<any>

Implementation of

Agent.createReadStateRequest

fetchRootKey()

fetchRootKey(): Promise<Uint8Array<ArrayBufferLike>>

Defined in: packages/core/src/agent/agent/http/index.ts:1537

By default, the agent is configured to talk to the main Internet Computer, and verifies responses using a hard-coded public key.

This function will instruct the agent to ask the endpoint for its public key, and use that instead. This is required when talking to a local test instance, for example.

Only use this when you are not talking to the main Internet Computer, otherwise you are prone to man-in-the-middle attacks! Do not call this function by default.

Returns

Promise<Uint8Array<ArrayBufferLike>>

Implementation of

Agent.fetchRootKey

fetchSubnetKeys()

fetchSubnetKeys(canisterId): Promise<SubnetNodeKeys>

Defined in: packages/core/src/agent/agent/http/index.ts:1587

Parameters

canisterId

string | Principal

Returns

Promise<SubnetNodeKeys>

getPrincipal()

getPrincipal(): Promise<Principal>

Defined in: packages/core/src/agent/agent/http/index.ts:468

Returns the principal ID associated with this agent (by default). It only shows the principal of the default identity in the agent, which is the principal used when calls don’t specify it.

Returns

Promise<Principal>

Implementation of

Agent.getPrincipal

getSubnetIdFromCanister()

getSubnetIdFromCanister(canisterId): Promise<Principal>

Defined in: packages/core/src/agent/agent/http/index.ts:1651

Returns the subnet ID for a given canister ID, by looking at the certificate delegation returned by the canister’s state obtained by requesting the /time path with readState.

Parameters

canisterId

string | Principal

The canister ID to get the subnet ID for.

Returns

Promise<Principal>

The subnet ID for the given canister ID.

getTimeDiffMsecs()

getTimeDiffMsecs(): number

Defined in: packages/core/src/agent/agent/http/index.ts:1689

Returns the time difference in milliseconds between the IC network clock and the client’s clock, after the clock has been synced.

If the time has not been synced, returns 0.

Returns

number

hasSyncedTime()

hasSyncedTime(): boolean

Defined in: packages/core/src/agent/agent/http/index.ts:1696

Returns true if the time has been synced at least once with the IC network, false otherwise.

Returns

boolean

invalidateIdentity()

invalidateIdentity(): void

Defined in: packages/core/src/agent/agent/http/index.ts:1579

If an application needs to invalidate an identity under certain conditions, an Agent may expose an invalidateIdentity method. Invoking this method will set the inner identity used by the Agent to null.

A use case for this would be - after a certain period of inactivity, a secure application chooses to invalidate the identity of any HttpAgent instances. An invalid identity can be replaced by Agent.replaceIdentity

Returns

void

Implementation of

Agent.invalidateIdentity

isLocal()

isLocal(): boolean

Defined in: packages/core/src/agent/agent/http/index.ts:439

Returns

boolean

parseTimeFromResponse()

parseTimeFromResponse(response): number

Defined in: packages/core/src/agent/agent/http/index.ts:1358

Parameters

response

certificate

Uint8Array

Returns

number

query()

query(canisterId, fields, identity?): Promise<ApiQueryResponse>

Defined in: packages/core/src/agent/agent/http/index.ts:1016

Send a query call to a canister. See the interface spec.

Parameters

canisterId

string | Principal

The Principal of the Canister to send the query to. Sending a query to the management canister is not supported (as it has no meaning from an agent).

fields

QueryFields

identity?

Identity | Promise<Identity>

Sender principal to use when sending the query.

Returns

Promise<ApiQueryResponse>

The response from the replica. The Promise will only reject when the communication failed. If the query itself failed but no protocol errors happened, the response will be of type QueryResponseRejected.

Implementation of

Agent.query

readState()

readState(canisterId, fields, _identity?, request?): Promise<ReadStateResponse>

Defined in: packages/core/src/agent/agent/http/index.ts:1239

Send a read state query to the replica. This includes a list of paths to return, and will return a Certificate. This will only reject on communication errors, but the certificate might contain less information than requested.

Parameters

canisterId

string | Principal

fields

ReadStateOptions

_identity?

Identity | Promise<Identity>

request?

any

The request to send in case it has already been created.

Returns

Promise<ReadStateResponse>

Implementation of

Agent.readState

readSubnetState()

readSubnetState(subnetId, options): Promise<ReadStateResponse>

Defined in: packages/core/src/agent/agent/http/index.ts:1289

Reads the state of a subnet from the /api/v3/subnet/{subnetId}/read_state endpoint.

Parameters

subnetId

string | Principal

The ID of the subnet to read the state of. If you have a canister ID, you can use getSubnetIdFromCanister to get the subnet ID.

options

ReadStateOptions

The options for the read state request.

Returns

Promise<ReadStateResponse>

The response from the read state request.

replaceIdentity()

replaceIdentity(identity): void

Defined in: packages/core/src/agent/agent/http/index.ts:1583

If an application needs to replace an identity under certain conditions, an Agent may expose a replaceIdentity method. Invoking this method will set the inner identity used by the Agent to a newly provided identity.

A use case for this would be - after authenticating using @icp-sdk/auth/client, you can replace the AnonymousIdentity of your Actor with a DelegationIdentity.

Actor.agentOf(defaultActor).replaceIdentity(await authClient.getIdentity());

Parameters

identity

Identity

Returns

void

Implementation of

Agent.replaceIdentity

status()

status(): Promise<JsonObject>

Defined in: packages/core/src/agent/agent/http/index.ts:1518

Query the status endpoint of the replica. This normally has a few fields that corresponds to the version of the replica, its root public key, and any other information made public.

Returns

Promise<JsonObject>

A JsonObject that is essentially a record of fields from the status endpoint.

Implementation of

Agent.status

syncTime()

syncTime(canisterIdOverride?): Promise<void>

Defined in: packages/core/src/agent/agent/http/index.ts:1398

Allows agent to sync its time with the network. Can be called during initialization or mid-lifecycle if the device’s clock has drifted away from the network time. This is necessary to set the Expiry for a request

Parameters

canisterIdOverride?

Principal

Pass a canister ID if you need to sync the time with a particular subnet. Uses the ICP ledger canister by default.

Returns

Promise<void>

syncTimeWithSubnet()

syncTimeWithSubnet(subnetId): Promise<void>

Defined in: packages/core/src/agent/agent/http/index.ts:1461

Allows agent to sync its time with the network.

Parameters

subnetId

Principal

Pass the subnet ID you need to sync the time with.

Returns

Promise<void>

update()

update(canisterId, fields, pollingOptions?): Promise<UpdateResult>

Defined in: packages/core/src/agent/agent/http/index.ts:649

Executes an update call to a canister and returns the certified result.

Parameters

canisterId

string | Principal

The canister to call.

fields

UpdateOptions

The call options (method name, arg, effective canister ID, optional nonce).

pollingOptions?

PollingOptions = {}

Optional polling configuration.

Returns

Promise<UpdateResult>

The certified result including the certificate, reply bytes, and raw certificate bytes.

Implementation of

Agent.update

create()

static create(options?): Promise<HttpAgent>

Defined in: packages/core/src/agent/agent/http/index.ts:414

Parameters

options?

HttpAgentOptions = {}

Returns

Promise<HttpAgent>

createSync()

static createSync(options?): HttpAgent

Defined in: packages/core/src/agent/agent/http/index.ts:410

Parameters

options?

HttpAgentOptions = {}

Returns

HttpAgent

from()

static from(agent): Promise<HttpAgent>

Defined in: packages/core/src/agent/agent/http/index.ts:420

Parameters

agent

V1HttpAgentInterface | Pick<HttpAgent, "config">

Returns

Promise<HttpAgent>

---

HttpErrorCode

Defined in: packages/core/src/agent/errors.ts:814

Extends

• ErrorCode

Constructors

Constructor

new HttpErrorCode(status, statusText, headers, bodyText?): HttpErrorCode

Defined in: packages/core/src/agent/errors.ts:817

Parameters

status

number

statusText

string

headers

HttpHeaderField[]

bodyText?

string

Returns

HttpErrorCode

Overrides

ErrorCode.constructor

Properties

bodyText?

readonly optional bodyText?: string

Defined in: packages/core/src/agent/errors.ts:821

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

headers

readonly headers: HttpHeaderField[]

Defined in: packages/core/src/agent/errors.ts:820

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'HttpErrorCode'

Defined in: packages/core/src/agent/errors.ts:815

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

status

readonly status: number

Defined in: packages/core/src/agent/errors.ts:818

statusText

readonly statusText: string

Defined in: packages/core/src/agent/errors.ts:819

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:827

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

HttpFetchErrorCode

Defined in: packages/core/src/agent/errors.ts:852

Extends

• ErrorCode

Constructors

Constructor

new HttpFetchErrorCode(error): HttpFetchErrorCode

Defined in: packages/core/src/agent/errors.ts:855

Parameters

error

unknown

Returns

HttpFetchErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

error

readonly error: unknown

Defined in: packages/core/src/agent/errors.ts:855

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'HttpFetchErrorCode'

Defined in: packages/core/src/agent/errors.ts:853

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:860

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

HttpV4ApiNotSupportedErrorCode

Defined in: packages/core/src/agent/errors.ts:839

Extends

• ErrorCode

Constructors

Constructor

new HttpV4ApiNotSupportedErrorCode(): HttpV4ApiNotSupportedErrorCode

Defined in: packages/core/src/agent/errors.ts:842

Returns

HttpV4ApiNotSupportedErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'HttpV4ApiNotSupportedErrorCode'

Defined in: packages/core/src/agent/errors.ts:840

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:847

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

IdentityInvalidErrorCode

Defined in: packages/core/src/agent/errors.ts:641

Extends

• ErrorCode

Constructors

Constructor

new IdentityInvalidErrorCode(): IdentityInvalidErrorCode

Defined in: packages/core/src/agent/errors.ts:644

Returns

IdentityInvalidErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'IdentityInvalidErrorCode'

Defined in: packages/core/src/agent/errors.ts:642

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:649

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

IngressExpiryInvalidErrorCode

Defined in: packages/core/src/agent/errors.ts:654

Extends

• ErrorCode

Constructors

Constructor

new IngressExpiryInvalidErrorCode(message, providedIngressExpiryInMinutes): IngressExpiryInvalidErrorCode

Defined in: packages/core/src/agent/errors.ts:657

Parameters

message

string

providedIngressExpiryInMinutes

number

Returns

IngressExpiryInvalidErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

message

readonly message: string

Defined in: packages/core/src/agent/errors.ts:658

name

name: string = 'IngressExpiryInvalidErrorCode'

Defined in: packages/core/src/agent/errors.ts:655

providedIngressExpiryInMinutes

readonly providedIngressExpiryInMinutes: number

Defined in: packages/core/src/agent/errors.ts:659

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:665

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

InputError

Defined in: packages/core/src/agent/errors.ts:218

Extends

• ErrorKind

Constructors

Constructor

new InputError(code): InputError

Defined in: packages/core/src/agent/errors.ts:221

Parameters

code

ErrorCode

Returns

InputError

Overrides

ErrorKind.constructor

Properties

cause

readonly cause: object

Defined in: packages/core/src/agent/errors.ts:116

code

code: ErrorCode

kind

kind: ErrorKindEnum

Inherited from

ErrorKind.cause

message

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

ErrorKind.message

name

name: string = 'InputError'

Defined in: packages/core/src/agent/errors.ts:219

Overrides

ErrorKind.name

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

ErrorKind.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ErrorKind.stackTraceLimit

Accessors

code

Get Signature

get code(): ErrorCode

Defined in: packages/core/src/agent/errors.ts:118

Returns

ErrorCode

Set Signature

set code(code): void

Defined in: packages/core/src/agent/errors.ts:121

Parameters

code

ErrorCode

Returns

void

Inherited from

ErrorKind.code

isCertified

Get Signature

get isCertified(): boolean

Defined in: packages/core/src/agent/errors.ts:136

Reads the isCertified property of the underlying error code.

Returns

boolean

true if the error is certified, false otherwise.

Inherited from

ErrorKind.isCertified

kind

Get Signature

get kind(): ErrorKindEnum

Defined in: packages/core/src/agent/errors.ts:125

Returns

ErrorKindEnum

Set Signature

set kind(kind): void

Defined in: packages/core/src/agent/errors.ts:128

Parameters

kind

ErrorKindEnum

Returns

void

Inherited from

ErrorKind.kind

Methods

hasCode()

hasCode<C>(code): boolean

Defined in: packages/core/src/agent/errors.ts:146

Type Parameters

C

C extends ErrorCode

Parameters

code

(…args) => C

Returns

boolean

Inherited from

ErrorKind.hasCode

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:150

Returns a string representation of an object.

Returns

string

Inherited from

ErrorKind.toString

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ErrorKind.captureStackTrace

fromCode()

static fromCode<C, E>(this, code): E

Defined in: packages/core/src/agent/errors.ts:156

Type Parameters

C

C extends ErrorCode

E

E extends ErrorKind

Parameters

this

(code) => E

code

C

Returns

E

Inherited from

ErrorKind.fromCode

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

ErrorKind.prepareStackTrace

---

InvalidReadStateRequestErrorCode

Defined in: packages/core/src/agent/errors.ts:878

Extends

• ErrorCode

Constructors

Constructor

new InvalidReadStateRequestErrorCode(request): InvalidReadStateRequestErrorCode

Defined in: packages/core/src/agent/errors.ts:881

Parameters

request

unknown

Returns

InvalidReadStateRequestErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'InvalidReadStateRequestErrorCode'

Defined in: packages/core/src/agent/errors.ts:879

request

readonly request: unknown

Defined in: packages/core/src/agent/errors.ts:881

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:886

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

InvalidRootKeyErrorCode

Defined in: packages/core/src/agent/errors.ts:904

Extends

• ErrorCode

Constructors

Constructor

new InvalidRootKeyErrorCode(rootKey, expectedLength): InvalidRootKeyErrorCode

Defined in: packages/core/src/agent/errors.ts:907

Parameters

rootKey

Uint8Array

expectedLength

number

Returns

InvalidRootKeyErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

expectedLength

readonly expectedLength: number

Defined in: packages/core/src/agent/errors.ts:909

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'InvalidRootKeyErrorCode'

Defined in: packages/core/src/agent/errors.ts:905

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

rootKey

readonly rootKey: Uint8Array

Defined in: packages/core/src/agent/errors.ts:908

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:915

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

LimitError

Defined in: packages/core/src/agent/errors.ts:209

Extends

• ErrorKind

Constructors

Constructor

new LimitError(code): LimitError

Defined in: packages/core/src/agent/errors.ts:212

Parameters

code

ErrorCode

Returns

LimitError

Overrides

ErrorKind.constructor

Properties

cause

readonly cause: object

Defined in: packages/core/src/agent/errors.ts:116

code

code: ErrorCode

kind

kind: ErrorKindEnum

Inherited from

ErrorKind.cause

message

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

ErrorKind.message

name

name: string = 'LimitError'

Defined in: packages/core/src/agent/errors.ts:210

Overrides

ErrorKind.name

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

ErrorKind.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ErrorKind.stackTraceLimit

Accessors

code

Get Signature

get code(): ErrorCode

Defined in: packages/core/src/agent/errors.ts:118

Returns

ErrorCode

Set Signature

set code(code): void

Defined in: packages/core/src/agent/errors.ts:121

Parameters

code

ErrorCode

Returns

void

Inherited from

ErrorKind.code

isCertified

Get Signature

get isCertified(): boolean

Defined in: packages/core/src/agent/errors.ts:136

Reads the isCertified property of the underlying error code.

Returns

boolean

true if the error is certified, false otherwise.

Inherited from

ErrorKind.isCertified

kind

Get Signature

get kind(): ErrorKindEnum

Defined in: packages/core/src/agent/errors.ts:125

Returns

ErrorKindEnum

Set Signature

set kind(kind): void

Defined in: packages/core/src/agent/errors.ts:128

Parameters

kind

ErrorKindEnum

Returns

void

Inherited from

ErrorKind.kind

Methods

hasCode()

hasCode<C>(code): boolean

Defined in: packages/core/src/agent/errors.ts:146

Type Parameters

C

C extends ErrorCode

Parameters

code

(…args) => C

Returns

boolean

Inherited from

ErrorKind.hasCode

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:150

Returns a string representation of an object.

Returns

string

Inherited from

ErrorKind.toString

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ErrorKind.captureStackTrace

fromCode()

static fromCode<C, E>(this, code): E

Defined in: packages/core/src/agent/errors.ts:156

Type Parameters

C

C extends ErrorCode

E

E extends ErrorKind

Parameters

this

(code) => E

code

C

Returns

E

Inherited from

ErrorKind.fromCode

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

ErrorKind.prepareStackTrace

---

LookupErrorCode

Defined in: packages/core/src/agent/errors.ts:317

Extends

• ErrorCode

Constructors

Constructor

new LookupErrorCode(message, lookupStatus): LookupErrorCode

Defined in: packages/core/src/agent/errors.ts:320

Parameters

message

string

lookupStatus

LookupSubtreeStatus | LookupPathStatus

Returns

LookupErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

lookupStatus

readonly lookupStatus: LookupSubtreeStatus | LookupPathStatus

Defined in: packages/core/src/agent/errors.ts:322

message

readonly message: string

Defined in: packages/core/src/agent/errors.ts:321

name

name: string = 'LookupErrorCode'

Defined in: packages/core/src/agent/errors.ts:318

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:328

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

MalformedLookupFoundValueErrorCode

Defined in: packages/core/src/agent/errors.ts:333

Extends

• ErrorCode

Constructors

Constructor

new MalformedLookupFoundValueErrorCode(message): MalformedLookupFoundValueErrorCode

Defined in: packages/core/src/agent/errors.ts:336

Parameters

message

string

Returns

MalformedLookupFoundValueErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

message

readonly message: string

Defined in: packages/core/src/agent/errors.ts:336

name

name: string = 'MalformedLookupFoundValueErrorCode'

Defined in: packages/core/src/agent/errors.ts:334

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:341

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

MalformedPublicKeyErrorCode

Defined in: packages/core/src/agent/errors.ts:738

Extends

• ErrorCode

Constructors

Constructor

new MalformedPublicKeyErrorCode(): MalformedPublicKeyErrorCode

Defined in: packages/core/src/agent/errors.ts:741

Returns

MalformedPublicKeyErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'MalformedPublicKeyErrorCode'

Defined in: packages/core/src/agent/errors.ts:739

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:746

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

MalformedSignatureErrorCode

Defined in: packages/core/src/agent/errors.ts:712

Extends

• ErrorCode

Constructors

Constructor

new MalformedSignatureErrorCode(error): MalformedSignatureErrorCode

Defined in: packages/core/src/agent/errors.ts:715

Parameters

error

string

Returns

MalformedSignatureErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

error

readonly error: string

Defined in: packages/core/src/agent/errors.ts:715

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'MalformedSignatureErrorCode'

Defined in: packages/core/src/agent/errors.ts:713

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:720

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

MissingCanisterIdErrorCode

Defined in: packages/core/src/agent/errors.ts:865

Extends

• ErrorCode

Constructors

Constructor

new MissingCanisterIdErrorCode(receivedCanisterId): MissingCanisterIdErrorCode

Defined in: packages/core/src/agent/errors.ts:868

Parameters

receivedCanisterId

unknown

Returns

MissingCanisterIdErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'MissingCanisterIdErrorCode'

Defined in: packages/core/src/agent/errors.ts:866

receivedCanisterId

readonly receivedCanisterId: unknown

Defined in: packages/core/src/agent/errors.ts:868

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:873

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

MissingCookieErrorCode

Defined in: packages/core/src/agent/errors.ts:920

Extends

• ErrorCode

Constructors

Constructor

new MissingCookieErrorCode(expectedCookieName): MissingCookieErrorCode

Defined in: packages/core/src/agent/errors.ts:923

Parameters

expectedCookieName

string

Returns

MissingCookieErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

expectedCookieName

readonly expectedCookieName: string

Defined in: packages/core/src/agent/errors.ts:923

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'MissingCookieErrorCode'

Defined in: packages/core/src/agent/errors.ts:921

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:928

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

MissingFetchErrorCode

Defined in: packages/core/src/agent/errors.ts:670

Extends

• ErrorCode

Constructors

Constructor

new MissingFetchErrorCode(): MissingFetchErrorCode

Defined in: packages/core/src/agent/errors.ts:673

Returns

MissingFetchErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'MissingFetchErrorCode'

Defined in: packages/core/src/agent/errors.ts:671

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:678

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

MissingLookupValueErrorCode

Defined in: packages/core/src/agent/errors.ts:346

Extends

• ErrorCode

Constructors

Constructor

new MissingLookupValueErrorCode(message): MissingLookupValueErrorCode

Defined in: packages/core/src/agent/errors.ts:349

Parameters

message

string

Returns

MissingLookupValueErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

message

readonly message: string

Defined in: packages/core/src/agent/errors.ts:349

name

name: string = 'MissingLookupValueErrorCode'

Defined in: packages/core/src/agent/errors.ts:347

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:354

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

MissingRootKeyErrorCode

Defined in: packages/core/src/agent/errors.ts:612

Extends

• ErrorCode

Constructors

Constructor

new MissingRootKeyErrorCode(shouldFetchRootKey?): MissingRootKeyErrorCode

Defined in: packages/core/src/agent/errors.ts:615

Parameters

shouldFetchRootKey?

boolean

Returns

MissingRootKeyErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'MissingRootKeyErrorCode'

Defined in: packages/core/src/agent/errors.ts:613

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

shouldFetchRootKey?

readonly optional shouldFetchRootKey?: boolean

Defined in: packages/core/src/agent/errors.ts:615

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:620

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

MissingSignatureErrorCode

Defined in: packages/core/src/agent/errors.ts:725

Extends

• ErrorCode

Constructors

Constructor

new MissingSignatureErrorCode(): MissingSignatureErrorCode

Defined in: packages/core/src/agent/errors.ts:728

Returns

MissingSignatureErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'MissingSignatureErrorCode'

Defined in: packages/core/src/agent/errors.ts:726

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:733

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

Observable

Defined in: packages/core/src/agent/observable.ts:5

Extended by

• ObservableLog

Type Parameters

T

T

Constructors

Constructor

new Observable<T>(): Observable<T>

Defined in: packages/core/src/agent/observable.ts:8

Returns

Observable<T>

Properties

observers

observers: ObserveFunction<T>[]

Defined in: packages/core/src/agent/observable.ts:6

Methods

notify()

notify(data, …rest): void

Defined in: packages/core/src/agent/observable.ts:20

Parameters

data

T

rest

…unknown[]

Returns

void

subscribe()

subscribe(func): void

Defined in: packages/core/src/agent/observable.ts:12

Parameters

func

ObserveFunction<T>

Returns

void

unsubscribe()

unsubscribe(func): void

Defined in: packages/core/src/agent/observable.ts:16

Parameters

func

ObserveFunction<T>

Returns

void

---

ObservableLog

Defined in: packages/core/src/agent/observable.ts:36

Extends

• Observable<AgentLog>

Constructors

Constructor

new ObservableLog(): ObservableLog

Defined in: packages/core/src/agent/observable.ts:37

Returns

ObservableLog

Overrides

Observable.constructor

Properties

observers

observers: ObserveFunction<AgentLog>[]

Defined in: packages/core/src/agent/observable.ts:6

Inherited from

Observable.observers

Methods

error()

error(message, error, …rest): void

Defined in: packages/core/src/agent/observable.ts:46

Parameters

message

string

error

AgentError

rest

…unknown[]

Returns

void

notify()

notify(data, …rest): void

Defined in: packages/core/src/agent/observable.ts:20

Parameters

data

AgentLog

rest

…unknown[]

Returns

void

Inherited from

Observable.notify

print()

print(message, …rest): void

Defined in: packages/core/src/agent/observable.ts:40

Parameters

message

string

rest

…unknown[]

Returns

void

subscribe()

subscribe(func): void

Defined in: packages/core/src/agent/observable.ts:12

Parameters

func

ObserveFunction<AgentLog>

Returns

void

Inherited from

Observable.subscribe

unsubscribe()

unsubscribe(func): void

Defined in: packages/core/src/agent/observable.ts:16

Parameters

func

ObserveFunction<AgentLog>

Returns

void

Inherited from

Observable.unsubscribe

warn()

warn(message, …rest): void

Defined in: packages/core/src/agent/observable.ts:43

Parameters

message

string

rest

…unknown[]

Returns

void

---

ProtocolError

Defined in: packages/core/src/agent/errors.ts:173

Extends

• ErrorKind

Constructors

Constructor

new ProtocolError(code): ProtocolError

Defined in: packages/core/src/agent/errors.ts:176

Parameters

code

ErrorCode

Returns

ProtocolError

Overrides

ErrorKind.constructor

Properties

cause

readonly cause: object

Defined in: packages/core/src/agent/errors.ts:116

code

code: ErrorCode

kind

kind: ErrorKindEnum

Inherited from

ErrorKind.cause

message

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

ErrorKind.message

name

name: string = 'ProtocolError'

Defined in: packages/core/src/agent/errors.ts:174

Overrides

ErrorKind.name

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

ErrorKind.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ErrorKind.stackTraceLimit

Accessors

code

Get Signature

get code(): ErrorCode

Defined in: packages/core/src/agent/errors.ts:118

Returns

ErrorCode

Set Signature

set code(code): void

Defined in: packages/core/src/agent/errors.ts:121

Parameters

code

ErrorCode

Returns

void

Inherited from

ErrorKind.code

isCertified

Get Signature

get isCertified(): boolean

Defined in: packages/core/src/agent/errors.ts:136

Reads the isCertified property of the underlying error code.

Returns

boolean

true if the error is certified, false otherwise.

Inherited from

ErrorKind.isCertified

kind

Get Signature

get kind(): ErrorKindEnum

Defined in: packages/core/src/agent/errors.ts:125

Returns

ErrorKindEnum

Set Signature

set kind(kind): void

Defined in: packages/core/src/agent/errors.ts:128

Parameters

kind

ErrorKindEnum

Returns

void

Inherited from

ErrorKind.kind

Methods

hasCode()

hasCode<C>(code): boolean

Defined in: packages/core/src/agent/errors.ts:146

Type Parameters

C

C extends ErrorCode

Parameters

code

(…args) => C

Returns

boolean

Inherited from

ErrorKind.hasCode

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:150

Returns a string representation of an object.

Returns

string

Inherited from

ErrorKind.toString

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ErrorKind.captureStackTrace

fromCode()

static fromCode<C, E>(this, code): E

Defined in: packages/core/src/agent/errors.ts:156

Type Parameters

C

C extends ErrorCode

E

E extends ErrorKind

Parameters

this

(code) => E

code

C

Returns

E

Inherited from

ErrorKind.fromCode

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

ErrorKind.prepareStackTrace

---

QuerySignatureVerificationFailedErrorCode

Defined in: packages/core/src/agent/errors.ts:751

Extends

• ErrorCode

Constructors

Constructor

new QuerySignatureVerificationFailedErrorCode(nodeId): QuerySignatureVerificationFailedErrorCode

Defined in: packages/core/src/agent/errors.ts:754

Parameters

nodeId

string

Returns

QuerySignatureVerificationFailedErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'QuerySignatureVerificationFailedErrorCode'

Defined in: packages/core/src/agent/errors.ts:752

nodeId

readonly nodeId: string

Defined in: packages/core/src/agent/errors.ts:754

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:759

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

RejectError

Defined in: packages/core/src/agent/errors.ts:182

Extends

• ErrorKind

Constructors

Constructor

new RejectError(code): RejectError

Defined in: packages/core/src/agent/errors.ts:185

Parameters

code

ErrorCode

Returns

RejectError

Overrides

ErrorKind.constructor

Properties

cause

readonly cause: object

Defined in: packages/core/src/agent/errors.ts:116

code

code: ErrorCode

kind

kind: ErrorKindEnum

Inherited from

ErrorKind.cause

message

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

ErrorKind.message

name

name: string = 'RejectError'

Defined in: packages/core/src/agent/errors.ts:183

Overrides

ErrorKind.name

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

ErrorKind.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ErrorKind.stackTraceLimit

Accessors

code

Get Signature

get code(): ErrorCode

Defined in: packages/core/src/agent/errors.ts:118

Returns

ErrorCode

Set Signature

set code(code): void

Defined in: packages/core/src/agent/errors.ts:121

Parameters

code

ErrorCode

Returns

void

Inherited from

ErrorKind.code

isCertified

Get Signature

get isCertified(): boolean

Defined in: packages/core/src/agent/errors.ts:136

Reads the isCertified property of the underlying error code.

Returns

boolean

true if the error is certified, false otherwise.

Inherited from

ErrorKind.isCertified

kind

Get Signature

get kind(): ErrorKindEnum

Defined in: packages/core/src/agent/errors.ts:125

Returns

ErrorKindEnum

Set Signature

set kind(kind): void

Defined in: packages/core/src/agent/errors.ts:128

Parameters

kind

ErrorKindEnum

Returns

void

Inherited from

ErrorKind.kind

Methods

hasCode()

hasCode<C>(code): boolean

Defined in: packages/core/src/agent/errors.ts:146

Type Parameters

C

C extends ErrorCode

Parameters

code

(…args) => C

Returns

boolean

Inherited from

ErrorKind.hasCode

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:150

Returns a string representation of an object.

Returns

string

Inherited from

ErrorKind.toString

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ErrorKind.captureStackTrace

fromCode()

static fromCode<C, E>(this, code): E

Defined in: packages/core/src/agent/errors.ts:156

Type Parameters

C

C extends ErrorCode

E

E extends ErrorKind

Parameters

this

(code) => E

code

C

Returns

E

Inherited from

ErrorKind.fromCode

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

ErrorKind.prepareStackTrace

---

RequestStatusDoneNoReplyErrorCode

Defined in: packages/core/src/agent/errors.ts:596

Extends

• ErrorCode

Constructors

Constructor

new RequestStatusDoneNoReplyErrorCode(requestId): RequestStatusDoneNoReplyErrorCode

Defined in: packages/core/src/agent/errors.ts:599

Parameters

requestId

RequestId

Returns

RequestStatusDoneNoReplyErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'RequestStatusDoneNoReplyErrorCode'

Defined in: packages/core/src/agent/errors.ts:597

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

requestId

readonly requestId: RequestId

Defined in: packages/core/src/agent/errors.ts:599

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:604

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

abstract SignIdentity

Defined in: packages/core/src/agent/auth.ts:57

An Identity that can sign blobs.

Extended by

• Ed25519KeyIdentity
• ECDSAKeyIdentity
• DelegationIdentity
• Secp256k1KeyIdentity
• WebAuthnIdentity

Implements

• Identity

Constructors

Constructor

new SignIdentity(): SignIdentity

Returns

SignIdentity

Properties

_principal

protected _principal: Principal | undefined

Defined in: packages/core/src/agent/auth.ts:58

Methods

getPrincipal()

getPrincipal(): Principal

Defined in: packages/core/src/agent/auth.ts:74

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

Returns

Principal

Implementation of

Identity.getPrincipal

getPublicKey()

abstract getPublicKey(): PublicKey

Defined in: packages/core/src/agent/auth.ts:63

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

Returns

PublicKey

sign()

abstract sign(blob): Promise<Signature>

Defined in: packages/core/src/agent/auth.ts:68

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

Parameters

blob

Uint8Array

Returns

Promise<Signature>

transformRequest()

transformRequest(request): Promise<unknown>

Defined in: packages/core/src/agent/auth.ts:87

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>

Implementation of

Identity.transformRequest

---

TimeoutWaitingForResponseErrorCode

Defined in: packages/core/src/agent/errors.ts:478

Extends

• ErrorCode

Constructors

Constructor

new TimeoutWaitingForResponseErrorCode(message, requestId?, status?): TimeoutWaitingForResponseErrorCode

Defined in: packages/core/src/agent/errors.ts:481

Parameters

message

string

requestId?

RequestId

status?

RequestStatusResponseStatus

Returns

TimeoutWaitingForResponseErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

message

readonly message: string

Defined in: packages/core/src/agent/errors.ts:482

name

name: string = 'TimeoutWaitingForResponseErrorCode'

Defined in: packages/core/src/agent/errors.ts:479

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

requestId?

readonly optional requestId?: RequestId

Defined in: packages/core/src/agent/errors.ts:483

status?

readonly optional status?: RequestStatusResponseStatus

Defined in: packages/core/src/agent/errors.ts:484

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:490

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

abstract ToCborValue

Defined in: packages/core/src/agent/cbor.ts:9

Used to extend classes that need to provide a custom value for the CBOR encoding process.

Constructors

Constructor

new ToCborValue(): ToCborValue

Returns

ToCborValue

Methods

toCborValue()

abstract toCborValue(): any

Defined in: packages/core/src/agent/cbor.ts:13

Returns a value that can be encoded with CBOR. Typically called in the replacer function of the encode function.

Returns

any

---

TransportError

Defined in: packages/core/src/agent/errors.ts:191

Extends

• ErrorKind

Constructors

Constructor

new TransportError(code): TransportError

Defined in: packages/core/src/agent/errors.ts:194

Parameters

code

ErrorCode

Returns

TransportError

Overrides

ErrorKind.constructor

Properties

cause

readonly cause: object

Defined in: packages/core/src/agent/errors.ts:116

code

code: ErrorCode

kind

kind: ErrorKindEnum

Inherited from

ErrorKind.cause

message

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

ErrorKind.message

name

name: string = 'TransportError'

Defined in: packages/core/src/agent/errors.ts:192

Overrides

ErrorKind.name

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

ErrorKind.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ErrorKind.stackTraceLimit

Accessors

code

Get Signature

get code(): ErrorCode

Defined in: packages/core/src/agent/errors.ts:118

Returns

ErrorCode

Set Signature

set code(code): void

Defined in: packages/core/src/agent/errors.ts:121

Parameters

code

ErrorCode

Returns

void

Inherited from

ErrorKind.code

isCertified

Get Signature

get isCertified(): boolean

Defined in: packages/core/src/agent/errors.ts:136

Reads the isCertified property of the underlying error code.

Returns

boolean

true if the error is certified, false otherwise.

Inherited from

ErrorKind.isCertified

kind

Get Signature

get kind(): ErrorKindEnum

Defined in: packages/core/src/agent/errors.ts:125

Returns

ErrorKindEnum

Set Signature

set kind(kind): void

Defined in: packages/core/src/agent/errors.ts:128

Parameters

kind

ErrorKindEnum

Returns

void

Inherited from

ErrorKind.kind

Methods

hasCode()

hasCode<C>(code): boolean

Defined in: packages/core/src/agent/errors.ts:146

Type Parameters

C

C extends ErrorCode

Parameters

code

(…args) => C

Returns

boolean

Inherited from

ErrorKind.hasCode

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:150

Returns a string representation of an object.

Returns

string

Inherited from

ErrorKind.toString

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ErrorKind.captureStackTrace

fromCode()

static fromCode<C, E>(this, code): E

Defined in: packages/core/src/agent/errors.ts:156

Type Parameters

C

C extends ErrorCode

E

E extends ErrorKind

Parameters

this

(code) => E

code

C

Returns

E

Inherited from

ErrorKind.fromCode

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

ErrorKind.prepareStackTrace

---

TrustError

Defined in: packages/core/src/agent/errors.ts:164

Extends

• ErrorKind

Constructors

Constructor

new TrustError(code): TrustError

Defined in: packages/core/src/agent/errors.ts:167

Parameters

code

ErrorCode

Returns

TrustError

Overrides

ErrorKind.constructor

Properties

cause

readonly cause: object

Defined in: packages/core/src/agent/errors.ts:116

code

code: ErrorCode

kind

kind: ErrorKindEnum

Inherited from

ErrorKind.cause

message

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

ErrorKind.message

name

name: string = 'TrustError'

Defined in: packages/core/src/agent/errors.ts:165

Overrides

ErrorKind.name

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

ErrorKind.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ErrorKind.stackTraceLimit

Accessors

code

Get Signature

get code(): ErrorCode

Defined in: packages/core/src/agent/errors.ts:118

Returns

ErrorCode

Set Signature

set code(code): void

Defined in: packages/core/src/agent/errors.ts:121

Parameters

code

ErrorCode

Returns

void

Inherited from

ErrorKind.code

isCertified

Get Signature

get isCertified(): boolean

Defined in: packages/core/src/agent/errors.ts:136

Reads the isCertified property of the underlying error code.

Returns

boolean

true if the error is certified, false otherwise.

Inherited from

ErrorKind.isCertified

kind

Get Signature

get kind(): ErrorKindEnum

Defined in: packages/core/src/agent/errors.ts:125

Returns

ErrorKindEnum

Set Signature

set kind(kind): void

Defined in: packages/core/src/agent/errors.ts:128

Parameters

kind

ErrorKindEnum

Returns

void

Inherited from

ErrorKind.kind

Methods

hasCode()

hasCode<C>(code): boolean

Defined in: packages/core/src/agent/errors.ts:146

Type Parameters

C

C extends ErrorCode

Parameters

code

(…args) => C

Returns

boolean

Inherited from

ErrorKind.hasCode

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:150

Returns a string representation of an object.

Returns

string

Inherited from

ErrorKind.toString

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ErrorKind.captureStackTrace

fromCode()

static fromCode<C, E>(this, code): E

Defined in: packages/core/src/agent/errors.ts:156

Type Parameters

C

C extends ErrorCode

E

E extends ErrorKind

Parameters

this

(code) => E

code

C

Returns

E

Inherited from

ErrorKind.fromCode

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

ErrorKind.prepareStackTrace

---

UncertifiedRejectErrorCode

Defined in: packages/core/src/agent/errors.ts:547

Extends

• ErrorCode

Constructors

Constructor

new UncertifiedRejectErrorCode(requestId, rejectCode, rejectMessage, rejectErrorCode, signatures): UncertifiedRejectErrorCode

Defined in: packages/core/src/agent/errors.ts:550

Parameters

requestId

RequestId

rejectCode

ReplicaRejectCode

rejectMessage

string

rejectErrorCode

string | undefined

signatures

NodeSignature[] | undefined

Returns

UncertifiedRejectErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'UncertifiedRejectErrorCode'

Defined in: packages/core/src/agent/errors.ts:548

rejectCode

readonly rejectCode: ReplicaRejectCode

Defined in: packages/core/src/agent/errors.ts:552

rejectErrorCode

readonly rejectErrorCode: string | undefined

Defined in: packages/core/src/agent/errors.ts:554

rejectMessage

readonly rejectMessage: string

Defined in: packages/core/src/agent/errors.ts:553

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

requestId

readonly requestId: RequestId

Defined in: packages/core/src/agent/errors.ts:551

signatures

readonly signatures: NodeSignature[] | undefined

Defined in: packages/core/src/agent/errors.ts:555

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:561

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

UncertifiedRejectUpdateErrorCode

Defined in: packages/core/src/agent/errors.ts:572

Extends

• ErrorCode

Constructors

Constructor

new UncertifiedRejectUpdateErrorCode(requestId, rejectCode, rejectMessage, rejectErrorCode): UncertifiedRejectUpdateErrorCode

Defined in: packages/core/src/agent/errors.ts:575

Parameters

requestId

RequestId

rejectCode

ReplicaRejectCode

rejectMessage

string

rejectErrorCode

string | undefined

Returns

UncertifiedRejectUpdateErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'UncertifiedRejectUpdateErrorCode'

Defined in: packages/core/src/agent/errors.ts:573

rejectCode

readonly rejectCode: ReplicaRejectCode

Defined in: packages/core/src/agent/errors.ts:577

rejectErrorCode

readonly rejectErrorCode: string | undefined

Defined in: packages/core/src/agent/errors.ts:579

rejectMessage

readonly rejectMessage: string

Defined in: packages/core/src/agent/errors.ts:578

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

requestId

readonly requestId: RequestId

Defined in: packages/core/src/agent/errors.ts:576

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:585

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

UnexpectedErrorCode

Defined in: packages/core/src/agent/errors.ts:764

Extends

• ErrorCode

Constructors

Constructor

new UnexpectedErrorCode(error): UnexpectedErrorCode

Defined in: packages/core/src/agent/errors.ts:767

Parameters

error

unknown

Returns

UnexpectedErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

error

readonly error: unknown

Defined in: packages/core/src/agent/errors.ts:767

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'UnexpectedErrorCode'

Defined in: packages/core/src/agent/errors.ts:765

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:772

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

UnexpectedV4StatusErrorCode

Defined in: packages/core/src/agent/errors.ts:777

Extends

• ErrorCode

Constructors

Constructor

new UnexpectedV4StatusErrorCode(status, requestId, response, rawCertificate): UnexpectedV4StatusErrorCode

Defined in: packages/core/src/agent/errors.ts:780

Parameters

status

string | undefined

requestId

RequestId

response

body

v2ResponseBody | v4ResponseBody | null

headers

HttpHeaderField[]

ok

boolean

status

number

statusText

string

rawCertificate

Uint8Array

Returns

UnexpectedV4StatusErrorCode

Overrides

ErrorCode.constructor

Properties

callContext?

optional callContext?: CallContext | PollingCallContext

Defined in: packages/core/src/agent/errors.ts:78

Inherited from

ErrorCode.callContext

isCertified

readonly isCertified: boolean = false

Defined in: packages/core/src/agent/errors.ts:80

Inherited from

ErrorCode.isCertified

name

name: string = 'UnexpectedV4StatusErrorCode'

Defined in: packages/core/src/agent/errors.ts:778

rawCertificate

readonly rawCertificate: Uint8Array

Defined in: packages/core/src/agent/errors.ts:784

requestContext?

optional requestContext?: RequestContext

Defined in: packages/core/src/agent/errors.ts:77

Inherited from

ErrorCode.requestContext

requestId

readonly requestId: RequestId

Defined in: packages/core/src/agent/errors.ts:782

response

readonly response: object

Defined in: packages/core/src/agent/errors.ts:783

body

body: v2ResponseBody | v4ResponseBody | null

headers

headers: HttpHeaderField[]

ok

ok: boolean

status

status: number

statusText

statusText: string

status

readonly status: string | undefined

Defined in: packages/core/src/agent/errors.ts:781

verbosity

static verbosity: ErrorVerbosity = ErrorVerbosity.Normal

Defined in: packages/core/src/agent/errors.ts:75

Inherited from

ErrorCode.verbosity

Methods

toErrorMessage()

toErrorMessage(): string

Defined in: packages/core/src/agent/errors.ts:790

Returns

string

Overrides

ErrorCode.toErrorMessage

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:84

Returns

string

Inherited from

ErrorCode.toString

---

UnknownError

Defined in: packages/core/src/agent/errors.ts:227

Extends

• ErrorKind

Constructors

Constructor

new UnknownError(code): UnknownError

Defined in: packages/core/src/agent/errors.ts:230

Parameters

code

ErrorCode

Returns

UnknownError

Overrides

ErrorKind.constructor

Properties

cause

readonly cause: object

Defined in: packages/core/src/agent/errors.ts:116

code

code: ErrorCode

kind

kind: ErrorKindEnum

Inherited from

ErrorKind.cause

message

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

ErrorKind.message

name

name: string = 'UnknownError'

Defined in: packages/core/src/agent/errors.ts:228

Overrides

ErrorKind.name

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

ErrorKind.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ErrorKind.stackTraceLimit

Accessors

code

Get Signature

get code(): ErrorCode

Defined in: packages/core/src/agent/errors.ts:118

Returns

ErrorCode

Set Signature

set code(code): void

Defined in: packages/core/src/agent/errors.ts:121

Parameters

code

ErrorCode

Returns

void

Inherited from

ErrorKind.code

isCertified

Get Signature

get isCertified(): boolean

Defined in: packages/core/src/agent/errors.ts:136

Reads the isCertified property of the underlying error code.

Returns

boolean

true if the error is certified, false otherwise.

Inherited from

ErrorKind.isCertified

kind

Get Signature

get kind(): ErrorKindEnum

Defined in: packages/core/src/agent/errors.ts:125

Returns

ErrorKindEnum

Set Signature

set kind(kind): void

Defined in: packages/core/src/agent/errors.ts:128

Parameters

kind

ErrorKindEnum

Returns

void

Inherited from

ErrorKind.kind

Methods

hasCode()

hasCode<C>(code): boolean

Defined in: packages/core/src/agent/errors.ts:146

Type Parameters

C

C extends ErrorCode

Parameters

code

(…args) => C

Returns

boolean

Inherited from

ErrorKind.hasCode

toString()

toString(): string

Defined in: packages/core/src/agent/errors.ts:150

Returns a string representation of an object.

Returns

string

Inherited from

ErrorKind.toString

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ErrorKind.captureStackTrace

fromCode()

static fromCode<C, E>(this, code): E

Defined in: packages/core/src/agent/errors.ts:156

Type Parameters

C

C extends ErrorCode

E

E extends ErrorKind

Parameters

this

(code) => E

code

C

Returns

E

Inherited from

ErrorKind.fromCode

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

ErrorKind.prepareStackTrace

Interfaces

ActorConfig

Defined in: packages/core/src/agent/actor.ts:61

Configuration that can be passed to customize the Actor behavior.

Extends

• Pick<CallConfig, "agent" | "effectiveCanisterId">

Properties

agent?

optional agent?: Agent

Defined in: packages/core/src/agent/actor.ts:35

An agent to use in this call, otherwise the actor or call will try to discover the agent to use.

Inherited from

CallConfig.agent

blsVerify?

optional blsVerify?: VerifyFunc

Defined in: packages/core/src/agent/actor.ts:88

Polyfill for BLS Certificate verification in case wasm is not supported

canisterId

canisterId: string | Principal

Defined in: packages/core/src/agent/actor.ts:65

The Canister ID of this Actor. This is required for an Actor.

effectiveCanisterId?

optional effectiveCanisterId?: Principal

Defined in: packages/core/src/agent/actor.ts:50

The effective canister ID.

Inherited from

CallConfig.effectiveCanisterId

pollingOptions?

optional pollingOptions?: PollingOptions

Defined in: packages/core/src/agent/actor.ts:93

Polling options to use when making update calls. This will override the default DEFAULT_POLLING_OPTIONS.

queryStrategy?

optional queryStrategy?: QueryStrategy

Defined in: packages/core/src/agent/actor.ts:101

Controls how query and composite_query methods are executed.

• 'query' (default) — standard non-replicated query call.
• 'update' — send query methods as update calls that go through consensus.

Default

'query'

Methods

callTransform()?

optional callTransform(methodName, args, callConfig): void | Partial<CallConfig>

Defined in: packages/core/src/agent/actor.ts:70

An override function for update calls’ CallConfig. This will be called on every calls.

Parameters

methodName

string

args

unknown[]

callConfig

CallConfig

Returns

void | Partial<CallConfig>

queryTransform()?

optional queryTransform(methodName, args, callConfig): void | Partial<CallConfig>

Defined in: packages/core/src/agent/actor.ts:79

An override function for query calls’ CallConfig. This will be called on every query.

Parameters

methodName

string

args

unknown[]

callConfig

CallConfig

Returns

void | Partial<CallConfig>

---

ActorMethod()

Defined in: packages/core/src/agent/actor.ts:113

An actor method type, defined for each methods of the actor service.

Extended by

• ActorMethodWithHttpDetails
• ActorMethodExtended

Type Parameters

Args

Args extends unknown[] = unknown[]

Ret

Ret = unknown

ActorMethod(…args): Promise<Ret>

Defined in: packages/core/src/agent/actor.ts:114

An actor method type, defined for each methods of the actor service.

Parameters

args

…Args

Returns

Promise<Ret>

Methods

withOptions()

withOptions(options): (…args) => Promise<Ret>

Defined in: packages/core/src/agent/actor.ts:116

Parameters

options

CallConfig

Returns

(…args) => Promise<Ret>

---

ActorMethodExtended()

Defined in: packages/core/src/agent/actor.ts:132

An actor method type, defined for each methods of the actor service.

Extends

• ActorMethod

Type Parameters

Args

Args extends unknown[] = unknown[]

Ret

Ret = unknown

Call Signature

ActorMethodExtended(…args): Promise<{ certificate?: Certificate; httpDetails?: HttpDetailsResponse; result: Ret; }>

Defined in: packages/core/src/agent/actor.ts:136

An actor method type, defined for each methods of the actor service.

Parameters

args

…Args

Returns

Promise<{ certificate?: Certificate; httpDetails?: HttpDetailsResponse; result: Ret; }>

Call Signature

ActorMethodExtended(…args): Promise<unknown>

Defined in: packages/core/src/agent/actor.ts:132

An actor method type, defined for each methods of the actor service.

Parameters

args

…unknown[]

Returns

Promise<unknown>

Methods

withOptions()

withOptions(options): (…args) => Promise<unknown>

Defined in: packages/core/src/agent/actor.ts:116

Parameters

options

CallConfig

Returns

(…args) => Promise<unknown>

Inherited from

ActorMethod.withOptions

---

ActorMethodWithHttpDetails()

Defined in: packages/core/src/agent/actor.ts:122

An actor method type, defined for each methods of the actor service.

Extends

• ActorMethod

Type Parameters

Args

Args extends unknown[] = unknown[]

Ret

Ret = unknown

Call Signature

ActorMethodWithHttpDetails(…args): Promise<{ httpDetails: HttpDetailsResponse; result: Ret; }>

Defined in: packages/core/src/agent/actor.ts:126

An actor method type, defined for each methods of the actor service.

Parameters

args

…Args

Returns

Promise<{ httpDetails: HttpDetailsResponse; result: Ret; }>

Call Signature

ActorMethodWithHttpDetails(…args): Promise<unknown>

Defined in: packages/core/src/agent/actor.ts:122

An actor method type, defined for each methods of the actor service.

Parameters

args

…unknown[]

Returns

Promise<unknown>

Methods

withOptions()

withOptions(options): (…args) => Promise<unknown>

Defined in: packages/core/src/agent/actor.ts:116

Parameters

options

CallConfig

Returns

(…args) => Promise<unknown>

Inherited from

ActorMethod.withOptions

---

Agent

Defined in: packages/core/src/agent/agent/api.ts:206

An Agent able to make calls and queries to a Replica.

Properties

rootKey

readonly rootKey: Uint8Array<ArrayBufferLike> | null

Defined in: packages/core/src/agent/agent/api.ts:207

Methods

call()

call(canisterId, fields): Promise<SubmitResponse>

Defined in: packages/core/src/agent/agent/api.ts:238

Parameters

canisterId

string | Principal

fields

CallOptions

Returns

Promise<SubmitResponse>

createReadStateRequest()?

optional createReadStateRequest(options, identity?): Promise<unknown>

Defined in: packages/core/src/agent/agent/api.ts:220

Create the request for the read state call. readState uses this internally. Useful to avoid signing the same request multiple times.

Parameters

options

ReadStateOptions

identity?

Identity

Returns

Promise<unknown>

fetchRootKey()

fetchRootKey(): Promise<Uint8Array<ArrayBufferLike>>

Defined in: packages/core/src/agent/agent/api.ts:291

By default, the agent is configured to talk to the main Internet Computer, and verifies responses using a hard-coded public key.

This function will instruct the agent to ask the endpoint for its public key, and use that instead. This is required when talking to a local test instance, for example.

Only use this when you are not talking to the main Internet Computer, otherwise you are prone to man-in-the-middle attacks! Do not call this function by default.

Returns

Promise<Uint8Array<ArrayBufferLike>>

getPrincipal()

getPrincipal(): Promise<Principal>

Defined in: packages/core/src/agent/agent/api.ts:213

Returns the principal ID associated with this agent (by default). It only shows the principal of the default identity in the agent, which is the principal used when calls don’t specify it.

Returns

Promise<Principal>

invalidateIdentity()?

optional invalidateIdentity(): void

Defined in: packages/core/src/agent/agent/api.ts:298

If an application needs to invalidate an identity under certain conditions, an Agent may expose an invalidateIdentity method. Invoking this method will set the inner identity used by the Agent to null.

A use case for this would be - after a certain period of inactivity, a secure application chooses to invalidate the identity of any HttpAgent instances. An invalid identity can be replaced by Agent.replaceIdentity

Returns

void

query()

query(canisterId, options, identity?): Promise<ApiQueryResponse>

Defined in: packages/core/src/agent/agent/api.ts:273

Send a query call to a canister. See the interface spec.

Parameters

canisterId

string | Principal

The Principal of the Canister to send the query to. Sending a query to the management canister is not supported (as it has no meaning from an agent).

options

QueryFields

Options to use to create and send the query.

identity?

Identity | Promise<Identity>

Sender principal to use when sending the query.

Returns

Promise<ApiQueryResponse>

The response from the replica. The Promise will only reject when the communication failed. If the query itself failed but no protocol errors happened, the response will be of type QueryResponseRejected.

readState()

readState(effectiveCanisterId, options, identity?, request?): Promise<ReadStateResponse>

Defined in: packages/core/src/agent/agent/api.ts:231

Send a read state query to the replica. This includes a list of paths to return, and will return a Certificate. This will only reject on communication errors, but the certificate might contain less information than requested.

Parameters

effectiveCanisterId

string | Principal

A Canister ID related to this call.

options

ReadStateOptions

The options for this call.

identity?

Identity

Identity for the call. If not specified, uses the instance identity.

request?

unknown

The request to send in case it has already been created.

Returns

Promise<ReadStateResponse>

replaceIdentity()?

optional replaceIdentity(identity): void

Defined in: packages/core/src/agent/agent/api.ts:309

If an application needs to replace an identity under certain conditions, an Agent may expose a replaceIdentity method. Invoking this method will set the inner identity used by the Agent to a newly provided identity.

A use case for this would be - after authenticating using @icp-sdk/auth/client, you can replace the AnonymousIdentity of your Actor with a DelegationIdentity.

Actor.agentOf(defaultActor).replaceIdentity(await authClient.getIdentity());

Parameters

identity

Identity

Returns

void

status()

status(): Promise<JsonObject>

Defined in: packages/core/src/agent/agent/api.ts:260

Query the status endpoint of the replica. This normally has a few fields that corresponds to the version of the replica, its root public key, and any other information made public.

Returns

Promise<JsonObject>

A JsonObject that is essentially a record of fields from the status endpoint.

update()

update(canisterId, fields, pollingOptions?): Promise<UpdateResult>

Defined in: packages/core/src/agent/agent/api.ts:247

Executes an update call to a canister and returns the certified result.

Parameters

canisterId

string | Principal

The canister to call.

fields

CallOptions

The call options (method name, arg, effective canister ID, optional nonce).

pollingOptions?

PollingOptions

Optional polling configuration.

Returns

Promise<UpdateResult>

The certified result including the certificate, reply bytes, and raw certificate bytes.

---

AnonymousIdentityDescriptor

Defined in: packages/core/src/agent/auth.ts:126

Properties

type

type: "AnonymousIdentity"

Defined in: packages/core/src/agent/auth.ts:127

---

CallConfig

Defined in: packages/core/src/agent/actor.ts:30

Configuration to make calls to the Replica.

Properties

agent?

optional agent?: Agent

Defined in: packages/core/src/agent/actor.ts:35

An agent to use in this call, otherwise the actor or call will try to discover the agent to use.

canisterId?

optional canisterId?: string | Principal

Defined in: packages/core/src/agent/actor.ts:45

The canister ID of this Actor.

effectiveCanisterId?

optional effectiveCanisterId?: Principal

Defined in: packages/core/src/agent/actor.ts:50

The effective canister ID.

nonce?

optional nonce?: Uint8Array<ArrayBufferLike>

Defined in: packages/core/src/agent/actor.ts:55

The nonce to use for this call. This is used to prevent replay attacks.

pollingOptions?

optional pollingOptions?: PollingOptions

Defined in: packages/core/src/agent/actor.ts:40

Options for controlling polling behavior.

---

CallContext

Defined in: packages/core/src/agent/errors.ts:44

Call context for errors that arise from a direct HTTP call response.

Extends

• PollingCallContext

Properties

canisterId

canisterId: Principal

Defined in: packages/core/src/agent/errors.ts:37

Inherited from

PollingCallContext.canisterId

httpDetails

httpDetails: HttpDetailsResponse

Defined in: packages/core/src/agent/errors.ts:45

methodName

methodName: string

Defined in: packages/core/src/agent/errors.ts:38

Inherited from

PollingCallContext.methodName

---

CallOptions

Defined in: packages/core/src/agent/agent/api.ts:103

Options when doing a Agent.call call.

Extended by

• UpdateOptions

Properties

arg

arg: Uint8Array

Defined in: packages/core/src/agent/agent/api.ts:112

A binary encoded argument. This is already encoded and will be sent as is.

callSync?

optional callSync?: boolean

Defined in: packages/core/src/agent/agent/api.ts:123

Whether to use synchronous call mode. Defaults to true.

effectiveCanisterId

effectiveCanisterId: string | Principal

Defined in: packages/core/src/agent/agent/api.ts:118

An effective canister ID, used for routing. Usually the canister ID, except for management canister calls.

See

https://internetcomputer.org/docs/current/references/ic-interface-spec/#http-effective-canister-id

methodName

methodName: string

Defined in: packages/core/src/agent/agent/api.ts:107

The method name to call.

nonce?

optional nonce?: Uint8Array<ArrayBufferLike>

Defined in: packages/core/src/agent/agent/api.ts:128

An optional nonce to use for the call, used to prevent replay attacks.

---

CallRequest

Defined in: packages/core/src/agent/agent/http/types.ts:62

Extends

• Record<string, any>

Indexable

[key: string]: any

Properties

arg

arg: Uint8Array

Defined in: packages/core/src/agent/agent/http/types.ts:66

canister_id

canister_id: Principal

Defined in: packages/core/src/agent/agent/http/types.ts:64

ingress_expiry

ingress_expiry: Expiry

Defined in: packages/core/src/agent/agent/http/types.ts:68

method_name

method_name: string

Defined in: packages/core/src/agent/agent/http/types.ts:65

nonce?

optional nonce?: Nonce

Defined in: packages/core/src/agent/agent/http/types.ts:69

request_type

request_type: Call

Defined in: packages/core/src/agent/agent/http/types.ts:63

sender

sender: Uint8Array<ArrayBufferLike> | Principal

Defined in: packages/core/src/agent/agent/http/types.ts:67

---

Cert

Defined in: packages/core/src/agent/certificate.ts:41

Properties

delegation?

optional delegation?: Delegation

Defined in: packages/core/src/agent/certificate.ts:44

signature

signature: Uint8Array

Defined in: packages/core/src/agent/certificate.ts:43

tree

tree: HashTree

Defined in: packages/core/src/agent/certificate.ts:42

---

CheckCanisterRangesParams

Defined in: packages/core/src/agent/certificate.ts:876

Properties

canisterId

canisterId: Principal

Defined in: packages/core/src/agent/certificate.ts:877

subnetId

subnetId: Principal

Defined in: packages/core/src/agent/certificate.ts:878

tree

tree: HashTree

Defined in: packages/core/src/agent/certificate.ts:879

---

CreateActorClassOpts

Defined in: packages/core/src/agent/actor.ts:174

Properties

certificate?

optional certificate?: boolean

Defined in: packages/core/src/agent/actor.ts:176

httpDetails?

optional httpDetails?: boolean

Defined in: packages/core/src/agent/actor.ts:175

---

CreateCertificateOptions

Defined in: packages/core/src/agent/certificate.ts:170

Properties

agent?

optional agent?: Agent

Defined in: packages/core/src/agent/certificate.ts:209

The agent used to sync time with the IC network, if the certificate fails the freshness check. If the agent does not implement the HttpAgent.getTimeDiffMsecs, HttpAgent.hasSyncedTime, HttpAgent.syncTime and HttpAgent.syncTimeWithSubnet methods, time will not be synced in case of a freshness check failure.

Default

undefined

blsVerify?

optional blsVerify?: VerifyFunc

Defined in: packages/core/src/agent/certificate.ts:187

BLS Verification strategy. Default strategy uses bls12_381 from @noble/curves

certificate

certificate: Uint8Array

Defined in: packages/core/src/agent/certificate.ts:174

The bytes encoding the certificate to be verified

disableTimeVerification?

optional disableTimeVerification?: boolean

Defined in: packages/core/src/agent/certificate.ts:201

Overrides the maxAgeInMinutes setting and skips comparing the client’s time against the certificate. Used for scenarios where the machine’s clock is known to be out of sync, or for inspecting expired certificates.

Default

false

maxAgeInMinutes?

optional maxAgeInMinutes?: number

Defined in: packages/core/src/agent/certificate.ts:195

The maximum age of the certificate in minutes. Default is 5 minutes. This is used to verify the time the certificate was signed, particularly for validating Delegation certificates, which can live for longer than the default window of +/- 5 minutes. If the certificate is older than the specified age, it will fail verification.

Default

5

principal

principal: CertificatePrincipal

Defined in: packages/core/src/agent/certificate.ts:183

The principal for which the certificate is being verified.

rootKey

rootKey: Uint8Array

Defined in: packages/core/src/agent/certificate.ts:179

The root key against which to verify the certificate (normally, the root key of the IC main network)

---

ExpirableStore

Defined in: packages/core/src/agent/utils/expirableStore.ts:6

Generic interface for a key-value store with time-based expiration. Keys are strings, values are of type V. Implementations must handle expiration internally.

Type Parameters

V

V

Properties

expirationTime

readonly expirationTime: number

Defined in: packages/core/src/agent/utils/expirableStore.ts:10

Time in milliseconds after which entries expire.

Methods

delete()

delete(key): Promise<void>

Defined in: packages/core/src/agent/utils/expirableStore.ts:27

Delete the entry for a key.

Parameters

key

string

Returns

Promise<void>

get()

get(key): Promise<V | undefined>

Defined in: packages/core/src/agent/utils/expirableStore.ts:16

Get the value for a key. Returns undefined if the key is not present or has expired.

Parameters

key

string

Returns

Promise<V | undefined>

set()

set(key, value): Promise<void>

Defined in: packages/core/src/agent/utils/expirableStore.ts:22

Store a value for a key. Prunes expired entries before inserting.

Parameters

key

string

value

V

Returns

Promise<void>

---

HttpAgentBaseRequest

Defined in: packages/core/src/agent/agent/http/types.ts:21

Extended by

• HttpAgentSubmitRequest
• HttpAgentQueryRequest
• HttpAgentReadStateRequest

Properties

endpoint

readonly endpoint: Endpoint

Defined in: packages/core/src/agent/agent/http/types.ts:22

request

request: RequestInit

Defined in: packages/core/src/agent/agent/http/types.ts:23

---

HttpAgentOptions

Defined in: packages/core/src/agent/agent/http/index.ts:132

Properties

backoffStrategy?

optional backoffStrategy?: BackoffStrategyFactory

Defined in: packages/core/src/agent/agent/http/index.ts:179

The strategy to use for backoff when retrying requests

callOptions?

optional callOptions?: Record<string, unknown>

Defined in: packages/core/src/agent/agent/http/index.ts:142

credentials?

optional credentials?: object

Defined in: packages/core/src/agent/agent/http/index.ts:158

name

name: string

password?

optional password?: string

fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/core/src/agent/agent/http/index.ts:134

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

URL | RequestInfo

init?

RequestInit

Returns

Promise<Response>

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

string | URL | Request

init?

RequestInit

Returns

Promise<Response>

fetchOptions?

optional fetchOptions?: Record<string, unknown>

Defined in: packages/core/src/agent/agent/http/index.ts:139

host?

optional host?: string

Defined in: packages/core/src/agent/agent/http/index.ts:146

identity?

optional identity?: Identity | Promise<Identity>

Defined in: packages/core/src/agent/agent/http/index.ts:150

ingressExpiryInMinutes?

optional ingressExpiryInMinutes?: number

Defined in: packages/core/src/agent/agent/http/index.ts:156

The maximum time a request can be delayed before being rejected.

Default

5 minutes

logToConsole?

optional logToConsole?: boolean

Defined in: packages/core/src/agent/agent/http/index.ts:194

Whether to log to the console. Defaults to false.

retryTimes?

optional retryTimes?: number

Defined in: packages/core/src/agent/agent/http/index.ts:175

Number of times to retry requests before throwing an error

Default

3

rootKey?

optional rootKey?: Uint8Array<ArrayBufferLike>

Defined in: packages/core/src/agent/agent/http/index.ts:199

Alternate root key to use for verifying certificates. If not provided, the default IC root key will be used.

shouldFetchRootKey?

optional shouldFetchRootKey?: boolean

Defined in: packages/core/src/agent/agent/http/index.ts:204

Whether or not the root key should be automatically fetched during construction. Defaults to false.

shouldSyncTime?

optional shouldSyncTime?: boolean

Defined in: packages/core/src/agent/agent/http/index.ts:209

Whether or not to sync the time with the network during construction. Defaults to false.

subnetNodeKeyExpirableStore?

optional subnetNodeKeyExpirableStore?: ExpirableStore<SubnetNodeKeys>

Defined in: packages/core/src/agent/agent/http/index.ts:190

Custom store for caching subnet node keys. Allows sharing the cache across multiple HttpAgent instances. Defaults to IndexedDB in browser environments, in-memory otherwise.

useQueryNonces?

optional useQueryNonces?: boolean

Defined in: packages/core/src/agent/agent/http/index.ts:170

Adds a unique Nonce with each query. Enabling will prevent queries from being answered with a cached response.

Example

const agent = new HttpAgent({ useQueryNonces: true });
agent.addTransform(makeNonceTransform(makeNonce);

Default

false

verifyQuerySignatures?

optional verifyQuerySignatures?: boolean

Defined in: packages/core/src/agent/agent/http/index.ts:184

Whether the agent should verify signatures signed by node keys on query responses. Increases security, but adds overhead and must make a separate request to cache the node keys for the canister’s subnet.

Default

true

---

HttpAgentQueryRequest

Defined in: packages/core/src/agent/agent/http/types.ts:33

Extends

• HttpAgentBaseRequest

Properties

body

body: ReadRequest

Defined in: packages/core/src/agent/agent/http/types.ts:35

endpoint

readonly endpoint: Query

Defined in: packages/core/src/agent/agent/http/types.ts:34

Overrides

HttpAgentBaseRequest.endpoint

request

request: RequestInit

Defined in: packages/core/src/agent/agent/http/types.ts:23

Inherited from

HttpAgentBaseRequest.request

---

HttpAgentReadStateRequest

Defined in: packages/core/src/agent/agent/http/types.ts:38

Extends

• HttpAgentBaseRequest

Properties

body

body: ReadRequest

Defined in: packages/core/src/agent/agent/http/types.ts:40

endpoint

readonly endpoint: ReadState

Defined in: packages/core/src/agent/agent/http/types.ts:39

Overrides

HttpAgentBaseRequest.endpoint

request

request: RequestInit

Defined in: packages/core/src/agent/agent/http/types.ts:23

Inherited from

HttpAgentBaseRequest.request

---

HttpAgentRequestTransformFn()

Defined in: packages/core/src/agent/agent/http/types.ts:55

HttpAgentRequestTransformFn(args): Promise<void | HttpAgentRequest | undefined>

Defined in: packages/core/src/agent/agent/http/types.ts:56

Parameters

args

HttpAgentRequest

Returns

Promise<void | HttpAgentRequest | undefined>

Properties

priority?

optional priority?: number

Defined in: packages/core/src/agent/agent/http/types.ts:57

---

HttpAgentSubmitRequest

Defined in: packages/core/src/agent/agent/http/types.ts:28

Extends

• HttpAgentBaseRequest

Properties

body

body: CallRequest

Defined in: packages/core/src/agent/agent/http/types.ts:30

endpoint

readonly endpoint: Call

Defined in: packages/core/src/agent/agent/http/types.ts:29

Overrides

HttpAgentBaseRequest.endpoint

request

request: RequestInit

Defined in: packages/core/src/agent/agent/http/types.ts:23

Inherited from

HttpAgentBaseRequest.request

---

HttpDetailsResponse

Defined in: packages/core/src/agent/agent/api.ts:40

Properties

headers

headers: HttpHeaderField[]

Defined in: packages/core/src/agent/agent/api.ts:44

ok

ok: boolean

Defined in: packages/core/src/agent/agent/api.ts:41

status

status: number

Defined in: packages/core/src/agent/agent/api.ts:42

statusText

statusText: string

Defined in: packages/core/src/agent/agent/api.ts:43

---

Identity

Defined in: packages/core/src/agent/auth.ts:39

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.

Methods

getPrincipal()

getPrincipal(): Principal

Defined in: packages/core/src/agent/auth.ts:44

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

Returns

Principal

transformRequest()

transformRequest(request): Promise<unknown>

Defined in: packages/core/src/agent/auth.ts:51

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

Returns

Promise<unknown>

---

JsonnableExpiry

Defined in: packages/core/src/agent/agent/http/expiry.ts:20

Properties

__expiry__

__expiry__: string

Defined in: packages/core/src/agent/agent/http/expiry.ts:21

---

KeyPair

Defined in: packages/core/src/agent/auth.ts:9

A Key Pair, containing a secret and public key.

Properties

publicKey

publicKey: PublicKey

Defined in: packages/core/src/agent/auth.ts:11

secretKey

secretKey: Uint8Array

Defined in: packages/core/src/agent/auth.ts:10

---

LookupLabelResultAbsent

Defined in: packages/core/src/agent/certificate.ts:579

Properties

status

status: Absent

Defined in: packages/core/src/agent/certificate.ts:580

---

LookupLabelResultFound

Defined in: packages/core/src/agent/certificate.ts:587

Properties

status

status: Found

Defined in: packages/core/src/agent/certificate.ts:588

value

value: HashTree

Defined in: packages/core/src/agent/certificate.ts:589

---

LookupLabelResultGreater

Defined in: packages/core/src/agent/certificate.ts:592

Properties

status

status: Greater

Defined in: packages/core/src/agent/certificate.ts:593

---

LookupLabelResultLess

Defined in: packages/core/src/agent/certificate.ts:596

Properties

status

status: Less

Defined in: packages/core/src/agent/certificate.ts:597

---

LookupLabelResultUnknown

Defined in: packages/core/src/agent/certificate.ts:583

Properties

status

status: Unknown

Defined in: packages/core/src/agent/certificate.ts:584

---

LookupPathResultAbsent

Defined in: packages/core/src/agent/certificate.ts:524

Properties

status

status: Absent

Defined in: packages/core/src/agent/certificate.ts:525

---

LookupPathResultError

Defined in: packages/core/src/agent/certificate.ts:537

Properties

status

status: Error

Defined in: packages/core/src/agent/certificate.ts:538

---

LookupPathResultFound

Defined in: packages/core/src/agent/certificate.ts:532

Properties

status

status: Found

Defined in: packages/core/src/agent/certificate.ts:533

value

value: Uint8Array

Defined in: packages/core/src/agent/certificate.ts:534

---

LookupPathResultUnknown

Defined in: packages/core/src/agent/certificate.ts:528

Properties

status

status: Unknown

Defined in: packages/core/src/agent/certificate.ts:529

---

LookupSubtreeResultAbsent

Defined in: packages/core/src/agent/certificate.ts:553

Properties

status

status: Absent

Defined in: packages/core/src/agent/certificate.ts:554

---

LookupSubtreeResultFound

Defined in: packages/core/src/agent/certificate.ts:561

Properties

status

status: Found

Defined in: packages/core/src/agent/certificate.ts:562

value

value: HashTree

Defined in: packages/core/src/agent/certificate.ts:563

---

LookupSubtreeResultUnknown

Defined in: packages/core/src/agent/certificate.ts:557

Properties

status

status: Unknown

Defined in: packages/core/src/agent/certificate.ts:558

---

NodeSignature

Defined in: packages/core/src/agent/agent/api.ts:57

Properties

identity

identity: Uint8Array

Defined in: packages/core/src/agent/agent/api.ts:63

signature

signature: Uint8Array

Defined in: packages/core/src/agent/agent/api.ts:61

timestamp

timestamp: bigint

Defined in: packages/core/src/agent/agent/api.ts:59

---

PollForResponseResult

Defined in: packages/core/src/agent/polling/types.ts:21

The result of polling for a response, including the certificate, reply bytes, and raw certificate bytes.

Extended by

• UpdateResult

Properties

certificate

certificate: Certificate

Defined in: packages/core/src/agent/polling/types.ts:23

The certificate for the request, which can be used to verify the reply.

rawCertificate

rawCertificate: Uint8Array

Defined in: packages/core/src/agent/polling/types.ts:27

The raw certificate bytes for the request.

reply

reply: Uint8Array

Defined in: packages/core/src/agent/polling/types.ts:25

The reply bytes for the request.

---

PollingCallContext

Defined in: packages/core/src/agent/errors.ts:36

Call context for errors that arise during polling.

Extended by

• CallContext

Properties

canisterId

canisterId: Principal

Defined in: packages/core/src/agent/errors.ts:37

methodName

methodName: string

Defined in: packages/core/src/agent/errors.ts:38

---

PollingOptions

Defined in: packages/core/src/agent/polling/index.ts:39

Options for controlling polling behavior

Properties

blsVerify?

optional blsVerify?: VerifyFunc

Defined in: packages/core/src/agent/polling/index.ts:56

Optional replacement function that verifies the BLS signature of a certificate.

preSignReadStateRequest?

optional preSignReadStateRequest?: boolean

Defined in: packages/core/src/agent/polling/index.ts:51

Whether to reuse the same signed request for polling or create a new unsigned request each time.

Default

false

request?

optional request?: ReadStateRequest

Defined in: packages/core/src/agent/polling/index.ts:62

The request to use for polling. If not provided, a new request will be created. This is only used if preSignReadStateRequest is set to false.

strategy?

optional strategy?: PollStrategy

Defined in: packages/core/src/agent/polling/index.ts:45

A polling strategy that dictates how much and often we should poll the read_state endpoint to get the result of an update call.

Default

defaultStrategy

---

PublicKey

Defined in: packages/core/src/agent/auth.ts:27

A Public Key implementation.

Properties

derKey?

optional derKey?: DerEncodedPublicKey

Defined in: packages/core/src/agent/auth.ts:32

rawKey?

optional rawKey?: Uint8Array<ArrayBufferLike>

Defined in: packages/core/src/agent/auth.ts:31

Methods

toDer()

toDer(): DerEncodedPublicKey

Defined in: packages/core/src/agent/auth.ts:28

Returns

DerEncodedPublicKey

toRaw()?

optional toRaw(): Uint8Array

Defined in: packages/core/src/agent/auth.ts:30

Returns

Uint8Array

---

PublicKeyIdentityDescriptor

Defined in: packages/core/src/agent/auth.ts:129

Properties

publicKey

publicKey: string

Defined in: packages/core/src/agent/auth.ts:131

type

type: "PublicKeyIdentity"

Defined in: packages/core/src/agent/auth.ts:130

---

QueryFields

Defined in: packages/core/src/agent/agent/api.ts:83

Options when doing a Agent.query call.

Properties

arg

arg: Uint8Array

Defined in: packages/core/src/agent/agent/api.ts:92

A binary encoded argument. This is already encoded and will be sent as is.

effectiveCanisterId?

optional effectiveCanisterId?: Principal

Defined in: packages/core/src/agent/agent/api.ts:97

Overrides canister id for path to fetch. This is used for management canister calls.

methodName

methodName: string

Defined in: packages/core/src/agent/agent/api.ts:87

The method name to call.

---

QueryRequest

Defined in: packages/core/src/agent/agent/http/types.ts:85

Extends

• Record<string, any>

Indexable

[key: string]: any

Properties

arg

arg: Uint8Array

Defined in: packages/core/src/agent/agent/http/types.ts:89

canister_id

canister_id: Principal

Defined in: packages/core/src/agent/agent/http/types.ts:87

ingress_expiry

ingress_expiry: Expiry

Defined in: packages/core/src/agent/agent/http/types.ts:91

method_name

method_name: string

Defined in: packages/core/src/agent/agent/http/types.ts:88

nonce?

optional nonce?: Nonce

Defined in: packages/core/src/agent/agent/http/types.ts:92

request_type

request_type: Query

Defined in: packages/core/src/agent/agent/http/types.ts:86

sender

sender: Uint8Array<ArrayBufferLike> | Principal

Defined in: packages/core/src/agent/agent/http/types.ts:90

---

QueryResponseBase

Defined in: packages/core/src/agent/agent/api.ts:52

Extended by

• QueryResponseReplied
• QueryResponseRejected

Properties

requestDetails?

optional requestDetails?: QueryRequest

Defined in: packages/core/src/agent/agent/api.ts:54

status

status: QueryResponseStatus

Defined in: packages/core/src/agent/agent/api.ts:53

---

QueryResponseRejected

Defined in: packages/core/src/agent/agent/api.ts:72

Extends

• QueryResponseBase

Properties

error_code

error_code: string

Defined in: packages/core/src/agent/agent/api.ts:76

reject_code

reject_code: ReplicaRejectCode

Defined in: packages/core/src/agent/agent/api.ts:74

reject_message

reject_message: string

Defined in: packages/core/src/agent/agent/api.ts:75

requestDetails?

optional requestDetails?: QueryRequest

Defined in: packages/core/src/agent/agent/api.ts:54

Inherited from

QueryResponseBase.requestDetails

signatures?

optional signatures?: NodeSignature[]

Defined in: packages/core/src/agent/agent/api.ts:77

status

status: Rejected

Defined in: packages/core/src/agent/agent/api.ts:73

Overrides

QueryResponseBase.status

---

QueryResponseReplied

Defined in: packages/core/src/agent/agent/api.ts:66

Extends

• QueryResponseBase

Properties

reply

reply: object

Defined in: packages/core/src/agent/agent/api.ts:68

arg

arg: Uint8Array

requestDetails?

optional requestDetails?: QueryRequest

Defined in: packages/core/src/agent/agent/api.ts:54

Inherited from

QueryResponseBase.requestDetails

signatures?

optional signatures?: NodeSignature[]

Defined in: packages/core/src/agent/agent/api.ts:69

status

status: Replied

Defined in: packages/core/src/agent/agent/api.ts:67

Overrides

QueryResponseBase.status

---

ReadStateOptions

Defined in: packages/core/src/agent/agent/api.ts:23

Options when doing a Agent.readState call.

Properties

paths

paths: Uint8Array<ArrayBufferLike>[][]

Defined in: packages/core/src/agent/agent/api.ts:27

A list of paths to read the state of.

---

ReadStateRequest

Defined in: packages/core/src/agent/agent/http/types.ts:96

Extends

• Record<string, any>

Indexable

[key: string]: any

Properties

ingress_expiry

ingress_expiry: Expiry

Defined in: packages/core/src/agent/agent/http/types.ts:99

paths

paths: Uint8Array<ArrayBufferLike>[][]

Defined in: packages/core/src/agent/agent/http/types.ts:98

request_type

request_type: ReadState

Defined in: packages/core/src/agent/agent/http/types.ts:97

sender

sender: Uint8Array<ArrayBufferLike> | Principal

Defined in: packages/core/src/agent/agent/http/types.ts:100

---

ReadStateResponse

Defined in: packages/core/src/agent/agent/api.ts:144

Properties

certificate

certificate: Uint8Array

Defined in: packages/core/src/agent/agent/api.ts:145

---

RequestContext

Defined in: packages/core/src/agent/errors.ts:26

Properties

ingressExpiry

ingressExpiry: Expiry

Defined in: packages/core/src/agent/errors.ts:30

requestId?

optional requestId?: RequestId

Defined in: packages/core/src/agent/errors.ts:27

senderPubKey

senderPubKey: Uint8Array

Defined in: packages/core/src/agent/errors.ts:28

senderSignature

senderSignature: Uint8Array

Defined in: packages/core/src/agent/errors.ts:29

---

Signed

Defined in: packages/core/src/agent/agent/http/types.ts:43

Type Parameters

T

T

Properties

content

content: T

Defined in: packages/core/src/agent/agent/http/types.ts:44

sender_pubkey

sender_pubkey: ArrayBuffer

Defined in: packages/core/src/agent/agent/http/types.ts:45

sender_sig

sender_sig: ArrayBuffer

Defined in: packages/core/src/agent/agent/http/types.ts:46

---

SubmitResponse

Defined in: packages/core/src/agent/agent/api.ts:180

Properties

requestDetails?

optional requestDetails?: CallRequest

Defined in: packages/core/src/agent/agent/api.ts:189

requestId

requestId: RequestId

Defined in: packages/core/src/agent/agent/api.ts:181

response

response: object

Defined in: packages/core/src/agent/agent/api.ts:182

body

body: v2ResponseBody | v4ResponseBody | null

headers

headers: HttpHeaderField[]

ok

ok: boolean

status

status: number

statusText

statusText: string

---

UnSigned

Defined in: packages/core/src/agent/agent/http/types.ts:49

Type Parameters

T

T

Properties

content

content: T

Defined in: packages/core/src/agent/agent/http/types.ts:50

---

UpdateOptions

Defined in: packages/core/src/agent/agent/api.ts:131

Options when doing a Agent.call call.

Extends

• CallOptions

Properties

arg

arg: Uint8Array

Defined in: packages/core/src/agent/agent/api.ts:112

A binary encoded argument. This is already encoded and will be sent as is.

Inherited from

CallOptions.arg

callSync?

optional callSync?: boolean

Defined in: packages/core/src/agent/agent/api.ts:123

Whether to use synchronous call mode. Defaults to true.

Inherited from

CallOptions.callSync

effectiveCanisterId

effectiveCanisterId: string | Principal

Defined in: packages/core/src/agent/agent/api.ts:118

An effective canister ID, used for routing. Usually the canister ID, except for management canister calls.

See

https://internetcomputer.org/docs/current/references/ic-interface-spec/#http-effective-canister-id

Inherited from

CallOptions.effectiveCanisterId

methodName

methodName: string

Defined in: packages/core/src/agent/agent/api.ts:107

The method name to call.

Inherited from

CallOptions.methodName

nonce?

optional nonce?: Uint8Array<ArrayBufferLike>

Defined in: packages/core/src/agent/agent/api.ts:128

An optional nonce to use for the call, used to prevent replay attacks.

Inherited from

CallOptions.nonce

onPollingStarted?

optional onPollingStarted?: () => void

Defined in: packages/core/src/agent/agent/api.ts:141

An optional callback that will be invoked once the agent starts polling for the result of the update call.

If callSync is set to false, polling will start, and the callback will be invoked, once the request has been accepted by a single node. If callSync is set to true, the IC will first try to process the request synchronously. But if the synchronous request timeout is exceeded, the agent will start polling for the result, at which point the callback will be invoked.

Returns

void

---

UpdateResult

Defined in: packages/core/src/agent/agent/api.ts:196

The result of Agent.update, extending PollForResponseResult with the request details and raw HTTP response from the call.

Extends

• PollForResponseResult

Properties

callResponse

callResponse: object

Defined in: packages/core/src/agent/agent/api.ts:200

The raw HTTP response from the call endpoint.

body

body: v2ResponseBody | v4ResponseBody | null

headers

headers: HttpHeaderField[]

ok

ok: boolean

status

status: number

statusText

statusText: string

certificate

certificate: Certificate

Defined in: packages/core/src/agent/polling/types.ts:23

The certificate for the request, which can be used to verify the reply.

Inherited from

PollForResponseResult.certificate

rawCertificate

rawCertificate: Uint8Array

Defined in: packages/core/src/agent/polling/types.ts:27

The raw certificate bytes for the request.

Inherited from

PollForResponseResult.rawCertificate

reply

reply: Uint8Array

Defined in: packages/core/src/agent/polling/types.ts:25

The reply bytes for the request.

Inherited from

PollForResponseResult.reply

requestDetails?

optional requestDetails?: CallRequest

Defined in: packages/core/src/agent/agent/api.ts:198

The request details from the call, if available.

---

v2ResponseBody

Defined in: packages/core/src/agent/agent/api.ts:148

Properties

error_code?

optional error_code?: string

Defined in: packages/core/src/agent/agent/api.ts:149

reject_code

reject_code: number

Defined in: packages/core/src/agent/agent/api.ts:150

reject_message

reject_message: string

Defined in: packages/core/src/agent/agent/api.ts:151

---

v4ResponseBody

Defined in: packages/core/src/agent/agent/api.ts:165

Properties

certificate

certificate: Uint8Array

Defined in: packages/core/src/agent/agent/api.ts:166

Type Aliases

ActorConstructor

ActorConstructor = (config) => ActorSubclass

Defined in: packages/core/src/agent/actor.ts:375

Parameters

config

ActorConfig

Returns

ActorSubclass

---

ActorMethodMappedExtended

ActorMethodMappedExtended<T> = { [K in keyof T]: T[K] extends FunctionWithArgsAndReturn<infer Args, infer Ret> ? ActorMethodExtended<Args, Ret> : never }

Defined in: packages/core/src/agent/actor.ts:155

Type Parameters

T

T

---

ActorMethodMappedWithHttpDetails

ActorMethodMappedWithHttpDetails<T> = { [K in keyof T]: T[K] extends FunctionWithArgsAndReturn<infer Args, infer Ret> ? ActorMethodWithHttpDetails<Args, Ret> : never }

Defined in: packages/core/src/agent/actor.ts:148

Type Parameters

T

T

---

ActorSubclass

ActorSubclass<T> = Actor & T

Defined in: packages/core/src/agent/actor.ts:108

A subclass of an actor. Actor class itself is meant to be a based class.

Type Parameters

T

T = Record<string, ActorMethod>

---

AgentLog

AgentLog = { level: "warn" | "info"; message: string; } | { error: AgentError; level: "error"; message: string; }

Defined in: packages/core/src/agent/observable.ts:25

---

ApiQueryResponse

ApiQueryResponse = QueryResponse & object

Defined in: packages/core/src/agent/agent/api.ts:47

Type Declaration

httpDetails

httpDetails: HttpDetailsResponse

requestId

requestId: RequestId

---

CanisterRanges

CanisterRanges = [Principal, Principal][]

Defined in: packages/core/src/agent/certificate.ts:886

Canister ranges in the form of an array of [start, end] principal tuples, usually decoded from the certificate.

---

CertificatePrincipal

CertificatePrincipal = { canisterId: Principal; } | { subnetId: Principal; }

Defined in: packages/core/src/agent/certificate.ts:155

Union Members

Type Literal

{ canisterId: Principal; }

canisterId

canisterId: Principal

The effective canister ID of the request when verifying a response, or the signing canister ID when verifying a certified variable.

---

Type Literal

{ subnetId: Principal; }

subnetId

subnetId: Principal

The subnet ID when verifying a certificate from a subnet.

---

DerEncodedPublicKey

DerEncodedPublicKey = Uint8Array & object

Defined in: packages/core/src/agent/auth.ts:17

A public key that is DER encoded. This is a branded Uint8Array.

Type Declaration

__derEncodedPublicKey__?

optional __derEncodedPublicKey__?: void

---

EmptyHashTree

EmptyHashTree = [Empty]

Defined in: packages/core/src/agent/certificate.ts:60

---

Envelope

Envelope<T> = Signed<T> | UnSigned<T>

Defined in: packages/core/src/agent/agent/http/types.ts:53

Type Parameters

T

T

---

ForkHashTree

ForkHashTree = [Fork, HashTree, HashTree]

Defined in: packages/core/src/agent/certificate.ts:61

---

FunctionWithArgsAndReturn

FunctionWithArgsAndReturn<Args, Ret> = (…args) => Ret

Defined in: packages/core/src/agent/actor.ts:143

Type Parameters

Args

Args extends unknown[] = unknown[]

Ret

Ret = unknown

Parameters

args

…Args

Returns

Ret

---

HashTree

HashTree = EmptyHashTree | ForkHashTree | LabeledHashTree | LeafHashTree | PrunedHashTree

Defined in: packages/core/src/agent/certificate.ts:66

---

HttpAgentRequest

HttpAgentRequest = HttpAgentQueryRequest | HttpAgentSubmitRequest | HttpAgentReadStateRequest

Defined in: packages/core/src/agent/agent/http/types.ts:16

---

HttpHeaderField

HttpHeaderField = [string, string]

Defined in: packages/core/src/agent/agent/http/types.ts:26

---

IdentityDescriptor

IdentityDescriptor = AnonymousIdentityDescriptor | PublicKeyIdentityDescriptor

Defined in: packages/core/src/agent/auth.ts:133

---

LabeledHashTree

LabeledHashTree = [Labeled, NodeLabel, HashTree]

Defined in: packages/core/src/agent/certificate.ts:62

---

LabelLookupResult

LabelLookupResult = LookupLabelResultAbsent | LookupLabelResultUnknown | LookupLabelResultFound | LookupLabelResultGreater | LookupLabelResultLess

Defined in: packages/core/src/agent/certificate.ts:600

---

LeafHashTree

LeafHashTree = [Leaf, NodeValue]

Defined in: packages/core/src/agent/certificate.ts:63

---

LookupResult

LookupResult = LookupPathResultAbsent | LookupPathResultUnknown | LookupPathResultFound | LookupPathResultError

Defined in: packages/core/src/agent/certificate.ts:541

---

NodeHash

NodeHash = Uint8Array & object

Defined in: packages/core/src/agent/certificate.ts:58

Type Declaration

__nodeHash__

__nodeHash__: void

---

NodeLabel

NodeLabel = Uint8Array & object

Defined in: packages/core/src/agent/certificate.ts:56

Type Declaration

__nodeLabel__

__nodeLabel__: void

---

NodePath

NodePath = (Uint8Array | string)[]

Defined in: packages/core/src/agent/certificate.ts:55

---

NodeValue

NodeValue = Uint8Array & object

Defined in: packages/core/src/agent/certificate.ts:57

Type Declaration

__nodeValue__

__nodeValue__: void

---

Nonce

Nonce = Uint8Array & object

Defined in: packages/core/src/agent/agent/http/types.ts:125

Type Declaration

__nonce__

__nonce__: void

---

ObserveFunction

ObserveFunction<T> = (data, …rest) => void

Defined in: packages/core/src/agent/observable.ts:3

Type Parameters

T

T

Parameters

data

T

rest

…unknown[]

Returns

void

---

PollStrategy

PollStrategy = (canisterId, requestId, status) => Promise<void>

Defined in: packages/core/src/agent/polling/types.ts:6

Parameters

canisterId

Principal

requestId

RequestId

status

RequestStatusResponseStatus

Returns

Promise<void>

---

PrunedHashTree

PrunedHashTree = [Pruned, NodeHash]

Defined in: packages/core/src/agent/certificate.ts:64

---

QueryResponse

QueryResponse = QueryResponseReplied | QueryResponseRejected

Defined in: packages/core/src/agent/agent/api.ts:33

---

QueryStrategy

QueryStrategy = "query" | "update"

Defined in: packages/core/src/agent/actor.ts:25

Controls how query and composite_query methods are executed.

• 'query' — standard non-replicated query call (default).
• 'update' — send query methods as update calls that go through consensus.

---

ReadRequest

ReadRequest = QueryRequest | ReadStateRequest

Defined in: packages/core/src/agent/agent/http/types.ts:103

---

RequestId

RequestId = Uint8Array & object

Defined in: packages/core/src/agent/request_id.ts:8

Type Declaration

__requestId__

__requestId__: void

---

Signature

Signature = Uint8Array & object

Defined in: packages/core/src/agent/auth.ts:22

A signature array buffer.

Type Declaration

__signature__

__signature__: void

---

SubtreeLookupResult

SubtreeLookupResult = LookupSubtreeResultAbsent | LookupSubtreeResultUnknown | LookupSubtreeResultFound

Defined in: packages/core/src/agent/certificate.ts:566

Variables

ACTOR_METHOD_WITH_CERTIFICATE

const ACTOR_METHOD_WITH_CERTIFICATE: "certificate" = 'certificate'

Defined in: packages/core/src/agent/actor.ts:378

---

ACTOR_METHOD_WITH_HTTP_DETAILS

const ACTOR_METHOD_WITH_HTTP_DETAILS: "http-details" = 'http-details'

Defined in: packages/core/src/agent/actor.ts:377

---

BLS12_381_G2_OID

const BLS12_381_G2_OID: Uint8Array<ArrayBuffer>

Defined in: packages/core/src/agent/der.ts:116

---

Cbor

const Cbor: object

Defined in: packages/core/src/agent/cbor.ts:60

Type Declaration

decode

decode: <T>(input) => T

Decode a CBOR encoded value into a JavaScript value.

Type Parameters

T

T

Parameters

input

Uint8Array

The CBOR encoded value

Returns

T

encode

encode: (value) => Uint8Array

Encode a JavaScript value into CBOR. If the value is an instance of ToCborValue, the ToCborValue.toCborValue method will be called to get the value to encode.

Parameters

value

unknown

The value to encode

Returns

Uint8Array

---

DEFAULT_POLLING_OPTIONS

const DEFAULT_POLLING_OPTIONS: PollingOptions

Defined in: packages/core/src/agent/polling/index.ts:65

---

DER_COSE_OID

const DER_COSE_OID: Uint8Array<ArrayBuffer>

Defined in: packages/core/src/agent/der.ts:90

A DER encoded SEQUENCE(OID) for DER-encoded-COSE

---

ED25519_OID

const ED25519_OID: Uint8Array<ArrayBuffer>

Defined in: packages/core/src/agent/der.ts:99

A DER encoded SEQUENCE(OID) for the Ed25519 algorithm

---

IC_REQUEST_AUTH_DELEGATION_DOMAIN_SEPARATOR

const IC_REQUEST_AUTH_DELEGATION_DOMAIN_SEPARATOR: Uint8Array<ArrayBuffer>

Defined in: packages/core/src/agent/constants.ts:22

The \x1Aic-request-auth-delegation domain separator used in the signature of delegations.

---

IC_REQUEST_DOMAIN_SEPARATOR

const IC_REQUEST_DOMAIN_SEPARATOR: Uint8Array<ArrayBuffer>

Defined in: packages/core/src/agent/constants.ts:12

The \x0Aic-request domain separator used in the signature of IC requests.

---

IC_RESPONSE_DOMAIN_SEPARATOR

const IC_RESPONSE_DOMAIN_SEPARATOR: Uint8Array<ArrayBuffer>

Defined in: packages/core/src/agent/constants.ts:17

The \x0Bic-response domain separator used in the signature of IC responses.

---

IC_ROOT_KEY

const IC_ROOT_KEY: string

Defined in: packages/core/src/agent/agent/http/index.ts:109

---

IC_STATE_ROOT_DOMAIN_SEPARATOR

const IC_STATE_ROOT_DOMAIN_SEPARATOR: Uint8Array<ArrayBuffer>

Defined in: packages/core/src/agent/constants.ts:7

The \x0Dic-state-root domain separator used in the root hash of IC certificates.

---

JSON_KEY_EXPIRY

const JSON_KEY_EXPIRY: "__expiry__" = '__expiry__'

Defined in: packages/core/src/agent/agent/http/expiry.ts:4

---

MANAGEMENT_CANISTER_ID

const MANAGEMENT_CANISTER_ID: "aaaaa-aa" = 'aaaaa-aa'

Defined in: packages/core/src/agent/agent/http/index.ts:115

---

SECP256K1_OID

const SECP256K1_OID: Uint8Array<ArrayBuffer>

Defined in: packages/core/src/agent/der.ts:108

A DER encoded SEQUENCE(OID) for secp256k1 with the ECDSA algorithm

---

UNREACHABLE_ERROR

const UNREACHABLE_ERROR: Error

Defined in: packages/core/src/agent/errors.ts:962

Special error used to indicate that a code path is unreachable.

For internal use only.

---

verify

verify: (pk, sig, msg) => boolean

Defined in: packages/core/src/agent/utils/bls.ts:4

Parameters

pk

Uint8Array

sig

Uint8Array

msg

Uint8Array

Returns

boolean

Functions

blsVerify()

blsVerify(pk, sig, msg): boolean

Defined in: packages/core/src/agent/utils/bls.ts:13

Parameters

pk

Uint8Array

primary key: Uint8Array

sig

Uint8Array

signature: Uint8Array

msg

Uint8Array

message: Uint8Array

Returns

boolean

boolean

---

calculateIngressExpiry()

calculateIngressExpiry(maxIngressExpiryInMinutes, timeDiffMsecs): Expiry

Defined in: packages/core/src/agent/agent/http/index.ts:1708

Calculates the ingress expiry time based on the maximum allowed expiry in minutes and the time difference in milliseconds. The expiry is rounded down according to the Expiry.fromDeltaInMilliseconds method.

Parameters

maxIngressExpiryInMinutes

number

The maximum ingress expiry time in minutes.

timeDiffMsecs

number

The time difference in milliseconds to adjust the expiry.

Returns

Expiry

The calculated ingress expiry as an Expiry object.

---

check_canister_ranges()

check_canister_ranges(params): boolean

Defined in: packages/core/src/agent/certificate.ts:896

Check if a canister ID falls within the canister ranges of a given subnet

Parameters

params

CheckCanisterRangesParams

the parameters with which to check the canister ranges

Returns

boolean

true if the canister is in the range, false otherwise

---

constructRequest()

constructRequest(options): Promise<ReadStateRequest>

Defined in: packages/core/src/agent/polling/index.ts:219

Constructs a read state request for the given paths. If the request is already signed and has an expiry, it will be returned as is. Otherwise, a new request will be created.

Parameters

options

The options to use for creating the request.

agent

Agent

The agent to use to create the request.

paths

Uint8Array<ArrayBufferLike>[][]

The paths to read from.

pollingOptions

PollingOptions

The options to use for creating the request.

Returns

Promise<ReadStateRequest>

The read state request.

---

createIdentityDescriptor()

createIdentityDescriptor(identity): IdentityDescriptor

Defined in: packages/core/src/agent/auth.ts:139

Create an IdentityDescriptor from an Identity

Parameters

identity

SignIdentity | AnonymousIdentity

identity describe in returned descriptor

Returns

IdentityDescriptor

---

decodeCanisterRanges()

decodeCanisterRanges(lookupValue): CanisterRanges

Defined in: packages/core/src/agent/certificate.ts:973

Decode canister ranges from CBOR-encoded buffer

Parameters

lookupValue

Uint8Array

the CBOR-encoded value read from the certificate

Returns

CanisterRanges

an array of canister range tuples [start, end]

---

decodeLen()

decodeLen(buf, offset): number

Defined in: packages/core/src/agent/der.ts:70

Parameters

buf

Uint8Array

offset

number

Returns

number

---

decodeLenBytes()

decodeLenBytes(buf, offset): number

Defined in: packages/core/src/agent/der.ts:51

Parameters

buf

Uint8Array

offset

number

Returns

number

---

domain_sep()

domain_sep(s): Uint8Array

Defined in: packages/core/src/agent/certificate.ts:507

Creates a domain separator for hashing by encoding the input string with its length as a prefix.

Parameters

s

string

The input string to encode.

Returns

Uint8Array

A Uint8Array containing the encoded domain separator.

---

encodeLen()

encodeLen(buf, offset, len): number

Defined in: packages/core/src/agent/der.ts:25

Parameters

buf

Uint8Array

offset

number

len

number

Returns

number

---

encodeLenBytes()

encodeLenBytes(len): number

Defined in: packages/core/src/agent/der.ts:9

Parameters

len

number

Returns

number

---

fetchCandid()

fetchCandid(canisterId, agent?): Promise<string>

Defined in: packages/core/src/agent/fetch_candid.ts:13

Retrieves the Candid interface for the specified canister.

Parameters

canisterId

string

A string corresponding to the canister ID

agent?

HttpAgent

The agent to use for the request (usually an HttpAgent)

Returns

Promise<string>

Candid source code

---

find_label()

find_label(label, tree): LabelLookupResult

Defined in: packages/core/src/agent/certificate.ts:750

Find a label in a tree

Parameters

label

NodeLabel

the label to find

tree

HashTree

the tree to search

Returns

LabelLookupResult

the result of the label lookup

---

flatten_forks()

flatten_forks(t): (LabeledHashTree | LeafHashTree | PrunedHashTree)[]

Defined in: packages/core/src/agent/certificate.ts:733

If the tree is a fork, flatten it into an array of trees

Parameters

t

HashTree

the tree to flatten

Returns

(LabeledHashTree | LeafHashTree | PrunedHashTree)[]

the flattened tree

---

getSubnetIdFromCertificate()

getSubnetIdFromCertificate(certificate, rootKey): Principal

Defined in: packages/core/src/agent/certificate.ts:1052

Get the subnet ID from a certificate If the certificate has a delegation, it returns the subnet ID from the delegation. If the certificate has no delegation, it returns the root subnet ID.

Parameters

certificate

Cert

the certificate to get the subnet ID from

rootKey

Uint8Array

the root key to use to get the subnet ID

Returns

Principal

the subnet ID

---

hashOfMap()

hashOfMap(map): Uint8Array

Defined in: packages/core/src/agent/request_id.ts:80

Hash a map into a Uint8Array using the representation-independent-hash function. https://sdk.dfinity.org/docs/interface-spec/index.html#hash-of-map

Parameters

map

Record<string, unknown>

Any non-nested object

Returns

Uint8Array

Uint8Array

---

hashTreeToString()

hashTreeToString(tree): string

Defined in: packages/core/src/agent/certificate.ts:77

Make a human readable string out of a hash tree.

Parameters

tree

HashTree

The hash tree to convert to a string

Returns

string

---

hashValue()

hashValue(value): Uint8Array

Defined in: packages/core/src/agent/request_id.ts:19

Parameters

value

unknown

unknown value

Returns

Uint8Array

Uint8Array

---

httpHeadersTransform()

httpHeadersTransform(headers): HttpHeaderField[]

Defined in: packages/core/src/agent/agent/http/transforms.ts:48

Maps the default fetch headers field to the serializable HttpHeaderField.

Parameters

headers

Headers

Fetch definition of the headers type

Returns

HttpHeaderField[]

array of header fields

---

isV2ResponseBody()

isV2ResponseBody(body): body is v2ResponseBody

Defined in: packages/core/src/agent/agent/api.ts:159

Utility function to check if a body is a v2ResponseBody for type safety.

Parameters

body

v2ResponseBody | v4ResponseBody | null

The body to check

Returns

body is v2ResponseBody

boolean indicating if the body is a v2ResponseBody

---

isV4ResponseBody()

isV4ResponseBody(body): body is v4ResponseBody

Defined in: packages/core/src/agent/agent/api.ts:174

Utility function to check if a body is a v4ResponseBody for type safety.

Parameters

body

v2ResponseBody | v4ResponseBody | null

The body to check

Returns

body is v4ResponseBody

boolean indicating if the body is a v4ResponseBody

---

lookup_path()

lookup_path(path, tree): LookupResult

Defined in: packages/core/src/agent/certificate.ts:613

Lookup a path in a tree. If the path is a subtree, use lookup_subtree instead.

Parameters

path

NodePath

the path to look up

tree

HashTree

the tree to search

Returns

LookupResult

the result of the lookup

---

lookup_subtree()

lookup_subtree(path, tree): SubtreeLookupResult

Defined in: packages/core/src/agent/certificate.ts:692

Lookup a subtree in a tree.

Parameters

path

NodePath

the path to look up

tree

HashTree

the tree to search

Returns

SubtreeLookupResult

the result of the lookup

---

lookupCanisterRanges()

lookupCanisterRanges(params): Uint8Array

Defined in: packages/core/src/agent/certificate.ts:919

Lookup the canister ranges using the /canister_ranges/<subnet_id>/<ranges> path. Certificates returned by /api/v4/canister/<effective_canister_id>/call and /api/v3/canister/<effective_canister_id>/read_state use this path.

If the new lookup is not found, it tries the fallback lookup with lookupCanisterRangesFallback.

Parameters

params

CheckCanisterRangesParams

the parameters with which to lookup the canister ranges

Returns

Uint8Array

the encoded canister ranges. Use decodeCanisterRanges to decode them.

See

• https://internetcomputer.org/docs/references/ic-interface-spec#http-read-state
• https://internetcomputer.org/docs/references/ic-interface-spec#state-tree-canister-ranges

---

lookupCanisterRangesFallback()

lookupCanisterRangesFallback(subnetId, tree): Uint8Array

Defined in: packages/core/src/agent/certificate.ts:955

Lookup the canister ranges using the /subnet/<subnet_id>/canister_ranges path. Certificates returned by /api/v3/canister/<effective_canister_id>/call and /api/v2/canister/<effective_canister_id>/read_state use this path.

Parameters

subnetId

Principal

the subnet ID to lookup the canister ranges for

tree

HashTree

the tree to search

Returns

Uint8Array

the encoded canister ranges. Use decodeCanisterRanges to decode them.

See

https://internetcomputer.org/docs/references/ic-interface-spec#http-read-state

---

lookupResultToBuffer()

lookupResultToBuffer(result): Uint8Array<ArrayBufferLike> | undefined

Defined in: packages/core/src/agent/certificate.ts:463

Utility function to constrain the type of a lookup result

Parameters

result

LookupResult

the result of a lookup

Returns

Uint8Array<ArrayBufferLike> | undefined

the value if the lookup was found, undefined otherwise

---

makeExpiryTransform()

makeExpiryTransform(delayInMilliseconds): HttpAgentRequestTransformFn

Defined in: packages/core/src/agent/agent/http/transforms.ts:37

Create a transform that adds a delay (by default 5 minutes) to the expiry.

Parameters

delayInMilliseconds

number

The delay to add to the call time, in milliseconds.

Returns

HttpAgentRequestTransformFn

---

makeNonce()

makeNonce(): Nonce

Defined in: packages/core/src/agent/agent/http/types.ts:130

Create a random Nonce, based on random values

Returns

Nonce

---

makeNonceTransform()

makeNonceTransform(nonceFn?): HttpAgentRequestTransformFn

Defined in: packages/core/src/agent/agent/http/transforms.ts:18

Create a Nonce transform, which takes a function that returns a Buffer, and adds it as the nonce to every call requests.

Parameters

nonceFn?

() => Nonce

A function that returns a buffer. By default uses a semi-random method.

Returns

HttpAgentRequestTransformFn

---

pollForResponse()

pollForResponse(agent, canisterId, requestId, options?): Promise<PollForResponseResult>

Defined in: packages/core/src/agent/polling/index.ts:126

Polls the IC to check the status of the given request then returns the response bytes once the request has been processed.

Parameters

agent

Agent

The agent to use to poll read_state.

canisterId

Principal

The effective canister ID.

requestId

RequestId

The Request ID to poll status for.

options?

PollingOptions = {}

polling options to control behavior

Returns

Promise<PollForResponseResult>

The certificate, reply bytes, and raw certificate bytes for the request.

Throws

If the agent’s root key is not available.

Throws

If the request was rejected by the canister.

Throws

If the request reached done status without a reply.

---

randomNumber()

randomNumber(): number

Defined in: packages/core/src/agent/utils/random.ts:5

Generates a random unsigned 32-bit integer between 0 and 0xffffffff

Returns

number

a random number

---

reconstruct()

reconstruct(t): Promise<Uint8Array<ArrayBufferLike>>

Defined in: packages/core/src/agent/certificate.ts:478

Parameters

t

HashTree

The hash tree to reconstruct

Returns

Promise<Uint8Array<ArrayBufferLike>>

---

requestIdOf()

requestIdOf(request): RequestId

Defined in: packages/core/src/agent/request_id.ts:70

Get the RequestId of the provided ic-ref request. RequestId is the result of the representation-independent-hash function. https://sdk.dfinity.org/docs/interface-spec/index.html#hash-of-map

Parameters

request

Record<string, unknown>

ic-ref request to hash into RequestId

Returns

RequestId

---

uint8Equals()

uint8Equals(a, b): boolean

Defined in: packages/core/src/agent/utils/buffer.ts:54

Compares two Uint8Arrays for equality.

Parameters

a

Uint8Array

The first Uint8Array.

b

Uint8Array

The second Uint8Array.

Returns

boolean

True if the Uint8Arrays are equal, false otherwise.

---

uint8FromBufLike()

uint8FromBufLike(bufLike): Uint8Array

Defined in: packages/core/src/agent/utils/buffer.ts:6

Returns a true Uint8Array from an ArrayBufferLike object.

Parameters

bufLike

ArrayBufferLike | Uint8Array<ArrayBufferLike> | number[] | DataView<ArrayBufferLike> | ArrayBufferView<ArrayBufferLike> | [number] | { buffer: ArrayBuffer; }

a buffer-like object

Returns

Uint8Array

Uint8Array

---

uint8ToBuf()

uint8ToBuf(arr): ArrayBuffer

Defined in: packages/core/src/agent/utils/buffer.ts:41

Returns a true ArrayBuffer from a Uint8Array, as Uint8Array.buffer is unsafe.

Parameters

arr

Uint8Array

Uint8Array to convert

Returns

ArrayBuffer

ArrayBuffer

---

unwrapDER()

unwrapDER(derEncoded, oid): Uint8Array

Defined in: packages/core/src/agent/der.ts:165

Extracts a payload from the given derEncoded data, and checks that it was tagged with the given oid.

derEncoded = SEQUENCE(oid, BITSTRING(payload))

Parameters

derEncoded

Uint8Array

The DER encoded and tagged data

oid

Uint8Array

The DER encoded (and SEQUENCE wrapped!) expected OID

Returns

Uint8Array

The unwrapped payload

---

wrapDER()

wrapDER(payload, oid): Uint8Array

Defined in: packages/core/src/agent/der.ts:132

Wraps the given payload in a DER encoding tagged with the given encoded oid like so: SEQUENCE(oid, BITSTRING(payload))

Parameters

payload

Uint8Array

The payload to encode as the bit string

oid

Uint8Array

The DER encoded (and SEQUENCE wrapped!) OID to tag the payload with

Returns

Uint8Array

References

defaultStrategy

Re-exports defaultStrategy