one-ewallet-otc-ui 0.0.7 → 0.0.9

package/README.md

@@ -82,7 +82,7 @@ function MyComponent() {
       baseUrl="/api"                    // API base URL
       authToken="your-auth-token"       // User authentication token
       userAddress="user-sui-address"    // User Sui address
-      lang="EN"                         // Language: 'ZH' | 'EN', default is 'EN'
+      lang="EN"                         // Language: 'ZH' | 'EN' | 'VI', default is 'EN'
     >
       <button>Open OTC Trading</button>
     </OtcModal>
@@ -98,7 +98,12 @@ function MyComponent() {
 | `baseUrl` | `string` | ✅ | - | API base URL |
 | `authToken` | `string` | ✅ | - | User authentication token |
 | `userAddress` | `string` | ✅ | - | User Sui wallet address |
-| `lang` | `'ZH' \| 'EN'` | ❌ | `'EN'` | Interface language |
+| `lang` | `'ZH' \| 'EN' \| 'VI'` | ❌ | `'EN'` | Interface language |
+| `channel` | `string` | ❌ | `'RWA'` |Interface channel |
+| `currencyListApi` | `string` | ❌ | `'/ext/ewallet/currencyList'` | Currency list API endpoint path |
+| `getAddressApi` | `string` | ❌ | `'/ext/ewallet/getOtcAddress'` | Get OTC address API endpoint path |
+| `listRecordsApi` | `string` | ❌ | `'/ext/ewallet/list'` | List records API endpoint path |
+| `applyDepositApi` | `string` | ❌ | `'/ext/ewallet/applyDeposit'` | Apply deposit API endpoint path |
 
 ### 4. Using Withdraw Component
 
@@ -111,7 +116,15 @@ import { useSuiClient } from '@onelabs/dapp-kit'
 function MyComponent() {
   const suiClient = useSuiClient()
   
-  const handleWithdraw = (withdrawData: any, callback: () => void) => {
+  const handleWithdraw = (withdrawData: {
+    network: string;      // Network/chain name
+    currency: string;     // Payment token
+    address: string;      // Withdrawal address
+    amount: string;       // Withdrawal amount
+    areaCode: string;     // Area code (for HPAY network)
+    toCurrency: string;   // Token to receive
+    minAmount: number;    // Minimum withdrawal amount
+  }, callback: () => void) => {
     // Handle withdrawal logic
     console.log('Withdrawal data:', withdrawData)
     // Execute withdrawal operation...
@@ -125,10 +138,14 @@ function MyComponent() {
       authToken="your-auth-token"
       userAddress="user-sui-address"
       suiClient={suiClient}
-      USDH_COIN_TYPE="0x72eba41c73c4c2ce2bcfc6ec1dc0896ba1b5c17bfe7ae7c6c779943f84912b41::usdh::USDH"
-      USDH_DECIMALS={9}
+      tokenCoinTypeList={[
+        { name: 'USDH', coinType: '0x72eba41c73c4c2ce2bcfc6ec1dc0896ba1b5c17bfe7ae7c6c779943f84912b41::usdh::USDH', decimals: 9 }
+      ]}
       onSubmit={handleWithdraw}
       lang="EN"
+      currencyListApi="/ext/ewallet/currencyList"
+      getWithdrawAddressApi="/ext/ewallet/getWithdrawAddress"
+      listRecordsApi="/ext/ewallet/list"
     >
       <button>Open Withdrawal</button>
     </Withdraw>
@@ -145,10 +162,42 @@ function MyComponent() {
 | `authToken` | `string` | ✅ | - | User authentication token |
 | `userAddress` | `string` | ✅ | - | User Sui wallet address |
 | `suiClient` | `ReturnType<typeof useSuiClient>` | ✅ | - | SuiClient instance (obtained via `useSuiClient()` hook) |
-| `USDH_COIN_TYPE` | `string` | ✅ | - | USDH token Coin Type |
-| `USDH_DECIMALS` | `number` | ✅ | - | USDH token decimal places |
-| `onSubmit` | `(withdrawData: any, callback: () => void) => void` | ✅ | - | Withdrawal submit callback function |
-| `lang` | `'ZH' \| 'EN'` | ❌ | `'EN'` | Interface language |
+| `tokenCoinTypeList` | `tokenCoinType[]` | ✅ | - | Token coin type list, each item contains `name`, `coinType`, `decimals` |
+| `onSubmit` | `(withdrawData: WithdrawData, callback: () => void) => void` | ✅ | - | Withdrawal submit callback function |
+| `lang` | `'ZH' \| 'EN' \| 'VI'` | ❌ | `'EN'` | Interface language |
+| `channel` | `string` | ❌ | `'RWA'` |Interface channel |
+| `currencyListApi` | `string` | ❌ | `'/ext/ewallet/currencyList'` | Currency list API endpoint path |
+| `getWithdrawAddressApi` | `string` | ❌ | `'/ext/ewallet/getWithdrawAddress'` | Get withdrawal address API endpoint path |
+| `listRecordsApi` | `string` | ❌ | `'/ext/ewallet/list'` | List records API endpoint path |
+
+#### Type Definitions
+
+**tokenCoinType Interface:**
+
+```typescript
+interface tokenCoinType {
+  name: string;      // Token name (e.g., 'USDH', 'USDT')
+  coinType: string;  // Sui coin type (e.g., '0x72eba41c73c4c2ce2bcfc6ec1dc0896ba1b5c17bfe7ae7c6c779943f84912b41::usdh::USDH')
+  decimals: number;  // Token decimal places (e.g., 9)
+}
+```
+
+**WithdrawData Interface:**
+
+The `withdrawData` parameter passed to `onSubmit` callback has the following structure:
+
+```typescript
+interface WithdrawData {
+  network: string;      // Network/chain name (e.g., 'HPAY', 'BSC', 'ETH', 'TRX')
+  currency: string;     // Payment token (e.g., 'USDH')
+  address: string;      // Withdrawal address
+  amount: string;       // Withdrawal amount
+  areaCode: string;     // Area code (for HPAY network, e.g., '+855')
+  toCurrency: string;   // Token to receive (e.g., 'USDT', 'USD')
+  minAmount: number;    // Minimum withdrawal amount
+}
+```
+
 
 ## 📝 Complete Example
 
@@ -189,6 +238,11 @@ const AppContent = () => {
         authToken="your-auth-token"
         userAddress="0x..."
         lang="EN"
+        channel="RWA"
+        currencyListApi="/ext/ewallet/currencyList"
+        getAddressApi="/ext/ewallet/getOtcAddress"
+        listRecordsApi="/ext/ewallet/list"
+        applyDepositApi="/ext/ewallet/applyDeposit"
       >
         <button>OTC Trading</button>
       </OtcModal>
@@ -198,10 +252,15 @@ const AppContent = () => {
         authToken="your-auth-token"
         userAddress="0x..."
         suiClient={suiClient}
-        USDH_COIN_TYPE="0x72eba41c73c4c2ce2bcfc6ec1dc0896ba1b5c17bfe7ae7c6c779943f84912b41::usdh::USDH"
-        USDH_DECIMALS={9}
+        tokenCoinTypeList={[
+          { name: 'USDH', coinType: '0x72eba41c73c4c2ce2bcfc6ec1dc0896ba1b5c17bfe7ae7c6c779943f84912b41::usdh::USDH', decimals: 9 }
+        ]}
         onSubmit={handleWithdraw}
         lang="EN"
+        channel="RWA"
+        currencyListApi="/ext/ewallet/currencyList"
+        getWithdrawAddressApi="/ext/ewallet/getWithdrawAddress"
+        listRecordsApi="/ext/ewallet/list"
       >
         <button>Withdraw</button>
       </Withdraw>
@@ -238,17 +297,22 @@ The component library includes built-in styles written in SCSS. The styles are a
 
 ## 🔌 API Endpoints
 
-The components require the following API endpoints:
+The components require the following API endpoints. You can customize the API paths by passing the corresponding props:
 
 ### OtcModal Required Endpoints
 
-- `POST {baseUrl}/ext/ewallet/getOtcAddress` - Get OTC address
-- Other OTC related endpoints...
+- `POST {baseUrl}{currencyListApi}` - Get currency list (default: `/ext/ewallet/currencyList`)
+- `POST {baseUrl}{getAddressApi}` - Get OTC address (default: `/ext/ewallet/getOtcAddress`)
+- `POST {baseUrl}{listRecordsApi}` - List transaction records (default: `/ext/ewallet/list`)
+- `POST {baseUrl}{applyDepositApi}` - Apply deposit (default: `/ext/ewallet/applyDeposit`)
 
 ### Withdraw Required Endpoints
 
-- `POST {baseUrl}/ext/ewallet/getWithdrawAddress` - Get withdrawal address
-- Other withdrawal related endpoints...
+- `POST {baseUrl}{currencyListApi}` - Get currency list (default: `/ext/ewallet/currencyList`)
+- `POST {baseUrl}{getWithdrawAddressApi}` - Get withdrawal address (default: `/ext/ewallet/getWithdrawAddress`)
+- `POST {baseUrl}{listRecordsApi}` - List transaction records (default: `/ext/ewallet/list`)
+
+You can customize these endpoints by passing the corresponding API path props to the components.
 
 ## 🛠️ Development
 
@@ -266,6 +330,42 @@ npm run build
 npm run preview
 ```
 
+## 📝 Changelog
+
+### Latest Updates
+
+#### 1. 支持越南语 (Vietnamese Language Support)
+- 新增支持 `'VI'` 语言选项
+- `OtcModal` 和 `Withdraw` 组件现在都支持 `lang="VI"` 参数
+- 所有界面文本已翻译为越南语
+
+#### 2. 接口路径可配置化 (Configurable API Endpoints)
+- **OtcModal 组件**新增以下可选参数：
+  - `currencyListApi`: 币种列表接口路径（默认: `'/ext/ewallet/currencyList'`）
+  - `getAddressApi`: 获取OTC地址接口路径（默认: `'/ext/ewallet/getOtcAddress'`）
+  - `listRecordsApi`: 交易记录列表接口路径（默认: `'/ext/ewallet/list'`）
+  - `applyDepositApi`: 申请充值接口路径（默认: `'/ext/ewallet/applyDeposit'`）
+
+- **Withdraw 组件**新增以下可选参数：
+  - `currencyListApi`: 币种列表接口路径（默认: `'/ext/ewallet/currencyList'`）
+  - `getWithdrawAddressApi`: 获取提现地址接口路径（默认: `'/ext/ewallet/getWithdrawAddress'`）
+  - `listRecordsApi`: 交易记录列表接口路径（默认: `'/ext/ewallet/list'`）
+
+- **Withdraw 组件参数变更**：
+  - `USDH_COIN_TYPE` 和 `USDH_DECIMALS` 已合并为 `tokenCoinTypeList` 参数
+  - `tokenCoinTypeList` 类型为 `tokenCoinType[]`，支持多个代币配置
+  - 每个 `tokenCoinType` 包含：`name`（代币名称）、`coinType`（代币类型）、`decimals`（小数位数）
+
+- **onSubmit 回调参数类型**：
+  - `withdrawData` 参数现在有明确的类型定义，包含以下字段：
+    - `network`: 网络/链名称
+    - `currency`: 支付代币
+    - `address`: 提现地址
+    - `amount`: 提现金额
+    - `areaCode`: 区号（HPAY网络使用）
+    - `toCurrency`: 接收代币
+    - `minAmount`: 最小提现金额
+
 ## 📄 License
 
 MIT