@swapkit/wallet-keystore 1.0.0-rc.98 → 1.0.0

package/package.json

@@ -1,59 +1,39 @@
 {
-  "author": "swapkit-oss",
   "dependencies": {
-    "@scure/bip39": "1.2.2",
-    "blakejs": "1.2.1"
-  },
-  "description": "SwapKit Lib keystore",
-  "devDependencies": {
-    "@rollup/plugin-node-resolve": "15.2.3",
-    "@vitest/coverage-istanbul": "1.3.1",
-    "vite": "5.1.3",
-    "vitest": "1.3.1",
-    "@swapkit/helpers": "1.0.0-rc.74",
-    "@swapkit/toolbox-cosmos": "1.0.0-rc.85",
-    "@swapkit/toolbox-evm": "1.0.0-rc.80",
-    "@swapkit/toolbox-substrate": "1.0.0-rc.9",
-    "@swapkit/toolbox-utxo": "1.0.0-rc.81",
-    "@swapkit/types": "1.0.0-rc.40"
-  },
-  "exports": {
-    ".": {
-      "import": "./dist/index.es.js",
-      "require": "./dist/index.cjs",
-      "types": "./dist/index.d.ts"
-    }
+    "@scure/bip39": "1.3.0",
+    "@swapkit/helpers": "1.0.0",
+    "@swapkit/toolbox-cosmos": "1.0.0",
+    "@swapkit/toolbox-evm": "1.0.0",
+    "@swapkit/toolbox-radix": "1.0.0",
+    "@swapkit/toolbox-solana": "1.0.0",
+    "@swapkit/toolbox-substrate": "1.0.0",
+    "@swapkit/toolbox-utxo": "1.0.0",
+    "blakejs": "1.2.1",
+    "micro-key-producer": "0.7.0"
   },
+  "description": "SwapKit Wallet - Keystore",
   "files": [
     "src/",
     "dist/"
   ],
   "homepage": "https://github.com/thorswap/SwapKit",
   "license": "Apache-2.0",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.es.js",
+  "main": "./dist/index.js",
   "name": "@swapkit/wallet-keystore",
-  "peerDependencies": {
-    "@swapkit/helpers": "1.0.0-rc.74",
-    "@swapkit/toolbox-cosmos": "1.0.0-rc.85",
-    "@swapkit/toolbox-evm": "1.0.0-rc.80",
-    "@swapkit/toolbox-substrate": "1.0.0-rc.9",
-    "@swapkit/toolbox-utxo": "1.0.0-rc.81",
-    "@swapkit/types": "1.0.0-rc.40"
-  },
   "react-native": "./src/index.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/thorswap/SwapKit.git"
   },
-  "type": "module",
-  "types": "./dist/index.d.ts",
-  "version": "1.0.0-rc.98",
   "scripts": {
-    "build": "vite build",
-    "clean": "rm -rf dist vite.config.ts.* node_modules",
-    "lint": "biome check --apply ./src",
-    "test": "echo 'vitest --run'",
-    "test:coverage": "echo 'vitest run --coverage'"
-  }
-}
+    "build": "bun run ./build.ts",
+    "clean": "rm -rf dist node_modules *.tsbuildinfo",
+    "lint": "biome check --write ./src",
+    "test": "echo 'bun test'",
+    "test:coverage": "bun test --coverage",
+    "type-check": "tsc --noEmit"
+  },
+  "type": "module",
+  "types": "./src/index.ts",
+  "version": "1.0.0"
+}

package/src/helpers.ts

@@ -1,5 +1,5 @@
-import crypto from "crypto";
-import { generateMnemonic } from "@scure/bip39";
+import crypto from "node:crypto";
+import { generateMnemonic, validateMnemonic } from "@scure/bip39";
 import { wordlist } from "@scure/bip39/wordlists/english";
 import { blake2bFinal, blake2bInit, blake2bUpdate } from "blakejs";
 
@@ -91,9 +91,12 @@ export const encryptToKeyStore = async (phrase: string, password: string) => {
   };
 };
 
-export const generatePhrase = (size = 12) => {
-  const entropy = size === 12 ? 128 : 256;
-  return generateMnemonic(wordlist, entropy);
+export const generatePhrase = (size: 12 | 24 = 12) => {
+  return generateMnemonic(wordlist, size === 12 ? 128 : 256);
+};
+
+export const validatePhrase = (phrase: string) => {
+  return validateMnemonic(phrase, wordlist);
 };
 
 export const decryptFromKeystore = async (keystore: Keystore, password: string) => {

package/src/keystore.ts

@@ -1,18 +1,22 @@
-import { setRequestClientConfig } from "@swapkit/helpers";
-import type {
-  BinanceToolboxType,
-  DepositParam,
-  ThorchainToolboxType,
-  TransferParams,
-} from "@swapkit/toolbox-cosmos";
+import {
+  type AssetValue,
+  Chain,
+  type ConnectWalletParams,
+  DerivationPath,
+  RPCUrl,
+  type WalletChain,
+  WalletOption,
+  type WalletTxParams,
+  type Witness,
+  setRequestClientConfig,
+} from "@swapkit/helpers";
+import type { DepositParam, ThorchainToolboxType, TransferParams } from "@swapkit/toolbox-cosmos";
 import type {
   Psbt,
   TransactionType,
   UTXOTransferParams,
   UTXOWalletTransferParams,
 } from "@swapkit/toolbox-utxo";
-import type { ConnectWalletParams, Witness } from "@swapkit/types";
-import { Chain, DerivationPath, WalletOption } from "@swapkit/types";
 
 type KeystoreOptions = {
   ethplorerApiKey?: string;
@@ -22,7 +26,7 @@ type KeystoreOptions = {
 };
 
 type Params = KeystoreOptions & {
-  api?: any;
+  api?: Todo;
   rpcUrl?: string;
   chain: Chain;
   phrase: string;
@@ -44,6 +48,9 @@ const getWalletMethodsForChain = async ({
 
   switch (chain) {
     case Chain.BinanceSmartChain:
+    case Chain.Arbitrum:
+    case Chain.Optimism:
+    case Chain.Polygon:
     case Chain.Avalanche:
     case Chain.Ethereum: {
       if (chain === Chain.Ethereum && !ethplorerApiKey) {
@@ -65,10 +72,7 @@ const getWalletMethodsForChain = async ({
         ethplorerApiKey: ethplorerApiKey as string,
       });
 
-      return {
-        address: wallet.address,
-        walletMethods: { ...toolbox },
-      };
+      return { address: wallet.address, walletMethods: toolbox };
     }
 
     case Chain.BitcoinCash: {
@@ -81,17 +85,6 @@ const getWalletMethodsForChain = async ({
       const keys = await toolbox.createKeysForPath({ phrase, derivationPath });
       const address = toolbox.getAddressFromKeys(keys);
 
-      const signTransaction = async ({
-        builder,
-        utxos,
-      }: Awaited<ReturnType<typeof toolbox.buildBCHTx>>) => {
-        utxos.forEach((utxo, index) => {
-          builder.sign(index, keys, undefined, 0x41, (utxo.witnessUtxo as Witness).value);
-        });
-
-        return builder.build();
-      };
-
       const walletMethods = {
         ...toolbox,
         transfer: (
@@ -99,13 +92,28 @@ const getWalletMethodsForChain = async ({
             Awaited<ReturnType<typeof toolbox.buildBCHTx>>,
             TransactionType
           >,
-        ) => toolbox.transfer({ ...params, from: address, signTransaction }),
+        ) =>
+          toolbox.transfer({
+            ...params,
+            from: address,
+            signTransaction: ({
+              builder,
+              utxos,
+            }: Awaited<ReturnType<typeof toolbox.buildBCHTx>>) => {
+              utxos.forEach((utxo, index) => {
+                builder.sign(index, keys, undefined, 0x41, (utxo.witnessUtxo as Witness).value);
+              });
+
+              return builder.build();
+            },
+          }),
       };
 
       return { address, walletMethods };
     }
 
     case Chain.Bitcoin:
+    case Chain.Dash:
     case Chain.Dogecoin:
     case Chain.Litecoin: {
       const { getToolboxByChain } = await import("@swapkit/toolbox-utxo");
@@ -116,7 +124,7 @@ const getWalletMethodsForChain = async ({
         apiClient: api,
       });
 
-      const keys = await toolbox.createKeysForPath({ phrase, derivationPath });
+      const keys = toolbox.createKeysForPath({ phrase, derivationPath });
       const address = toolbox.getAddressFromKeys(keys);
 
       return {
@@ -136,7 +144,6 @@ const getWalletMethodsForChain = async ({
       };
     }
 
-    case Chain.Binance:
     case Chain.Cosmos:
     case Chain.Kujira:
     case Chain.Maya:
@@ -144,13 +151,7 @@ const getWalletMethodsForChain = async ({
       const { getToolboxByChain } = await import("@swapkit/toolbox-cosmos");
 
       const toolbox = getToolboxByChain(chain)({ server: api, stagenet });
-      const additionalParams =
-        chain === Chain.Binance
-          ? {
-              privkey: await (toolbox as BinanceToolboxType).createPrivateKeyFromPhrase(phrase),
-            }
-          : { signer: await toolbox.getSigner(phrase) };
-
+      const signer = await toolbox.getSigner(phrase);
       const address = await toolbox.getAddressFromMnemonic(phrase);
 
       const transfer = async ({ assetValue, recipient, memo }: TransferParams) =>
@@ -159,7 +160,7 @@ const getWalletMethodsForChain = async ({
           recipient,
           assetValue,
           memo,
-          ...additionalParams,
+          signer,
         });
 
       const deposit =
@@ -169,7 +170,7 @@ const getWalletMethodsForChain = async ({
                 assetValue,
                 memo,
                 from: address,
-                ...additionalParams,
+                signer,
               });
             }
           : undefined;
@@ -195,15 +196,37 @@ const getWalletMethodsForChain = async ({
         "@swapkit/toolbox-substrate"
       );
 
-      const network = Network[chain];
+      const signer = await createKeyring(phrase, Network[chain].prefix);
+      const toolbox = await getToolboxByChain(chain, { signer });
+
+      return { address: signer.address, walletMethods: toolbox };
+    }
+
+    case Chain.Radix: {
+      const { getRadixCoreApiClient, RadixToolbox, createPrivateKey, RadixMainnet } = await import(
+        "@swapkit/toolbox-radix"
+      );
+
+      const api = await getRadixCoreApiClient(RPCUrl.Radix, RadixMainnet);
+      const signer = await createPrivateKey(phrase);
+      const toolbox = await RadixToolbox({ api, signer });
 
-      const signer = await createKeyring(phrase, network.prefix);
+      return { address: await toolbox.getAddress(), walletMethods: toolbox };
+    }
 
-      const toolbox = await getToolboxByChain(chain, {
-        signer,
-      });
+    case Chain.Solana: {
+      const { SOLToolbox } = await import("@swapkit/toolbox-solana");
+      const toolbox = SOLToolbox({ rpcUrl });
+      const keypair = toolbox.createKeysForPath({ phrase, derivationPath });
 
-      return { address: signer.address, walletMethods: toolbox };
+      return {
+        address: toolbox.getAddressFromKeys(keypair),
+        walletMethods: {
+          ...toolbox,
+          transfer: (params: WalletTxParams & { assetValue: AssetValue }) =>
+            toolbox.transfer({ ...params, fromKeypair: keypair }),
+        },
+      };
     }
 
     default:
@@ -211,21 +234,13 @@ const getWalletMethodsForChain = async ({
   }
 };
 
-const connectKeystore =
-  ({
-    addChain,
-    apis,
-    rpcUrls,
-    config: {
-      thorswapApiKey,
-      covalentApiKey,
-      ethplorerApiKey,
-      blockchairApiKey,
-      utxoApiKey,
-      stagenet,
-    },
-  }: ConnectWalletParams) =>
-  async (chains: Chain[], phrase: string, index = 0) => {
+function connectKeystore({
+  addChain,
+  apis,
+  rpcUrls,
+  config: { thorswapApiKey, covalentApiKey, ethplorerApiKey, blockchairApiKey, stagenet },
+}: ConnectWalletParams) {
+  return async function connectKeystore(chains: WalletChain[], phrase: string, index = 0) {
     setRequestClientConfig({ apiKey: thorswapApiKey });
 
     const promises = chains.map(async (chain) => {
@@ -237,7 +252,7 @@ const connectKeystore =
         covalentApiKey,
         ethplorerApiKey,
         phrase,
-        blockchairApiKey: blockchairApiKey || utxoApiKey,
+        blockchairApiKey,
         stagenet,
       });
 
@@ -251,9 +266,9 @@ const connectKeystore =
     });
 
     await Promise.all(promises);
+
+    return true;
   };
+}
 
-export const keystoreWallet = {
-  connectMethodName: "connectKeystore" as const,
-  connect: connectKeystore,
-};
+export const keystoreWallet = { connectKeystore } as const;

package/LICENSE

@@ -1,201 +0,0 @@
-                                 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 2023 THORSwap
-
-   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.