Interface CallConfig

Configuration to make calls to the Replica.

interface CallConfig {
    agent?: utils.agent.Agent;
    pollingOptions?: utils.agent.PollingOptions;
    canisterId?: string | types.Principal;
    effectiveCanisterId?: types.Principal;
    nonce?: Uint8Array<ArrayBufferLike>;
}

Hierarchy (View Summary)

CallConfig

Index

Properties

agent? pollingOptions? canisterId? effectiveCanisterId? nonce?

Properties

`Optional`agent

agent?: utils.agent.Agent

An agent to use in this call, otherwise the actor or call will try to discover the agent to use.

`Optional`pollingOptions

pollingOptions?: utils.agent.PollingOptions

Options for controlling polling behavior.

`Optional`canisterId

canisterId?: string | types.Principal

The canister ID of this Actor.

`Optional`effectiveCanisterId

effectiveCanisterId?: types.Principal

The effective canister ID. This should almost always be ignored.

`Optional`nonce

nonce?: Uint8Array<ArrayBufferLike>

The nonce to use for this call. This is used to prevent replay attacks.