You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
3
3
## [Unreleased]
4
4
5
+
See the [v5 upgrading guide](https://js.icp.build/core/v5/upgrading/v5/) for more information.
6
+
5
7
- feat(core)!: removes `@dfinity/{agent,candid,identity,identity-secp256k1,principal}` peer dependencies and moves their source code to the `@icp-sdk/core` package
Copy file name to clipboardExpand all lines: docs/src/content/docs/upgrading/v5.md
+45-13Lines changed: 45 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,12 +14,12 @@ This release completes the migration of all `@dfinity/*` packages into `@icp-sdk
14
14
## TL;DR
15
15
16
16
-**New API versions**: Agent now uses the latest IC API endpoints: `/api/v4` for calls and `/api/v3` for queries/read_state.
17
-
-**Local replica upgrade required**: Use dfx >=v0.30.1 or PocketIC >=v11.0.0.
17
+
-**Local replica upgrade required**: Use dfx >=[v0.30.1](https://github.com/dfinity/sdk/releases/tag/0.30.1) or PocketIC >=[v11.0.0](https://github.com/dfinity/pocketic/releases/tag/11.0.0).
18
18
-**Peer dependencies removed**: `@dfinity/*` packages are no longer peer dependencies. Remove them before upgrading.
19
19
20
20
## Before You Begin
21
21
22
-
Before upgrading to v5, you **must** remove the `@dfinity/*`peer dependencies from your project. These packages are now fully integrated into `@icp-sdk/core` and are no longer required as separate dependencies.
22
+
Before upgrading to v5, you **must** remove the `@dfinity/{agent,candid,identity,identity-secp256k1,principal}` (peer) dependencies from your project. These packages are now fully integrated into `@icp-sdk/core` and are no longer required as separate dependencies.
@@ -31,14 +31,32 @@ Then, upgrade `@icp-sdk/core` to the latest version:
31
31
npm install @icp-sdk/core@latest
32
32
```
33
33
34
+
> **NOTE**: If your project is using any package from the old `ic-js` suite (see [Legacy single-entry packages](https://github.com/dfinity/icp-js-canisters/blob/5fc7e162f0622dd335bb163f2dc3ab2c5325d16c/README.md#-legacy-single-entry-packages)), you should migrate to the new [`@icp-sdk/canisters`](https://js.icp.build/canisters/) package, which also doesn't depend on the `@dfinity/{agent,candid,identity,identity-secp256k1,principal}` packages.
35
+
34
36
## Breaking Changes
35
37
36
38
### Source Code Moved to `@icp-sdk/core`
37
39
38
40
In v4, `@icp-sdk/core` re-exported the `@dfinity/*` packages as peer dependencies. In v5, the source code of all core packages has been moved directly into `@icp-sdk/core`. This means:
39
41
40
42
- You no longer need to install `@dfinity/agent`, `@dfinity/candid`, `@dfinity/identity`, `@dfinity/identity-secp256k1`, or `@dfinity/principal` as separate packages.
41
-
- All imports should use `@icp-sdk/core/*` submodules, as described in the [v4 upgrading guide](https://js.icp.build/core/latest/upgrading/v4/).
43
+
- All imports should use `@icp-sdk/core/*` submodules:
> If you're developing locally with **dfx**, make sure you upgrade to [v0.30.1](https://github.com/dfinity/sdk/releases/tag/0.30.1) or later.
57
77
58
-
> If you're developing locally, make sure you upgrade to [dfx v0.30.1](https://github.com/dfinity/sdk/releases/tag/0.30.1) or later.
78
+
> If you're using **PocketIC** for testing, upgrade to [v11.0.0](https://github.com/dfinity/pocketic/releases/tag/11.0.0) or later.
59
79
60
-
> If you're using PocketIC for testing, upgrade to [v11](https://github.com/dfinity/pocketic/releases/tag/11.0.0) or later.
80
+
> If you're using [`@dfinity/pic-js`](https://js.icp.build/pic-js/) for testing, upgrade to [v0.17.0](https://github.com/dfinity/pic-js/releases/tag/0.17.0) or later.
61
81
62
82
### Certificate Verification: `canisterId` Replaced with `principal`
A new `SubnetStatus` namespace has been introduced to request subnet information directly from the IC public API:
185
+
A new [`SubnetStatus`](../libs/agent/api/namespaces/SubnetStatus/index.md) namespace has been introduced to request subnet information directly from the IC public API:
0 commit comments