Security News
Combatting Alert Fatigue by Prioritizing Malicious Intent
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
@dfinity/agent
Advanced tools
JavaScript and TypeScript library to interact with the Internet Computer
JavaScript and TypeScript library to interact with the Internet Computer for Node.js and Client applications
Visit the Dfinity Forum and SDK Documentation for more information and support building on the Internet Computer.
Additional API Documentation can be found here.
Using agent:
npm i --save @dfinity/agent
import * as agent from "@dfinity/agent";
or using individual exports:
import { Actor, HttpAgent } from "@dfinity/agent";
const actor = require("@dfinity/agent");
The agent is a low-level interface that the Actor uses to encode and decode messages to the Internet Computer. It provides call
, query
and readState
methods to the Actor, as well as a few additional utilities. For the most part, calls through the agent are intended to be structured through an Actor, configured with a canister interface that can be automatically generated from a Candid interface.
The most common use for the agent is to create an actor. This is done by calling the Actor.createActor
constructor:
Actor.createActor(interfaceFactory: InterfaceFactory, configuration: ActorConfig): ActorSubclass<T>
The interfaceFactory
is a function that returns a runtime interface that the Actor uses to strucure calls to a canister. The interfaceFactory can be written manually, but it is recommended to use the dfx generate
command to generate the interface for your project, or to use the didc
tool to generate the interface for your project.
Use the Actor.agentOf
method to get the agent of an actor:
const defaultAgent = Actor.agentOf(defaultActor);
This is useful if you need to replace or invalidate the identity used by an actor's agent.
For example, if you want to replace the identity of an actor's agent with a newly authenticated identity from Internet Identity, you can do so by calling the Actor.replaceAgent
method:
defaultAgent.replaceIdentity(await authClient.getIdentity());
FAQs
JavaScript and TypeScript library to interact with the Internet Computer
The npm package @dfinity/agent receives a total of 51,689 weekly downloads. As such, @dfinity/agent popularity was classified as popular.
We found that @dfinity/agent demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 10 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.