@sodax/wallet-sdk-react 0.0.1-rc.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2025] [Sodax]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,233 @@
+# @sodax/wallet-sdk-react
+
+A comprehensive React Wallet SDK tailored for the Sodax ecosystem that provides unified wallet connectivity across multiple blockchain networks.
+
+## Features
+- Seamless wallet connectivity for all supported wallets in the Sodax network
+  - EVM Wallets: All browser extensions that support [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) (Hana Wallet, MetaMask, Phantom, etc.) ✅
+  - Sui Wallets: All browser extension that @mysten/dapp-kit supports (Hana, Sui Wallet, Suiet, etc.) ✅
+  - Solana Wallets: ✅
+  - Stellar Wallets: ✅
+  - Injective Wallets: ✅
+  - ICON Wallets: ✅ (Hana Wallet and other ICON-compatible extensions)
+
+- Address and connection state management
+  - EVM (Arbitrum, Avalanche, Base, BSC, Optimism, Polygon) ✅
+  - Sui ✅
+  - Solana ✅
+  - Stellar ✅
+  - Injective ✅
+  - ICON ✅
+
+
+## Installation
+
+```bash
+# Using npm
+npm install @sodax/wallet-sdk-react
+
+# Using yarn
+yarn add @sodax/wallet-sdk-react
+
+# Using pnpm
+pnpm add @sodax/wallet-sdk-react
+```
+
+## Peer Dependencies
+
+This package requires the following peer dependencies:
+
+```json
+{
+  "react": ">=19",
+  "@tanstack/react-query": "latest"
+}
+```
+
+## Quick Start
+
+```typescript
+import { SodaxWalletProvider, useXConnectors, useXConnect, useXAccount } from '@sodax/wallet-sdk-react';
+import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
+import {
+  ARBITRUM_MAINNET_CHAIN_ID,
+  AVALANCHE_MAINNET_CHAIN_ID,
+  BASE_MAINNET_CHAIN_ID,
+  BSC_MAINNET_CHAIN_ID,
+  OPTIMISM_MAINNET_CHAIN_ID,
+  POLYGON_MAINNET_CHAIN_ID,
+  SONIC_MAINNET_CHAIN_ID,
+} from '@sodax/types';
+
+// Create a QueryClient instance
+const queryClient = new QueryClient();
+
+function App() {
+  return (
+    <QueryClientProvider client={queryClient}>
+      <SodaxWalletProvider
+        config={{
+          EVM: {
+            chains: [
+              ARBITRUM_MAINNET_CHAIN_ID,
+              AVALANCHE_MAINNET_CHAIN_ID,
+              BASE_MAINNET_CHAIN_ID,
+              BSC_MAINNET_CHAIN_ID,
+              OPTIMISM_MAINNET_CHAIN_ID,
+              POLYGON_MAINNET_CHAIN_ID,
+              SONIC_MAINNET_CHAIN_ID,
+            ],
+          },
+          SUI: {
+            isMainnet: true,
+          },
+          SOLANA: {
+            endpoint: 'https://your-rpc-endpoint',
+          },
+          ICON: {},
+          INJECTIVE: {},
+          STELLAR: {},
+        }}
+      >
+        <WalletConnect />
+              </SodaxWalletProvider>
+    </QueryClientProvider>
+  );
+}
+
+function WalletConnect() {
+  // Get available connectors for EVM chain
+  const connectors = useXConnectors('EVM');
+  
+  // Get connect mutation
+  const { mutateAsync: connect } = useXConnect();
+
+  // Get connected account info
+  const account = useXAccount('EVM');
+
+  return (
+    <div className="space-y-4">
+      {/* Display connected wallet address if connected */}
+      {account?.address && (
+        <div className="p-4 bg-gray-100 rounded-lg">
+          <p className="text-sm text-gray-600">Connected Wallet:</p>
+          <p className="font-mono">{account.address}</p>
+        </div>
+      )}
+
+      {/* Display available connectors */}
+      <div className="space-y-2">
+        {connectors.map((connector) => (
+          <button
+            key={connector.id}
+            onClick={() => connect(connector)}
+            className="flex items-center gap-2 p-2 border rounded-lg hover:bg-gray-50"
+          >
+            <img 
+              src={connector.icon} 
+              alt={connector.name} 
+              width={24} 
+              height={24} 
+              className="rounded-md" 
+            />
+            <span>Connect {connector.name}</span>
+          </button>
+        ))}
+      </div>
+    </div>
+  );
+}
+```
+
+This example demonstrates:
+1. Setting up the required providers (`QueryClientProvider` and `SodaxWalletProvider`)
+2. Using `useXConnectors` to get available wallet connectors
+3. Using `useXConnect` to handle wallet connections
+4. Using `useXAccount` to display the connected wallet address
+5. A basic UI to display and connect to available wallets
+
+
+## Requirements
+
+- Node.js >= 18.0.0
+- React >= 19
+- TypeScript
+
+
+## API Reference
+
+### Components
+
+- [`SodaxWalletProvider`](./src/SodaxWalletProvider.tsx) - Main provider component for wallet connectivity
+
+### Hooks
+
+#### Core Wallet Hooks
+- [`useXConnectors`](./src/hooks/useXConnectors.ts) - Get available wallet connectors
+- [`useXConnect`](./src/hooks/useXConnect.ts) - Connect to a wallet
+- [`useXAccount`](./src/hooks/useXAccount.ts) - Get account information
+- [`useXDisconnect`](./src/hooks/useXDisconnect.ts) - Disconnect from a wallet
+
+#### Chain-Specific Hooks
+- [`useEvmSwitchChain`](./src/hooks/evm/useEvmSwitchChain.ts) - Switch between EVM chains
+
+#### Balance Hooks
+- [`useXBalances`](./src/hooks/useXBalances.ts) - Fetch token balances
+
+#### Service Hooks
+- [`useXService`](./src/hooks/useXService.ts) - Access chain-specific service
+
+### Types
+
+#### Core Types
+- [`XAccount`](./src/types/index.ts) - Wallet account type
+- [`XConnection`](./src/types/index.ts) - Wallet connection type
+- [`XConnector`](./src/types/index.ts) - Wallet connector type
+- [`XToken`](./src/types/index.ts) - Cross-chain token type
+
+### Classes
+
+#### XConnector
+- [`XConnector`](./src/core/XConnector.ts) - Base class for wallet connectors
+- [`EvmXConnector`](./src/xchains/evm/EvmXConnector.ts) - EVM wallet connector
+- [`SolanaXConnector`](./src/xchains/solana/SolanaXConnector.ts) - Solana wallet connector
+- [`SuiXConnector`](./src/xchains/sui/SuiXConnector.ts) - Sui wallet connector
+- [`StellarXConnector`](./src/xchains/stellar/StellarWalletsKitXConnector.ts) - Stellar wallet connector
+- [`InjectiveMetamaskXConnector`](./src/xchains/injective/InjectiveMetamaskXConnector.ts) - Injective MetaMask connector
+- [`InjectiveKelprXConnector`](./src/xchains/injective/InjectiveKelprXConnector.ts) - Injective Keplr connector
+- [`IconXConnector`](./src/xchains/icon/IconHanaXConnector.ts) - ICON wallet connector
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build the package
+pnpm build      
+
+# Run in development mode
+pnpm dev
+
+# Run type checking
+pnpm checkTs
+
+# Format code
+pnpm pretty
+
+# Lint code
+pnpm lint
+```
+
+## License
+
+[MIT](LICENSE)
+
+## Support
+
+- [GitHub Issues](https://github.com/icon-project/sodax-frontend/issues)
+- [Discord Community](https://discord.gg/sodax-formerly-icon-880651922682560582)