Skip to content

docs: update docs for APIs, examples, and types & Use Uint8Array and btc-vision hex utils#116

Merged
BlobMaster41 merged 4 commits intomainfrom
remove/buffer
Feb 16, 2026
Merged

docs: update docs for APIs, examples, and types & Use Uint8Array and btc-vision hex utils#116
BlobMaster41 merged 4 commits intomainfrom
remove/buffer

Conversation

@BlobMaster41
Copy link
Contributor

@BlobMaster41 BlobMaster41 commented Feb 16, 2026

Description

Large documentation sweep: correct ABI encodings (STRING/BYTES use u32), clarify SCHNORR_SIGNATURE format, add new ReconstructionOptions fee fields, and adjust signer-related types across transaction builders to Signer | UniversalSigner. Clarify ML-DSA types to QuantumBIP32Interface | null, update offline signing examples to include mldsa/gas fields, and note Unisat/Xverse multi-PSBT behavior in wallet-extension docs. Improve generators docs (feature priority, fees return shape), expand Address API docs with original/tweaked/hybrid public key helpers and set() behavior, fix examples to use toHex() and remove version printout, reorganize TransactionFactory/flowchart and method signatures, and tidy various cross-links to the transaction-factory page. Also normalize primitive/type table entries in utils and adjust small wording/throw descriptions in epoch docs.

Add a comprehensive documentation site under documentation/, including ABI, address types, API reference, transaction-building guides, keypair/wallet, binary/ABI docs, signer utilities, offline signing, browser integration, epoch/challenge guides, generators, utilities, and a detailed README/TOC with quick-start examples. Move and reorganize several docs (e.g. offline-transaction-signing into documentation/offline, split transaction-building into subpages) and remove old legacy docs. Also update package.json and touch multiple source files (ABICoder, BinaryReader/Writer, Compressor, transaction builders, offline manager, utils, OPNet provider, etc.) to align with the documentation and apply related fixes/cleanup. This change provides a complete developer reference and organized doc structure for the @btc-vision/transaction project.

Replace Node Buffer usage with Uint8Array across ChallengeVerification, ChallengeSubmission, and ChallengeSolution. Use @btc-vision/bitcoin fromHex/toHex helpers for hex <-> byte conversions and update stringToBuffer to return Uint8Array. Adjust toBuffer return type and update hex serialization calls to use toHex.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Performance improvement
  • Refactoring (no functional changes)
  • Documentation update
  • CI/CD changes
  • Dependencies update

Checklist

Build & Tests

  • npm install completes without errors
  • npm test passes all tests

Code Quality

  • Code follows the project's coding standards
  • No new compiler warnings introduced
  • Error handling is appropriate
  • SafeMath used for all arithmetic operations

Documentation

  • Code comments added for complex logic
  • Public APIs are documented
  • README updated (if applicable)

Security

  • No sensitive data (keys, credentials) committed
  • No new security vulnerabilities introduced
  • No floating-point arithmetic used

Testing

Related Issues


By submitting this PR, I confirm that my contribution is made under the terms of the project's license.

Replace Node Buffer usage with Uint8Array across ChallengeVerification, ChallengeSubmission, and ChallengeSolution. Use @btc-vision/bitcoin fromHex/toHex helpers for hex <-> byte conversions and update stringToBuffer to return Uint8Array. Adjust toBuffer return type and update hex serialization calls to use toHex.
Add a comprehensive documentation site under documentation/, including ABI, address types, API reference, transaction-building guides, keypair/wallet, binary/ABI docs, signer utilities, offline signing, browser integration, epoch/challenge guides, generators, utilities, and a detailed README/TOC with quick-start examples. Move and reorganize several docs (e.g. offline-transaction-signing into documentation/offline, split transaction-building into subpages) and remove old legacy docs. Also update package.json and touch multiple source files (ABICoder, BinaryReader/Writer, Compressor, transaction builders, offline manager, utils, OPNet provider, etc.) to align with the documentation and apply related fixes/cleanup. This change provides a complete developer reference and organized doc structure for the @btc-vision/transaction project.
Large documentation sweep: correct ABI encodings (STRING/BYTES use u32), clarify SCHNORR_SIGNATURE format, add new ReconstructionOptions fee fields, and adjust signer-related types across transaction builders to `Signer | UniversalSigner`. Clarify ML-DSA types to `QuantumBIP32Interface | null`, update offline signing examples to include mldsa/gas fields, and note Unisat/Xverse multi-PSBT behavior in wallet-extension docs. Improve generators docs (feature priority, fees return shape), expand Address API docs with original/tweaked/hybrid public key helpers and `set()` behavior, fix examples to use `toHex()` and remove version printout, reorganize TransactionFactory/flowchart and method signatures, and tidy various cross-links to the transaction-factory page. Also normalize primitive/type table entries in utils and adjust small wording/throw descriptions in epoch docs.
@BlobMaster41 BlobMaster41 added documentation Improvements or additions to documentation enhancement New feature or request breaking-change labels Feb 16, 2026
@BlobMaster41 BlobMaster41 merged commit 8454f37 into main Feb 16, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking-change documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant