fix(deps): update dependency bitcoinjs-lib to v6.1.7

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
bitcoinjs-lib	6.1.5 -> 6.1.7

---

Release Notes

bitcoinjs/bitcoinjs-lib (bitcoinjs-lib)

v6.1.7

Compare Source

added

• skip ecc library verification via DANGER_DO_NOT_VERIFY_ECCLIB flag

v6.1.6

Compare Source

fixed

• Fix sighash treatment when signing taproot script sign scripts using Psbt (#​2104)
• Fix error for invalid scripts in toASM (#​2097)
• Fix mutation of input to addOutput method on Psbt (#​2091)

---

Configuration

📅 Schedule: Branch creation - "* 0-4 * * 3" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.

[github-actions]

[puLL-Merge] - bitcoinjs/[email protected]

Description

This PR introduces significant changes to improve documentation, fix bugs, and enhance functionality across various parts of the bitcoinjs-lib codebase. The main changes include:

1. Adding TypeDoc for generating API documentation
2. Improving and adding JSDoc comments throughout the codebase
3. Fixing several bugs in existing functions
4. Updating GitHub Actions workflow to build and deploy documentation
5. Updating the README to mention the new documentation
6. Making minor improvements and refactors to existing code

Possible Issues

• The introduction of TypeDoc may require additional setup or dependencies for contributors.
• Some of the added JSDoc comments might need further refinement or clarification.

Security Hotspots

No significant security issues were identified in this change.

Changes

Changes

1. .github/workflows/main_ci.yml:

   • Added new jobs for building and deploying documentation to GitHub Pages

2. .gitignore:

   • Added docs and plugin to the ignored files

3. CHANGELOG.md:

   • Added entries for version 6.1.6, including bug fixes

4. CONTRIBUTING.md:

   • Updated communication channels information

5. README.md:

   • Added information about the new documentation

6. package.json:

   • Updated version to 6.1.6
   • Added typedoc as a dev dependency
   • Added a doc script to generate documentation

7. Various TypeScript source files (ts_src/):

   • Added comprehensive JSDoc comments to functions and classes
   • Fixed bugs in p2tr.ts, script_signature.ts, and other files
   • Improved type definitions and error handling
   • Removed unused functions and types

8. typedoc.json:

   • Added configuration file for TypeDoc

9. Test files:

   • Updated tests to reflect changes in the main codebase
   • Removed some unused helper functions

Overall, this PR significantly improves the project's documentation and makes several important bug fixes and code improvements.

[github-actions]

[puLL-Merge] - bitcoinjs/[email protected]

Description

This PR introduces several significant changes to the bitcoinjs-lib project, including documentation improvements, code refactoring, and the addition of new features. The main goals appear to be enhancing the library's functionality, improving code quality, and making the API more user-friendly and better documented.

Possible Issues

1. The removal of the audit job from the CI workflow might reduce security checks.
2. Changes to the initEccLib function could potentially break existing implementations if not handled carefully.

Security Hotspots

1. The addition of the DANGER_DO_NOT_VERIFY_ECCLIB flag in the initEccLib function could potentially allow insecure ECC libraries to be used if mishandled.

Changes

Changes

1. .github/workflows/main_ci.yml:

   • Removed the audit job
   • Added new jobs for building and deploying documentation

2. src/ecc_lib.js and ts_src/ecc_lib.ts:

   • Modified initEccLib function to include an optional parameter for skipping ECC library verification

3. src/psbt.js and ts_src/psbt.ts:

   • Fixed a bug in the getTaprootHashesForSig function

4. Various files:

   • Added JSDoc comments to improve documentation
   • Refactored some functions for better readability and maintainability
   • Added type definitions and improved existing ones

5. package.json:

   • Updated version to 6.1.7
   • Added typedoc as a dev dependency
   • Removed better-npm-audit dependency

6. New file typedoc.json:

   • Added configuration for TypeDoc to generate API documentation

sequenceDiagram
    participant User
    participant PSBT
    participant EccLib
    participant Transaction
    participant Documentation

    User->>PSBT: Create new PSBT
    PSBT->>EccLib: Initialize ECC Library
    Note over EccLib: New option to skip verification
    PSBT->>Transaction: Create unsigned transaction
    PSBT->>PSBT: Add inputs and outputs
    PSBT->>PSBT: Sign inputs
    PSBT->>Transaction: Finalize and extract
    User->>Documentation: Generate API docs
    Documentation->>User: Serve generated docs

Loading