Merge pull request #2192 from Odysseus130/master

Rewrite network and payment comments
bitcoinjs · Dec 23, 2024 · 2a8f83f · 2a8f83f
2 parents 19d8f72 + 1b258e9
commit 2a8f83f
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 15 deletions.
diff --git a/src/cjs/networks.cjs b/src/cjs/networks.cjs
@@ -1,6 +1,4 @@
 'use strict';
-// https://en.bitcoin.it/wiki/List_of_address_prefixes
-// Dogecoin BIP32 is a proposed standard: https://bitcointalk.org/index.php?topic=409731
 Object.defineProperty(exports, '__esModule', { value: true });
 exports.testnet = exports.regtest = exports.bitcoin = void 0;
 /**

diff --git a/src/cjs/networks.d.ts b/src/cjs/networks.d.ts
@@ -1,6 +1,11 @@
 /**
- * Represents a Bitcoin network configuration，including messagePrefix, bech32, bip32, pubKeyHash, scriptHash, wif.
- * Support bitcoin、bitcoin testnet and bitcoin regtest.
+ * This module defines the network configurations for Bitcoin and its variants, including message prefixes,
+ * Bech32 address format, BIP32 key derivation prefixes, and other address-related configurations.
+ * It supports Bitcoin, Bitcoin testnet, and Bitcoin regtest networks.
+ *
+ * Additional information on address prefixes can be found here:
+ * - https://en.bitcoin.it/wiki/List_of_address_prefixes
+ *
  * @packageDocumentation
  */
 export interface Network {

diff --git a/src/cjs/payments/index.d.ts b/src/cjs/payments/index.d.ts
@@ -1,7 +1,15 @@
 /**
- * Represents a payment object, which is used to create a payment.
+ * Provides functionality for creating and managing Bitcoin payment objects.
  *
- * Supports P2PKH、P2SH、P2WPKH、P2WSH、P2TR and so on
+ * This module supports multiple Bitcoin address types for payments, including:
+ * - P2PKH (Pay-to-PubKey-Hash)
+ * - P2SH (Pay-to-Script-Hash)
+ * - P2WPKH (Pay-to-Witness-PubKey-Hash)
+ * - P2WSH (Pay-to-Witness-Script-Hash)
+ * - P2TR (Taproot)
+ *
+ * The `Payment` interface defines the structure of a payment object used for constructing various
+ * payment types, with fields for signatures, public keys, redeem scripts, and more.
  *
  * @packageDocumentation
  */

diff --git a/src/esm/networks.js b/src/esm/networks.js
@@ -1,5 +1,3 @@
-// https://en.bitcoin.it/wiki/List_of_address_prefixes
-// Dogecoin BIP32 is a proposed standard: https://bitcointalk.org/index.php?topic=409731
 /**
  * Represents the Bitcoin network configuration.
  */

diff --git a/ts_src/networks.ts b/ts_src/networks.ts
@@ -1,9 +1,11 @@
-// https://en.bitcoin.it/wiki/List_of_address_prefixes
-// Dogecoin BIP32 is a proposed standard: https://bitcointalk.org/index.php?topic=409731
-
 /**
- * Represents a Bitcoin network configuration，including messagePrefix, bech32, bip32, pubKeyHash, scriptHash, wif.
- * Support bitcoin、bitcoin testnet and bitcoin regtest.
+ * This module defines the network configurations for Bitcoin and its variants, including message prefixes,
+ * Bech32 address format, BIP32 key derivation prefixes, and other address-related configurations.
+ * It supports Bitcoin, Bitcoin testnet, and Bitcoin regtest networks.
+ *
+ * Additional information on address prefixes can be found here:
+ * - https://en.bitcoin.it/wiki/List_of_address_prefixes
+ *
  * @packageDocumentation
  */
 export interface Network {

diff --git a/ts_src/payments/index.ts b/ts_src/payments/index.ts
@@ -1,7 +1,15 @@
 /**
- * Represents a payment object, which is used to create a payment.
+ * Provides functionality for creating and managing Bitcoin payment objects.
  *
- * Supports P2PKH、P2SH、P2WPKH、P2WSH、P2TR and so on
+ * This module supports multiple Bitcoin address types for payments, including:
+ * - P2PKH (Pay-to-PubKey-Hash)
+ * - P2SH (Pay-to-Script-Hash)
+ * - P2WPKH (Pay-to-Witness-PubKey-Hash)
+ * - P2WSH (Pay-to-Witness-Script-Hash)
+ * - P2TR (Taproot)
+ *
+ * The `Payment` interface defines the structure of a payment object used for constructing various
+ * payment types, with fields for signatures, public keys, redeem scripts, and more.
  *
  * @packageDocumentation
  */