clawreum-sdk 1.0.0 → 1.0.1

package/README.md

@@ -15,24 +15,24 @@ const ClawreumMiner = require('clawreum-sdk');
 
 const miner = new ClawreumMiner({
   platform: 'telegram',      // 'telegram' | 'discord' | 'whatsapp'
-  botId: '123456789',        // 플랫폼 봇 ID
-  botName: 'MyMiningBot'     // 봇 표시 이름
+  botId: '123456789',        // Platform bot ID
+  botName: 'MyMiningBot'     // Bot display name
 });
 
-// 이벤트 리스너
+// Event listeners
 miner.on('reward', (data) => {
   console.log(`+${data.reward.toFixed(4)} CLAWREUM`);
 });
 
 miner.on('balance', (data) => {
-  console.log(`정제중: ${data.refining}, 클레임 가능: ${data.claimable}`);
+  console.log(`Refining: ${data.refining}, Claimable: ${data.claimable}`);
 });
 
 miner.on('error', (err) => {
-  console.error('에러:', err.message);
+  console.error('Error:', err.message);
 });
 
-// 채굴 시작
+// Start mining
 miner.start();
 ```
 
@@ -40,41 +40,41 @@ miner.start();
 
 | Option | Type | Required | Default | Description |
 |--------|------|----------|---------|-------------|
-| `platform` | string | ✓ | - | 봇 플랫폼 (`telegram`, `discord`, `whatsapp`) |
-| `botId` | string | ✓ | - | 플랫폼 봇 ID |
-| `botName` | string | ✓ | - | 봇 표시 이름 |
-| `server` | string | | `wss://api.clawreum.com` | WebSocket 서버 URL |
-| `ownerWallet` | string | | - | 보상 받을 지갑 주소 |
-| `autoReconnect` | boolean | | `true` | 자동 재연결 |
-| `miningInterval` | number | | `250` | 채굴 액션 간격 (ms) |
+| `platform` | string | Yes | - | Bot platform (`telegram`, `discord`, `whatsapp`) |
+| `botId` | string | Yes | - | Platform bot ID |
+| `botName` | string | Yes | - | Bot display name |
+| `server` | string | No | `wss://api.clawreum.com` | WebSocket server URL |
+| `ownerWallet` | string | No | - | Wallet address for rewards |
+| `autoReconnect` | boolean | No | `true` | Auto reconnect on disconnect |
+| `miningInterval` | number | No | `250` | Mining action interval (ms) |
 
 ## Events
 
 | Event | Data | Description |
 |-------|------|-------------|
-| `registered` | `{ botId, characterName }` | 봇 등록 완료 |
-| `authenticated` | `{ botName }` | 인증 성공 |
-| `joined` | `{ room, botId }` | 방 입장 |
-| `mining` | `{ started: true }` | 채굴 루프 시작 |
-| `progress` | `{ progress }` | 채굴 진행률 (0~1) |
-| `reward` | `{ reward, base, bonus, packId }` | 채굴 보상 |
-| `balance` | `{ refining, claimable, world, boost }` | 잔액 동기화 |
-| `block` | `{ block, pack, difficulty }` | 블록 업데이트 |
-| `disconnected` | `{ code, reason }` | 연결 종료 |
-| `stopped` | - | 채굴 중지 |
-| `error` | `Error` | 에러 발생 |
-| `log` | `string` | 로그 메시지 |
+| `registered` | `{ botId, characterName }` | Bot registration complete |
+| `authenticated` | `{ botName }` | Authentication successful |
+| `joined` | `{ room, botId }` | Joined mining room |
+| `mining` | `{ started: true }` | Mining loop started |
+| `progress` | `{ progress }` | Mining progress (0~1) |
+| `reward` | `{ reward, base, bonus, packId }` | Mining reward received |
+| `balance` | `{ refining, claimable, world, boost }` | Balance sync |
+| `block` | `{ block, pack, difficulty }` | Block update |
+| `disconnected` | `{ code, reason }` | Connection closed |
+| `stopped` | - | Mining stopped |
+| `error` | `Error` | Error occurred |
+| `log` | `string` | Log message |
 
 ## Methods
 
 ### `start()`
-채굴을 시작합니다.
+Start mining.
 
 ### `stop()`
-채굴을 중지하고 연결을 종료합니다.
+Stop mining and close connection.
 
 ### `getStatus()`
-현재 상태를 반환합니다.
+Get current status.
 
 ```javascript
 const status = miner.getStatus();
@@ -104,27 +104,27 @@ miner.on('log', console.log);
 miner.on('error', console.error);
 
 miner.on('registered', ({ botId }) => {
-  console.log(`봇 등록됨: ${botId}`);
+  console.log(`Bot registered: ${botId}`);
 });
 
 miner.on('reward', ({ reward, bonus }) => {
-  console.log(`채굴 성공! +${reward.toFixed(4)} (보너스: ${bonus.toFixed(4)})`);
+  console.log(`Mining success! +${reward.toFixed(4)} (bonus: ${bonus.toFixed(4)})`);
 });
 
 miner.on('balance', ({ refining, claimable }) => {
-  console.log(`잔액 - 정제중: ${refining.toFixed(2)}, 클레임: ${claimable.toFixed(2)}`);
+  console.log(`Balance - Refining: ${refining.toFixed(2)}, Claimable: ${claimable.toFixed(2)}`);
 });
 
-// 시작
+// Start
 miner.start();
 
-// 10분 후 상태 확인
+// Check status after 10 minutes
 setTimeout(() => {
   const status = miner.getStatus();
-  console.log(`총 채굴량: ${status.stats.totalMined.toFixed(4)} CLAWREUM`);
+  console.log(`Total mined: ${status.stats.totalMined.toFixed(4)} CLAWREUM`);
 }, 600000);
 
-// 종료 처리
+// Graceful shutdown
 process.on('SIGINT', () => {
   miner.stop();
   process.exit();
@@ -134,7 +134,7 @@ process.on('SIGINT', () => {
 ## Requirements
 
 - Node.js 18+
-- 등록된 봇 (Telegram/Discord/WhatsApp)
+- Registered bot (Telegram/Discord/WhatsApp)
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clawreum-sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Clawreum Mining SDK - Bot client for mining CLAWREUM tokens",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/index.js

@@ -1,7 +1,7 @@
 /**
  * Clawreum Mining SDK
  *
- * 사용법:
+ * Usage:
  *   const ClawreumMiner = require('clawreum-sdk');
  *
  *   const miner = new ClawreumMiner({
@@ -25,18 +25,18 @@ class ClawreumMiner extends EventEmitter {
   /**
    * @param {Object} options
    * @param {string} options.platform - 'telegram' | 'discord' | 'whatsapp'
-   * @param {string} options.botId - 플랫폼 봇 ID
-   * @param {string} options.botName - 봇 표시 이름
-   * @param {string} [options.server] - WebSocket 서버 URL (기본: wss://api.clawreum.com)
-   * @param {string} [options.ownerWallet] - 보상 받을 지갑 주소
-   * @param {boolean} [options.autoReconnect] - 자동 재연결 (기본: true)
-   * @param {number} [options.miningInterval] - 채굴 액션 간격 ms (기본: 250)
+   * @param {string} options.botId - Platform bot ID
+   * @param {string} options.botName - Bot display name
+   * @param {string} [options.server] - WebSocket server URL (default: wss://api.clawreum.com)
+   * @param {string} [options.ownerWallet] - Wallet address for rewards
+   * @param {boolean} [options.autoReconnect] - Auto reconnect (default: true)
+   * @param {number} [options.miningInterval] - Mining action interval in ms (default: 250)
    */
   constructor(options = {}) {
     super();
 
     if (!options.platform || !options.botId || !options.botName) {
-      throw new Error('필수 옵션: platform, botId, botName');
+      throw new Error('Required options: platform, botId, botName');
     }
 
     this.options = {
@@ -55,7 +55,7 @@ class ClawreumMiner extends EventEmitter {
     this.maxReconnectAttempts = 10;
     this.botId = null;
 
-    // 통계
+    // Stats
     this.stats = {
       totalMined: 0,
       miningCount: 0,
@@ -65,15 +65,15 @@ class ClawreumMiner extends EventEmitter {
   }
 
   /**
-   * 채굴 시작
+   * Start mining
    */
   async start() {
     if (this.isConnected) {
-      this.emit('warn', '이미 연결되어 있습니다');
+      this.emit('warn', 'Already connected');
       return;
     }
 
-    this.emit('log', `서버 연결 중: ${this.options.server}`);
+    this.emit('log', `Connecting to server: ${this.options.server}`);
 
     try {
       const wsToken = await this._registerBot();
@@ -87,7 +87,7 @@ class ClawreumMiner extends EventEmitter {
   }
 
   /**
-   * 채굴 중지
+   * Stop mining
    */
   stop() {
     this._stopMiningLoop();
@@ -102,7 +102,7 @@ class ClawreumMiner extends EventEmitter {
   }
 
   /**
-   * 현재 상태 조회
+   * Get current status
    */
   getStatus() {
     return {
@@ -147,7 +147,7 @@ class ClawreumMiner extends EventEmitter {
     const result = await response.json();
 
     if (!result.success) {
-      throw new Error(result.message || '봇 등록 실패');
+      throw new Error(result.message || 'Bot registration failed');
     }
 
     this.botId = result.botId;
@@ -162,13 +162,13 @@ class ClawreumMiner extends EventEmitter {
       this.ws = new WebSocket(wsUrl);
 
       const timeout = setTimeout(() => {
-        reject(new Error('연결 타임아웃'));
+        reject(new Error('Connection timeout'));
         this.ws.close();
       }, 30000);
 
       this.ws.on('open', () => {
         clearTimeout(timeout);
-        this.emit('log', 'WebSocket 연결됨');
+        this.emit('log', 'WebSocket connected');
         this.reconnectAttempts = 0;
       });
 
@@ -177,7 +177,7 @@ class ClawreumMiner extends EventEmitter {
           const msg = JSON.parse(data.toString());
           this._handleMessage(msg, resolve, reject);
         } catch (err) {
-          this.emit('error', new Error(`메시지 파싱 실패: ${err.message}`));
+          this.emit('error', new Error(`Message parsing failed: ${err.message}`));
         }
       });
 
@@ -218,7 +218,7 @@ class ClawreumMiner extends EventEmitter {
         break;
 
       case 'attestFail':
-        this.emit('error', new Error(`인증 실패: ${data.reason}`));
+        this.emit('error', new Error(`Authentication failed: ${data.reason}`));
         if (rejectConnect) rejectConnect(new Error(data.reason));
         break;
 
@@ -264,11 +264,11 @@ class ClawreumMiner extends EventEmitter {
 
       case 'reAttestSuccess':
         this.sessionSecret = data.sessionSecret;
-        this.emit('log', '재인증 성공');
+        this.emit('log', 'Re-authentication successful');
         break;
 
       case 'sessionRevoked':
-        this.emit('error', new Error(`세션 취소: ${data.reason}`));
+        this.emit('error', new Error(`Session revoked: ${data.reason}`));
         this.stop();
         break;
 
@@ -285,7 +285,7 @@ class ClawreumMiner extends EventEmitter {
         break;
 
       default:
-        // 기타 메시지
+        // Other messages
         break;
     }
   }
@@ -293,7 +293,7 @@ class ClawreumMiner extends EventEmitter {
   _handleChallenge(challenge, isReAttest = false) {
     const { challengeId, nonce, difficulty } = challenge;
 
-    this.emit('log', `${isReAttest ? '재' : ''}인증 챌린지 (difficulty: ${difficulty})`);
+    this.emit('log', `${isReAttest ? 'Re-' : ''}Authentication challenge (difficulty: ${difficulty})`);
 
     const solution = this._solveChallenge(nonce, difficulty);
 
@@ -354,14 +354,14 @@ class ClawreumMiner extends EventEmitter {
 
   _scheduleReconnect() {
     if (this.reconnectAttempts >= this.maxReconnectAttempts) {
-      this.emit('error', new Error('최대 재연결 시도 초과'));
+      this.emit('error', new Error('Max reconnection attempts exceeded'));
       return;
     }
 
     const delay = Math.min(1000 * Math.pow(2, this.reconnectAttempts), 30000);
     this.reconnectAttempts++;
 
-    this.emit('log', `${delay / 1000}초 후 재연결 시도 (${this.reconnectAttempts}/${this.maxReconnectAttempts})`);
+    this.emit('log', `Reconnecting in ${delay / 1000}s (${this.reconnectAttempts}/${this.maxReconnectAttempts})`);
 
     setTimeout(() => {
       this.start();