@icp-sdk/signer 5.2.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works; in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor contributes Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if advised
+      of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, by accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 DFINITY Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,165 @@
+# @icp-sdk/signer
+
+Library to interact with [ICRC-25](https://github.com/dfinity/wg-identity-authentication/blob/main/topics/icrc_25_signer_interaction_standard.md) compliant signers on the Internet Computer.
+
+## What are signers?
+
+A signer is an application that holds private keys and can sign messages on behalf of a user. Each signer chooses which standards to implement, but they typically fall into two categories:
+
+- **Asset wallets** support accounts and canister calls — users approve transactions directly through the signer (e.g. [OISY](https://oisy.com), [Plug](https://plugwallet.ooo), [PrimeVault](https://primevault.com)).
+- **Authentication providers** support delegations — users grant a session key that can sign on their behalf for a limited time (e.g. [Internet Identity](https://id.ai)).
+
+Some signers support both (e.g. [NFID](https://nfid.one)). This library provides a unified interface to interact with all of them.
+
+## Installation
+
+```shell
+npm install @icp-sdk/signer
+```
+
+## Import Paths
+
+- `@icp-sdk/signer` — `Signer` for standardized signer interaction
+- `@icp-sdk/signer/agent` — `SignerAgent` as a drop-in replacement for `HttpAgent`
+- `@icp-sdk/signer/web` — `PostMessageTransport` for web-based signers
+- `@icp-sdk/signer/extension` — `BrowserExtensionTransport` for browser extension signers
+
+## Connecting to a Signer
+
+Two transport types are supported. Web-based signers (like OISY, NFID, Internet Identity) use a window opened to the signer's URL. Browser extensions (like Plug, PrimeVault) are discovered automatically.
+
+### Web
+
+The [ICRC-29](https://github.com/dfinity/wg-identity-authentication/blob/main/topics/icrc_29_window_post_message_transport.md) post message transport communicates with signers that run as web applications. A window is opened to the signer's URL, and messages are exchanged via `postMessage`.
+
+```ts
+import { Signer } from "@icp-sdk/signer";
+import { PostMessageTransport } from "@icp-sdk/signer/web";
+
+const transport = new PostMessageTransport({ url: SIGNER_URL });
+const signer = new Signer({ transport });
+```
+
+### Extension
+
+The [ICRC-94](https://github.com/dfinity/wg-identity-authentication/blob/main/topics/icrc_94_multi_injected_provider_discovery.md) transport communicates with signers installed as browser extensions. Extensions announce themselves and are discovered automatically.
+
+```ts
+import { Signer } from "@icp-sdk/signer";
+import { BrowserExtensionTransport } from "@icp-sdk/signer/extension";
+
+// Discover all installed extension signers
+const providerDetails = await BrowserExtensionTransport.discover();
+
+// Let the user choose, then create a transport
+const transport = new BrowserExtensionTransport({
+  providerDetail: providerDetails[0],
+});
+const signer = new Signer({ transport });
+```
+
+Or connect directly by UUID if you know which extension to use:
+
+```ts
+const transport = await BrowserExtensionTransport.findTransport({
+  uuid: EXTENSION_UUID,
+});
+```
+
+## Checking Capabilities
+
+Signers vary in what they support. Query the supported standards before making calls so you can handle unsupported features gracefully:
+
+```ts
+const standards = await signer.getSupportedStandards();
+
+// signer.getAccounts() requires ICRC-27
+const canGetAccounts = standards.some((s) => s.name === "ICRC-27");
+
+// signer.callCanister() requires ICRC-49
+const canCallCanisters = standards.some((s) => s.name === "ICRC-49");
+
+// signer.requestDelegation() requires ICRC-34
+const canDelegate = standards.some((s) => s.name === "ICRC-34");
+
+// Asset wallets need both accounts and canister calls
+const isAssetWallet = canGetAccounts && canCallCanisters;
+
+// The returned standards also include token standards (e.g. ICRC-1 for
+// fungible tokens, ICRC-7 for NFTs), so you can check whether the
+// signer can manage a particular asset type.
+const supportsFungibleTokens = standards.some((s) => s.name === "ICRC-1");
+```
+
+## Transactions
+
+Asset wallets allow users to approve transactions. Use `SignerAgent` as a drop-in replacement for `HttpAgent` — it routes canister calls through the signer for user approval.
+
+```ts
+import { Signer } from "@icp-sdk/signer";
+import { PostMessageTransport } from "@icp-sdk/signer/web";
+import { SignerAgent } from "@icp-sdk/signer/agent";
+
+// Connect to an asset wallet
+const transport = new PostMessageTransport({ url: "https://oisy.com/sign" });
+const signer = new Signer({ transport });
+
+// Get the user's accounts — some asset wallets return multiple (e.g. NFID),
+// others only one (e.g. OISY).
+// Each account has an `owner` (Principal) and an optional `subaccount`.
+const accounts = await signer.getAccounts();
+const account = accounts[0]; // Let the user choose if there are multiple
+
+// Create an agent for the chosen account's principal.
+// The agent only needs the owner — the principal that controls the account
+// and on whose behalf canister calls are signed.
+const agent = await SignerAgent.create({
+  signer,
+  account: account.owner,
+});
+
+// Use the agent with any canister library
+import { IcrcLedgerCanister } from "@icp-sdk/canisters/ledger/icrc";
+
+const icpLedger = IcrcLedgerCanister.create({
+  agent,
+  canisterId: ICP_LEDGER_CANISTER_ID,
+});
+await icpLedger.transfer({
+  to: TARGET_ACCOUNT,
+  amount: 100_000_000n,
+});
+```
+
+## Authentication
+
+Authentication providers issue delegations — temporary keys that can sign on behalf of the user. This is useful for session-based authentication where individual transaction approval is not needed.
+
+```ts
+import { Signer } from "@icp-sdk/signer";
+import { PostMessageTransport } from "@icp-sdk/signer/web";
+import { ECDSAKeyIdentity, DelegationIdentity } from "@icp-sdk/core/identity";
+import { HttpAgent } from "@icp-sdk/core/agent";
+
+// Connect to an authentication provider
+const transport = new PostMessageTransport({ url: "https://id.ai/authorize" });
+const signer = new Signer({ transport });
+
+// Create a session key and request a delegation
+const sessionKey = await ECDSAKeyIdentity.generate();
+const delegationChain = await signer.requestDelegation({
+  publicKey: sessionKey.getPublicKey().toDer(),
+});
+
+// Create a DelegationIdentity that can sign without further user interaction
+const identity = DelegationIdentity.fromDelegation(sessionKey, delegationChain);
+const agent = await HttpAgent.create({ identity });
+```
+
+## TypeScript
+
+This package requires the `node16` (or later) [`moduleResolution`](https://www.typescriptlang.org/tsconfig#moduleResolution) strategy.
+
+## License
+
+This project is licensed under the Apache-2.0 license.

package/lib/esm/agent/agent.d.ts

@@ -0,0 +1,112 @@
+import { type Agent, type ApiQueryResponse, type CallOptions, HttpAgent, type Identity, type QueryFields, type ReadStateOptions, type ReadStateResponse, type SubmitResponse, type UpdateResult } from '@icp-sdk/core/agent';
+import { type JsonObject } from '@icp-sdk/core/candid';
+import { Principal } from '@icp-sdk/core/principal';
+import type { Signer, Transport } from '../index.js';
+/** Options for creating a {@link SignerAgent}. */
+export interface SignerAgentOptions<T extends Transport = Transport> {
+    /** The {@link Signer} used to send ICRC-49 canister call requests. */
+    signer: Signer<T>;
+    /** The principal of the account on whose behalf canister calls are made. */
+    account: Principal;
+    /**
+     * An {@link HttpAgent} used for fetching the root key and status.
+     * @default A new HttpAgent connected to the IC mainnet.
+     */
+    agent?: HttpAgent;
+}
+/**
+ * Error thrown by {@link SignerAgent} when a signer returns an invalid
+ * response or certificate validation fails.
+ */
+export declare class SignerAgentError extends Error {
+}
+/**
+ * An {@link Agent} implementation that routes canister calls through a
+ * {@link Signer} for user approval. Drop-in replacement for {@link HttpAgent}
+ * when canister calls need to be signed by an external signer.
+ *
+ * Calls are sent to the signer via ICRC-49, and the returned content map
+ * and certificate are validated before being returned to the caller.
+ *
+ * Use {@link SignerAgent.create} or {@link SignerAgent.createSync} to
+ * construct an instance — the constructor is private.
+ * @example
+ * ```ts
+ * const agent = await SignerAgent.create({ signer, account });
+ * const result = await agent.update(canisterId, { methodName: "transfer", arg, effectiveCanisterId: canisterId });
+ * ```
+ */
+export declare class SignerAgent<T extends Transport = Transport> implements Agent {
+    #private;
+    private constructor();
+    /** The root key used for certificate verification. */
+    get rootKey(): Uint8Array<ArrayBufferLike>;
+    /** The signer this agent routes calls through. */
+    get signer(): Signer<T>;
+    /**
+     * Creates a new SignerAgent, asynchronously initializing the
+     * underlying HttpAgent if one is not provided.
+     * @param options - The signer agent options.
+     */
+    static create<T extends Transport>(options: SignerAgentOptions<T>): Promise<SignerAgent<T>>;
+    /**
+     * Creates a new SignerAgent synchronously.
+     * Use this when you already have an HttpAgent or don't need async initialization.
+     * @param options - The signer agent options.
+     */
+    static createSync<T extends Transport>(options: SignerAgentOptions<T>): SignerAgent<T>;
+    /**
+     * Sends a canister call through the signer.
+     * Returns the request ID and a synthetic HTTP response.
+     * @param canisterId - The target canister principal or its text representation.
+     * @param fields - The call options including method name and arguments.
+     */
+    call(canisterId: Principal | string, fields: CallOptions): Promise<SubmitResponse>;
+    /**
+     * Executes a canister update call and returns the certified result.
+     * Combines {@link call} with certificate validation and reply extraction.
+     * @param canisterId - The target canister principal or its text representation.
+     * @param fields - The call options including method name and arguments.
+     * @param _pollingOptions - Ignored. The signer already returns the
+     *   certificate with the reply in a single round-trip.
+     */
+    update(canisterId: Principal | string, fields: CallOptions, _pollingOptions?: unknown): Promise<UpdateResult>;
+    /**
+     * Executes a query by upgrading it to a canister call through the signer.
+     * The signer signs and submits the call, and the reply is extracted
+     * from the certified response.
+     * @param canisterId - The target canister principal or its text representation.
+     * @param options - The query fields including method name and arguments.
+     * @param _identity - Ignored. The signer manages identity internally.
+     */
+    query(canisterId: Principal | string, options: QueryFields, _identity?: Identity | Promise<Identity>): Promise<ApiQueryResponse>;
+    /** Fetches the IC root key via the underlying HttpAgent. */
+    fetchRootKey(): Promise<Uint8Array>;
+    /** Returns the account principal this agent makes calls on behalf of. */
+    getPrincipal(): Promise<Principal>;
+    /**
+     * @internal
+     * @param _options - The read state options.
+     * @param _identity - The identity to use for the request.
+     */
+    createReadStateRequest(_options: ReadStateOptions, _identity?: Identity): Promise<unknown>;
+    /**
+     * Returns the raw certificate for a previously completed call.
+     * The certificate is deleted after being read (single-use).
+     *
+     * Only supports `request_status` paths for request IDs that were
+     * returned by a prior {@link call}, {@link update}, or {@link query}.
+     * @param _canisterId - The target canister principal (unused).
+     * @param options - The read state options containing paths to look up.
+     * @param _identity - The identity to use (unused).
+     * @param _request - The request object (unused).
+     */
+    readState(_canisterId: Principal | string, options: ReadStateOptions, _identity?: Identity | Promise<Identity>, _request?: unknown): Promise<ReadStateResponse>;
+    /** Queries the IC replica status via the underlying HttpAgent. */
+    status(): Promise<JsonObject>;
+    /**
+     * Replaces the account principal used for subsequent calls.
+     * @param account - The new account principal to use for subsequent calls.
+     */
+    replaceAccount(account: Principal): void;
+}