@ultrade/react-sdk 1.0.0 → 1.0.2

package/README.md

@@ -4,10 +4,11 @@ Redux Toolkit Query adaptor for @ultrade/ultrade-js-sdk. Provides RTK Query endp
 
 **Repository:** [https://github.com/ultrade-org/ultrade-react-sdk](https://github.com/ultrade-org/ultrade-react-sdk)
 
+**SDK Repository:** [https://github.com/ultrade-org/ultrade-js-sdk](https://github.com/ultrade-org/ultrade-js-sdk)
+
 ## Package Info
 
 - **Name:** `@ultrade/react-sdk`
-- **Purpose:** Bridge between Redux Toolkit Query and Ultrade SDK
 - **Main Entry:** `./dist/index.js`
 - **Types:** `./dist/index.d.ts`
 
@@ -27,37 +28,6 @@ yarn add @ultrade/react-sdk
 pnpm add @ultrade/react-sdk
 ```
 
-## TypeScript Configuration
-
-For proper type resolution and convenient development, you need to configure your `tsconfig.json` correctly.
-
-### Recommended Configuration
-
-The configuration should be able to resolve types that account for the `exports` field in `package.json`:
-
-```json
-{
-  "compilerOptions": {
-    "moduleResolution": "nodenext"
-    // Alternative options: "node16" or "bundler"
-  }
-}
-```
-
-### Alternative: Manual Path Configuration
-
-If you cannot change your TypeScript settings, you can explicitly specify paths:
-
-```json
-{
-  "compilerOptions": {
-    "paths": {
-      "@ultrade/shared/browser/*": ["../shared/dist/browser/*"]
-    }
-  }
-}
-```
-
 ## Structure
 
 ```
@@ -120,65 +90,92 @@ Defined in `tsconfig.alias.json`:
 | `@interfaces` | `./src/interfaces/index.ts` | TypeScript interfaces |
 | `@utils` | `./src/utils/index.ts` | Utility functions |
 
-## Usage Example
+### Creating RTK SDK Client
 
 ```typescript
-import { marketsPairsApi, walletApi } from '@ultrade/react-sdk';
-
-// Use in React component
-function TradingComponent() {
-  const { data: pairs } = marketsPairsApi.useGetPairListQuery({ companyId: 1 });
-  const { data: transactions } = walletApi.useGetWalletTransactionsQuery({ 
-    type: 'DEPOSIT',
-    page: 1,
-    limit: 50
-  });
-
-  return (
-    <div>
-      {/* Render data */}
-    </div>
-  );
-}
+import RTKSDKAdaptor from '@ultrade/react-sdk';
+import algosdk from 'algosdk';
+
+// Create Algorand SDK client
+const rtkAlgodClient = new algosdk.Algodv2(
+  '', // token
+  'https://testnet-api.algonode.cloud', // server
+  '' // port
+);
+
+// Initialize RTK SDK client (extends Client from @ultrade/ultrade-js-sdk)
+const rtkSdkClient = new RTKSDKAdaptor({
+  network: 'testnet', // or 'mainnet'
+  apiUrl: 'https://api.testnet.ultrade.org',
+  algoSdkClient: rtkAlgodClient,
+  websocketUrl: 'wss://ws.testnet.ultrade.org',
+});
+
+// Set signer (same as base SDK)
+rtkSdkClient.setSigner({
+  signMessage,
+  signMessageByToken
+});
 ```
 
-## Build Commands
+### Redux Store Setup
 
-**Important:** First install node_modules from monorepo root (npm_packages)
+```typescript
+import { SDKReducers, SDKMiddlewares } from '@ultrade/react-sdk';
 
-- `npm run build` - Production build
-- `npm run dev` - Development build with watch mode
+export const store = configureStore({
+  reducer: {
+    // ... your other reducers
+    ...SDKReducers
+  },
+  middleware: (getDefaultMiddleware) =>
+    getDefaultMiddleware().concat(SDKMiddlewares)
+});
 
-## Key Features
+```
 
-1. **Type-Safe RTK Query Endpoints** - All endpoints use SDK argument interfaces
-2. **Cache Management** - Automatic cache invalidation with tags
-3. **WebSocket Integration** - Real-time updates through WebSocket handlers
-4. **Error Handling** - Centralized error handling with `withErrorHandling`
-5. **SDK Client Singleton** - Single SDK client instance via `getSdkClient()`
+### Using RTK Query Hooks
 
-## Cache Tags
+```typescript
+import { useAppSelector } from './hooks';
+import { useEffect } from 'react';
+
+function Component() {
+  //...
+
+  const { useLazyGetSettingsQuery, useLazyGetPairListQuery } = rtkSdkClient.markets();
+  const { useGetTradingKeysQuery, useAddTradingKeyMutation } = rtkSdkClient.walletApi();
+  
+  // Lazy query for settings
+  const [getSettings, { data: settings, isLoading: isLoadingSettings }] = useLazyGetSettingsQuery();
+  
+  // Query for trading pairs
+  const [getPairList, { data: pairs, isLoading: isLoadingPairs }] = useLazyGetPairListQuery();
+  
+  // Query for trading keys
+  const { data: tradingKeys, isLoading: isLoadingKeys } = useGetTradingKeysQuery();
+  
+  // Mutation for creating trading key
+  const [addTradingKey, { isLoading: isCreatingKey }] = useAddTradingKeyMutation();
+  
+  return <></>
+}
+```
 
-All endpoints use cache tags for automatic invalidation:
+## Redux integration
 
-- `markets_balances` - Balance data
-- `markets_settings` - Market settings
-- `markets_depth` - Order book depth
-- `markets_history` - Historical candles
-- `markets_orders` - User orders
-- `markets_pair_list` - Trading pairs
-- `markets_last_trades` - Recent trades
-- `wallet_transactions` - Wallet transactions
-- `wallet_transfers` - Transfer history
-- `wallet_whitelist` - Withdrawal whitelist
-- `wallet_trading_keys` - Trading keys
-- `wallet_pending_transactions` - Pending transactions
-- `withdrawal_wallets` - Withdrawal wallets
+```typescript
+import { Provider } from 'react-redux';
+import { store } from './store';
 
-## Dependencies
+function App() {
+  
+  //component logic
 
-- **Peer Dependencies:**
-  - `@reduxjs/toolkit`
-  - `react-redux`
-  - `@ultrade/ultrade-js-sdk`
-  - `@ultrade/shared`
+  return (
+    <Provider store={store}>
+      <YourApp />
+    </Provider>
+  );
+}
+```

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import RtkSdkAdaptor from "@api";
+import RtkSdkAdaptor from "./api/index.ts";
 export * from './connection/middlewares';
 export * from './connection/reducers';
-export * from "@api";
+export * from "./api/index.ts";
 export default RtkSdkAdaptor;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ultrade/react-sdk",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "",
   "keywords": [],
   "main": "./dist/index.js",
@@ -12,11 +12,15 @@
   },
   "author": "",
   "files": [
-    "dist",
-    "README.md"
+    "dist"
   ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
   "peerDependencies": {
     "@reduxjs/toolkit": "^1.9.7",
+    "@ultrade/ultrade-js-sdk": "^2.0.2",
     "bignumber.js": "^9.1.2",
     "react": "^18.0.0",
     "react-redux": "^8.0.0"
@@ -31,8 +35,5 @@
     "esbuild-plugin-d.ts": "^1.3.1",
     "ts-node": "^10.9.2",
     "typescript": "^5.6.3"
-  },
-  "dependencies": {
-    "@ultrade/ultrade-js-sdk": "^2.0.2"
   }
 }