The @icp-sdk/core package is a JavaScript and TypeScript library designed to interact with the Internet Computer. It acts as a meta-package that re-exports functionality from several other @dfinity packages, providing a convenient way to access multiple tools and utilities in one place.
Do you want to know more about developing on the Internet Computer? Visit the Developer Docs.
You can install the @icp-sdk/core package using your preferred package manager:
npm
npm install @icp-sdk/core
yarn
yarn add @icp-sdk/core
pnpm
pnpm add @icp-sdk/core
Import Paths
The package provides the following import paths for accessing the re-exported modules:
@icp-sdk/core/agent
@icp-sdk/core/candid
@icp-sdk/core/identity
@icp-sdk/core/identity/secp256k1
@icp-sdk/core/principal
Usage Example
Here is an example of how to use the @icp-sdk/core package:
// Importing the HttpAgent from the agent moduleimport { HttpAgent } from '@icp-sdk/core/agent';// Importing the Identity utilityimport { Ed25519KeyIdentity } from '@icp-sdk/core/identity';// Importing the Candid utilityimport { IDL } from '@icp-sdk/core/candid';// Importing the Principal utilityimport { Principal } from '@icp-sdk/core/principal';// Create a new identityconst identity = Ed25519KeyIdentity.generate();// Create a Principal from a stringconst canisterId = Principal.fromText('uqqxf-5h777-77774-qaaaa-cai');// Create an HttpAgent instanceconst agent = await HttpAgent.create({ host: 'https://icp-api.io', identity,});// Call a canisterconst response = await agent.call(canisterId, { methodName: 'greet', arg: IDL.encode([IDL.Text], ['world']),});console.log(response);
Note: If you are using TypeScript, this package requires the node16 (or later) moduleResolution strategy to function correctly.