Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • HttpAgent

Implements

Index

Constructors

Properties

_credentials: undefined | string
_fetch: { (input: RequestInfo, init?: RequestInit): Promise<Response>; (input: string | Request, init?: RequestInit | CMRequestInit): Promise<Response> }

Type declaration

    • (input: RequestInfo, init?: RequestInit): Promise<Response>
    • (input: string | Request, init?: RequestInit | CMRequestInit): Promise<Response>
    • Parameters

      • input: RequestInfo
      • Optional init: RequestInit

      Returns Promise<Response>

    • Parameters

      • input: string | Request
      • Optional init: RequestInit | CMRequestInit

      Returns Promise<Response>

_host: URL
_identity: null | Promise<Identity>
_pipeline: HttpAgentRequestTransformFn[] = []
_rootKeyFetched: boolean = false
rootKey: ArrayBuffer = ...

Methods

  • call(canisterId: string | Principal, options: { arg: ArrayBuffer; effectiveCanisterId?: string | Principal; methodName: string }, identity?: Identity | Promise<Identity>): Promise<SubmitResponse>
  • fetchRootKey(): Promise<ArrayBuffer>
  • 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<ArrayBuffer>

  • getPrincipal(): Promise<Principal>
  • 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(): void
  • 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

  • replaceIdentity(identity: Identity): void
  • 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 @dfinity/auth-client, you can replace the AnonymousIdentity of your Actor with a DelegationIdentity.

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

    Parameters

    Returns void

  • status(): Promise<JsonObject>
  • 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.

Generated using TypeDoc