@0xkey-io/eip-1193-provider 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# @0xkey-io/eip-1193-provider
+
+## 0.1.0
+
+Initial release.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 or translation 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 provides its 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 such Contributor
+    has been 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, in 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
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2026 0xkey
+
+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,133 @@
+# ZeroXKey EIP-1193 Provider
+
+The `@0xkey-io/eip-1193-provider` package delivers a ZeroXKey-compatible Ethereum provider that adheres to the EIP-1193 standards. It's built to integrate seamlessly with a broad spectrum of EVM-compatible chains, offering capabilities like account management, transaction signing, and blockchain interaction. This initial setup is intended for use in conjunction with the [`@0xkey-io/http`](https://www.npmjs.com/package/@0xkey-io/http) and [`@0xkey-io/webauthn-stamper`](https://www.npmjs.com/package/@0xkey-io/webauthn-stamper) package, for initial authentication.
+
+## Installation
+
+Before you start using the ZeroXKey EIP-1193 Provider, make sure to install the necessary packages in your project. This guide assumes you have a Node.js environment ready for development.
+
+Install the required packages using NPM or Yarn:
+
+```bash
+npm install @0xkey-io/eip-1193-provider @0xkey-io/http @0xkey-io/webauthn-stamper
+```
+
+```bash
+pnpm add @0xkey-io/eip-1193-provider @0xkey-io/http @0xkey-io/webauthn-stamper
+```
+
+```bash
+yarn add @0xkey-io/eip-1193-provider @0xkey-io/http @0xkey-io/webauthn-stamper
+```
+
+## Initialization
+
+To set up the ZeroXKey EIP-1193 Provider, you need to initialize it with your configuration, which includes setting up the ZeroXKey client with your base URL and stamper.
+
+```ts
+import { WebauthnStamper } from "@0xkey-io/webauthn-stamper";
+import { ZeroXKeyClient } from "@0xkey-io/http";
+
+const stamper = new WebauthnStamper({
+  rpId: "example.com",
+});
+
+// Initialize the ZeroXKey HTTP client
+const zeroXKeyClient = new ZeroXKeyClient(
+  { baseUrl: "https://api.0xkey.com" },
+  stamper,
+);
+
+// Get the organizationId of the sub-organization connected to the users account
+const { organizationId } = await zeroXKeyClient.getWhoami({
+  organizationId: process.env.ORGANIZATION_ID,
+});
+
+// Get the user wallets associated with their sub-organization
+const { wallets } = await zeroXKeyClient.getWallets({
+  organizationId,
+});
+
+// Get the walletId to connect to the provider
+const walletId = wallets[0].walletId;
+
+const chain = {
+  chainName: "Ethereum Mainnet",
+  chainId: "0x1",
+  rpcUrls: ["https://mainnet.infura.io/v3/your-infura-project-id"],
+};
+
+// Initialize the EIP-1193 Provider with your configuration
+const provider = await createEIP1193Provider({
+  walletId,
+  organizationId,
+  zeroXKeyClient,
+  chains: [
+    chain,
+    // Add more chains as needed
+  ],
+});
+```
+
+## Usage
+
+### `eth_requestAccounts`
+
+Requests the user to provide an Ethereum address for identification, as specified by [EIP-1102](https://eips.ethereum.org/EIPS/eip-1102). This method initiates connectivity with the client and will prompt for passkey authentication.
+
+```javascript
+const accounts = await provider.request({ method: "eth_requestAccounts" });
+// Logs the array accounts associated with the provided walletId & organization
+console.log(accounts);
+```
+
+### Authentication Prompt Methods
+
+The following methods also prompt for passkey authentication:
+
+- `personal_sign`: Signs a message with the specified account.
+- `eth_sign`: Signs data with the specified account.
+- `eth_signTransaction`: Signs a transaction with the specified account.
+- `eth_signTypedData_v4`: Signs typed data according to EIP-712 with the specified account.
+- `eth_sendTransaction`: Submits a transaction to the network for execution.
+
+## Testing (Local)
+
+1. Copy `.env.example` to `.env`
+
+   ```bash
+   $ cp .env.example .env
+   ```
+
+2. Start the Anvil node in one shell:
+   - Install [Foundry](https://book.getfoundry.sh/getting-started/installation) & Anvil if you haven't done so already
+   - Add Foundry to your `$PATH`
+     ```bash
+     $ export PATH="$PATH:$HOME/.foundry/bin"
+     ```
+   - Source your env e.g.
+     ```bash
+     $ source ~/.zshrc
+     ```
+   - Run `foundryup` to install `Anvil`
+     ```bash
+     $ foundryup
+     ```
+   - Start Anvil
+     ```
+     $ pnpm anvil
+     ```
+
+3. Run the tests in a new shell:
+
+   ```
+   $ pnpm test
+   ```
+
+## Contributing
+
+We welcome contributions to improve the `ZeroXKey EIP-1193 Provider`. Please follow the project's [contribution guidelines](https://github.com/0xkey-io/sdk-js/blob/ad9071716919d062ba67fd623a01cbd4523ed444/CONTRIBUTING.md).
+
+## License
+
+This project is licensed under [LICENSE](./LICENSE), with detailed information available in the repository.

package/dist/0xkey.d.ts

@@ -0,0 +1,34 @@
+import { ZeroXKeyClient } from "@0xkey-io/http";
+import type { ZeroXKeyBrowserClient } from "@0xkey-io/sdk-browser";
+import type { definitions } from "@0xkey-io/http/src/__generated__/services/coordinator/public/v1/public_api.types";
+import type { ZeroXKeySDKClientBase } from "@0xkey-io/core";
+export declare function unwrapActivityResult<T extends definitions["v1ActivityResponse"]>(activityResponse: T, { errorMessage }: {
+    errorMessage: string;
+}): T["activity"]["result"];
+export declare function signMessage({ client, message, organizationId, signWith, }: {
+    client: ZeroXKeyClient | ZeroXKeyBrowserClient | ZeroXKeySDKClientBase;
+    message: `0x${string}`;
+    organizationId: string;
+    signWith: string;
+}): Promise<string>;
+export declare function signTransaction({ client, unsignedTransaction, organizationId, signWith, }: {
+    client: ZeroXKeyClient | ZeroXKeyBrowserClient | ZeroXKeySDKClientBase;
+    unsignedTransaction: string;
+    organizationId: string;
+    signWith: string;
+}): Promise<string>;
+/**
+ * Checks if the error code corresponds to a disconnected state.
+ *
+ * Determines if provided error code is one of the known
+ * error codes that signify a disconnected state, specifically if the wallet
+ * or organization was not found.
+ *
+ * @param {Object} error - The error object containing the error code.
+ * @param {number} error.code - The error code to check against known disconnected state codes.
+ * @returns {boolean} - Returns true if the error code is for a disconnected state, otherwise false.
+ */
+export declare const zeroXKeyIsDisconnected: (error: {
+    code: number;
+}) => boolean;
+//# sourceMappingURL=0xkey.d.ts.map

package/dist/0xkey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"0xkey.d.ts","sourceRoot":"","sources":["../src/0xkey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAgB,MAAM,gBAAgB,CAAC;AAC9D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAKnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kFAAkF,CAAC;AAMpH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAE5D,wBAAgB,oBAAoB,CAClC,CAAC,SAAS,WAAW,CAAC,oBAAoB,CAAC,EAE3C,gBAAgB,EAAE,CAAC,EACnB,EAAE,YAAY,EAAE,EAAE;IAAE,YAAY,EAAE,MAAM,CAAA;CAAE,GACzC,CAAC,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAkBzB;AAED,wBAAsB,WAAW,CAAC,EAChC,MAAM,EACN,OAAO,EACP,cAAc,EACd,QAAQ,GACT,EAAE;IACD,MAAM,EAAE,cAAc,GAAG,qBAAqB,GAAG,qBAAqB,CAAC;IACvE,OAAO,EAAE,KAAK,MAAM,EAAE,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;CAClB,GAAG,OAAO,CAAC,MAAM,CAAC,CA0ClB;AAED,wBAAsB,eAAe,CAAC,EACpC,MAAM,EACN,mBAAmB,EACnB,cAAc,EACd,QAAQ,GACT,EAAE;IACD,MAAM,EAAE,cAAc,GAAG,qBAAqB,GAAG,qBAAqB,CAAC;IACvE,mBAAmB,EAAE,MAAM,CAAC;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;CAClB,GAAG,OAAO,CAAC,MAAM,CAAC,CAoClB;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,UAAW;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,YAI7D,CAAC"}

package/dist/0xkey.js

@@ -0,0 +1,112 @@
+'use strict';
+
+var http = require('@0xkey-io/http');
+var viem = require('viem');
+var utils = require('viem/utils');
+var constants = require('./constants.js');
+
+function unwrapActivityResult(activityResponse, { errorMessage }) {
+    const { activity } = activityResponse;
+    switch (activity.status) {
+        case "ACTIVITY_STATUS_CONSENSUS_NEEDED": {
+            throw "Consensus needed";
+        }
+        case "ACTIVITY_STATUS_COMPLETED": {
+            const result = activity.result;
+            if (result === undefined) {
+                throw "Activity result is undefined";
+            }
+            return result;
+        }
+        default: {
+            throw errorMessage;
+        }
+    }
+}
+async function signMessage({ client, message, organizationId, signWith, }) {
+    let activityResponse;
+    if (http.isHttpClient(client)) {
+        activityResponse = await client.signRawPayload({
+            type: "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2",
+            organizationId,
+            parameters: {
+                signWith,
+                payload: utils.pad(message),
+                encoding: "PAYLOAD_ENCODING_HEXADECIMAL",
+                hashFunction: "HASH_FUNCTION_NO_OP",
+            },
+            timestampMs: String(Date.now()), // millisecond timestamp
+        });
+    }
+    else {
+        activityResponse = await client.signRawPayload({
+            signWith,
+            payload: message,
+            encoding: "PAYLOAD_ENCODING_HEXADECIMAL",
+            hashFunction: "HASH_FUNCTION_NO_OP",
+        });
+    }
+    const { signRawPayloadResult: signature } = unwrapActivityResult(activityResponse /* Type casting is ok here. The invalid types are both actually strings. TS is too strict here! */, {
+        errorMessage: "Error signing message",
+    });
+    if (!signature) {
+        // @todo update error message
+        throw "Error signing message";
+    }
+    return viem.signatureToHex({
+        r: `0x${signature.r}`,
+        s: `0x${signature.s}`,
+        v: BigInt(signature.v) + 27n,
+    });
+}
+async function signTransaction({ client, unsignedTransaction, organizationId, signWith, }) {
+    let activityResponse;
+    if (http.isHttpClient(client)) {
+        activityResponse = await client.signTransaction({
+            type: "ACTIVITY_TYPE_SIGN_TRANSACTION_V2",
+            organizationId: organizationId,
+            parameters: {
+                signWith,
+                type: "TRANSACTION_TYPE_ETHEREUM",
+                unsignedTransaction: unsignedTransaction,
+            },
+            timestampMs: String(Date.now()), // millisecond timestamp
+        });
+    }
+    else {
+        activityResponse = await client.signTransaction({
+            signWith,
+            type: "TRANSACTION_TYPE_ETHEREUM",
+            unsignedTransaction: unsignedTransaction,
+        });
+    }
+    const { signTransactionResult } = unwrapActivityResult(activityResponse /* Type casting is ok here. The invalid types are both actually strings. TS is too strict here! */, {
+        errorMessage: "Error signing transaction",
+    });
+    if (!signTransactionResult) {
+        // @todo update error handling (e.g. consensus)
+        throw "Error signing transaction";
+    }
+    return signTransactionResult.signedTransaction;
+}
+/**
+ * Checks if the error code corresponds to a disconnected state.
+ *
+ * Determines if provided error code is one of the known
+ * error codes that signify a disconnected state, specifically if the wallet
+ * or organization was not found.
+ *
+ * @param {Object} error - The error object containing the error code.
+ * @param {number} error.code - The error code to check against known disconnected state codes.
+ * @returns {boolean} - Returns true if the error code is for a disconnected state, otherwise false.
+ */
+const zeroXKeyIsDisconnected = (error) => {
+    const { WALLET_NOT_FOUND, ORG_NOT_FOUND } = constants.ZEROXKEY_ERROR_CODE;
+    return [WALLET_NOT_FOUND, ORG_NOT_FOUND].includes(error.code);
+};
+
+exports.signMessage = signMessage;
+exports.signTransaction = signTransaction;
+exports.unwrapActivityResult = unwrapActivityResult;
+exports.zeroXKeyIsDisconnected = zeroXKeyIsDisconnected;
+//# sourceMappingURL=0xkey.js.map

package/dist/0xkey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"0xkey.js","sources":["../src/0xkey.ts"],"sourcesContent":[null],"names":["isHttpClient","pad","signatureToHex","ZEROXKEY_ERROR_CODE"],"mappings":";;;;;;;SAcgB,oBAAoB,CAGlC,gBAAmB,EACnB,EAAE,YAAY,EAA4B,EAAA;AAE1C,IAAA,MAAM,EAAE,QAAQ,EAAE,GAAG,gBAAgB;AAErC,IAAA,QAAQ,QAAQ,CAAC,MAAM;QACrB,KAAK,kCAAkC,EAAE;AACvC,YAAA,MAAM,kBAAkB;QAC1B;QACA,KAAK,2BAA2B,EAAE;AAChC,YAAA,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM;AAC9B,YAAA,IAAI,MAAM,KAAK,SAAS,EAAE;AACxB,gBAAA,MAAM,8BAA8B;YACtC;AACA,YAAA,OAAO,MAAM;QACf;QACA,SAAS;AACP,YAAA,MAAM,YAAY;QACpB;;AAEJ;AAEO,eAAe,WAAW,CAAC,EAChC,MAAM,EACN,OAAO,EACP,cAAc,EACd,QAAQ,GAMT,EAAA;AACC,IAAA,IAAI,gBAAgB;AAEpB,IAAA,IAAIA,iBAAY,CAAC,MAAM,CAAC,EAAE;AACxB,QAAA,gBAAgB,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC;AAC7C,YAAA,IAAI,EAAE,mCAAmC;YACzC,cAAc;AACd,YAAA,UAAU,EAAE;gBACV,QAAQ;AACR,gBAAA,OAAO,EAAEC,SAAG,CAAC,OAAO,CAAC;AACrB,gBAAA,QAAQ,EAAE,8BAA8B;AACxC,gBAAA,YAAY,EAAE,qBAAqB;AACpC,aAAA;YACD,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;AAChC,SAAA,CAAC;IACJ;SAAO;AACL,QAAA,gBAAgB,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC;YAC7C,QAAQ;AACR,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,QAAQ,EAAE,8BAA8B;AACxC,YAAA,YAAY,EAAE,qBAAqB;AACpC,SAAA,CAAC;IACJ;IAEA,MAAM,EAAE,oBAAoB,EAAE,SAAS,EAAE,GACvC,oBAAoB,CAClB,gBAAuB,qGACvB;AACE,QAAA,YAAY,EAAE,uBAAuB;AACtC,KAAA,CACF;IAEH,IAAI,CAAC,SAAS,EAAE;;AAEd,QAAA,MAAM,uBAAuB;IAC/B;AAEA,IAAA,OAAOC,mBAAc,CAAC;AACpB,QAAA,CAAC,EAAE,CAAA,EAAA,EAAK,SAAS,CAAC,CAAC,CAAA,CAAE;AACrB,QAAA,CAAC,EAAE,CAAA,EAAA,EAAK,SAAS,CAAC,CAAC,CAAA,CAAE;QACrB,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,GAAG;AAC7B,KAAA,CAAC;AACJ;AAEO,eAAe,eAAe,CAAC,EACpC,MAAM,EACN,mBAAmB,EACnB,cAAc,EACd,QAAQ,GAMT,EAAA;AACC,IAAA,IAAI,gBAAgB;AAEpB,IAAA,IAAIF,iBAAY,CAAC,MAAM,CAAC,EAAE;AACxB,QAAA,gBAAgB,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC;AAC9C,YAAA,IAAI,EAAE,mCAAmC;AACzC,YAAA,cAAc,EAAE,cAAc;AAC9B,YAAA,UAAU,EAAE;gBACV,QAAQ;AACR,gBAAA,IAAI,EAAE,2BAA2B;AACjC,gBAAA,mBAAmB,EAAE,mBAAmB;AACzC,aAAA;YACD,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;AAChC,SAAA,CAAC;IACJ;SAAO;AACL,QAAA,gBAAgB,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC;YAC9C,QAAQ;AACR,YAAA,IAAI,EAAE,2BAA2B;AACjC,YAAA,mBAAmB,EAAE,mBAAmB;AACzC,SAAA,CAAC;IACJ;IAEA,MAAM,EAAE,qBAAqB,EAAE,GAC7B,oBAAoB,CAClB,gBAAuB,qGACvB;AACE,QAAA,YAAY,EAAE,2BAA2B;AAC1C,KAAA,CACF;IAEH,IAAI,CAAC,qBAAqB,EAAE;;AAE1B,QAAA,MAAM,2BAA2B;IACnC;IAEA,OAAO,qBAAqB,CAAC,iBAAiB;AAChD;AAEA;;;;;;;;;;AAUG;AACI,MAAM,sBAAsB,GAAG,CAAC,KAAuB,KAAI;AAChE,IAAA,MAAM,EAAE,gBAAgB,EAAE,aAAa,EAAE,GAAGG,6BAAmB;AAE/D,IAAA,OAAO,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;AAC/D;;;;;;;"}

package/dist/0xkey.mjs

@@ -0,0 +1,107 @@
+import { isHttpClient } from '@0xkey-io/http';
+import { signatureToHex } from 'viem';
+import { pad } from 'viem/utils';
+import { ZEROXKEY_ERROR_CODE } from './constants.mjs';
+
+function unwrapActivityResult(activityResponse, { errorMessage }) {
+    const { activity } = activityResponse;
+    switch (activity.status) {
+        case "ACTIVITY_STATUS_CONSENSUS_NEEDED": {
+            throw "Consensus needed";
+        }
+        case "ACTIVITY_STATUS_COMPLETED": {
+            const result = activity.result;
+            if (result === undefined) {
+                throw "Activity result is undefined";
+            }
+            return result;
+        }
+        default: {
+            throw errorMessage;
+        }
+    }
+}
+async function signMessage({ client, message, organizationId, signWith, }) {
+    let activityResponse;
+    if (isHttpClient(client)) {
+        activityResponse = await client.signRawPayload({
+            type: "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2",
+            organizationId,
+            parameters: {
+                signWith,
+                payload: pad(message),
+                encoding: "PAYLOAD_ENCODING_HEXADECIMAL",
+                hashFunction: "HASH_FUNCTION_NO_OP",
+            },
+            timestampMs: String(Date.now()), // millisecond timestamp
+        });
+    }
+    else {
+        activityResponse = await client.signRawPayload({
+            signWith,
+            payload: message,
+            encoding: "PAYLOAD_ENCODING_HEXADECIMAL",
+            hashFunction: "HASH_FUNCTION_NO_OP",
+        });
+    }
+    const { signRawPayloadResult: signature } = unwrapActivityResult(activityResponse /* Type casting is ok here. The invalid types are both actually strings. TS is too strict here! */, {
+        errorMessage: "Error signing message",
+    });
+    if (!signature) {
+        // @todo update error message
+        throw "Error signing message";
+    }
+    return signatureToHex({
+        r: `0x${signature.r}`,
+        s: `0x${signature.s}`,
+        v: BigInt(signature.v) + 27n,
+    });
+}
+async function signTransaction({ client, unsignedTransaction, organizationId, signWith, }) {
+    let activityResponse;
+    if (isHttpClient(client)) {
+        activityResponse = await client.signTransaction({
+            type: "ACTIVITY_TYPE_SIGN_TRANSACTION_V2",
+            organizationId: organizationId,
+            parameters: {
+                signWith,
+                type: "TRANSACTION_TYPE_ETHEREUM",
+                unsignedTransaction: unsignedTransaction,
+            },
+            timestampMs: String(Date.now()), // millisecond timestamp
+        });
+    }
+    else {
+        activityResponse = await client.signTransaction({
+            signWith,
+            type: "TRANSACTION_TYPE_ETHEREUM",
+            unsignedTransaction: unsignedTransaction,
+        });
+    }
+    const { signTransactionResult } = unwrapActivityResult(activityResponse /* Type casting is ok here. The invalid types are both actually strings. TS is too strict here! */, {
+        errorMessage: "Error signing transaction",
+    });
+    if (!signTransactionResult) {
+        // @todo update error handling (e.g. consensus)
+        throw "Error signing transaction";
+    }
+    return signTransactionResult.signedTransaction;
+}
+/**
+ * Checks if the error code corresponds to a disconnected state.
+ *
+ * Determines if provided error code is one of the known
+ * error codes that signify a disconnected state, specifically if the wallet
+ * or organization was not found.
+ *
+ * @param {Object} error - The error object containing the error code.
+ * @param {number} error.code - The error code to check against known disconnected state codes.
+ * @returns {boolean} - Returns true if the error code is for a disconnected state, otherwise false.
+ */
+const zeroXKeyIsDisconnected = (error) => {
+    const { WALLET_NOT_FOUND, ORG_NOT_FOUND } = ZEROXKEY_ERROR_CODE;
+    return [WALLET_NOT_FOUND, ORG_NOT_FOUND].includes(error.code);
+};
+
+export { signMessage, signTransaction, unwrapActivityResult, zeroXKeyIsDisconnected };
+//# sourceMappingURL=0xkey.mjs.map

package/dist/0xkey.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"0xkey.mjs","sources":["../src/0xkey.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;SAcgB,oBAAoB,CAGlC,gBAAmB,EACnB,EAAE,YAAY,EAA4B,EAAA;AAE1C,IAAA,MAAM,EAAE,QAAQ,EAAE,GAAG,gBAAgB;AAErC,IAAA,QAAQ,QAAQ,CAAC,MAAM;QACrB,KAAK,kCAAkC,EAAE;AACvC,YAAA,MAAM,kBAAkB;QAC1B;QACA,KAAK,2BAA2B,EAAE;AAChC,YAAA,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM;AAC9B,YAAA,IAAI,MAAM,KAAK,SAAS,EAAE;AACxB,gBAAA,MAAM,8BAA8B;YACtC;AACA,YAAA,OAAO,MAAM;QACf;QACA,SAAS;AACP,YAAA,MAAM,YAAY;QACpB;;AAEJ;AAEO,eAAe,WAAW,CAAC,EAChC,MAAM,EACN,OAAO,EACP,cAAc,EACd,QAAQ,GAMT,EAAA;AACC,IAAA,IAAI,gBAAgB;AAEpB,IAAA,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE;AACxB,QAAA,gBAAgB,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC;AAC7C,YAAA,IAAI,EAAE,mCAAmC;YACzC,cAAc;AACd,YAAA,UAAU,EAAE;gBACV,QAAQ;AACR,gBAAA,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC;AACrB,gBAAA,QAAQ,EAAE,8BAA8B;AACxC,gBAAA,YAAY,EAAE,qBAAqB;AACpC,aAAA;YACD,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;AAChC,SAAA,CAAC;IACJ;SAAO;AACL,QAAA,gBAAgB,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC;YAC7C,QAAQ;AACR,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,QAAQ,EAAE,8BAA8B;AACxC,YAAA,YAAY,EAAE,qBAAqB;AACpC,SAAA,CAAC;IACJ;IAEA,MAAM,EAAE,oBAAoB,EAAE,SAAS,EAAE,GACvC,oBAAoB,CAClB,gBAAuB,qGACvB;AACE,QAAA,YAAY,EAAE,uBAAuB;AACtC,KAAA,CACF;IAEH,IAAI,CAAC,SAAS,EAAE;;AAEd,QAAA,MAAM,uBAAuB;IAC/B;AAEA,IAAA,OAAO,cAAc,CAAC;AACpB,QAAA,CAAC,EAAE,CAAA,EAAA,EAAK,SAAS,CAAC,CAAC,CAAA,CAAE;AACrB,QAAA,CAAC,EAAE,CAAA,EAAA,EAAK,SAAS,CAAC,CAAC,CAAA,CAAE;QACrB,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,GAAG;AAC7B,KAAA,CAAC;AACJ;AAEO,eAAe,eAAe,CAAC,EACpC,MAAM,EACN,mBAAmB,EACnB,cAAc,EACd,QAAQ,GAMT,EAAA;AACC,IAAA,IAAI,gBAAgB;AAEpB,IAAA,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE;AACxB,QAAA,gBAAgB,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC;AAC9C,YAAA,IAAI,EAAE,mCAAmC;AACzC,YAAA,cAAc,EAAE,cAAc;AAC9B,YAAA,UAAU,EAAE;gBACV,QAAQ;AACR,gBAAA,IAAI,EAAE,2BAA2B;AACjC,gBAAA,mBAAmB,EAAE,mBAAmB;AACzC,aAAA;YACD,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;AAChC,SAAA,CAAC;IACJ;SAAO;AACL,QAAA,gBAAgB,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC;YAC9C,QAAQ;AACR,YAAA,IAAI,EAAE,2BAA2B;AACjC,YAAA,mBAAmB,EAAE,mBAAmB;AACzC,SAAA,CAAC;IACJ;IAEA,MAAM,EAAE,qBAAqB,EAAE,GAC7B,oBAAoB,CAClB,gBAAuB,qGACvB;AACE,QAAA,YAAY,EAAE,2BAA2B;AAC1C,KAAA,CACF;IAEH,IAAI,CAAC,qBAAqB,EAAE;;AAE1B,QAAA,MAAM,2BAA2B;IACnC;IAEA,OAAO,qBAAqB,CAAC,iBAAiB;AAChD;AAEA;;;;;;;;;;AAUG;AACI,MAAM,sBAAsB,GAAG,CAAC,KAAuB,KAAI;AAChE,IAAA,MAAM,EAAE,gBAAgB,EAAE,aAAa,EAAE,GAAG,mBAAmB;AAE/D,IAAA,OAAO,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;AAC/D;;;;"}

package/dist/constants.d.ts

@@ -0,0 +1,20 @@
+export declare const PROVIDER_ERROR_MESSAGE: {
+    BLOCK_EXPLORER_URL: string;
+    INVALID_CHAIN_ID_HEX: string;
+    INVALID_CHAIN_ID_VALUE: string;
+    NATIVE_CURRENCY_SYMBOL_LENGTH: string;
+    NATIVE_CURRENCY_SYMBOL_MISMATCH: string;
+    INVALID_RPC_URL: string;
+    UNRECOGNIZED_CHAIN_ID: string;
+    CHAIN_ID_RPC_MISMATCH: string;
+    PROVIDER_DISCONNECTED: string;
+    RPC_URLS_REQUIRED: string;
+};
+export declare const PROVIDER_ERROR_CODE: {
+    ADD_ETHEREUM_CHAIN: number;
+};
+export declare const ZEROXKEY_ERROR_CODE: {
+    WALLET_NOT_FOUND: number;
+    ORG_NOT_FOUND: number;
+};
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sBAAsB;;;;;;;;;;;CAmBlC,CAAC;AAEF,eAAO,MAAM,mBAAmB;;CAE/B,CAAC;AAEF,eAAO,MAAM,mBAAmB;;;CAG/B,CAAC"}

package/dist/constants.js

@@ -0,0 +1,25 @@
+'use strict';
+
+const PROVIDER_ERROR_MESSAGE = {
+    BLOCK_EXPLORER_URL: "Expected null or array with at least one valid string HTTPS URL 'blockExplorerUrl'. Received: ",
+    INVALID_CHAIN_ID_HEX: "Expected 0x-prefixed, unpadded, non-zero hexadecimal string 'chainId'. Received: ",
+    INVALID_CHAIN_ID_VALUE: "Expected numerical value greater than max safe value. Received: ",
+    NATIVE_CURRENCY_SYMBOL_LENGTH: "Expected 2-6 character string 'nativeCurrency.symbol'. Received: ",
+    NATIVE_CURRENCY_SYMBOL_MISMATCH: "nativeCurrency.symbol does not match currency symbol for a network the user already has added with the same chainId. Received: ",
+    INVALID_RPC_URL: "rpcUrls field is required and must contain at least one valid HTTP/HTTPS URL",
+    UNRECOGNIZED_CHAIN_ID: "Unrecognized chain ID. Try adding the chain using wallet_addEthereumChain first. Received: ",
+    CHAIN_ID_RPC_MISMATCH: "Chain ID does not match the RPC endpoint. Provider Chain ID: ",
+    RPC_URLS_REQUIRED: "rpcUrls field is required and cannot be empty",
+};
+const PROVIDER_ERROR_CODE = {
+    ADD_ETHEREUM_CHAIN: -32602,
+};
+const ZEROXKEY_ERROR_CODE = {
+    WALLET_NOT_FOUND: 5,
+    ORG_NOT_FOUND: 3,
+};
+
+exports.PROVIDER_ERROR_CODE = PROVIDER_ERROR_CODE;
+exports.PROVIDER_ERROR_MESSAGE = PROVIDER_ERROR_MESSAGE;
+exports.ZEROXKEY_ERROR_CODE = ZEROXKEY_ERROR_CODE;
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sources":["../src/constants.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAO,MAAM,sBAAsB,GAAG;AACpC,IAAA,kBAAkB,EAChB,gGAAgG;AAClG,IAAA,oBAAoB,EAClB,mFAAmF;AACrF,IAAA,sBAAsB,EACpB,kEAAkE;AACpE,IAAA,6BAA6B,EAC3B,mEAAmE;AACrE,IAAA,+BAA+B,EAC7B,iIAAiI;AACnI,IAAA,eAAe,EACb,8EAA8E;AAChF,IAAA,qBAAqB,EACnB,6FAA6F;AAC/F,IAAA,qBAAqB,EACnB,+DAA+D;AACjE,IACA,iBAAiB,EAAE,+CAA+C;;AAG7D,MAAM,mBAAmB,GAAG;IACjC,kBAAkB,EAAE,MAAM;;AAGrB,MAAM,mBAAmB,GAAG;AACjC,IAAA,gBAAgB,EAAE,CAAC;AACnB,IAAA,aAAa,EAAE,CAAC;;;;;;;"}