Interface CallConfig

Configuration to make calls to the Replica.

interface CallConfig {
    agent?: utils.agent.Agent;
    pollingStrategyFactory?: utils.agent.polling.PollStrategyFactory;
    canisterId?: string | types.Principal;
    effectiveCanisterId?: types.Principal;
}

Hierarchy (view full)

CallConfig

Index

Properties

agent? pollingStrategyFactory? canisterId? effectiveCanisterId?

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` pollingStrategyFactory

pollingStrategyFactory?: utils.agent.polling.PollStrategyFactory

A polling strategy factory that dictates how much and often we should poll the read_state endpoint to get the result of an update call.

`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.