From ba3ed438e3b36be100c57900a526398a21f30c8b Mon Sep 17 00:00:00 2001 From: Kai Peacock Date: Fri, 6 Sep 2024 12:38:55 -0700 Subject: [PATCH] docs: clarifies meaning of `effectiveCanisterId` in `CallOptions` (#920) --- docs/CHANGELOG.md | 1 + packages/agent/src/agent/api.ts | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index b50095a8..3c5b5338 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -14,6 +14,7 @@ - docs: documentation and metadata for use-auth-client - feat: adds optional `rootKey` to `HttpAgentOptions` to allow for a custom root key to be used for verifying signatures from other networks - chore: npm audit bumping micromatch +- docs: clarifies meaning of `effectiveCanisterId` in `CallOptions` ### Changed - feat: replaces hdkey and bip32 implementations with `@scure/bip39` and `@scure/bip32` due to vulnerability and lack of maintenance for `elliptic` diff --git a/packages/agent/src/agent/api.ts b/packages/agent/src/agent/api.ts index a4425ae4..b11bd1e4 100644 --- a/packages/agent/src/agent/api.ts +++ b/packages/agent/src/agent/api.ts @@ -111,8 +111,8 @@ export interface CallOptions { arg: ArrayBuffer; /** - * An effective canister ID, used for routing. This should only be mentioned if - * it's different from the canister ID. + * An effective canister ID, used for routing. Usually the canister ID, except for management canister calls. + * @see https://internetcomputer.org/docs/current/references/ic-interface-spec/#http-effective-canister-id */ effectiveCanisterId: Principal | string; }