@tuwaio/orbit-evm 0.0.3

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 2025 FOP Tkach Oleksandr
+
+   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,68 @@
+# Orbit EVM
+
+[![NPM Version](https://img.shields.io/npm/v/@tuwaio/orbit-evm.svg)](https://www.npmjs.com/package/@tuwaio/orbit-evm)
+[![License](https://img.shields.io/npm/l/@tuwaio/orbit-evm.svg)](./LICENSE)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/TuwaIO/orbit-evm/release.yml?branch=main)](https://github.com/TuwaIO/orbit-evm/actions)
+
+EVM-specific implementation for the TUWA ecosystem, providing comprehensive utilities and helpers for interacting with EVM-compatible blockchains.
+
+---
+
+## 🏛️ What is `@tuwaio/orbit-evm`?
+
+`@tuwaio/orbit-evm` is the EVM-focused extension of the TUWA ecosystem, built with TypeScript and designed for modern Web3 development. It provides specialized tools for interacting with EVM-compatible blockchains like Ethereum, Polygon, and BSC.
+
+---
+
+## ✨ Key Features
+
+- **Type-Safe Development:** Full TypeScript 5.9 support
+- **Tree-Shaking Optimized:** Efficient bundle size through careful exports
+
+---
+
+## 💾 Installation
+
+### Requirements
+- Node.js 20+
+- TypeScript 5.9+
+
+```bash
+# Using pnpm (recommended)
+pnpm add @tuwaio/orbit-evm @wagmi/core viem
+# Using npm
+npm install @tuwaio/orbit-evm @wagmi/core viem
+# Using yarn
+yarn add @tuwaio/orbit-evm @wagmi/core viem
+```
+
+---
+
+## 🔧 Architecture
+
+The package is structured around these core components:
+
+### Build System
+- Built with `tsup` for optimal bundling
+- Outputs both CommonJS and ESM formats
+- Generates TypeScript declarations
+
+### Core Modules
+- **Configuration:** Wagmi and viem utilities
+---
+
+## 🤝 Contributing & Support
+
+Contributions are welcome! Please read our main **[Contribution Guidelines](https://github.com/TuwaIO/workflows/blob/main/CONTRIBUTING.md)**.
+
+If you find this library useful, please consider supporting its development. Every contribution helps!
+
+[**➡️ View Support Options**](https://github.com/TuwaIO/workflows/blob/main/Donation.md)
+
+## 📄 License
+
+This project is licensed under the **Apache-2.0 License** - see the [LICENSE](./LICENSE) file for details.
+
+## 👥 Contributors
+
+- **Oleksandr Tkach** - [GitHub](https://github.com/Argeare5)

package/dist/index.d.mts

@@ -0,0 +1,85 @@
+import { Config } from '@wagmi/core';
+import { PublicClient, Hex, Address } from 'viem';
+import { Chain } from 'viem/chains';
+
+/**
+ * @file This file contains a utility to ensure the user's wallet is connected to the correct chain before proceeding with a transaction.
+ */
+
+/**
+ * Checks if the user's wallet is connected to the specified chain. If not, it prompts
+ * the user to switch to the correct chain.
+ *
+ * This function is a crucial prerequisite for any action that requires a specific network.
+ *
+ * @param {number} chainId - The ID of the desired blockchain network.
+ * @param {Config} config - The wagmi configuration object.
+ * @returns {Promise<void>} A promise that resolves when the wallet is on the correct chain.
+ * It rejects if the user cancels the switch or if another error occurs.
+ *
+ * @throws {Error} Throws a specific error if the user rejects the chain switch or if the switch fails for other reasons.
+ */
+declare function checkAndSwitchChain(chainId: number, config: Config): Promise<void>;
+
+/**
+ * @file This file contains a utility function for creating a viem Public Client.
+ */
+
+/**
+ * Creates a viem Public Client for a specific chain.
+ *
+ * This client is used for read-only interactions with the blockchain, such as fetching
+ * transaction receipts or reading contract state, without needing a wallet connection.
+ *
+ * @param {number} chainId - The ID of the chain for which to create the client.
+ * @param {Chain[]} chains - An array of supported viem Chain objects.
+ *
+ * @returns {import('viem').PublicClient | undefined} A viem PublicClient instance if a matching chain is found, otherwise undefined.
+ * It will also log a warning to the console if the chain is not configured.
+ */
+declare function createViemClient(chainId: number, chains: readonly [Chain, ...Chain[]]): PublicClient | undefined;
+
+/**
+ * @file This file contains utility functions for interacting with the Ethereum Name Service (ENS).
+ * It provides methods for resolving names to addresses, addresses to names, and fetching avatars,
+ * all specifically targeting the Ethereum Mainnet where ENS is deployed.
+ */
+
+/**
+ * Fetches the primary ENS name for a given Ethereum address from the Ethereum Mainnet.
+ *
+ * @param {Hex} address - The Ethereum address to look up.
+ * @returns {Promise<string | null>} The ENS name if found, otherwise null.
+ */
+declare const getName: (address: Hex) => Promise<string | null>;
+/**
+ * Fetches the avatar URL for a given ENS name from the Ethereum Mainnet.
+ *
+ * @param {string} name - The ENS name (e.g., 'vitalik.eth').
+ * @returns {Promise<string | null>} The URL of the avatar image if found, otherwise null.
+ */
+declare const getAvatar: (name: string) => Promise<string | null>;
+/**
+ * Fetches the Ethereum address associated with a given ENS name from the Ethereum Mainnet.
+ *
+ * @param {string} name - The ENS name to resolve (e.g., 'vitalik.eth').
+ * @returns {Promise<Address | null>} The associated Ethereum address (lowercase) or null if not found.
+ */
+declare const getAddress: (name: string) => Promise<Address | null>;
+/**
+ * A heuristic to check if a string is likely an ENS name.
+ *
+ * This is not a foolproof validation but a quick check. A valid ENS name
+ * must contain at least one dot and should not be a valid Ethereum address.
+ *
+ * @param {string} nameOrAddress - The string to check.
+ * @returns {boolean} True if the string is likely an ENS name.
+ *
+ * @example
+ * isEnsName('vitalik.eth') // true
+ * isEnsName('0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045') // false
+ * isEnsName('notanaddress') // false (doesn't contain a dot)
+ */
+declare const isEnsName: (nameOrAddress: string) => boolean;
+
+export { checkAndSwitchChain, createViemClient, getAddress, getAvatar, getName, isEnsName };

package/dist/index.d.ts

@@ -0,0 +1,85 @@
+import { Config } from '@wagmi/core';
+import { PublicClient, Hex, Address } from 'viem';
+import { Chain } from 'viem/chains';
+
+/**
+ * @file This file contains a utility to ensure the user's wallet is connected to the correct chain before proceeding with a transaction.
+ */
+
+/**
+ * Checks if the user's wallet is connected to the specified chain. If not, it prompts
+ * the user to switch to the correct chain.
+ *
+ * This function is a crucial prerequisite for any action that requires a specific network.
+ *
+ * @param {number} chainId - The ID of the desired blockchain network.
+ * @param {Config} config - The wagmi configuration object.
+ * @returns {Promise<void>} A promise that resolves when the wallet is on the correct chain.
+ * It rejects if the user cancels the switch or if another error occurs.
+ *
+ * @throws {Error} Throws a specific error if the user rejects the chain switch or if the switch fails for other reasons.
+ */
+declare function checkAndSwitchChain(chainId: number, config: Config): Promise<void>;
+
+/**
+ * @file This file contains a utility function for creating a viem Public Client.
+ */
+
+/**
+ * Creates a viem Public Client for a specific chain.
+ *
+ * This client is used for read-only interactions with the blockchain, such as fetching
+ * transaction receipts or reading contract state, without needing a wallet connection.
+ *
+ * @param {number} chainId - The ID of the chain for which to create the client.
+ * @param {Chain[]} chains - An array of supported viem Chain objects.
+ *
+ * @returns {import('viem').PublicClient | undefined} A viem PublicClient instance if a matching chain is found, otherwise undefined.
+ * It will also log a warning to the console if the chain is not configured.
+ */
+declare function createViemClient(chainId: number, chains: readonly [Chain, ...Chain[]]): PublicClient | undefined;
+
+/**
+ * @file This file contains utility functions for interacting with the Ethereum Name Service (ENS).
+ * It provides methods for resolving names to addresses, addresses to names, and fetching avatars,
+ * all specifically targeting the Ethereum Mainnet where ENS is deployed.
+ */
+
+/**
+ * Fetches the primary ENS name for a given Ethereum address from the Ethereum Mainnet.
+ *
+ * @param {Hex} address - The Ethereum address to look up.
+ * @returns {Promise<string | null>} The ENS name if found, otherwise null.
+ */
+declare const getName: (address: Hex) => Promise<string | null>;
+/**
+ * Fetches the avatar URL for a given ENS name from the Ethereum Mainnet.
+ *
+ * @param {string} name - The ENS name (e.g., 'vitalik.eth').
+ * @returns {Promise<string | null>} The URL of the avatar image if found, otherwise null.
+ */
+declare const getAvatar: (name: string) => Promise<string | null>;
+/**
+ * Fetches the Ethereum address associated with a given ENS name from the Ethereum Mainnet.
+ *
+ * @param {string} name - The ENS name to resolve (e.g., 'vitalik.eth').
+ * @returns {Promise<Address | null>} The associated Ethereum address (lowercase) or null if not found.
+ */
+declare const getAddress: (name: string) => Promise<Address | null>;
+/**
+ * A heuristic to check if a string is likely an ENS name.
+ *
+ * This is not a foolproof validation but a quick check. A valid ENS name
+ * must contain at least one dot and should not be a valid Ethereum address.
+ *
+ * @param {string} nameOrAddress - The string to check.
+ * @returns {boolean} True if the string is likely an ENS name.
+ *
+ * @example
+ * isEnsName('vitalik.eth') // true
+ * isEnsName('0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045') // false
+ * isEnsName('notanaddress') // false (doesn't contain a dot)
+ */
+declare const isEnsName: (nameOrAddress: string) => boolean;
+
+export { checkAndSwitchChain, createViemClient, getAddress, getAvatar, getName, isEnsName };

package/dist/index.js

@@ -0,0 +1,2 @@
+'use strict';var core=require('@wagmi/core'),viem=require('viem'),chains=require('viem/chains'),ens=require('viem/ens');async function x(r,e){let{connector:n,chainId:o}=core.getAccount(e);if(n&&o!==r)try{await core.switchChain(e,{chainId:r});}catch(i){throw i.cause?.name==="UserRejectedRequestError"?new Error("User rejected the request to switch network."):(console.error("Failed to switch network:",i),new Error("An error occurred while switching the network."))}}function a(r,e){let n=e.find(o=>o.id===r);if(n)return viem.createPublicClient({chain:n,transport:viem.http()});console.warn(`createViemClient: No chain configuration found for chainId ${r}. A client could not be created.`);}var t=a(chains.mainnet.id,[chains.mainnet]),V=async r=>{if(!t)return null;try{return await ens.getEnsName(t,{address:r})}catch(e){return console.error(`ENS name lookup failed for address ${r}:`,e),null}},j=async r=>{if(!t)return null;try{return await ens.getEnsAvatar(t,{name:ens.normalize(r)})}catch(e){return console.error(`ENS avatar lookup failed for name ${r}:`,e),null}},q=async r=>{if(!t)return null;try{let e=await ens.getEnsAddress(t,{name:ens.normalize(r)});return e?e.toLowerCase():null}catch(e){return console.error(`ENS address lookup failed for name ${r}:`,e),null}},H=r=>r.includes(".")&&!viem.isAddress(r);exports.checkAndSwitchChain=x;exports.createViemClient=a;exports.getAddress=q;exports.getAvatar=j;exports.getName=V;exports.isEnsName=H;//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils/checkAndSwitchChain.ts","../src/utils/createViemClient.ts","../src/utils/ensUtils.ts"],"names":["checkAndSwitchChain","chainId","config","connector","activeChainId","getAccount","switchChain","error","createViemClient","chains","chain","c","createPublicClient","http","ensClient","mainnet","getName","address","getEnsName","getAvatar","name","getEnsAvatar","normalize","getAddress","getEnsAddress","isEnsName","nameOrAddress","isAddress"],"mappings":"wHAmBA,eAAsBA,CAAAA,CAAoBC,CAAAA,CAAiBC,CAAAA,CAA+B,CACxF,GAAM,CAAE,SAAA,CAAAC,EAAW,OAAA,CAASC,CAAc,CAAA,CAAIC,eAAAA,CAAWH,CAAM,CAAA,CAG/D,GAAIC,CAAAA,EAAaC,CAAAA,GAAkBH,CAAAA,CACjC,GAAI,CAEF,MAAMK,gBAAAA,CAAYJ,EAAQ,CAAE,OAAA,CAAAD,CAAQ,CAAC,EACvC,CAAA,MAASM,CAAAA,CAAO,CACd,MAAKA,CAAAA,CAAc,KAAA,EAAO,IAAA,GAAS,0BAAA,CAC3B,IAAI,KAAA,CAAM,8CAA8C,CAAA,EAEhE,OAAA,CAAQ,KAAA,CAAM,2BAAA,CAA6BA,CAAK,CAAA,CAC1C,IAAI,KAAA,CAAM,gDAAgD,CAAA,CAClE,CAEJ,CChBO,SAASC,CAAAA,CAAiBP,CAAAA,CAAiBQ,CAAAA,CAAgE,CAChH,IAAMC,CAAAA,CAAQD,CAAAA,CAAO,IAAA,CAAME,CAAAA,EAAMA,CAAAA,CAAE,KAAOV,CAAO,CAAA,CAEjD,GAAIS,CAAAA,CACF,OAAOE,uBAAAA,CAAmB,CACxB,KAAA,CAAOF,CAAAA,CACP,SAAA,CAAWG,SAAAA,EACb,CAAC,CAAA,CAGH,QAAQ,IAAA,CAAK,CAAA,2DAAA,EAA8DZ,CAAO,CAAA,gCAAA,CAAkC,EAGtH,CClBA,IAAMa,CAAAA,CAAYN,CAAAA,CAAiBO,cAAAA,CAAQ,EAAA,CAAI,CAACA,cAAO,CAAC,CAAA,CAQ3CC,CAAAA,CAAU,MAAOC,CAAAA,EAAyC,CACrE,GAAI,CAACH,CAAAA,CAAW,OAAO,IAAA,CACvB,GAAI,CAEF,OAAO,MAAMI,cAAAA,CAAWJ,CAAAA,CAAW,CAAE,OAAA,CAAAG,CAAQ,CAAC,CAChD,CAAA,MAASV,CAAAA,CAAO,CACd,OAAA,OAAA,CAAQ,KAAA,CAAM,CAAA,mCAAA,EAAsCU,CAAO,IAAKV,CAAK,CAAA,CAC9D,IACT,CACF,CAAA,CAQaY,CAAAA,CAAY,MAAOC,CAAAA,EAAyC,CACvE,GAAI,CAACN,CAAAA,CAAW,OAAO,IAAA,CACvB,GAAI,CAEF,OAAO,MAAMO,gBAAAA,CAAaP,CAAAA,CAAW,CAAE,IAAA,CAAMQ,aAAAA,CAAUF,CAAI,CAAE,CAAC,CAChE,CAAA,MAASb,CAAAA,CAAO,CACd,eAAQ,KAAA,CAAM,CAAA,kCAAA,EAAqCa,CAAI,CAAA,CAAA,CAAA,CAAKb,CAAK,CAAA,CAC1D,IACT,CACF,CAAA,CAQagB,CAAAA,CAAa,MAAOH,CAAAA,EAA0C,CACzE,GAAI,CAACN,CAAAA,CAAW,OAAO,IAAA,CACvB,GAAI,CACF,IAAMG,CAAAA,CAAU,MAAMO,iBAAAA,CAAcV,CAAAA,CAAW,CAAE,IAAA,CAAMQ,aAAAA,CAAUF,CAAI,CAAE,CAAC,CAAA,CAExE,OAAOH,CAAAA,CAAWA,CAAAA,CAAQ,WAAA,EAAY,CAAgB,IACxD,CAAA,MAASV,CAAAA,CAAO,CACd,OAAA,OAAA,CAAQ,KAAA,CAAM,CAAA,mCAAA,EAAsCa,CAAI,CAAA,CAAA,CAAA,CAAKb,CAAK,CAAA,CAC3D,IACT,CACF,CAAA,CAgBakB,CAAAA,CAAaC,CAAAA,EACjBA,CAAAA,CAAc,QAAA,CAAS,GAAG,CAAA,EAAK,CAACC,cAAAA,CAAUD,CAAa","file":"index.js","sourcesContent":["/**\n * @file This file contains a utility to ensure the user's wallet is connected to the correct chain before proceeding with a transaction.\n */\n\nimport { Config, getAccount, switchChain } from '@wagmi/core';\n\n/**\n * Checks if the user's wallet is connected to the specified chain. If not, it prompts\n * the user to switch to the correct chain.\n *\n * This function is a crucial prerequisite for any action that requires a specific network.\n *\n * @param {number} chainId - The ID of the desired blockchain network.\n * @param {Config} config - The wagmi configuration object.\n * @returns {Promise<void>} A promise that resolves when the wallet is on the correct chain.\n * It rejects if the user cancels the switch or if another error occurs.\n *\n * @throws {Error} Throws a specific error if the user rejects the chain switch or if the switch fails for other reasons.\n */\nexport async function checkAndSwitchChain(chainId: number, config: Config): Promise<void> {\n  const { connector, chainId: activeChainId } = getAccount(config);\n\n  // Proceed only if a wallet is connected and it is on a different chain than required.\n  if (connector && activeChainId !== chainId) {\n    try {\n      // Pause execution and wait for the user to confirm the chain switch in their wallet.\n      await switchChain(config, { chainId });\n    } catch (error) {\n      if ((error as any).cause?.name === 'UserRejectedRequestError') {\n        throw new Error('User rejected the request to switch network.');\n      }\n      console.error('Failed to switch network:', error);\n      throw new Error('An error occurred while switching the network.');\n    }\n  }\n}\n","/**\n * @file This file contains a utility function for creating a viem Public Client.\n */\n\nimport { createPublicClient, http, PublicClient } from 'viem';\nimport { Chain } from 'viem/chains';\n\n/**\n * Creates a viem Public Client for a specific chain.\n *\n * This client is used for read-only interactions with the blockchain, such as fetching\n * transaction receipts or reading contract state, without needing a wallet connection.\n *\n * @param {number} chainId - The ID of the chain for which to create the client.\n * @param {Chain[]} chains - An array of supported viem Chain objects.\n *\n * @returns {import('viem').PublicClient | undefined} A viem PublicClient instance if a matching chain is found, otherwise undefined.\n * It will also log a warning to the console if the chain is not configured.\n */\nexport function createViemClient(chainId: number, chains: readonly [Chain, ...Chain[]]): PublicClient | undefined {\n  const chain = chains.find((c) => c.id === chainId);\n\n  if (chain) {\n    return createPublicClient({\n      chain: chain,\n      transport: http(),\n    });\n  }\n  // Log a warning for easier debugging if a chain configuration is missing.\n  console.warn(`createViemClient: No chain configuration found for chainId ${chainId}. A client could not be created.`);\n\n  return undefined;\n}\n","/**\n * @file This file contains utility functions for interacting with the Ethereum Name Service (ENS).\n * It provides methods for resolving names to addresses, addresses to names, and fetching avatars,\n * all specifically targeting the Ethereum Mainnet where ENS is deployed.\n */\n\nimport { Address, Hex, isAddress } from 'viem';\nimport { mainnet } from 'viem/chains';\nimport { getEnsAddress, getEnsAvatar, getEnsName, normalize } from 'viem/ens';\n\nimport { createViemClient } from './createViemClient';\n\n// A single, shared viem client for all ENS lookups.\n// ENS lookups are always performed against Ethereum Mainnet, regardless of the app's connected chain.\nconst ensClient = createViemClient(mainnet.id, [mainnet]);\n\n/**\n * Fetches the primary ENS name for a given Ethereum address from the Ethereum Mainnet.\n *\n * @param {Hex} address - The Ethereum address to look up.\n * @returns {Promise<string | null>} The ENS name if found, otherwise null.\n */\nexport const getName = async (address: Hex): Promise<string | null> => {\n  if (!ensClient) return null;\n  try {\n    // getEnsName returns the name or null if not found.\n    return await getEnsName(ensClient, { address });\n  } catch (error) {\n    console.error(`ENS name lookup failed for address ${address}:`, error);\n    return null;\n  }\n};\n\n/**\n * Fetches the avatar URL for a given ENS name from the Ethereum Mainnet.\n *\n * @param {string} name - The ENS name (e.g., 'vitalik.eth').\n * @returns {Promise<string | null>} The URL of the avatar image if found, otherwise null.\n */\nexport const getAvatar = async (name: string): Promise<string | null> => {\n  if (!ensClient) return null;\n  try {\n    // getEnsAvatar returns the URL or null if not found.\n    return await getEnsAvatar(ensClient, { name: normalize(name) });\n  } catch (error) {\n    console.error(`ENS avatar lookup failed for name ${name}:`, error);\n    return null;\n  }\n};\n\n/**\n * Fetches the Ethereum address associated with a given ENS name from the Ethereum Mainnet.\n *\n * @param {string} name - The ENS name to resolve (e.g., 'vitalik.eth').\n * @returns {Promise<Address | null>} The associated Ethereum address (lowercase) or null if not found.\n */\nexport const getAddress = async (name: string): Promise<Address | null> => {\n  if (!ensClient) return null;\n  try {\n    const address = await getEnsAddress(ensClient, { name: normalize(name) });\n    // viem returns the address or null. We ensure it's lowercase if it exists.\n    return address ? (address.toLowerCase() as Address) : null;\n  } catch (error) {\n    console.error(`ENS address lookup failed for name ${name}:`, error);\n    return null;\n  }\n};\n\n/**\n * A heuristic to check if a string is likely an ENS name.\n *\n * This is not a foolproof validation but a quick check. A valid ENS name\n * must contain at least one dot and should not be a valid Ethereum address.\n *\n * @param {string} nameOrAddress - The string to check.\n * @returns {boolean} True if the string is likely an ENS name.\n *\n * @example\n * isEnsName('vitalik.eth') // true\n * isEnsName('0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045') // false\n * isEnsName('notanaddress') // false (doesn't contain a dot)\n */\nexport const isEnsName = (nameOrAddress: string): boolean => {\n  return nameOrAddress.includes('.') && !isAddress(nameOrAddress);\n};\n"]}

package/dist/index.mjs

@@ -0,0 +1,2 @@
+import {getAccount,switchChain}from'@wagmi/core';import {createPublicClient,http,isAddress}from'viem';import {mainnet}from'viem/chains';import {getEnsName,getEnsAvatar,normalize,getEnsAddress}from'viem/ens';async function x(r,e){let{connector:n,chainId:o}=getAccount(e);if(n&&o!==r)try{await switchChain(e,{chainId:r});}catch(i){throw i.cause?.name==="UserRejectedRequestError"?new Error("User rejected the request to switch network."):(console.error("Failed to switch network:",i),new Error("An error occurred while switching the network."))}}function a(r,e){let n=e.find(o=>o.id===r);if(n)return createPublicClient({chain:n,transport:http()});console.warn(`createViemClient: No chain configuration found for chainId ${r}. A client could not be created.`);}var t=a(mainnet.id,[mainnet]),V=async r=>{if(!t)return null;try{return await getEnsName(t,{address:r})}catch(e){return console.error(`ENS name lookup failed for address ${r}:`,e),null}},j=async r=>{if(!t)return null;try{return await getEnsAvatar(t,{name:normalize(r)})}catch(e){return console.error(`ENS avatar lookup failed for name ${r}:`,e),null}},q=async r=>{if(!t)return null;try{let e=await getEnsAddress(t,{name:normalize(r)});return e?e.toLowerCase():null}catch(e){return console.error(`ENS address lookup failed for name ${r}:`,e),null}},H=r=>r.includes(".")&&!isAddress(r);export{x as checkAndSwitchChain,a as createViemClient,q as getAddress,j as getAvatar,V as getName,H as isEnsName};//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils/checkAndSwitchChain.ts","../src/utils/createViemClient.ts","../src/utils/ensUtils.ts"],"names":["checkAndSwitchChain","chainId","config","connector","activeChainId","getAccount","switchChain","error","createViemClient","chains","chain","c","createPublicClient","http","ensClient","mainnet","getName","address","getEnsName","getAvatar","name","getEnsAvatar","normalize","getAddress","getEnsAddress","isEnsName","nameOrAddress","isAddress"],"mappings":"+MAmBA,eAAsBA,CAAAA,CAAoBC,CAAAA,CAAiBC,CAAAA,CAA+B,CACxF,GAAM,CAAE,SAAA,CAAAC,EAAW,OAAA,CAASC,CAAc,CAAA,CAAIC,UAAAA,CAAWH,CAAM,CAAA,CAG/D,GAAIC,CAAAA,EAAaC,CAAAA,GAAkBH,CAAAA,CACjC,GAAI,CAEF,MAAMK,WAAAA,CAAYJ,EAAQ,CAAE,OAAA,CAAAD,CAAQ,CAAC,EACvC,CAAA,MAASM,CAAAA,CAAO,CACd,MAAKA,CAAAA,CAAc,KAAA,EAAO,IAAA,GAAS,0BAAA,CAC3B,IAAI,KAAA,CAAM,8CAA8C,CAAA,EAEhE,OAAA,CAAQ,KAAA,CAAM,2BAAA,CAA6BA,CAAK,CAAA,CAC1C,IAAI,KAAA,CAAM,gDAAgD,CAAA,CAClE,CAEJ,CChBO,SAASC,CAAAA,CAAiBP,CAAAA,CAAiBQ,CAAAA,CAAgE,CAChH,IAAMC,CAAAA,CAAQD,CAAAA,CAAO,IAAA,CAAME,CAAAA,EAAMA,CAAAA,CAAE,KAAOV,CAAO,CAAA,CAEjD,GAAIS,CAAAA,CACF,OAAOE,kBAAAA,CAAmB,CACxB,KAAA,CAAOF,CAAAA,CACP,SAAA,CAAWG,IAAAA,EACb,CAAC,CAAA,CAGH,QAAQ,IAAA,CAAK,CAAA,2DAAA,EAA8DZ,CAAO,CAAA,gCAAA,CAAkC,EAGtH,CClBA,IAAMa,CAAAA,CAAYN,CAAAA,CAAiBO,OAAAA,CAAQ,EAAA,CAAI,CAACA,OAAO,CAAC,CAAA,CAQ3CC,CAAAA,CAAU,MAAOC,CAAAA,EAAyC,CACrE,GAAI,CAACH,CAAAA,CAAW,OAAO,IAAA,CACvB,GAAI,CAEF,OAAO,MAAMI,UAAAA,CAAWJ,CAAAA,CAAW,CAAE,OAAA,CAAAG,CAAQ,CAAC,CAChD,CAAA,MAASV,CAAAA,CAAO,CACd,OAAA,OAAA,CAAQ,KAAA,CAAM,CAAA,mCAAA,EAAsCU,CAAO,IAAKV,CAAK,CAAA,CAC9D,IACT,CACF,CAAA,CAQaY,CAAAA,CAAY,MAAOC,CAAAA,EAAyC,CACvE,GAAI,CAACN,CAAAA,CAAW,OAAO,IAAA,CACvB,GAAI,CAEF,OAAO,MAAMO,YAAAA,CAAaP,CAAAA,CAAW,CAAE,IAAA,CAAMQ,SAAAA,CAAUF,CAAI,CAAE,CAAC,CAChE,CAAA,MAASb,CAAAA,CAAO,CACd,eAAQ,KAAA,CAAM,CAAA,kCAAA,EAAqCa,CAAI,CAAA,CAAA,CAAA,CAAKb,CAAK,CAAA,CAC1D,IACT,CACF,CAAA,CAQagB,CAAAA,CAAa,MAAOH,CAAAA,EAA0C,CACzE,GAAI,CAACN,CAAAA,CAAW,OAAO,IAAA,CACvB,GAAI,CACF,IAAMG,CAAAA,CAAU,MAAMO,aAAAA,CAAcV,CAAAA,CAAW,CAAE,IAAA,CAAMQ,SAAAA,CAAUF,CAAI,CAAE,CAAC,CAAA,CAExE,OAAOH,CAAAA,CAAWA,CAAAA,CAAQ,WAAA,EAAY,CAAgB,IACxD,CAAA,MAASV,CAAAA,CAAO,CACd,OAAA,OAAA,CAAQ,KAAA,CAAM,CAAA,mCAAA,EAAsCa,CAAI,CAAA,CAAA,CAAA,CAAKb,CAAK,CAAA,CAC3D,IACT,CACF,CAAA,CAgBakB,CAAAA,CAAaC,CAAAA,EACjBA,CAAAA,CAAc,QAAA,CAAS,GAAG,CAAA,EAAK,CAACC,SAAAA,CAAUD,CAAa","file":"index.mjs","sourcesContent":["/**\n * @file This file contains a utility to ensure the user's wallet is connected to the correct chain before proceeding with a transaction.\n */\n\nimport { Config, getAccount, switchChain } from '@wagmi/core';\n\n/**\n * Checks if the user's wallet is connected to the specified chain. If not, it prompts\n * the user to switch to the correct chain.\n *\n * This function is a crucial prerequisite for any action that requires a specific network.\n *\n * @param {number} chainId - The ID of the desired blockchain network.\n * @param {Config} config - The wagmi configuration object.\n * @returns {Promise<void>} A promise that resolves when the wallet is on the correct chain.\n * It rejects if the user cancels the switch or if another error occurs.\n *\n * @throws {Error} Throws a specific error if the user rejects the chain switch or if the switch fails for other reasons.\n */\nexport async function checkAndSwitchChain(chainId: number, config: Config): Promise<void> {\n  const { connector, chainId: activeChainId } = getAccount(config);\n\n  // Proceed only if a wallet is connected and it is on a different chain than required.\n  if (connector && activeChainId !== chainId) {\n    try {\n      // Pause execution and wait for the user to confirm the chain switch in their wallet.\n      await switchChain(config, { chainId });\n    } catch (error) {\n      if ((error as any).cause?.name === 'UserRejectedRequestError') {\n        throw new Error('User rejected the request to switch network.');\n      }\n      console.error('Failed to switch network:', error);\n      throw new Error('An error occurred while switching the network.');\n    }\n  }\n}\n","/**\n * @file This file contains a utility function for creating a viem Public Client.\n */\n\nimport { createPublicClient, http, PublicClient } from 'viem';\nimport { Chain } from 'viem/chains';\n\n/**\n * Creates a viem Public Client for a specific chain.\n *\n * This client is used for read-only interactions with the blockchain, such as fetching\n * transaction receipts or reading contract state, without needing a wallet connection.\n *\n * @param {number} chainId - The ID of the chain for which to create the client.\n * @param {Chain[]} chains - An array of supported viem Chain objects.\n *\n * @returns {import('viem').PublicClient | undefined} A viem PublicClient instance if a matching chain is found, otherwise undefined.\n * It will also log a warning to the console if the chain is not configured.\n */\nexport function createViemClient(chainId: number, chains: readonly [Chain, ...Chain[]]): PublicClient | undefined {\n  const chain = chains.find((c) => c.id === chainId);\n\n  if (chain) {\n    return createPublicClient({\n      chain: chain,\n      transport: http(),\n    });\n  }\n  // Log a warning for easier debugging if a chain configuration is missing.\n  console.warn(`createViemClient: No chain configuration found for chainId ${chainId}. A client could not be created.`);\n\n  return undefined;\n}\n","/**\n * @file This file contains utility functions for interacting with the Ethereum Name Service (ENS).\n * It provides methods for resolving names to addresses, addresses to names, and fetching avatars,\n * all specifically targeting the Ethereum Mainnet where ENS is deployed.\n */\n\nimport { Address, Hex, isAddress } from 'viem';\nimport { mainnet } from 'viem/chains';\nimport { getEnsAddress, getEnsAvatar, getEnsName, normalize } from 'viem/ens';\n\nimport { createViemClient } from './createViemClient';\n\n// A single, shared viem client for all ENS lookups.\n// ENS lookups are always performed against Ethereum Mainnet, regardless of the app's connected chain.\nconst ensClient = createViemClient(mainnet.id, [mainnet]);\n\n/**\n * Fetches the primary ENS name for a given Ethereum address from the Ethereum Mainnet.\n *\n * @param {Hex} address - The Ethereum address to look up.\n * @returns {Promise<string | null>} The ENS name if found, otherwise null.\n */\nexport const getName = async (address: Hex): Promise<string | null> => {\n  if (!ensClient) return null;\n  try {\n    // getEnsName returns the name or null if not found.\n    return await getEnsName(ensClient, { address });\n  } catch (error) {\n    console.error(`ENS name lookup failed for address ${address}:`, error);\n    return null;\n  }\n};\n\n/**\n * Fetches the avatar URL for a given ENS name from the Ethereum Mainnet.\n *\n * @param {string} name - The ENS name (e.g., 'vitalik.eth').\n * @returns {Promise<string | null>} The URL of the avatar image if found, otherwise null.\n */\nexport const getAvatar = async (name: string): Promise<string | null> => {\n  if (!ensClient) return null;\n  try {\n    // getEnsAvatar returns the URL or null if not found.\n    return await getEnsAvatar(ensClient, { name: normalize(name) });\n  } catch (error) {\n    console.error(`ENS avatar lookup failed for name ${name}:`, error);\n    return null;\n  }\n};\n\n/**\n * Fetches the Ethereum address associated with a given ENS name from the Ethereum Mainnet.\n *\n * @param {string} name - The ENS name to resolve (e.g., 'vitalik.eth').\n * @returns {Promise<Address | null>} The associated Ethereum address (lowercase) or null if not found.\n */\nexport const getAddress = async (name: string): Promise<Address | null> => {\n  if (!ensClient) return null;\n  try {\n    const address = await getEnsAddress(ensClient, { name: normalize(name) });\n    // viem returns the address or null. We ensure it's lowercase if it exists.\n    return address ? (address.toLowerCase() as Address) : null;\n  } catch (error) {\n    console.error(`ENS address lookup failed for name ${name}:`, error);\n    return null;\n  }\n};\n\n/**\n * A heuristic to check if a string is likely an ENS name.\n *\n * This is not a foolproof validation but a quick check. A valid ENS name\n * must contain at least one dot and should not be a valid Ethereum address.\n *\n * @param {string} nameOrAddress - The string to check.\n * @returns {boolean} True if the string is likely an ENS name.\n *\n * @example\n * isEnsName('vitalik.eth') // true\n * isEnsName('0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045') // false\n * isEnsName('notanaddress') // false (doesn't contain a dot)\n */\nexport const isEnsName = (nameOrAddress: string): boolean => {\n  return nameOrAddress.includes('.') && !isAddress(nameOrAddress);\n};\n"]}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@tuwaio/orbit-evm",
+  "version": "0.0.3",
+  "private": false,
+  "author": "Oleksandr Tkach",
+  "license": "Apache-2.0",
+  "description": "The core, with web3 EVM utilities and helpers for TUWA projects.",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "web3",
+    "typescript",
+    "evm",
+    "headless"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TuwaIO/satellite-connect.git",
+    "directory": "packages/orbit-evm"
+  },
+  "homepage": "https://github.com/TuwaIO/satellite-connect",
+  "bugs": {
+    "url": "https://github.com/TuwaIO/satellite-connect/issues"
+  },
+  "contributors": [
+    {
+      "name": "Oleksandr Tkach",
+      "url": "https://github.com/Argeare5"
+    }
+  ],
+  "peerDependencies": {
+    "@wagmi/core": ">=2.2",
+    "viem": ">=2.3"
+  },
+  "devDependencies": {
+    "@wagmi/core": "^2.20.3",
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.2",
+    "viem": "^2.37.4"
+  },
+  "scripts": {
+    "start": "tsup src/index.ts --watch",
+    "build": "tsup"
+  }
+}