Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Rewrite network and payment comments #2192

Merged
merged 3 commits into from
Dec 23, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions src/cjs/networks.cjs
Original file line number Diff line number Diff line change
@@ -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;
/**
Expand Down
12 changes: 10 additions & 2 deletions src/cjs/networks.d.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
/**
* 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
*
* Note: Dogecoin BIP32 is a proposed standard, more info can be found here:
* - https://bitcointalk.org/index.php?topic=409731
*
* @packageDocumentation
*/
export interface Network {
Expand Down
12 changes: 10 additions & 2 deletions src/cjs/payments/index.d.ts
Original file line number Diff line number Diff line change
@@ -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
*/
Expand Down
2 changes: 0 additions & 2 deletions src/esm/networks.js
Original file line number Diff line number Diff line change
@@ -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.
*/
Expand Down
15 changes: 10 additions & 5 deletions ts_src/networks.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
// 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
*
* Note: Dogecoin BIP32 is a proposed standard, more info can be found here:
* - https://bitcointalk.org/index.php?topic=409731
Odysseus130 marked this conversation as resolved.
Show resolved Hide resolved
*
* @packageDocumentation
*/
export interface Network {
Expand Down
12 changes: 10 additions & 2 deletions ts_src/payments/index.ts
Original file line number Diff line number Diff line change
@@ -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
*/
Expand Down