Skip to content

Commit 1eeb17f

Browse files
committed
optimize network and payments namespace content
1 parent ec1f51c commit 1eeb17f

File tree

2 files changed

+21
-8
lines changed

2 files changed

+21
-8
lines changed

ts_src/networks.ts

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1-
// https://en.bitcoin.it/wiki/List_of_address_prefixes
2-
// Dogecoin BIP32 is a proposed standard: https://bitcointalk.org/index.php?topic=409731
3-
41
/**
5-
* Represents a Bitcoin network configuration,including messagePrefix, bech32, bip32, pubKeyHash, scriptHash, wif.
6-
* Support bitcoin、bitcoin testnet and bitcoin regtest.
2+
* This module defines the network configurations for Bitcoin and its variants, including message prefixes,
3+
* Bech32 address format, BIP32 key derivation prefixes, and other address-related configurations.
4+
* It supports Bitcoin, Bitcoin testnet, and Bitcoin regtest networks.
5+
*
6+
* Additional information on address prefixes can be found here:
7+
* - https://en.bitcoin.it/wiki/List_of_address_prefixes
8+
*
9+
* Note: Dogecoin BIP32 is a proposed standard, more info can be found here:
10+
* - https://bitcointalk.org/index.php?topic=409731
11+
*
712
* @packageDocumentation
813
*/
914
export interface Network {

ts_src/payments/index.ts

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
/**
2-
* Represents a payment object, which is used to create a payment.
3-
*
4-
* Supports P2PKH、P2SH、P2WPKH、P2WSH、P2TR and so on
2+
* Provides functionality for creating and managing Bitcoin payment objects.
3+
*
4+
* This module supports multiple Bitcoin address types for payments, including:
5+
* - P2PKH (Pay-to-PubKey-Hash)
6+
* - P2SH (Pay-to-Script-Hash)
7+
* - P2WPKH (Pay-to-Witness-PubKey-Hash)
8+
* - P2WSH (Pay-to-Witness-Script-Hash)
9+
* - P2TR (Taproot)
10+
*
11+
* The `Payment` interface defines the structure of a payment object used for constructing various
12+
* payment types, with fields for signatures, public keys, redeem scripts, and more.
513
*
614
* @packageDocumentation
715
*/

0 commit comments

Comments
 (0)