@0xkey-io/wallet-stamper 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# @0xkey-io/wallet-stamper
+
+## 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,232 @@
+# ZeroXKey Wallet Stamper
+
+The `@0xkey-io/wallet-stamper` package provides a mechanism to stamp requests using a wallet public key and signature. This package supports both Solana and Ethereum wallets, allowing for seamless integration with various blockchain applications.
+
+## Installation
+
+Before you start using the ZeroXKey Wallet Stamper, 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, Yarn, or PNPM:
+
+```bash
+npm install @0xkey-io/wallet-stamper @0xkey-io/http
+```
+
+## Usage
+
+### Prerequisites
+
+#### Add Wallet Public Key as Authenticator
+
+To use the wallet stamper, you must add the user's wallet public key as an API key authenticator.
+This can be achieved either by creating a sub-organization activity or by generating a new API key and passing in the wallet's public key.
+
+The API key stamper is necessary because we need to use the parent organization's API key to add the authenticator initially.
+Once this is done, the wallet can stamp activity requests independently without needing the parent organization's API private and public keys.
+
+Below are the steps to add a Solana public key as a wallet authenticator:
+
+```typescript
+const apiKeyStamper = new ApiKeyStamper({
+  apiPublicKey: process.env.API_PUBLIC_KEY ?? "",
+  apiPrivateKey: process.env.API_PRIVATE_KEY ?? "",
+});
+
+const client = new ZeroXKeyClient({ baseUrl: BASE_URL }, apiKeyStamper);
+
+const activityPoller = createActivityPoller({
+  client,
+  requestFn: client.createApiKeys,
+});
+
+// See "Example: Signing with a Solana Wallet" below for how to implement the SolanaWallet interface
+const mockWallet = new MockSolanaWallet();
+
+// This is the public key of the wallet that will be added as an API key and used to stamp future requests
+const publicKey = mockWallet.recoverPublicKey();
+
+// The userId of the user that we will add the wallet public key as an authenticator
+const userId = "f4a5e6b4-3b9c-4f69-b7f6-9c2f456a4d23";
+
+// We set the curve type to 'API_KEY_CURVE_ED25519' for solana wallets
+// If using an Ethereum wallet, set the curve type to 'API_KEY_CURVE_SECP256K1'
+const curveType = "API_KEY_CURVE_ED25519";
+
+const result = activityPoller({
+  type: "ACTIVITY_TYPE_CREATE_API_KEYS_V2",
+  timestampMs: new Date().getTime().toString(),
+  organizationId: "acd0bc97-2af5-475b-bc34-0fa7ca3bdc75",
+  parameters: {
+    apiKeys: [
+      {
+        apiKeyName: "solana-wallet",
+        publicKey,
+        curveType,
+      },
+    ],
+    userId,
+  },
+});
+```
+
+#### Using the Wallet Stamper
+
+To use the `@0xkey-io/wallet-stamper` package, follow these steps:
+
+1. **Choose Your Wallet Type**: Decide whether you will use an EVM-based wallet (e.g., Ethereum) or a Solana-based wallet.
+
+2. **Implement the Wallet Interface**: Depending on your chosen blockchain, implement the wallet interface. This involves creating methods to sign messages and recover public keys.
+
+> Note: We've provided a default implementation for Ethereum wallets via the `EthereumWallet` class. For custom implementations, you may implement the `WalletInterface` yourself.
+
+3. **Instantiate the WalletStamper**: Create an instance of the `WalletStamper` using the wallet interface.
+
+4. **Instantiate the ZeroXKeyClient**: Create an instance of the `ZeroXKeyClient` with the `WalletStamper` instance.
+
+5. **Stamp Requests**: Now when making request using the `ZeroXKeyClient`, the wallet stamper will automatically stamp the request with the user's wallet public key and signature.
+
+### Example: Signing with a Solana Wallet
+
+In this example, we are using a local Solana wallet.
+For information on using an injected Solana wallet such as Solflare, please refer to the [`with-wallet-stamper`](../../examples/with-wallet-stamper) example.
+
+```typescript
+import { Keypair } from "@solana/web3.js";
+import { decodeUTF8 } from "tweetnacl-util";
+import nacl from "tweetnacl";
+import { ZeroXKeyClient } from "@0xkey-io/http";
+import { WalletStamper, SolanaWalletInterface } from "@0xkey-io/wallet-stamper";
+
+class SolanaWallet implements SolanaWalletInterface {
+  keypair = Keypair.fromSecretKey(SOLANA_PRIVATE_KEY);
+  type = "solana" as const;
+
+  async signMessage(message: string): Promise<string> {
+    const messageBytes = decodeUTF8(message);
+    const signature = nacl.sign.detached(messageBytes, this.keypair.secretKey);
+    return Buffer.from(signature).toString("hex");
+  }
+
+  async getPublicKey(): Promise<string> {
+    // Convert the base24 encoded Solana wallet public key (the one displayed in the wallet)
+    // into the ed25519 decoded public key
+    const ed25519PublicKey = Buffer.from(
+      this.keypair.publicKey.toBuffer(),
+    ).toString("hex");
+    return ed25519PublicKey;
+  }
+}
+
+// Instantiate the WalletStamper with the SolanaWallet
+const walletStamper = new WalletStamper(new SolanaWallet());
+
+// Instantiate the ZeroXKeyClient with the WalletStamper
+const client = new ZeroXKeyClient({ baseUrl: BASE_URL }, walletStamper);
+
+// Call getWhoami to get the sub org's organizationId and userId passing in the parent org id
+// whoami { organizationId: string; organizationName: string; userId: string; username: string; }
+const whoami = await client.getWhoami({
+  organizationId: process.env.NEXT_PUBLIC_ORGANIZATION_ID,
+});
+
+// Now that we have the sub organization id, we can make requests using that sub org id
+
+// Get the wallets for this sub organization
+const wallets = await client.getWallets({
+  organizationId: whoami.organizationId,
+});
+```
+
+### Example: Signing with an Ethereum Wallet
+
+The main distinction between signing with an Ethereum Wallet and a Solana Wallet lies in how the public key is obtained.
+For Solana, the public key can be directly derived from the wallet.
+In contrast, with Ethereum, the secp256k1 public key isn't directly accessible.
+Instead, you need to first obtain a signature from the user and then recover the public key from that signature.
+
+```typescript
+import {
+  createWalletClient,
+  custom,
+  recoverPublicKey,
+  hashMessage,
+} from "viem";
+import { privateKeyToAccount } from "viem/accounts";
+import { mainnet } from "viem/chains";
+
+import { WalletStamper, EthereumWallet } from "@0xkey-io/wallet-stamper";
+
+// Instantiate the WalletStamper with the EthereumWallet
+const walletStamper = new WalletStamper(new EthereumWallet());
+
+// Instantiate the ZeroXKeyClient with the WalletStamper
+const client = new ZeroXKeyClient({ baseUrl: BASE_URL }, walletStamper);
+
+// Call getWhoami to get the sub-org's organizationId and userId passing in the parent org id
+// whoami { organizationId: string; organizationName: string; userId: string; username: string; }
+const whoami = await client.getWhoami({
+  organizationId: process.env.ORGANIZATION_ID,
+});
+
+let subOrganizationId = whoami?.organizationId;
+
+// User does not yet have a sub-organization, so we need to create one
+if (!subOrganizationId) {
+  // We'll need to use the parent org's API keys to create the sub-org on behalf of the user
+  const { ApiKeyStamper } = await import("@0xkey-io/api-key-stamper");
+
+  // Instantiate the ZeroXKeyClient with the ApiKeyStamper
+  const parentOrgClient = new ZeroXKeyClient(
+    { baseUrl: BASE_URL },
+    new ApiKeyStamper({
+      // In practice we'll want to ensure these keys do not get exposed to the client
+      apiPublicKey: process.env.API_PUBLIC_KEY ?? "",
+      apiPrivateKey: process.env.API_PRIVATE_KEY ?? "",
+    }),
+  );
+
+  const apiKeys = [
+    {
+      apiKeyName: "Wallet Auth - Embedded Wallet",
+      // The public key of the wallet that will be added as an API key and used to stamp future requests
+      publicKey,
+      // We set the curve type to 'API_KEY_CURVE_ED25519' for solana wallets
+      // If using an Ethereum wallet, set the curve type to 'API_KEY_CURVE_SECP256K1'
+      curveType,
+    },
+  ];
+
+  const subOrg = await parentOrgClient.createSubOrganization({
+    organizationId: process.env.ORGANIZATION_ID,
+    subOrganizationName: `Sub Org - ${publicKey}`,
+    rootUsers: [
+      {
+        // Replace with user provided values
+        userName: "New User",
+        userEmail: "wallet@domain.com",
+        apiKeys,
+      },
+    ],
+    rootQuorumThreshold: 1,
+    wallet: {
+      walletName: "Default Wallet",
+      accounts: DEFAULT_ETHEREUM_ACCOUNTS,
+    },
+  });
+
+  subOrganizationId = subOrg.subOrganizationId;
+}
+
+// Get the wallets for this sub-organization
+const wallets = await client.getWallets({
+  organizationId: subOrganizationId,
+});
+```
+
+## Contributing
+
+Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
+
+## License
+
+The `@0xkey-io/wallet-stamper` package is licensed under the [MIT License](LICENSE).

package/dist/_kernel/stamping.d.ts

@@ -0,0 +1,6 @@
+export declare const STAMP_HEADER_API_KEY = "X-Stamp";
+export declare function createStampResult<N extends string>(stampHeaderName: N, stampHeaderValue: string): {
+    stampHeaderName: N;
+    stampHeaderValue: string;
+};
+//# sourceMappingURL=stamping.d.ts.map

package/dist/_kernel/stamping.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stamping.d.ts","sourceRoot":"","sources":["../../src/_kernel/stamping.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,oBAAoB,YAAY,CAAC;AAE9C,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,MAAM,EAChD,eAAe,EAAE,CAAC,EAClB,gBAAgB,EAAE,MAAM,GACvB;IAAE,eAAe,EAAE,CAAC,CAAC;IAAC,gBAAgB,EAAE,MAAM,CAAA;CAAE,CAElD"}

package/dist/_kernel/stamping.js

@@ -0,0 +1,10 @@
+'use strict';
+
+const STAMP_HEADER_API_KEY = "X-Stamp";
+function createStampResult(stampHeaderName, stampHeaderValue) {
+    return { stampHeaderName, stampHeaderValue };
+}
+
+exports.STAMP_HEADER_API_KEY = STAMP_HEADER_API_KEY;
+exports.createStampResult = createStampResult;
+//# sourceMappingURL=stamping.js.map

package/dist/_kernel/stamping.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stamping.js","sources":["../../src/_kernel/stamping.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAO,MAAM,oBAAoB,GAAG;AAE9B,SAAU,iBAAiB,CAC/B,eAAkB,EAClB,gBAAwB,EAAA;AAExB,IAAA,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE;AAC9C;;;;;"}

package/dist/_kernel/stamping.mjs

@@ -0,0 +1,7 @@
+const STAMP_HEADER_API_KEY = "X-Stamp";
+function createStampResult(stampHeaderName, stampHeaderValue) {
+    return { stampHeaderName, stampHeaderValue };
+}
+
+export { STAMP_HEADER_API_KEY, createStampResult };
+//# sourceMappingURL=stamping.mjs.map

package/dist/_kernel/stamping.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"stamping.mjs","sources":["../../src/_kernel/stamping.ts"],"sourcesContent":[null],"names":[],"mappings":"AAAO,MAAM,oBAAoB,GAAG;AAE9B,SAAU,iBAAiB,CAC/B,eAAkB,EAClB,gBAAwB,EAAA;AAExB,IAAA,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE;AAC9C;;;;"}

package/dist/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191 = "SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191";
+export declare const SIGNATURE_SCHEME_TK_API_ED25519 = "SIGNATURE_SCHEME_TK_API_ED25519";
+export { STAMP_HEADER_API_KEY as STAMP_HEADER_NAME } from "./_kernel/stamping";
+//# 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,wCAAwC,6CACT,CAAC;AAC7C,eAAO,MAAM,+BAA+B,oCACT,CAAC;AAEpC,OAAO,EAAE,oBAAoB,IAAI,iBAAiB,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/constants.js

@@ -0,0 +1,8 @@
+'use strict';
+
+const SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191 = "SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191";
+const SIGNATURE_SCHEME_TK_API_ED25519 = "SIGNATURE_SCHEME_TK_API_ED25519";
+
+exports.SIGNATURE_SCHEME_TK_API_ED25519 = SIGNATURE_SCHEME_TK_API_ED25519;
+exports.SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191 = SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191;
+//# 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,wCAAwC,GACnD;AACK,MAAM,+BAA+B,GAC1C;;;;;"}

package/dist/constants.mjs

@@ -0,0 +1,5 @@
+const SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191 = "SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191";
+const SIGNATURE_SCHEME_TK_API_ED25519 = "SIGNATURE_SCHEME_TK_API_ED25519";
+
+export { SIGNATURE_SCHEME_TK_API_ED25519, SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191 };
+//# sourceMappingURL=constants.mjs.map

package/dist/constants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.mjs","sources":["../src/constants.ts"],"sourcesContent":[null],"names":[],"mappings":"AAAO,MAAM,wCAAwC,GACnD;AACK,MAAM,+BAA+B,GAC1C;;;;"}

package/dist/errors.d.ts

@@ -0,0 +1,5 @@
+export declare class WalletStamperError extends Error {
+    originalError: any;
+    constructor(message: string, originalError?: any);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,kBAAmB,SAAQ,KAAK;IAGlC,aAAa,EAAE,GAAG;gBADzB,OAAO,EAAE,MAAM,EACR,aAAa,GAAE,GAAU;CAOnC"}

package/dist/errors.js

@@ -0,0 +1,12 @@
+'use strict';
+
+class WalletStamperError extends Error {
+    constructor(message, originalError = null) {
+        super(`${message}${originalError ? ` - error: ${originalError.message}` : ""}`);
+        this.originalError = originalError;
+        this.name = "WalletStamperError";
+    }
+}
+
+exports.WalletStamperError = WalletStamperError;
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sources":["../src/errors.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAM,MAAO,kBAAmB,SAAQ,KAAK,CAAA;IAC3C,WAAA,CACE,OAAe,EACR,aAAA,GAAqB,IAAI,EAAA;AAEhC,QAAA,KAAK,CACH,CAAA,EAAG,OAAO,GAAG,aAAa,GAAG,CAAA,UAAA,EAAa,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,CAAA,CAAE,CACzE;QAJM,IAAA,CAAA,aAAa,GAAb,aAAa;AAKpB,QAAA,IAAI,CAAC,IAAI,GAAG,oBAAoB;IAClC;AACD;;;;"}

package/dist/errors.mjs

@@ -0,0 +1,10 @@
+class WalletStamperError extends Error {
+    constructor(message, originalError = null) {
+        super(`${message}${originalError ? ` - error: ${originalError.message}` : ""}`);
+        this.originalError = originalError;
+        this.name = "WalletStamperError";
+    }
+}
+
+export { WalletStamperError };
+//# sourceMappingURL=errors.mjs.map

package/dist/errors.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.mjs","sources":["../src/errors.ts"],"sourcesContent":[null],"names":[],"mappings":"AAAM,MAAO,kBAAmB,SAAQ,KAAK,CAAA;IAC3C,WAAA,CACE,OAAe,EACR,aAAA,GAAqB,IAAI,EAAA;AAEhC,QAAA,KAAK,CACH,CAAA,EAAG,OAAO,GAAG,aAAa,GAAG,CAAA,UAAA,EAAa,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,CAAA,CAAE,CACzE;QAJM,IAAA,CAAA,aAAa,GAAb,aAAa;AAKpB,QAAA,IAAI,CAAC,IAAI,GAAG,oBAAoB;IAClC;AACD;;;;"}

package/dist/ethereum.d.ts

@@ -0,0 +1,71 @@
+import { EthereumWalletInterface, WalletType } from "./types";
+import { Hex } from "viem";
+import "viem/window";
+/**
+ * Abstract class representing a base Ethereum wallet.
+ * This class is used for stamping requests with an Ethereum wallet.
+ *
+ * To use this class, extend it and implement the `signMessage` method
+ * to provide a custom signing function. The `signMessage` method should
+ * return a promise that resolves to a hexadecimal string representing
+ * the signature of the provided message.
+ */
+export declare abstract class BaseEthereumWallet implements EthereumWalletInterface {
+    type: WalletType.Ethereum;
+    /**
+     * Abstract method to sign a message.
+     * Must be implemented by subclasses to provide a custom signing function.
+     *
+     * @param message - The message to be signed, either as a string or a Hex.
+     * @returns A promise that resolves to a Hex string representing the signature.
+     */
+    abstract signMessage(message: string | Hex): Promise<Hex>;
+    /**
+     * Retrieves the public key associated with the wallet.
+     *
+     * @returns A promise that resolves to a string representing the compressed public key.
+     */
+    getPublicKey(): Promise<string>;
+}
+/**
+ * EthereumWallet class extends the BaseEthereumWallet to provide
+ * specific implementations for Ethereum-based wallets.
+ *
+ * This class is responsible for signing messages using the Ethereum
+ * provider available in the browser (e.g., MetaMask). It interacts
+ * with the Ethereum provider to request account access and sign
+ * messages.
+ */
+export declare class EthereumWallet extends BaseEthereumWallet {
+    /**
+     * Signs a message using the Ethereum provider.
+     *
+     * @param message - The message to be signed, either as a string or a Hex.
+     * @returns A promise that resolves to a Hex string representing the signature.
+     *
+     * This method uses the 'personal_sign' method of the Ethereum provider
+     * to sign the message with the user's account.
+     */
+    signMessage(message: string | Hex): Promise<`0x${string}`>;
+    /**
+     * Retrieves the Ethereum provider from the window object.
+     *
+     * @returns The EIP1193Provider instance.
+     *
+     * This method checks if the Ethereum provider is available in the
+     * window object and throws an error if not found.
+     */
+    private getProvider;
+    /**
+     * Requests the user's Ethereum account from the provider.
+     *
+     * @returns A promise that resolves to the user's Ethereum address.
+     *
+     * This method uses the 'eth_requestAccounts' method of the Ethereum
+     * provider to request access to the user's account. It throws an error
+     * if no account is connected.
+     */
+    private getAccount;
+}
+export declare const getCompressedPublicKey: (signature: Hex, message: string) => Promise<string>;
+//# sourceMappingURL=ethereum.d.ts.map

package/dist/ethereum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ethereum.d.ts","sourceRoot":"","sources":["../src/ethereum.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAC9D,OAAO,EAGL,GAAG,EAGJ,MAAM,MAAM,CAAC;AACd,OAAO,aAAa,CAAC;AAKrB;;;;;;;;GAQG;AACH,8BAAsB,kBAAmB,YAAW,uBAAuB;IACzE,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAuB;IAEhD;;;;;;OAMG;IACH,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAEzD;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC;CAKtC;AAED;;;;;;;;GAQG;AACH,qBAAa,cAAe,SAAQ,kBAAkB;IACpD;;;;;;;;OAQG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG;IAWvC;;;;;;;OAOG;IACH,OAAO,CAAC,WAAW;IAQnB;;;;;;;;OAQG;YACW,UAAU;CAazB;AAED,eAAO,MAAM,sBAAsB,cACtB,GAAG,WACL,MAAM,oBAShB,CAAC"}

package/dist/ethereum.js

@@ -0,0 +1,107 @@
+'use strict';
+
+var types = require('./types.js');
+var viem = require('viem');
+require('viem/window');
+var errors = require('./errors.js');
+var crypto = require('@0xkey-io/crypto');
+
+/**
+ * Abstract class representing a base Ethereum wallet.
+ * This class is used for stamping requests with an Ethereum wallet.
+ *
+ * To use this class, extend it and implement the `signMessage` method
+ * to provide a custom signing function. The `signMessage` method should
+ * return a promise that resolves to a hexadecimal string representing
+ * the signature of the provided message.
+ */
+class BaseEthereumWallet {
+    constructor() {
+        this.type = types.WalletType.Ethereum;
+    }
+    /**
+     * Retrieves the public key associated with the wallet.
+     *
+     * @returns A promise that resolves to a string representing the compressed public key.
+     */
+    async getPublicKey() {
+        const message = "GET_PUBLIC_KEY";
+        const signature = await this.signMessage(message);
+        return getCompressedPublicKey(signature, message);
+    }
+}
+/**
+ * EthereumWallet class extends the BaseEthereumWallet to provide
+ * specific implementations for Ethereum-based wallets.
+ *
+ * This class is responsible for signing messages using the Ethereum
+ * provider available in the browser (e.g., MetaMask). It interacts
+ * with the Ethereum provider to request account access and sign
+ * messages.
+ */
+class EthereumWallet extends BaseEthereumWallet {
+    /**
+     * Signs a message using the Ethereum provider.
+     *
+     * @param message - The message to be signed, either as a string or a Hex.
+     * @returns A promise that resolves to a Hex string representing the signature.
+     *
+     * This method uses the 'personal_sign' method of the Ethereum provider
+     * to sign the message with the user's account.
+     */
+    async signMessage(message) {
+        const account = await this.getAccount();
+        const signature = await this.getProvider().request({
+            method: "personal_sign",
+            params: [message, account],
+        });
+        return signature;
+    }
+    /**
+     * Retrieves the Ethereum provider from the window object.
+     *
+     * @returns The EIP1193Provider instance.
+     *
+     * This method checks if the Ethereum provider is available in the
+     * window object and throws an error if not found.
+     */
+    getProvider() {
+        if (!window?.ethereum) {
+            throw new errors.WalletStamperError("No ethereum provider found");
+        }
+        return window.ethereum;
+    }
+    /**
+     * Requests the user's Ethereum account from the provider.
+     *
+     * @returns A promise that resolves to the user's Ethereum address.
+     *
+     * This method uses the 'eth_requestAccounts' method of the Ethereum
+     * provider to request access to the user's account. It throws an error
+     * if no account is connected.
+     */
+    async getAccount() {
+        const provider = this.getProvider();
+        const [connectedAccount] = await provider.request({
+            method: "eth_requestAccounts",
+        });
+        if (!connectedAccount) {
+            throw new errors.WalletStamperError("No connected account found");
+        }
+        return connectedAccount;
+    }
+}
+const getCompressedPublicKey = async (signature, message) => {
+    const secp256k1PublicKey = await viem.recoverPublicKey({
+        hash: viem.hashMessage(message),
+        signature: signature,
+    });
+    const publicKey = secp256k1PublicKey.replace("0x", "");
+    const publicKeyBytes = Uint8Array.from(Buffer.from(publicKey, "hex"));
+    return Buffer.from(crypto.compressRawPublicKey(publicKeyBytes)).toString("hex");
+};
+
+exports.BaseEthereumWallet = BaseEthereumWallet;
+exports.EthereumWallet = EthereumWallet;
+exports.getCompressedPublicKey = getCompressedPublicKey;
+//# sourceMappingURL=ethereum.js.map

package/dist/ethereum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ethereum.js","sources":["../src/ethereum.ts"],"sourcesContent":[null],"names":["WalletType","WalletStamperError","recoverPublicKey","hashMessage","compressRawPublicKey"],"mappings":";;;;;;;;AAaA;;;;;;;;AAQG;MACmB,kBAAkB,CAAA;AAAxC,IAAA,WAAA,GAAA;AACE,QAAA,IAAA,CAAA,IAAI,GAAwBA,gBAAU,CAAC,QAAQ;IAqBjD;AAVE;;;;AAIG;AACH,IAAA,MAAM,YAAY,GAAA;QAChB,MAAM,OAAO,GAAG,gBAAgB;QAChC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;AACjD,QAAA,OAAO,sBAAsB,CAAC,SAAS,EAAE,OAAO,CAAC;IACnD;AACD;AAED;;;;;;;;AAQG;AACG,MAAO,cAAe,SAAQ,kBAAkB,CAAA;AACpD;;;;;;;;AAQG;IACH,MAAM,WAAW,CAAC,OAAqB,EAAA;AACrC,QAAA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE;QAEvC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC;AACjD,YAAA,MAAM,EAAE,eAAwB;AAChC,YAAA,MAAM,EAAE,CAAC,OAAc,EAAE,OAAO,CAAC;AAClC,SAAA,CAAC;AAEF,QAAA,OAAO,SAAS;IAClB;AAEA;;;;;;;AAOG;IACK,WAAW,GAAA;AACjB,QAAA,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE;AACrB,YAAA,MAAM,IAAIC,yBAAkB,CAAC,4BAA4B,CAAC;QAC5D;QAEA,OAAO,MAAM,CAAC,QAAQ;IACxB;AAEA;;;;;;;;AAQG;AACK,IAAA,MAAM,UAAU,GAAA;AACtB,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE;QAEnC,MAAM,CAAC,gBAAgB,CAAC,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC;AAChD,YAAA,MAAM,EAAE,qBAAqB;AAC9B,SAAA,CAAC;QAEF,IAAI,CAAC,gBAAgB,EAAE;AACrB,YAAA,MAAM,IAAIA,yBAAkB,CAAC,4BAA4B,CAAC;QAC5D;AAEA,QAAA,OAAO,gBAAgB;IACzB;AACD;AAEM,MAAM,sBAAsB,GAAG,OACpC,SAAc,EACd,OAAe,KACb;AACF,IAAA,MAAM,kBAAkB,GAAG,MAAMC,qBAAgB,CAAC;AAChD,QAAA,IAAI,EAAEC,gBAAW,CAAC,OAAO,CAAC;AAC1B,QAAA,SAAS,EAAE,SAAgB;AAC5B,KAAA,CAAC;IACF,MAAM,SAAS,GAAG,kBAAkB,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;AACtD,IAAA,MAAM,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;AACrE,IAAA,OAAO,MAAM,CAAC,IAAI,CAACC,2BAAoB,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;AAC1E;;;;;;"}

package/dist/ethereum.mjs

@@ -0,0 +1,103 @@
+import { WalletType } from './types.mjs';
+import { recoverPublicKey, hashMessage } from 'viem';
+import 'viem/window';
+import { WalletStamperError } from './errors.mjs';
+import { compressRawPublicKey } from '@0xkey-io/crypto';
+
+/**
+ * Abstract class representing a base Ethereum wallet.
+ * This class is used for stamping requests with an Ethereum wallet.
+ *
+ * To use this class, extend it and implement the `signMessage` method
+ * to provide a custom signing function. The `signMessage` method should
+ * return a promise that resolves to a hexadecimal string representing
+ * the signature of the provided message.
+ */
+class BaseEthereumWallet {
+    constructor() {
+        this.type = WalletType.Ethereum;
+    }
+    /**
+     * Retrieves the public key associated with the wallet.
+     *
+     * @returns A promise that resolves to a string representing the compressed public key.
+     */
+    async getPublicKey() {
+        const message = "GET_PUBLIC_KEY";
+        const signature = await this.signMessage(message);
+        return getCompressedPublicKey(signature, message);
+    }
+}
+/**
+ * EthereumWallet class extends the BaseEthereumWallet to provide
+ * specific implementations for Ethereum-based wallets.
+ *
+ * This class is responsible for signing messages using the Ethereum
+ * provider available in the browser (e.g., MetaMask). It interacts
+ * with the Ethereum provider to request account access and sign
+ * messages.
+ */
+class EthereumWallet extends BaseEthereumWallet {
+    /**
+     * Signs a message using the Ethereum provider.
+     *
+     * @param message - The message to be signed, either as a string or a Hex.
+     * @returns A promise that resolves to a Hex string representing the signature.
+     *
+     * This method uses the 'personal_sign' method of the Ethereum provider
+     * to sign the message with the user's account.
+     */
+    async signMessage(message) {
+        const account = await this.getAccount();
+        const signature = await this.getProvider().request({
+            method: "personal_sign",
+            params: [message, account],
+        });
+        return signature;
+    }
+    /**
+     * Retrieves the Ethereum provider from the window object.
+     *
+     * @returns The EIP1193Provider instance.
+     *
+     * This method checks if the Ethereum provider is available in the
+     * window object and throws an error if not found.
+     */
+    getProvider() {
+        if (!window?.ethereum) {
+            throw new WalletStamperError("No ethereum provider found");
+        }
+        return window.ethereum;
+    }
+    /**
+     * Requests the user's Ethereum account from the provider.
+     *
+     * @returns A promise that resolves to the user's Ethereum address.
+     *
+     * This method uses the 'eth_requestAccounts' method of the Ethereum
+     * provider to request access to the user's account. It throws an error
+     * if no account is connected.
+     */
+    async getAccount() {
+        const provider = this.getProvider();
+        const [connectedAccount] = await provider.request({
+            method: "eth_requestAccounts",
+        });
+        if (!connectedAccount) {
+            throw new WalletStamperError("No connected account found");
+        }
+        return connectedAccount;
+    }
+}
+const getCompressedPublicKey = async (signature, message) => {
+    const secp256k1PublicKey = await recoverPublicKey({
+        hash: hashMessage(message),
+        signature: signature,
+    });
+    const publicKey = secp256k1PublicKey.replace("0x", "");
+    const publicKeyBytes = Uint8Array.from(Buffer.from(publicKey, "hex"));
+    return Buffer.from(compressRawPublicKey(publicKeyBytes)).toString("hex");
+};
+
+export { BaseEthereumWallet, EthereumWallet, getCompressedPublicKey };
+//# sourceMappingURL=ethereum.mjs.map

package/dist/ethereum.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ethereum.mjs","sources":["../src/ethereum.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AAaA;;;;;;;;AAQG;MACmB,kBAAkB,CAAA;AAAxC,IAAA,WAAA,GAAA;AACE,QAAA,IAAA,CAAA,IAAI,GAAwB,UAAU,CAAC,QAAQ;IAqBjD;AAVE;;;;AAIG;AACH,IAAA,MAAM,YAAY,GAAA;QAChB,MAAM,OAAO,GAAG,gBAAgB;QAChC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;AACjD,QAAA,OAAO,sBAAsB,CAAC,SAAS,EAAE,OAAO,CAAC;IACnD;AACD;AAED;;;;;;;;AAQG;AACG,MAAO,cAAe,SAAQ,kBAAkB,CAAA;AACpD;;;;;;;;AAQG;IACH,MAAM,WAAW,CAAC,OAAqB,EAAA;AACrC,QAAA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE;QAEvC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC;AACjD,YAAA,MAAM,EAAE,eAAwB;AAChC,YAAA,MAAM,EAAE,CAAC,OAAc,EAAE,OAAO,CAAC;AAClC,SAAA,CAAC;AAEF,QAAA,OAAO,SAAS;IAClB;AAEA;;;;;;;AAOG;IACK,WAAW,GAAA;AACjB,QAAA,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE;AACrB,YAAA,MAAM,IAAI,kBAAkB,CAAC,4BAA4B,CAAC;QAC5D;QAEA,OAAO,MAAM,CAAC,QAAQ;IACxB;AAEA;;;;;;;;AAQG;AACK,IAAA,MAAM,UAAU,GAAA;AACtB,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE;QAEnC,MAAM,CAAC,gBAAgB,CAAC,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC;AAChD,YAAA,MAAM,EAAE,qBAAqB;AAC9B,SAAA,CAAC;QAEF,IAAI,CAAC,gBAAgB,EAAE;AACrB,YAAA,MAAM,IAAI,kBAAkB,CAAC,4BAA4B,CAAC;QAC5D;AAEA,QAAA,OAAO,gBAAgB;IACzB;AACD;AAEM,MAAM,sBAAsB,GAAG,OACpC,SAAc,EACd,OAAe,KACb;AACF,IAAA,MAAM,kBAAkB,GAAG,MAAM,gBAAgB,CAAC;AAChD,QAAA,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;AAC1B,QAAA,SAAS,EAAE,SAAgB;AAC5B,KAAA,CAAC;IACF,MAAM,SAAS,GAAG,kBAAkB,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;AACtD,IAAA,MAAM,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;AACrE,IAAA,OAAO,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;AAC1E;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./constants";
+export * from "./errors";
+export * from "./types";
+export * from "./stamper";
+export * from "./ethereum";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,24 @@
+'use strict';
+
+var constants = require('./constants.js');
+var errors = require('./errors.js');
+var types = require('./types.js');
+var stamper = require('./stamper.js');
+var ethereum = require('./ethereum.js');
+var stamping = require('./_kernel/stamping.js');
+
+
+
+exports.SIGNATURE_SCHEME_TK_API_ED25519 = constants.SIGNATURE_SCHEME_TK_API_ED25519;
+exports.SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191 = constants.SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191;
+exports.WalletStamperError = errors.WalletStamperError;
+Object.defineProperty(exports, "WalletType", {
+	enumerable: true,
+	get: function () { return types.WalletType; }
+});
+exports.WalletStamper = stamper.WalletStamper;
+exports.BaseEthereumWallet = ethereum.BaseEthereumWallet;
+exports.EthereumWallet = ethereum.EthereumWallet;
+exports.getCompressedPublicKey = ethereum.getCompressedPublicKey;
+exports.STAMP_HEADER_NAME = stamping.STAMP_HEADER_API_KEY;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.mjs

@@ -0,0 +1,7 @@
+export { SIGNATURE_SCHEME_TK_API_ED25519, SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191 } from './constants.mjs';
+export { WalletStamperError } from './errors.mjs';
+export { WalletType } from './types.mjs';
+export { WalletStamper } from './stamper.mjs';
+export { BaseEthereumWallet, EthereumWallet, getCompressedPublicKey } from './ethereum.mjs';
+export { STAMP_HEADER_API_KEY as STAMP_HEADER_NAME } from './_kernel/stamping.mjs';
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}

package/dist/stamper.d.ts

@@ -0,0 +1,7 @@
+import { type TStamper, type WalletInterface, type TStamp } from "./types";
+export declare class WalletStamper implements TStamper {
+    private wallet;
+    constructor(wallet: WalletInterface);
+    stamp(payload: string): Promise<TStamp>;
+}
+//# sourceMappingURL=stamper.d.ts.map

package/dist/stamper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stamper.d.ts","sourceRoot":"","sources":["../src/stamper.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,eAAe,EACpB,KAAK,MAAM,EAEZ,MAAM,SAAS,CAAC;AAWjB,qBAAa,aAAc,YAAW,QAAQ;IAC5C,OAAO,CAAC,MAAM,CAAkB;gBAEpB,MAAM,EAAE,eAAe;IAI7B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAyD9C"}

package/dist/stamper.js

@@ -0,0 +1,64 @@
+'use strict';
+
+var encoding = require('@0xkey-io/encoding');
+var errors = require('./errors.js');
+var types = require('./types.js');
+var constants = require('./constants.js');
+var stamping = require('./_kernel/stamping.js');
+
+// WalletStamper class implements the TStamper interface to use wallet's signature and public key
+// to authenticate requests to ZeroXKey.
+class WalletStamper {
+    constructor(wallet) {
+        this.wallet = wallet;
+    }
+    async stamp(payload) {
+        let signature;
+        try {
+            signature = await this.wallet.signMessage(payload);
+        }
+        catch (error) {
+            throw new errors.WalletStamperError("Failed to sign the message", error);
+        }
+        // Determine the signature scheme based on the wallet type.
+        const scheme = this.wallet.type === types.WalletType.Solana
+            ? constants.SIGNATURE_SCHEME_TK_API_ED25519
+            : constants.SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191;
+        let publicKey;
+        try {
+            // For Ethereum, we need to recover the public key from the signature over the payload.
+            // This is because recovering the SECP256K1 public key requires a signed message.
+            // This avoids an additional call to the wallet to get the public key.
+            if (this.wallet.type === types.WalletType.Ethereum) {
+                const { recoverPublicKey, hashMessage } = await import('viem');
+                const { compressRawPublicKey, toDerSignature } = await import('@0xkey-io/crypto');
+                const secp256k1PublicKey = await recoverPublicKey({
+                    hash: hashMessage(payload),
+                    signature: signature,
+                });
+                publicKey = secp256k1PublicKey.replace("0x", "");
+                const publicKeyBytes = Uint8Array.from(Buffer.from(publicKey, "hex"));
+                publicKey = Buffer.from(compressRawPublicKey(publicKeyBytes)).toString("hex");
+                // Convert the signature to DER format which is required by the ZeroXKey API.
+                signature = toDerSignature(signature.replace("0x", ""));
+            }
+            else {
+                // For Solana, we can directly use the public key.
+                publicKey = await this.wallet.getPublicKey();
+            }
+        }
+        catch (error) {
+            throw new errors.WalletStamperError("Failed to recover public key", error);
+        }
+        const stamp = {
+            publicKey,
+            scheme,
+            signature,
+        };
+        // Return the stamp as a base64url encoded JSON string in the header format.
+        return stamping.createStampResult(stamping.STAMP_HEADER_API_KEY, encoding.stringToBase64urlString(JSON.stringify(stamp)));
+    }
+}
+
+exports.WalletStamper = WalletStamper;
+//# sourceMappingURL=stamper.js.map

package/dist/stamper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stamper.js","sources":["../src/stamper.ts"],"sourcesContent":[null],"names":["WalletStamperError","WalletType","SIGNATURE_SCHEME_TK_API_ED25519","SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191","createStampResult","STAMP_HEADER_NAME","stringToBase64urlString"],"mappings":";;;;;;;;AAgBA;AACA;MACa,aAAa,CAAA;AAGxB,IAAA,WAAA,CAAY,MAAuB,EAAA;AACjC,QAAA,IAAI,CAAC,MAAM,GAAG,MAAM;IACtB;IAEA,MAAM,KAAK,CAAC,OAAe,EAAA;AACzB,QAAA,IAAI,SAAiB;AACrB,QAAA,IAAI;YACF,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC;QACpD;QAAE,OAAO,KAAK,EAAE;AACd,YAAA,MAAM,IAAIA,yBAAkB,CAAC,4BAA4B,EAAE,KAAK,CAAC;QACnE;;QAGA,MAAM,MAAM,GACV,IAAI,CAAC,MAAM,CAAC,IAAI,KAAKC,gBAAU,CAAC;AAC9B,cAAEC;cACAC,kDAAwC;AAE9C,QAAA,IAAI,SAAiB;AACrB,QAAA,IAAI;;;;YAIF,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAKF,gBAAU,CAAC,QAAQ,EAAE;gBAC5C,MAAM,EAAE,gBAAgB,EAAE,WAAW,EAAE,GAAG,MAAM,OAAO,MAAM,CAAC;gBAC9D,MAAM,EAAE,oBAAoB,EAAE,cAAc,EAAE,GAAG,MAAM,OACrD,kBAAkB,CACnB;AAED,gBAAA,MAAM,kBAAkB,GAAG,MAAM,gBAAgB,CAAC;AAChD,oBAAA,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;AAC1B,oBAAA,SAAS,EAAE,SAAgB;AAC5B,iBAAA,CAAC;gBACF,SAAS,GAAG,kBAAkB,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;AAChD,gBAAA,MAAM,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;AACrE,gBAAA,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CACpE,KAAK,CACN;;AAGD,gBAAA,SAAS,GAAG,cAAc,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACzD;iBAAO;;gBAEL,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;YAC9C;QACF;QAAE,OAAO,KAAK,EAAE;AACd,YAAA,MAAM,IAAID,yBAAkB,CAAC,8BAA8B,EAAE,KAAK,CAAC;QACrE;AAEA,QAAA,MAAM,KAAK,GAAG;YACZ,SAAS;YACT,MAAM;YACN,SAAS;SACV;;AAGD,QAAA,OAAOI,0BAAiB,CACtBC,6BAAiB,EACjBC,gCAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAC/C;IACH;AACD;;;;"}

package/dist/stamper.mjs

@@ -0,0 +1,62 @@
+import { stringToBase64urlString } from '@0xkey-io/encoding';
+import { WalletStamperError } from './errors.mjs';
+import { WalletType } from './types.mjs';
+import { SIGNATURE_SCHEME_TK_API_ED25519, SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191 } from './constants.mjs';
+import { createStampResult, STAMP_HEADER_API_KEY } from './_kernel/stamping.mjs';
+
+// WalletStamper class implements the TStamper interface to use wallet's signature and public key
+// to authenticate requests to ZeroXKey.
+class WalletStamper {
+    constructor(wallet) {
+        this.wallet = wallet;
+    }
+    async stamp(payload) {
+        let signature;
+        try {
+            signature = await this.wallet.signMessage(payload);
+        }
+        catch (error) {
+            throw new WalletStamperError("Failed to sign the message", error);
+        }
+        // Determine the signature scheme based on the wallet type.
+        const scheme = this.wallet.type === WalletType.Solana
+            ? SIGNATURE_SCHEME_TK_API_ED25519
+            : SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191;
+        let publicKey;
+        try {
+            // For Ethereum, we need to recover the public key from the signature over the payload.
+            // This is because recovering the SECP256K1 public key requires a signed message.
+            // This avoids an additional call to the wallet to get the public key.
+            if (this.wallet.type === WalletType.Ethereum) {
+                const { recoverPublicKey, hashMessage } = await import('viem');
+                const { compressRawPublicKey, toDerSignature } = await import('@0xkey-io/crypto');
+                const secp256k1PublicKey = await recoverPublicKey({
+                    hash: hashMessage(payload),
+                    signature: signature,
+                });
+                publicKey = secp256k1PublicKey.replace("0x", "");
+                const publicKeyBytes = Uint8Array.from(Buffer.from(publicKey, "hex"));
+                publicKey = Buffer.from(compressRawPublicKey(publicKeyBytes)).toString("hex");
+                // Convert the signature to DER format which is required by the ZeroXKey API.
+                signature = toDerSignature(signature.replace("0x", ""));
+            }
+            else {
+                // For Solana, we can directly use the public key.
+                publicKey = await this.wallet.getPublicKey();
+            }
+        }
+        catch (error) {
+            throw new WalletStamperError("Failed to recover public key", error);
+        }
+        const stamp = {
+            publicKey,
+            scheme,
+            signature,
+        };
+        // Return the stamp as a base64url encoded JSON string in the header format.
+        return createStampResult(STAMP_HEADER_API_KEY, stringToBase64urlString(JSON.stringify(stamp)));
+    }
+}
+
+export { WalletStamper };
+//# sourceMappingURL=stamper.mjs.map

package/dist/stamper.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"stamper.mjs","sources":["../src/stamper.ts"],"sourcesContent":[null],"names":["STAMP_HEADER_NAME"],"mappings":";;;;;;AAgBA;AACA;MACa,aAAa,CAAA;AAGxB,IAAA,WAAA,CAAY,MAAuB,EAAA;AACjC,QAAA,IAAI,CAAC,MAAM,GAAG,MAAM;IACtB;IAEA,MAAM,KAAK,CAAC,OAAe,EAAA;AACzB,QAAA,IAAI,SAAiB;AACrB,QAAA,IAAI;YACF,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC;QACpD;QAAE,OAAO,KAAK,EAAE;AACd,YAAA,MAAM,IAAI,kBAAkB,CAAC,4BAA4B,EAAE,KAAK,CAAC;QACnE;;QAGA,MAAM,MAAM,GACV,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC;AAC9B,cAAE;cACA,wCAAwC;AAE9C,QAAA,IAAI,SAAiB;AACrB,QAAA,IAAI;;;;YAIF,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,QAAQ,EAAE;gBAC5C,MAAM,EAAE,gBAAgB,EAAE,WAAW,EAAE,GAAG,MAAM,OAAO,MAAM,CAAC;gBAC9D,MAAM,EAAE,oBAAoB,EAAE,cAAc,EAAE,GAAG,MAAM,OACrD,kBAAkB,CACnB;AAED,gBAAA,MAAM,kBAAkB,GAAG,MAAM,gBAAgB,CAAC;AAChD,oBAAA,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;AAC1B,oBAAA,SAAS,EAAE,SAAgB;AAC5B,iBAAA,CAAC;gBACF,SAAS,GAAG,kBAAkB,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;AAChD,gBAAA,MAAM,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;AACrE,gBAAA,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CACpE,KAAK,CACN;;AAGD,gBAAA,SAAS,GAAG,cAAc,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACzD;iBAAO;;gBAEL,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;YAC9C;QACF;QAAE,OAAO,KAAK,EAAE;AACd,YAAA,MAAM,IAAI,kBAAkB,CAAC,8BAA8B,EAAE,KAAK,CAAC;QACrE;AAEA,QAAA,MAAM,KAAK,GAAG;YACZ,SAAS;YACT,MAAM;YACN,SAAS;SACV;;AAGD,QAAA,OAAO,iBAAiB,CACtBA,oBAAiB,EACjB,uBAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAC/C;IACH;AACD;;;;"}

package/dist/types.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @typedef {Object} TStamp
+ * @property {'X-Stamp'} stampHeaderName - The name of the stamp header.
+ * @property {string} stampHeaderValue - The value of the stamp header.
+ */
+export type TStamp = {
+    stampHeaderName: "X-Stamp";
+    stampHeaderValue: string;
+};
+/**
+ * @interface TStamper
+ * @property {function(string): Promise<TStamp>} stamp - Function to stamp an input string.
+ */
+export interface TStamper {
+    stamp: (input: string) => Promise<TStamp>;
+}
+/**
+ * Base interface for wallet functionalities common across different blockchain chains.
+ * @interface BaseWalletInterface
+ * @property {function(string): Promise<string>} signMessage - Signs a message and returns the hex signature as a string.
+ * @property {function(): Promise<string>} getPublicKey - Retrieves the public key as a string.
+ */
+export interface BaseWalletInterface {
+    type: WalletType.Ethereum | WalletType.Solana;
+    signMessage: (message: string) => Promise<string>;
+    getPublicKey: () => Promise<string>;
+}
+/**
+ * Solana wallets can directly access the public key without needing a signed message.
+ * @interface SolanaWalletInterface
+ * @extends BaseWalletInterface
+ * @property {function(): string} getPublicKey - Returns the public key, which is the ED25519 hex encoded public key from your Solana wallet public key.
+ * @property {'solana'} type - The type of the wallet.
+ */
+export interface SolanaWalletInterface extends BaseWalletInterface {
+    type: WalletType.Solana;
+}
+/**
+ * Ethereum wallets require a signed message to derive the public key.
+ *
+ * @remarks This is the SECP256K1 public key of the Ethereum wallet, not the address.
+ * This requires that the wallet signs a message in order to derive the public key.
+ *
+ * @interface EthereumWalletInterface
+ * @extends BaseWalletInterface
+ * @property {function(): Promise<string>} getPublicKey - Returns the public key, which is the SECP256K1 hex encoded public key from your Ethereum wallet.
+ * @property {'ethereum'} type - The type of the wallet.
+ */
+export interface EthereumWalletInterface extends BaseWalletInterface {
+    type: WalletType.Ethereum;
+}
+/**
+ * Union type for wallet interfaces, supporting both Solana and Ethereum wallets.
+ * @typedef {SolanaWalletInterface | EthereumWalletInterface} WalletInterface
+ */
+export type WalletInterface = SolanaWalletInterface | EthereumWalletInterface;
+/**
+ * Enum representing the type of wallet the user is stamping with.
+ */
+export declare enum WalletType {
+    Ethereum = "ethereum",
+    Solana = "solana"
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,eAAe,EAAE,SAAS,CAAC;IAC3B,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CAC3C;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,UAAU,CAAC,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC;IAC9C,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAClD,YAAY,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;CACrC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB;IAChE,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC;CACzB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB;IAClE,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,qBAAqB,GAAG,uBAAuB,CAAC;AAE9E;;GAEG;AACH,oBAAY,UAAU;IACpB,QAAQ,aAAa;IACrB,MAAM,WAAW;CAClB"}

package/dist/types.js

@@ -0,0 +1,11 @@
+'use strict';
+
+/**
+ * Enum representing the type of wallet the user is stamping with.
+ */
+exports.WalletType = void 0;
+(function (WalletType) {
+    WalletType["Ethereum"] = "ethereum";
+    WalletType["Solana"] = "solana";
+})(exports.WalletType || (exports.WalletType = {}));
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sources":["../src/types.ts"],"sourcesContent":[null],"names":["WalletType"],"mappings":";;AA8DA;;AAEG;AACSA;AAAZ,CAAA,UAAY,UAAU,EAAA;AACpB,IAAA,UAAA,CAAA,UAAA,CAAA,GAAA,UAAqB;AACrB,IAAA,UAAA,CAAA,QAAA,CAAA,GAAA,QAAiB;AACnB,CAAC,EAHWA,kBAAU,KAAVA,kBAAU,GAAA,EAAA,CAAA,CAAA;;"}

package/dist/types.mjs

@@ -0,0 +1,11 @@
+/**
+ * Enum representing the type of wallet the user is stamping with.
+ */
+var WalletType;
+(function (WalletType) {
+    WalletType["Ethereum"] = "ethereum";
+    WalletType["Solana"] = "solana";
+})(WalletType || (WalletType = {}));
+
+export { WalletType };
+//# sourceMappingURL=types.mjs.map

package/dist/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","sources":["../src/types.ts"],"sourcesContent":[null],"names":[],"mappings":"AA8DA;;AAEG;IACS;AAAZ,CAAA,UAAY,UAAU,EAAA;AACpB,IAAA,UAAA,CAAA,UAAA,CAAA,GAAA,UAAqB;AACrB,IAAA,UAAA,CAAA,QAAA,CAAA,GAAA,QAAiB;AACnB,CAAC,EAHW,UAAU,KAAV,UAAU,GAAA,EAAA,CAAA,CAAA;;;;"}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@0xkey-io/wallet-stamper",
+  "version": "0.1.0",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "license": "Apache-2.0",
+  "description": "Wallet stamper for @0xkey-io/http",
+  "keywords": [
+    "0xkey",
+    "http",
+    "stamper",
+    "wallet authentication"
+  ],
+  "author": {
+    "name": "0xkey",
+    "url": "https://0xkey.com/"
+  },
+  "homepage": "https://github.com/0xkey-io/sdk-js/tree/main/packages/wallet-stamper",
+  "bugs": {
+    "url": "https://github.com/0xkey-io/sdk-js/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/0xkey-io/sdk-js.git",
+    "directory": "packages/wallet-stamper"
+  },
+  "files": [
+    "dist/",
+    "CHANGELOG.md",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@0xkey-io/encoding": "0.1.0",
+    "@0xkey-io/crypto": "0.1.0"
+  },
+  "optionalDependencies": {
+    "viem": "^2.21.35"
+  },
+  "devDependencies": {
+    "@solana/web3.js": "^1.95.8",
+    "dotenv": "^16.0.3",
+    "tweetnacl": "^1.0.3",
+    "tweetnacl-util": "^0.15.1",
+    "typescript": "5.4.3",
+    "@0xkey-io/http": "0.1.0",
+    "@0xkey-io/api-key-stamper": "0.1.0"
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "clean": "rimraf ./dist ./.cache",
+    "test": "jest",
+    "typecheck": "tsc -p tsconfig.typecheck.json"
+  }
+}