chore: trim redundant comments

Author: SlowBearDigger

assets/js/monero-checkout.js

@@ -1,21 +1,19 @@
-// Live payment progress on the order-received page. Real on-chain state polled
-// server-side: order status, confirmations, chain tip. Steps: Watching → Detected
-// → Confirming N/M → Confirmed.
+// Live Monero payment status for the order page.
 (function () {
 	var host = document.getElementById('monero-gateway-status');
 	if (!host) return;
 	var url = host.getAttribute('data-poll');
 	var already = host.getAttribute('data-paid') === '1';
 	var rawRedirect = host.getAttribute('data-redirect') || '';
-	// Only follow absolute http(s) or same-origin relative path — never javascript:/data:/protocol-relative.
+	// Restrict redirects to HTTP(S) or same-origin relative paths.
 	var redirect = (/^https?:\/\//i.test(rawRedirect) || /^\/[^/]/.test(rawRedirect)) ? rawRedirect : '';
 	if (!url) return;
 
 	var L = window.monero_gatewayL10n || {};
 	var STEPS = [L.watching || 'Watching', L.detected || 'Detected', L.confirming || 'Confirming', L.confirmed || 'Confirmed'];
 
 	var wrap = document.createElement('div'); wrap.className = 'mg-prog';
-	// Visual stepper is decorative; live status is announced via .mg-msg (avoids double-speak).
+	// The message, not the decorative stepper, announces live status.
 	var steps = document.createElement('div'); steps.className = 'mg-steps'; steps.setAttribute('aria-hidden', 'true');
 	var dots = [];
 	for (var i = 0; i < STEPS.length; i++) {
@@ -35,20 +33,18 @@
 
 	function fmt(n) { return String(n).replace(/\B(?=(\d{3})+(?!\d))/g, ','); }
 
-	// Original expected amount/label from the monero-pay element before any mutation.
 	function findPay() {
 		return document.querySelector('.monero-gateway-panel monero-pay') || document.querySelector('monero-pay');
 	}
 	var payInit = findPay();
 	var originalAmount = payInit ? payInit.getAttribute('amount') : null;
 	var originalLabel = payInit ? payInit.getAttribute('label') : null;
 
-	// Drive QR amount from server state on every paint (two-way; no sticky shortfall).
 	function syncPayWidget(d) {
 		var el = findPay();
 		if (!el) return;
 		var st = d && d.status;
-		// Payment in flight or finished: hide QR/URI so the buyer cannot overpay.
+		// Hide payment instructions once funds are in flight.
 		if (d.terminal || d.paid || st === 'mempool' || st === 'unconfirmed' || st === 'locked' || st === 'confirming') {
 			el.style.display = 'none';
 			return;
@@ -109,7 +105,6 @@
 		else {
 			msg.style.color = '#b45309';
 			if (d.status === 'mempool') text = L.mMempool || 'Payment detected — waiting for the first confirmation.';
-			// unconfirmed + confirming share the same l10n string (c/m confirmations).
 			else if (d.status === 'unconfirmed' || d.status === 'confirming') text = (L.mConfirming || 'Confirming — {c}/{m} confirmations.').replace('{c}', d.confirmations != null ? d.confirmations : 0).replace('{m}', d.minConfirmations != null ? d.minConfirmations : 1);
 			else if (d.status === 'partial') text = (L.mPartial || 'Received {r} XMR — send {s} more (QR updated).').replace('{r}', d.receivedXmr != null ? d.receivedXmr : '?').replace('{s}', d.shortfallXmr || '?');
 			else if (d.status === 'locked') text = L.mLocked || 'Funds received — maturing on-chain…';
@@ -125,8 +120,7 @@
 	if (already) { paint({ paid: true }); return; }
 	paint({ status: 'pending' });
 
-	// Poll politely: (a) never poll a hidden tab, (b) ramp interval as wait grows,
-	// (c) hard-stop after ~6h (unless payment in flight), (d) stop on terminal state.
+	// Back off while waiting, pause when hidden, and stop on terminal states.
 	var stopped = false, timer = null, started = Date.now(), lastStatus = null;
 	var MAX_MS = 6 * 60 * 60 * 1000;
 	function interval() {
@@ -145,7 +139,7 @@
 	function run() {
 		if (stopped) return;
 		if (Date.now() - started > MAX_MS) {
-			// Keep polling while a payment is in flight (incl. locked / confirming).
+			// Keep polling while a payment is in flight.
 			if (lastStatus !== 'partial' && lastStatus !== 'mempool' && lastStatus !== 'unconfirmed' &&
 				lastStatus !== 'locked' && lastStatus !== 'confirming') {
 				hardStop();

includes/class-monero-admin-payments.php

@@ -1,9 +1,5 @@
 <?php
-/**
- * Monero payments admin list.
- *
- * @package Monero_Gateway
- */
+/** WooCommerce admin list for Monero payments. */
 
 if ( ! defined( 'ABSPATH' ) ) {
 	exit;
@@ -15,9 +11,7 @@
 	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
 }
 
-/**
- * Lists orders using the Monero gateway.
- */
+/** List-table implementation for Monero orders. */
 class Monero_Gateway_Admin_Payments_List extends WP_List_Table {
 	private const VIEWS = array(
 		'pending'   => array( 'watching', 'partial', 'underpaid', 'mempool', 'unconfirmed', 'confirming', 'locked' ),
@@ -26,9 +20,7 @@ class Monero_Gateway_Admin_Payments_List extends WP_List_Table {
 		'expired'   => array( 'expired' ),
 	);
 
-	/**
-	 * Number of orders displayed per page.
-	 */
+	/** Orders displayed per page. */
 	const PER_PAGE = 20;
 
 	public static function status_values_for_view( $view ) {
@@ -56,9 +48,7 @@ private function query_args_for_view( $view ) {
 		return $args;
 	}
 
-	/**
-	 * Set up the list table.
-	 */
+	/** Configure the list table. */
 	public function __construct() {
 		parent::__construct(
 			array(
@@ -69,11 +59,7 @@ public function __construct() {
 		);
 	}
 
-	/**
-	 * Get the table columns.
-	 *
-	 * @return array<string, string>
-	 */
+	/** Return table columns. */
 	public function get_columns() {
 		return array(
 			'order'         => __( 'Order', 'monero_gateway' ),
@@ -87,9 +73,7 @@ public function get_columns() {
 		);
 	}
 
-	/**
-	 * Prepare the current page of orders.
-	 */
+	/** Prepare the current page of orders. */
 	public function prepare_items() {
 		$current_page = max( 1, $this->get_pagenum() );
 		$results      = wc_get_orders(
@@ -129,13 +113,7 @@ public function get_views() {
 		return $views;
 	}
 
-	/**
-	 * Render a column value.
-	 *
-	 * @param WC_Order $order       Order being displayed.
-	 * @param string   $column_name Column name.
-	 * @return void
-	 */
+	/** Render a column value. */
 	public function column_default( $order, $column_name ) {
 		switch ( $column_name ) {
 			case 'order':
@@ -177,11 +155,7 @@ public function column_default( $order, $column_name ) {
 		}
 	}
 
-	/**
-	 * Render the order and payment statuses.
-	 *
-	 * @param WC_Order $order Order being displayed.
-	 */
+	/** Render order and payment statuses. */
 	private function render_status( $order ) {
 		$order_status   = wc_get_order_status_name( $order->get_status() );
 		$payment_status = $this->get_meta_string( $order, '_monero_payment_status' );
@@ -192,11 +166,7 @@ private function render_status( $order ) {
 		}
 	}
 
-	/**
-	 * Render a shortened payment address.
-	 *
-	 * @param string $address Payment address.
-	 */
+	/** Render a shortened payment address. */
 	private function render_address( $address ) {
 		if ( '' === $address ) {
 			echo esc_html( '—' );
@@ -214,20 +184,12 @@ private function render_address( $address ) {
 		);
 	}
 
-	/**
-	 * Render a scalar value or a placeholder.
-	 *
-	 * @param string $value Value to render.
-	 */
+	/** Render a scalar value or placeholder. */
 	private function render_value( $value ) {
 		echo '' !== $value ? esc_html( $value ) : esc_html( '—' );
 	}
 
-	/**
-	 * Render transaction IDs stored as JSON or comma-separated text.
-	 *
-	 * @param mixed $stored_txids Stored transaction IDs.
-	 */
+	/** Render stored transaction IDs. */
 	private function render_txids( $stored_txids ) {
 		$txids = $this->parse_txids( $stored_txids );
 
@@ -244,12 +206,7 @@ private function render_txids( $stored_txids ) {
 		}
 	}
 
-	/**
-	 * Parse transaction IDs from order meta.
-	 *
-	 * @param mixed $stored_txids Stored transaction IDs.
-	 * @return string[]
-	 */
+	/** Parse transaction IDs from order metadata. */
 	private function parse_txids( $stored_txids ) {
 		if ( is_array( $stored_txids ) ) {
 			$txids = $stored_txids;
@@ -267,35 +224,23 @@ private function parse_txids( $stored_txids ) {
 		return array_values( array_filter( $txids, 'strlen' ) );
 	}
 
-	/**
-	 * Get scalar order meta as a string.
-	 *
-	 * @param WC_Order $order Order being displayed.
-	 * @param string   $key   Meta key.
-	 * @return string
-	 */
+	/** Read scalar order metadata. */
 	private function get_meta_string( $order, $key ) {
 		$value = $order->get_meta( $key );
 
 		return is_scalar( $value ) ? (string) $value : '';
 	}
 
-	/**
-	 * Message shown when no orders match.
-	 */
+	/** Render the empty-list message. */
 	public function no_items() {
 		esc_html_e( 'No Monero payments found.', 'monero_gateway' );
 	}
 }
 
-/**
- * Register and render the Monero payments page.
- */
+/** Register and render the Monero payments page. */
 class Monero_Gateway_Admin_Payments {
 
-	/**
-	 * Register the WooCommerce submenu page.
-	 */
+	/** Register the WooCommerce submenu. */
 	public static function register_menu() {
 		add_submenu_page(
 			'woocommerce',
@@ -307,9 +252,7 @@ public static function register_menu() {
 		);
 	}
 
-	/**
-	 * Render the payments page.
-	 */
+	/** Render the payments page. */
 	public static function render_page() {
 		if ( ! current_user_can( 'manage_woocommerce' ) ) {
 			return;

includes/class-monero-blocks.php

@@ -1,43 +1,30 @@
 <?php
-/**
- * WooCommerce Blocks checkout integration for the Monero gateway.
- */
+/** WooCommerce Blocks checkout integration for Monero. */
 
 if ( ! defined( 'ABSPATH' ) ) {
 	exit;
 }
 
 use Automattic\WooCommerce\Blocks\Payments\Integrations\AbstractPaymentMethodType;
 
-/**
- * Registers monero_gateway as a Blocks payment method type.
- */
+/** Register Monero as a Blocks payment method. */
 final class Monero_Blocks_Support extends AbstractPaymentMethodType {
 
-	/** @var string Payment method name (must match gateway id). */
+	/** Payment method name. */
 	protected $name = 'monero_gateway';
 
-	/**
-	 * Load gateway settings.
-	 */
+	/** Load gateway settings. */
 	public function initialize() {
 		$this->settings = get_option( 'woocommerce_monero_gateway_settings', array() );
 	}
 
-	/**
-	 * Whether the method is available at Blocks checkout.
-	 * Uses the same runtime checks as the classic checkout.
-	 */
+	/** Mirror classic-checkout availability. */
 	public function is_active() {
 		$gateways = WC()->payment_gateways()->payment_gateways();
 		return isset( $gateways[ $this->name ] ) && $gateways[ $this->name ]->can_accept_payments();
 	}
 
-	/**
-	 * Register and return the Blocks payment method script handle.
-	 *
-	 * @return string[]
-	 */
+	/** Register and return the Blocks script handle. */
 	public function get_payment_method_script_handles() {
 		wp_register_script(
 			'monero-gateway-blocks',
@@ -49,11 +36,7 @@ public function get_payment_method_script_handles() {
 		return array( 'monero-gateway-blocks' );
 	}
 
-	/**
-	 * Data exposed to the Blocks script as monero_gateway_data.
-	 *
-	 * @return array
-	 */
+	/** Return settings exposed to the Blocks script. */
 	public function get_payment_method_data() {
 		return array(
 			'title'       => $this->settings['title'] ?? __( 'Monero (XMR)', 'monero_gateway' ),