[1] feat!: stacksjs refactor

[janniks]

EPIC 🏰 Breaking Refactoring Stacks.js

Goal: Make network/networking more obvious and less confusing for developers. While the default code will stay largely the same for most users, it should become more clear what node URL, and fetch implementation is used when.

• Move to a network OBJECT approach (similar to bitcoin-js, micro-btc-signer, and others). The network will not be an instantiated class, but a static exported object with all information that might be relevant (txVersion, magicBytes, etc.)
• Remove fetch functions from network and introduce StacksNodeApi, which can derive it's URL from a network, but should be treated separately -- more closely mirroring to what's actually happening in the background. Can be seen as a maintained API client, with post-processing of responses.
• The majority of users doesn't realize network is also setting changes for "networking"
  • Most users don't customize fetchFn or URL. For users hosting their own node the only change becomes { api: { url: "my-node.com" }, ...} in the params of most relevant tx functions.

Supersedes https://github.com/hirosystems/stacks.js/pull/1596

@ Reviewers: ✨ Please feel free to leave any feedback on these PRs. Going over the code will show what it's like to code in the new style. So any ideas and feedback (especially negative) is welcome 🙏

---

This PR:

• removes duplicate definitions for next steps
• refactors common package

---

Split into multiple PRs for easier reviewing

next     ↑ feat/next-cleanup-common-files this PR 🟢     ↑ feat/next-add-new-network #1623     ↑ feat/next-add-api-package #1624     ↑ feat/next-update-api-stacking #1625     ↑ feat/next-update-cli #1626

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
stacksjs-docs	❌ Failed (Inspect)			Feb 5, 2024 3:40pm

[hugocaillard]

@janniks So this PR is a small set of changes and is mostly just refactoring with almost no impact for developers right?

[janniks]

Yes mostly small refactoring, however there are breaking changes with many consequences in the chain of PRs. I tried to split them up for easier review and following the refactor. Feel free to take a look at the other PRs mentioned in the description, some will be more breaking than others, but follow the same narrative.