@vbyte/btc-dev 1.1.8 → 2.1.0

package/CHANGELOG.md

@@ -0,0 +1,127 @@
+# CHANGELOG
+
+## [2.1.0] - 2026-01-26
+
+### License
+
+- **Changed license to MIT**: Updated from CC-BY-1.0/CC0 to MIT license for broader compatibility.
+
+### New Features
+
+- **Custom error classes**: Added `ValidationError`, `DecodingError`, and `ConfigError` for better error handling.
+  - `ValidationError`: Invalid input format, out of range values, type mismatches
+  - `DecodingError`: Malformed data during decode/parse operations
+  - `ConfigError`: Invalid configuration (unknown network, invalid sighash, etc.)
+- **Standardized error types**: All modules now throw appropriate custom error classes instead of generic `Error`.
+
+### Documentation
+
+- **Restructured security documentation**: Moved security best practices into GUIDE.md, expanded FAQ.md security section.
+- **New SECURITY.md**: Added vulnerability reporting policy at project root.
+- **Fixed documentation errors**: Corrected `tweak_seckey` references in GUIDE.md and FAQ.md to use `@vbyte/crypto/ecc`.
+
+### Packaging
+
+- **Docs included in package**: Added `docs/` to package files for npm distribution.
+- **Fixed package script**: Changed from pipe to `&&` so test failures prevent builds.
+
+### Testing
+
+- Added 190 new tests (total: 1253 tests passing)
+- **Custom error tests**: Full coverage for ValidationError, DecodingError, and ConfigError
+- **Scribe tests**: Inscription encoding/decoding, rune labels
+- **Verify-tx tests**: Multi-input transaction verification scenarios
+- **Taproot tests**: Control block creation/verification, tree depth limits
+
+## [2.0.0] - 2026-01-23
+
+### Security Fixes
+
+- **Fixed witness parsing bug**: Added missing `break` statements in switch block in `src/lib/witness/parse.ts` that could cause incorrect script extraction for p2ts and p2wsh witness types.
+- **Implemented `verify_tx()` function**: Full signature verification for segwit (ECDSA) and taproot (Schnorr) transactions, supporting all sighash types.
+- **Added input validation to sign functions**: Secret key format validation in `sign_segwit_tx()` and `sign_taproot_tx()` to prevent invalid key errors.
+- **Added transaction size limits**: Maximum transaction size (4MB), varint size (10MB), and element count (100k) limits in decoder to prevent memory exhaustion attacks.
+- **Added taproot tree depth limits**: Maximum depth of 128 levels in merkle tree construction to prevent stack overflow from deeply nested trees.
+- **Sanitized error messages**: Removed sensitive data from error messages in address and transaction modules.
+- **Fixed taproot verification null check**: Added proper null check for `prevout` in taproot input verification to prevent runtime errors.
+
+### New Features
+
+- **Full signature verification**: `verify_tx()` now returns detailed verification results including per-input status and error messages.
+- **Enhanced witness parsing**: Improved annex detection and control block parsing for taproot witnesses.
+
+### Code Quality
+
+- **Biome linting compliance**: Applied comprehensive linting fixes across all 59 source files in `src/`
+  - Converted string concatenation to template literals
+  - Added explicit radix parameter to all `parseInt()` calls
+  - Converted `import` statements to `import type` where appropriate
+  - Replaced `isNaN()` with `Number.isNaN()` for type safety
+  - Simplified computed property access to literal keys
+  - Standardized code formatting (quotes, semicolons, indentation)
+- **Improved control block construction**: Replaced `forEach` with spread operator in taproot control block building
+
+### Testing
+
+- Added 843+ new tests (total: 1063 tests passing)
+- **SIGNER module tests**: Essential signing function tests, transaction scenarios, and sighash coverage
+- **WITNESS module tests**: Full witness parsing coverage (p2wpkh, p2wsh, p2tr, p2ts, annex) plus edge cases
+- **SCRIPT module tests**: Lock script detection, decode/encode roundtrips, malformed script handling, size limits
+- **SIGHASH module tests**: Bounds checking and edge cases
+- **META module tests**: BIP-65 locktime, BIP-68 sequence, and reference pointer encoding/decoding
+- **TX module tests**: Size calculation, essential operations, create functions, encoding functions, error handling
+- **TAPROOT module tests**: Parse operations coverage
+- **Integration tests**: End-to-end workflows for address creation, transaction building, and signing
+
+### Documentation
+
+- **README.md**: Expanded with installation instructions, quick start guide, module overview, and API examples
+- **SECURITY.md**: New security guidelines document covering private key handling, input validation, and best practices
+- **EXAMPLES.md**: New examples document with practical code for common Bitcoin development tasks
+- **CONVENTIONS.md**: Added project coding conventions documentation
+- **JSDoc**: Added comprehensive documentation to exported functions with @param, @returns, @throws, and @example
+- **Type definitions**: Documented all interfaces in `src/types/`
+- **Schemas**: Added inline documentation for validation schemas
+
+### Breaking Changes
+
+- `verify_tx()` now returns a `VerifyResult` object instead of a boolean. Access the `.valid` property for boolean result.
+
+## [1.1.8]
+
+- Removed excess logging.
+
+## [1.1.7]
+
+- Removed schema dependency.
+- Fixed an issue with the transaction encoder.
+
+## [1.1.6]
+
+- Changed `create_address` to `get_address`, fixed issues with interface.
+
+## [1.1.5]
+
+- Updated exports for Script module.
+
+## [1.1.4]
+
+- Updates to API for Address module.
+- Updates to API for Script module.
+- Updates to API for TX module.
+
+## [1.1.3]
+
+- Updated transaction utils to have a better input interface.
+
+## [1.1.2]
+
+- Methods `get_tx_output_type` and `get_tx_output_version` have been updated and replaced with `get_script_pk_type` and `get_script_pk_version`.
+
+## [1.1.1]
+
+- Updated `encode_script`
+
+## [1.1.0]
+
+- Public release.

package/LICENSE

@@ -1,121 +1,21 @@
-Creative Commons Legal Code
-
-CC0 1.0 Universal
-
-    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
-    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
-    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
-    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
-    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
-    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
-    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
-    HEREUNDER.
-
-Statement of Purpose
-
-The laws of most jurisdictions throughout the world automatically confer
-exclusive Copyright and Related Rights (defined below) upon the creator
-and subsequent owner(s) (each and all, an "owner") of an original work of
-authorship and/or a database (each, a "Work").
-
-Certain owners wish to permanently relinquish those rights to a Work for
-the purpose of contributing to a commons of creative, cultural and
-scientific works ("Commons") that the public can reliably and without fear
-of later claims of infringement build upon, modify, incorporate in other
-works, reuse and redistribute as freely as possible in any form whatsoever
-and for any purposes, including without limitation commercial purposes.
-These owners may contribute to the Commons to promote the ideal of a free
-culture and the further production of creative, cultural and scientific
-works, or to gain reputation or greater distribution for their Work in
-part through the use and efforts of others.
-
-For these and/or other purposes and motivations, and without any
-expectation of additional consideration or compensation, the person
-associating CC0 with a Work (the "Affirmer"), to the extent that he or she
-is an owner of Copyright and Related Rights in the Work, voluntarily
-elects to apply CC0 to the Work and publicly distribute the Work under its
-terms, with knowledge of his or her Copyright and Related Rights in the
-Work and the meaning and intended legal effect of CC0 on those rights.
-
-1. Copyright and Related Rights. A Work made available under CC0 may be
-protected by copyright and related or neighboring rights ("Copyright and
-Related Rights"). Copyright and Related Rights include, but are not
-limited to, the following:
-
-  i. the right to reproduce, adapt, distribute, perform, display,
-     communicate, and translate a Work;
- ii. moral rights retained by the original author(s) and/or performer(s);
-iii. publicity and privacy rights pertaining to a person's image or
-     likeness depicted in a Work;
- iv. rights protecting against unfair competition in regards to a Work,
-     subject to the limitations in paragraph 4(a), below;
-  v. rights protecting the extraction, dissemination, use and reuse of data
-     in a Work;
- vi. database rights (such as those arising under Directive 96/9/EC of the
-     European Parliament and of the Council of 11 March 1996 on the legal
-     protection of databases, and under any national implementation
-     thereof, including any amended or successor version of such
-     directive); and
-vii. other similar, equivalent or corresponding rights throughout the
-     world based on applicable law or treaty, and any national
-     implementations thereof.
-
-2. Waiver. To the greatest extent permitted by, but not in contravention
-of, applicable law, Affirmer hereby overtly, fully, permanently,
-irrevocably and unconditionally waives, abandons, and surrenders all of
-Affirmer's Copyright and Related Rights and associated claims and causes
-of action, whether now known or unknown (including existing as well as
-future claims and causes of action), in the Work (i) in all territories
-worldwide, (ii) for the maximum duration provided by applicable law or
-treaty (including future time extensions), (iii) in any current or future
-medium and for any number of copies, and (iv) for any purpose whatsoever,
-including without limitation commercial, advertising or promotional
-purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
-member of the public at large and to the detriment of Affirmer's heirs and
-successors, fully intending that such Waiver shall not be subject to
-revocation, rescission, cancellation, termination, or any other legal or
-equitable action to disrupt the quiet enjoyment of the Work by the public
-as contemplated by Affirmer's express Statement of Purpose.
-
-3. Public License Fallback. Should any part of the Waiver for any reason
-be judged legally invalid or ineffective under applicable law, then the
-Waiver shall be preserved to the maximum extent permitted taking into
-account Affirmer's express Statement of Purpose. In addition, to the
-extent the Waiver is so judged Affirmer hereby grants to each affected
-person a royalty-free, non transferable, non sublicensable, non exclusive,
-irrevocable and unconditional license to exercise Affirmer's Copyright and
-Related Rights in the Work (i) in all territories worldwide, (ii) for the
-maximum duration provided by applicable law or treaty (including future
-time extensions), (iii) in any current or future medium and for any number
-of copies, and (iv) for any purpose whatsoever, including without
-limitation commercial, advertising or promotional purposes (the
-"License"). The License shall be deemed effective as of the date CC0 was
-applied by Affirmer to the Work. Should any part of the License for any
-reason be judged legally invalid or ineffective under applicable law, such
-partial invalidity or ineffectiveness shall not invalidate the remainder
-of the License, and in such case Affirmer hereby affirms that he or she
-will not (i) exercise any of his or her remaining Copyright and Related
-Rights in the Work or (ii) assert any associated claims and causes of
-action with respect to the Work, in either case contrary to Affirmer's
-express Statement of Purpose.
-
-4. Limitations and Disclaimers.
-
- a. No trademark or patent rights held by Affirmer are waived, abandoned,
-    surrendered, licensed or otherwise affected by this document.
- b. Affirmer offers the Work as-is and makes no representations or
-    warranties of any kind concerning the Work, express, implied,
-    statutory or otherwise, including without limitation warranties of
-    title, merchantability, fitness for a particular purpose, non
-    infringement, or the absence of latent or other defects, accuracy, or
-    the present or absence of errors, whether or not discoverable, all to
-    the greatest extent permissible under applicable law.
- c. Affirmer disclaims responsibility for clearing rights of other persons
-    that may apply to the Work or any use thereof, including without
-    limitation any person's Copyright and Related Rights in the Work.
-    Further, Affirmer disclaims responsibility for obtaining any necessary
-    consents, permissions or other rights required for any use of the
-    Work.
- d. Affirmer understands and acknowledges that Creative Commons is not a
-    party to this document and has no duty or obligation with respect to
-    this CC0 or use of the Work.
+MIT License
+
+Copyright (c) 2024 Christopher Scott
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,5 +1,71 @@
-# btc-dev
+# @vbyte/btc-dev
 
-Experimental revision of the bitcoin [tapscript](https://www.npmjs.com/package/@cmdcode/tapscript) library.
+[![npm version](https://img.shields.io/npm/v/@vbyte/btc-dev.svg)](https://www.npmjs.com/package/@vbyte/btc-dev)
+[![License: CC-BY-1.0](https://img.shields.io/badge/License-CC--BY--1.0-blue.svg)](LICENSE)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)](https://www.typescriptlang.org/)
 
-Documentation coming soon!
+A batteries-included TypeScript toolset for Bitcoin development. Create, sign, and verify Bitcoin transactions with full support for segwit and taproot.
+
+## Installation
+
+```bash
+npm install @vbyte/btc-dev
+```
+
+## Quick Example
+
+```typescript
+import { ADDRESS, TX, SIGNER } from '@vbyte/btc-dev'
+
+// Create a P2WPKH address
+const address = ADDRESS.p2wpkh(pubkey, 'main')
+console.log(address.data)  // bc1q...
+
+// Parse a transaction
+const tx = TX.parse(rawTxHex)
+
+// Sign and verify
+const signature = SIGNER.sign_segwit_tx(secretKey, tx, {
+  txindex: 0,
+  pubkey,
+  sigflag: 0x01
+})
+const result = SIGNER.verify_tx(tx)
+```
+
+## Modules
+
+| Module | Description |
+|--------|-------------|
+| `ADDRESS` | Create and parse addresses (P2PKH, P2SH, P2WPKH, P2WSH, P2TR) |
+| `TX` | Transaction creation, encoding, decoding, parsing |
+| `SCRIPT` | Script encoding, decoding, type detection |
+| `SIGHASH` | Signature hash calculation (BIP-143, BIP-341) |
+| `SIGNER` | Sign and verify transactions (ECDSA, Schnorr) |
+| `TAPROOT` | Taproot trees, control blocks, tweaking |
+| `WITNESS` | Witness data parsing and analysis |
+| `META` | Locktime, sequence, reference IDs |
+
+## Documentation
+
+- **[Guide](docs/GUIDE.md)** - Complete tutorial covering addresses, transactions, signing, and taproot
+- **[API Reference](docs/API.md)** - Full function reference for all modules
+- **[Security](docs/SECURITY.md)** - Best practices for production use
+- **[FAQ](docs/FAQ.md)** - Common questions and troubleshooting
+- **[Conventions](docs/CONVENTIONS.md)** - Coding conventions for contributors
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.
+
+## Dependencies
+
+- [@noble/curves](https://github.com/paulmillr/noble-curves) - Elliptic curve cryptography
+- [@noble/hashes](https://github.com/paulmillr/noble-hashes) - Cryptographic hash functions
+- [@scure/btc-signer](https://github.com/paulmillr/scure-btc-signer) - Bitcoin signing utilities
+- [@vbyte/buff](https://www.npmjs.com/package/@vbyte/buff) - Buffer manipulation
+- [zod](https://zod.dev) - Runtime validation
+
+## License
+
+[CC-BY-1.0](LICENSE)

package/dist/const.d.ts

@@ -36,3 +36,6 @@ export declare const TX_SIZE: {
 export declare const SIGHASH_DEFAULT = 1;
 export declare const SIGHASH_SEGWIT: number[];
 export declare const SIGHASH_TAPROOT: number[];
+export declare const MAX_SCRIPT_SIZE = 10000;
+export declare const MAX_VARINT_SIZE = 520000;
+export declare const OP_1_OFFSET = 80;

package/dist/const.js

@@ -1,36 +1,34 @@
 export const COINBASE = {
-    TXID: '00'.repeat(32),
-    VOUT: 0xFFFFFFFF,
+    TXID: "00".repeat(32),
+    VOUT: 0xffffffff,
 };
 export const DEFAULT = {
     LOCKTIME: 0,
-    SEQUENCE: 0xFFFFFFFF,
+    SEQUENCE: 0xffffffff,
     VERSION: 2,
 };
 export const TAPLEAF_VERSIONS = [
-    0xc0, 0xc2, 0xc4, 0xc6, 0xc8, 0xca, 0xcc, 0xce,
-    0xd0, 0xd2, 0xd4, 0xd6, 0xd8, 0xda, 0xdc, 0xde,
-    0xe0, 0xe2, 0xe4, 0xe6, 0xe8, 0xea, 0xec, 0xee,
-    0xf0, 0xf2, 0xf4, 0xf6, 0xf8, 0xfa, 0xfc, 0xfe,
-    0x66, 0x7e, 0x80, 0x84, 0x96, 0x98, 0xba, 0xbc,
-    0xbe
+    0xc0, 0xc2, 0xc4, 0xc6, 0xc8, 0xca, 0xcc, 0xce, 0xd0, 0xd2, 0xd4, 0xd6, 0xd8,
+    0xda, 0xdc, 0xde, 0xe0, 0xe2, 0xe4, 0xe6, 0xe8, 0xea, 0xec, 0xee, 0xf0, 0xf2,
+    0xf4, 0xf6, 0xf8, 0xfa, 0xfc, 0xfe, 0x66, 0x7e, 0x80, 0x84, 0x96, 0x98, 0xba,
+    0xbc, 0xbe,
 ];
 export const TAPLEAF_DEFAULT_VERSION = 0xc0;
 export const LOCK_SCRIPT_TYPE = {
-    P2PKH: 'p2pkh',
-    P2SH: 'p2sh',
-    P2WPKH: 'p2wpkh',
-    P2WSH: 'p2wsh',
-    P2TR: 'p2tr',
-    OPRETURN: 'opreturn',
+    P2PKH: "p2pkh",
+    P2SH: "p2sh",
+    P2WPKH: "p2wpkh",
+    P2WSH: "p2wsh",
+    P2TR: "p2tr",
+    OPRETURN: "opreturn",
 };
 export const SPEND_SCRIPT_TYPE = {
-    P2PKH: 'p2pkh',
-    P2SH: 'p2sh',
-    P2WPKH: 'p2wpkh',
-    P2WSH: 'p2wsh',
-    P2TR: 'p2tr',
-    P2TS: 'p2ts',
+    P2PKH: "p2pkh",
+    P2SH: "p2sh",
+    P2WPKH: "p2wpkh",
+    P2WSH: "p2wsh",
+    P2TR: "p2tr",
+    P2TS: "p2ts",
 };
 export const LOCK_SCRIPT_REGEX = {
     [LOCK_SCRIPT_TYPE.P2PKH]: /^76a914[0-9a-f]{40}88ac$/i,
@@ -40,7 +38,7 @@ export const LOCK_SCRIPT_REGEX = {
     [LOCK_SCRIPT_TYPE.P2TR]: /^5120[0-9a-f]{64}$/i,
     [LOCK_SCRIPT_TYPE.OPRETURN]: /^6a[0-9a-f]{2,}$/i,
 };
-export const SCRIPT_INT_KEY = '';
+export const SCRIPT_INT_KEY = "";
 export const TX_SIZE = {
     GLOBAL_BASE: 8,
     GLOBAL_WIT: 10,
@@ -50,3 +48,6 @@ export const TX_SIZE = {
 export const SIGHASH_DEFAULT = 0x01;
 export const SIGHASH_SEGWIT = [0x01, 0x02, 0x03, 0x81, 0x82, 0x83];
 export const SIGHASH_TAPROOT = [0x00, ...SIGHASH_SEGWIT];
+export const MAX_SCRIPT_SIZE = 10_000;
+export const MAX_VARINT_SIZE = 520_000;
+export const OP_1_OFFSET = 0x50;

package/dist/error.d.ts

@@ -0,0 +1,11 @@
+export declare class ValidationError extends Error {
+    field?: string;
+    constructor(message: string, field?: string);
+}
+export declare class DecodingError extends Error {
+    position?: number;
+    constructor(message: string, position?: number);
+}
+export declare class ConfigError extends Error {
+    constructor(message: string);
+}

package/dist/error.js

@@ -0,0 +1,20 @@
+export class ValidationError extends Error {
+    constructor(message, field) {
+        super(message);
+        this.name = "ValidationError";
+        this.field = field;
+    }
+}
+export class DecodingError extends Error {
+    constructor(message, position) {
+        super(message);
+        this.name = "DecodingError";
+        this.position = position;
+    }
+}
+export class ConfigError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "ConfigError";
+    }
+}

package/dist/index.d.ts

@@ -1,11 +1,12 @@
-export * as ADDRESS from './lib/address/index.js';
-export * as META from './lib/meta/index.js';
-export * as SCRIPT from './lib/script/index.js';
-export * as SIGHASH from './lib/sighash/index.js';
-export * as SIGNER from './lib/signer/index.js';
-export * as TAPROOT from './lib/taproot/index.js';
-export * as TX from './lib/tx/index.js';
-export * as WITNESS from './lib/witness/index.js';
-export * as CONST from './const.js';
-export * as SCHEMA from './schema/index.js';
-export type * from './types/index.js';
+export * as CONST from "./const.js";
+export * as ADDRESS from "./lib/address/index.js";
+export * as META from "./lib/meta/index.js";
+export * as SCRIPT from "./lib/script/index.js";
+export * as SIGHASH from "./lib/sighash/index.js";
+export * as SIGNER from "./lib/signer/index.js";
+export * as TAPROOT from "./lib/taproot/index.js";
+export * as TX from "./lib/tx/index.js";
+export * as WITNESS from "./lib/witness/index.js";
+export * as SCHEMA from "./schema/index.js";
+export { ValidationError, DecodingError, ConfigError } from "./error.js";
+export type * from "./types/index.js";

package/dist/index.js

@@ -1,10 +1,11 @@
-export * as ADDRESS from './lib/address/index.js';
-export * as META from './lib/meta/index.js';
-export * as SCRIPT from './lib/script/index.js';
-export * as SIGHASH from './lib/sighash/index.js';
-export * as SIGNER from './lib/signer/index.js';
-export * as TAPROOT from './lib/taproot/index.js';
-export * as TX from './lib/tx/index.js';
-export * as WITNESS from './lib/witness/index.js';
-export * as CONST from './const.js';
-export * as SCHEMA from './schema/index.js';
+export * as CONST from "./const.js";
+export * as ADDRESS from "./lib/address/index.js";
+export * as META from "./lib/meta/index.js";
+export * as SCRIPT from "./lib/script/index.js";
+export * as SIGHASH from "./lib/sighash/index.js";
+export * as SIGNER from "./lib/signer/index.js";
+export * as TAPROOT from "./lib/taproot/index.js";
+export * as TX from "./lib/tx/index.js";
+export * as WITNESS from "./lib/witness/index.js";
+export * as SCHEMA from "./schema/index.js";
+export { ValidationError, DecodingError, ConfigError } from "./error.js";

package/dist/lib/address/api.d.ts

@@ -1,4 +1,4 @@
-import { Bytes } from '@vbyte/buff';
-import type { AddressInfo, ChainNetwork } from '../../types/index.js';
+import { type Bytes } from "@vbyte/buff";
+import type { AddressInfo, ChainNetwork } from "../../types/index.js";
 export declare function get_address(script: Bytes, network?: ChainNetwork): string;
 export declare function parse_address(address: string): AddressInfo;

package/dist/lib/address/api.js

@@ -1,17 +1,18 @@
-import { Buff } from '@vbyte/buff';
-import { get_lock_script_type } from '../../lib/script/lock.js';
-import { get_address_info } from './util.js';
-import { LOCK_SCRIPT_TYPE } from '../../const.js';
-import { P2PKH } from './p2pkh.js';
-import { P2SH } from './p2sh.js';
-import { P2TR } from './p2tr.js';
-import { P2WPKH } from './p2wpkh.js';
-import { P2WSH } from './p2wsh.js';
-export function get_address(script, network = 'main') {
+import { Buff } from "@vbyte/buff";
+import { LOCK_SCRIPT_TYPE } from "../../const.js";
+import { ConfigError } from "../../error.js";
+import { get_lock_script_type } from "../../lib/script/lock.js";
+import { P2PKH } from "./p2pkh.js";
+import { P2SH } from "./p2sh.js";
+import { P2TR } from "./p2tr.js";
+import { P2WPKH } from "./p2wpkh.js";
+import { P2WSH } from "./p2wsh.js";
+import { get_address_info } from "./util.js";
+export function get_address(script, network = "main") {
     const bytes = Buff.bytes(script);
     const type = get_lock_script_type(bytes);
     if (type === null)
-        throw new Error('unknown locking script: ' + bytes.hex);
+        throw new ConfigError("Unknown or unsupported locking script type");
     switch (type) {
         case LOCK_SCRIPT_TYPE.P2PKH:
             return P2PKH.encode_address(script, network);
@@ -24,7 +25,7 @@ export function get_address(script, network = 'main') {
         case LOCK_SCRIPT_TYPE.P2TR:
             return P2TR.encode_address(script, network);
         default:
-            throw new Error('unknown script type: ' + type);
+            throw new ConfigError(`unknown script type: ${type}`);
     }
 }
 export function parse_address(address) {

package/dist/lib/address/encode.d.ts

@@ -1,3 +1,3 @@
-import type { EncoderConfig } from '../../types/address.js';
+import type { EncoderConfig } from "../../types/address.js";
 export declare function decode_address(address: string): EncoderConfig;
 export declare function encode_address(config: EncoderConfig): string;