HttpAgentOptions

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

Properties

backoffStrategy?

optional backoffStrategy?: BackoffStrategyFactory

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

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:141

---

credentials?

optional credentials?: object

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

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:133

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:138

---

host?

optional host?: string

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

---

identity?

optional identity?: Identity | Promise<Identity>

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

---

ingressExpiryInMinutes?

optional ingressExpiryInMinutes?: number

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

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:193

Whether to log to the console. Defaults to false.

---

retryTimes?

optional retryTimes?: number

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

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:198

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:203

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:208

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:189

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:169

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:183

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