docs: update docs for APIs, examples, and types & Use Uint8Array and btc-vision hex utils#116
Merged
BlobMaster41 merged 4 commits intomainfrom Feb 16, 2026
Merged
docs: update docs for APIs, examples, and types & Use Uint8Array and btc-vision hex utils#116BlobMaster41 merged 4 commits intomainfrom
BlobMaster41 merged 4 commits intomainfrom
Conversation
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.
This was referenced Feb 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 toQuantumBIP32Interface | 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 andset()behavior, fix examples to usetoHex()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
Checklist
Build & Tests
npm installcompletes without errorsnpm testpasses all testsCode Quality
Documentation
Security
Testing
Related Issues
By submitting this PR, I confirm that my contribution is made under the terms of the project's license.