docs: clarifies meaning of effectiveCanisterId in CallOptions

dfinity · Sep 6, 2024 · ddcc927 · ddcc927
1 parent 5d5415e
commit ddcc927
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git 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
@@ -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;
 }