@dyyxyzz/baileys-mod 6.0.49 → 6.0.50

package/lib/Socket/socket.js

@@ -78,36 +78,40 @@ const makeSocket = (config) => {
         return sendRawMessage(buff);
     };
     
-    const toLid = async (pn) => {
-        return pn;
-    };
-
-    const delay = async (ms) => {
-        return new Promise(resolve => setTimeout(resolve, ms));
-    };
+ const toLid = async (pn) => {
+return pn;
+};
 
-    const toPn = async (pn) => {
-        return pn;
-    };
+const delay = async (ms) => {
+    return new Promise(resolve => setTimeout(resolve, ms));
+ }
 
+const toPn = async (pn) => {
+    return pn;
+};
     /** log & process any unexpected errors */
     const onUnexpectedError = (err, msg) => {
         logger.error({ err }, `unexpected error in '${msg}'`);
         const message = (err && ((err.stack || err.message) || String(err))).toLowerCase();
+        // auto recover from cryptographic desyncs by re-uploading prekeys
         if (message.includes('bad mac') || (message.includes('mac') && message.includes('invalid'))) {
             try {
                 uploadPreKeysToServerIfRequired(true)
                     .catch(e => logger.warn({ e }, 'failed to re-upload prekeys after bad mac'));
             }
-            catch (_e) {}
+            catch (_e) {
+                // ignore
+            }
         }
+        // gently back off when encountering rate limits (429)
         if (message.includes('429') || message.includes('rate limit')) {
             const wait = Math.min(30000, (config.backoffDelayMs || 5000));
             logger.info({ wait }, 'backing off due to rate limit');
-            setTimeout(() => {}, wait);
+            setTimeout(() => {
+                // intentionally empty; wait to delay further sends
+            }, wait);
         }
     };
-
     /** await the next incoming message */
     const awaitNextMessage = async (sendMsg) => {
         if (!ws.isOpen) {
@@ -134,7 +138,11 @@ const makeSocket = (config) => {
         }
         return result;
     };
-
+    /**
+     * Wait for a message with a certain tag to be received
+     * @param msgId the message tag to await
+     * @param timeoutMs timeout after which the promise will reject
+     */
     const waitForMessage = async (msgId, timeoutMs = defaultQueryTimeoutMs) => {
         let onRecv;
         let onErr;
@@ -145,18 +153,18 @@ const makeSocket = (config) => {
                     reject(err || new boom_1.Boom('Connection Closed', { statusCode: Types_1.DisconnectReason.connectionClosed }));
                 };
                 ws.on(`TAG:${msgId}`, onRecv);
-                ws.on('close', onErr);
+                ws.on('close', onErr); // if the socket closes, you'll never receive the message
                 ws.off('error', onErr);
             });
             return result;
         }
         finally {
             ws.off(`TAG:${msgId}`, onRecv);
-            ws.off('close', onErr);
+            ws.off('close', onErr); // if the socket closes, you'll never receive the message
             ws.off('error', onErr);
         }
     };
-
+    /** send a query, and wait for its response. auto-generates message ID if not provided */
     const query = async (node, timeoutMs) => {
         if (!node.attrs.id) {
             node.attrs.id = generateMessageTag();
@@ -171,7 +179,6 @@ const makeSocket = (config) => {
         }
         return result;
     };
-
     /** connection handshake */
     const validateConnection = async () => {
         let helloMsg = {
@@ -203,7 +210,6 @@ const makeSocket = (config) => {
         noise.finishInit();
         startKeepAliveRequest();
     };
-
     const getAvailablePreKeysOnServer = async () => {
         const result = await query({
             tag: 'iq',
@@ -220,7 +226,7 @@ const makeSocket = (config) => {
         const countChild = (0, WABinary_1.getBinaryNodeChild)(result, 'count');
         return +countChild.attrs.value;
     };
-
+    /** generates and uploads a set of pre-keys to the server */
     const uploadPreKeys = async (count = Defaults_1.INITIAL_PREKEY_COUNT) => {
         await keys.transaction(async () => {
             logger.info({ count }, 'uploading pre-keys');
@@ -230,7 +236,6 @@ const makeSocket = (config) => {
             logger.info({ count }, 'uploaded pre-keys');
         });
     };
-
     const uploadPreKeysToServerIfRequired = async () => {
         const preKeyCount = await getAvailablePreKeysOnServer();
         logger.info(`${preKeyCount} pre-keys found on server`);
@@ -238,19 +243,22 @@ const makeSocket = (config) => {
             await uploadPreKeys();
         }
     };
-
     const onMessageReceived = (data) => {
         noise.decodeFrame(data, frame => {
             var _a;
+            // reset ping timeout
             lastDateRecv = new Date();
             let anyTriggered = false;
             anyTriggered = ws.emit('frame', frame);
+            // if it's a binary node
             if (!(frame instanceof Uint8Array)) {
                 const msgId = frame.attrs.id;
                 if (logger.level === 'trace') {
                     logger.trace({ xml: (0, WABinary_1.binaryNodeToString)(frame), msg: 'recv xml' });
                 }
+                /* Check if this is a response to a message we sent */
                 anyTriggered = ws.emit(`${Defaults_1.DEF_TAG_PREFIX}${msgId}`, frame) || anyTriggered;
+                /* Check if this is a response to a message we are expecting */
                 const l0 = frame.tag;
                 const l1 = frame.attrs || {};
                 const l2 = Array.isArray(frame.content) ? (_a = frame.content[0]) === null || _a === void 0 ? void 0 : _a.tag : '';
@@ -267,7 +275,6 @@ const makeSocket = (config) => {
             }
         });
     };
-
     const end = (error) => {
         if (closed) {
             logger.trace({ trace: error === null || error === void 0 ? void 0 : error.stack }, 'connection already closed');
@@ -296,7 +303,6 @@ const makeSocket = (config) => {
         });
         ev.removeAllListeners('connection.update');
     };
-
     const waitForSocketOpen = async () => {
         if (ws.isOpen) {
             return;
@@ -319,16 +325,20 @@ const makeSocket = (config) => {
             ws.off('error', onClose);
         });
     };
-
     const startKeepAliveRequest = () => (keepAliveReq = setInterval(() => {
         if (!lastDateRecv) {
             lastDateRecv = new Date();
         }
         const diff = Date.now() - lastDateRecv.getTime();
+        /*
+            check if it's been a suspicious amount of time since the server responded with our last seen
+            it could be that the network is down
+        */
         if (diff > keepAliveIntervalMs + 5000) {
             end(new boom_1.Boom('Connection was lost', { statusCode: Types_1.DisconnectReason.connectionLost }));
         }
         else if (ws.isOpen) {
+            // if its all good, send a keep alive request
             query({
                 tag: 'iq',
                 attrs: {
@@ -347,7 +357,7 @@ const makeSocket = (config) => {
             logger.warn('keep alive called when WS not open');
         }
     }, keepAliveIntervalMs));
-
+    /** i have no idea why this exists. pls enlighten me */
     const sendPassiveIq = (tag) => (query({
         tag: 'iq',
         attrs: {
@@ -359,7 +369,7 @@ const makeSocket = (config) => {
             { tag, attrs: {} }
         ]
     }));
-
+    /** logout & invalidate connection */
     const logout = async (msg) => {
         var _a;
         const jid = (_a = authState.creds.me) === null || _a === void 0 ? void 0 : _a.id;
@@ -385,7 +395,7 @@ const makeSocket = (config) => {
         }
         end(new boom_1.Boom(msg || 'Intentional Logout', { statusCode: Types_1.DisconnectReason.loggedOut }));
     };
-
+    
     /** This method was created by snowi, and implemented by KyuuRzy */
     /** hey bro, if you delete this text */
     /** you are the most cursed human being who likes to claim other people's property 😹🙌🏻 */
@@ -402,13 +412,7 @@ const makeSocket = (config) => {
         };
 
         ev.emit('creds.update', authState.creds);
-
-        // ── FIX: Platform ID 1 = Chrome, dikenali WA sebagai companion browser valid ──
-        // Sebelumnya pakai getPlatformId(browser[1]) yang return nilai tidak dikenal
-        // untuk string 'Android' sehingga WA tidak mengirimkan push notif pairing ke HP
-        const PLATFORM_ID = Buffer.from([1]); // 1 = Chrome/Browser companion
-        const PLATFORM_DISPLAY = Buffer.from('Chrome (Linux)', 'utf-8');
-
+        
         await sendNode({
             tag: 'iq',
             attrs: {
@@ -439,26 +443,25 @@ const makeSocket = (config) => {
                         {
                             tag: 'companion_platform_id',
                             attrs: {},
-                            content: PLATFORM_ID
+                            content: (0, Utils_1.getPlatformId)(browser[1])
                         },
                         {
                             tag: 'companion_platform_display',
                             attrs: {},
-                            content: PLATFORM_DISPLAY
+                            content: `${browser[1]} (${browser[0]})`
                         },
                         {
                             tag: 'link_code_pairing_nonce',
                             attrs: {},
-                            content: Buffer.from('0', 'utf-8')
+                            content: "0"
                         }
                     ]
                 }
             ]
         });
-
+        
         return authState.creds.pairingCode;
-    };
-
+    }
     async function generatePairingKey() {
         const salt = (0, crypto_1.randomBytes)(32);
         const randomIv = (0, crypto_1.randomBytes)(16);
@@ -466,7 +469,6 @@ const makeSocket = (config) => {
         const ciphered = (0, Utils_1.aesEncryptCTR)(authState.creds.pairingEphemeralKeyPair.public, key, randomIv);
         return Buffer.concat([salt, randomIv, ciphered]);
     }
-
     const sendWAMBuffer = (wamBuffer) => {
         return query({
             tag: 'iq',
@@ -484,7 +486,6 @@ const makeSocket = (config) => {
             ]
         });
     };
-
     ws.on('message', onMessageReceived);
     ws.on('open', async () => {
         try {
@@ -497,8 +498,9 @@ const makeSocket = (config) => {
     });
     ws.on('error', mapWebSocketError(end));
     ws.on('close', () => end(new boom_1.Boom('Connection Terminated', { statusCode: Types_1.DisconnectReason.connectionClosed })));
+    // the server terminated the connection
     ws.on('CB:xmlstreamend', () => end(new boom_1.Boom('Connection Terminated by Server', { statusCode: Types_1.DisconnectReason.connectionClosed })));
-
+    // QR gen
     ws.on('CB:iq,type:set,pair-device', async (stanza) => {
         const iq = {
             tag: 'iq',
@@ -514,7 +516,7 @@ const makeSocket = (config) => {
         const noiseKeyB64 = Buffer.from(creds.noiseKey.public).toString('base64');
         const identityKeyB64 = Buffer.from(creds.signedIdentityKey.public).toString('base64');
         const advB64 = creds.advSecretKey;
-        let qrMs = qrTimeout || 60000;
+        let qrMs = qrTimeout || 60000; // time to let a QR live
         const genPairQR = () => {
             if (!ws.isOpen) {
                 return;
@@ -528,11 +530,12 @@ const makeSocket = (config) => {
             const qr = [ref, noiseKeyB64, identityKeyB64, advB64].join(',');
             ev.emit('connection.update', { qr });
             qrTimer = setTimeout(genPairQR, qrMs);
-            qrMs = qrTimeout || 20000;
+            qrMs = qrTimeout || 20000; // shorter subsequent qrs
         };
         genPairQR();
     });
-
+    // device paired for the first time
+    // if device pairs successfully, the server asks to restart the connection
     ws.on('CB:iq,,pair-success', async (stanza) => {
         logger.debug('pair success recv');
         try {
@@ -547,13 +550,13 @@ const makeSocket = (config) => {
             end(error);
         }
     });
-
+    // login complete
     ws.on('CB:success', async (node) => {
         try {
             await uploadPreKeysToServerIfRequired();
             await sendPassiveIq('active');
             logger.info('opened connection to WA');
-            clearTimeout(qrTimer);
+            clearTimeout(qrTimer); // will never happen in all likelyhood -- but just in case WA sends success on first try
             ev.emit('creds.update', { me: { ...authState.creds.me, lid: node.attrs.lid } });
             ev.emit('connection.update', { connection: 'open' });
         }
@@ -562,22 +565,19 @@ const makeSocket = (config) => {
             end(err);
         }
     });
-
     ws.on('CB:stream:error', (node) => {
         logger.error({ node }, 'stream errored out');
         const { reason, statusCode } = (0, Utils_1.getErrorCodeFromStreamError)(node);
         end(new boom_1.Boom(`Stream Errored (${reason})`, { statusCode, data: node }));
     });
-
+    // stream fail, possible logout
     ws.on('CB:failure', (node) => {
         const reason = +(node.attrs.reason || 500);
         end(new boom_1.Boom('Connection Failure', { statusCode: reason, data: node.attrs }));
     });
-
     ws.on('CB:ib,,downgrade_webclient', () => {
         end(new boom_1.Boom('Multi-device beta not joined', { statusCode: Types_1.DisconnectReason.multideviceMismatch }));
     });
-
     ws.on('CB:ib,,offline_preview', (node) => {
         logger.info('offline preview received', JSON.stringify(node));
         sendNode({
@@ -586,7 +586,6 @@ const makeSocket = (config) => {
             content: [{ tag: 'offline_batch', attrs: { count: '100' } }]
         });
     });
-
     ws.on('CB:ib,,edge_routing', (node) => {
         const edgeRoutingNode = (0, WABinary_1.getBinaryNodeChild)(node, 'edge_routing');
         const routingInfo = (0, WABinary_1.getBinaryNodeChild)(edgeRoutingNode, 'routing_info');
@@ -595,17 +594,18 @@ const makeSocket = (config) => {
             ev.emit('creds.update', authState.creds);
         }
     });
-
     let didStartBuffer = false;
     process.nextTick(() => {
         var _a;
         if ((_a = creds.me) === null || _a === void 0 ? void 0 : _a.id) {
+            // start buffering important events
+            // if we're logged in
             ev.buffer();
             didStartBuffer = true;
         }
         ev.emit('connection.update', { connection: 'connecting', receivedPendingNotifications: false, qr: undefined });
     });
-
+    // called when all offline notifs are handled
     ws.on('CB:ib,,offline', (node) => {
         const child = (0, WABinary_1.getBinaryNodeChild)(node, 'offline');
         const offlineNotifs = +((child === null || child === void 0 ? void 0 : child.attrs.count) || 0);
@@ -616,10 +616,11 @@ const makeSocket = (config) => {
         }
         ev.emit('connection.update', { receivedPendingNotifications: true });
     });
-
+    // update credentials when required
     ev.on('creds.update', update => {
         var _a, _b;
         const name = (_a = update.me) === null || _a === void 0 ? void 0 : _a.name;
+        // if name has just been received
         if (((_b = creds.me) === null || _b === void 0 ? void 0 : _b.name) !== name) {
             logger.debug({ name }, 'updated pushName');
             sendNode({
@@ -632,11 +633,9 @@ const makeSocket = (config) => {
         }
         Object.assign(creds, update);
     });
-
     if (printQRInTerminal) {
         (0, Utils_1.printQRIfNecessaryListener)(ev, logger);
     }
-
     return {
         type: 'md',
         ws,
@@ -664,14 +663,19 @@ const makeSocket = (config) => {
         uploadPreKeys,
         uploadPreKeysToServerIfRequired,
         requestPairingCode,
+        /** Waits for the connection to WA to reach a state */
         waitForConnectionUpdate: (0, Utils_1.bindWaitForConnectionUpdate)(ev),
         sendWAMBuffer,
     };
 };
 exports.makeSocket = makeSocket;
-
+/**
+ * map the websocket error to the right type
+ * so it can be retried by the caller
+ * */
 function mapWebSocketError(handler) {
     return (error) => {
         handler(new boom_1.Boom(`WebSocket Error (${error === null || error === void 0 ? void 0 : error.message})`, { statusCode: (0, Utils_1.getCodeFromWSError)(error), data: error }));
     };
 }
+

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dyyxyzz/baileys-mod",
-    "version": "6.0.49",
+    "version": "6.0.50",
     "description": "WhatsApp API Modification",
     "keywords": [
         "whatsapp",