Interface CreateReactorCoreParameters

interface CreateReactorCoreParameters {
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    fetchOptions?: Record<string, unknown>;
    callOptions?: Record<string, unknown>;
    host?: string;
    identity?: types.Identity | Promise<types.Identity>;
    ingressExpiryInMinutes?: number;
    credentials?: {
        name: string;
        password?: string;
    };
    useQueryNonces?: boolean;
    retryTimes?: number;
    backoffStrategy?: BackoffStrategyFactory;
    verifyQuerySignatures?: boolean;
    logToConsole?: boolean;
    rootKey?: ArrayBuffer;
    idlFactory: types.IDL.InterfaceFactory;
    name?: string;
    canisterId: types.CanisterId;
    withVisitor?: boolean;
    withDevtools?: boolean;
    initializeOnCreate?: boolean;
    agentManager?: types.AgentManager;
    withProcessEnv?: boolean;
    withLocalEnv?: boolean;
    port?: number;
}

Hierarchy (view full)

Properties

fetch? fetchOptions? callOptions? host? identity? ingressExpiryInMinutes? credentials? useQueryNonces? retryTimes? backoffStrategy? verifyQuerySignatures? logToConsole? rootKey? idlFactory name? canisterId withVisitor? withDevtools? initializeOnCreate? agentManager? withProcessEnv? withLocalEnv? port?

Properties

Optional fetch

fetch?: {
    (input, init?): Promise<Response>;
    (input, init?): Promise<Response>;
}

Type declaration

Optional fetchOptions

fetchOptions?: Record<string, unknown>

Optional callOptions

callOptions?: Record<string, unknown>

Optional host

host?: string

Optional identity

identity?: types.Identity | Promise<types.Identity>

Optional ingressExpiryInMinutes

ingressExpiryInMinutes?: number

The maximum time a request can be delayed before being rejected.

Default

5 minutes

Optional credentials

credentials?: {
    name: string;
    password?: string;
}

Type declaration

  • name: string
  • Optional password?: string

Optional useQueryNonces

useQueryNonces?: boolean

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

Optional retryTimes

retryTimes?: number

Number of times to retry requests before throwing an error

Default

3

Optional backoffStrategy

backoffStrategy?: BackoffStrategyFactory

The strategy to use for backoff when retrying requests

Optional verifyQuerySignatures

verifyQuerySignatures?: boolean

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

Optional logToConsole

logToConsole?: boolean

Whether to log to the console. Defaults to false.

Optional rootKey

rootKey?: ArrayBuffer

Alternate root key to use for verifying certificates. If not provided, the default IC root key will be used.

idlFactory

idlFactory: types.IDL.InterfaceFactory

Optional name

name?: string

canisterId

canisterId: types.CanisterId

Optional withVisitor

withVisitor?: boolean

Optional withDevtools

withDevtools?: boolean

Optional initializeOnCreate

initializeOnCreate?: boolean

Optional agentManager

agentManager?: types.AgentManager

Optional withProcessEnv

withProcessEnv?: boolean

Optional withLocalEnv

withLocalEnv?: boolean

Optional port

port?: number

Settings

Member Visibility

Theme

On This Page

fetchfetchOptionscallOptionshostidentityingressExpiryInMinutescredentialsuseQueryNoncesretryTimesbackoffStrategyverifyQuerySignatureslogToConsolerootKeyidlFactorynamecanisterIdwithVisitorwithDevtoolsinitializeOnCreateagentManagerwithProcessEnvwithLocalEnvport