Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat!: update to new network object #1623

Merged
merged 2 commits into from
Mar 7, 2024
Merged

Conversation

janniks
Copy link
Collaborator

@janniks janniks commented Feb 5, 2024

Part of #1622

This PR:

  • adds the new "static" network (keeping the network package, most users won't need to import, because they can use string literals)
  • adds new .api options to allow separately from network defining a .url and .fetch to use
  • moves "fetch" functions from tx/builders.ts to tx/fetch.ts

Split into multiple PRs for easier reviewing

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

Copy link

vercel bot commented Feb 5, 2024

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

Name Status Preview Comments Updated (UTC)
stacksjs-docs ❌ Failed (Inspect) Mar 7, 2024 3:30pm

@janniks janniks changed the title Feat/next add new network feat: add new network Feb 5, 2024
@janniks janniks changed the title feat: add new network [2] feat: add new network Feb 5, 2024
Copy link
Contributor

@MicaiahReid MicaiahReid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just had one comment, but there were a few occurrences of it. Great work!

packages/transactions/src/fetch.ts Show resolved Hide resolved
@MicaiahReid MicaiahReid self-requested a review February 7, 2024 16:00
Copy link
Collaborator

@rafaelcr rafaelcr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Base automatically changed from feat/next-cleanup-common-files to next March 7, 2024 15:27
@janniks janniks changed the title [2] feat: add new network feat!: update to new network object Mar 7, 2024
# Conflicts:
#	packages/common/tests/fetch.test.ts
#	packages/common/tests/fetchMiddleware.test.ts
#	packages/network/src/network.ts
@janniks janniks merged commit a2171d4 into next Mar 7, 2024
7 of 9 checks passed
@janniks janniks deleted the feat/next-add-new-network branch March 7, 2024 15:31
janniks added a commit that referenced this pull request Mar 8, 2024
* feat: split network into object and api opts

* fix: update imports

---------

Co-authored-by: janniks <[email protected]>
janniks added a commit that referenced this pull request Mar 12, 2024
* feat: split network into object and api opts

* fix: update imports

---------

Co-authored-by: janniks <[email protected]>
@janniks janniks restored the feat/next-add-new-network branch March 12, 2024 01:36
@janniks janniks deleted the feat/next-add-new-network branch March 12, 2024 01:41
janniks added a commit that referenced this pull request Mar 12, 2024
* feat: split network into object and api opts

* fix: update imports

---------

Co-authored-by: janniks <[email protected]>
janniks added a commit that referenced this pull request Mar 18, 2024
* feat: split network into object and api opts

* fix: update imports

---------

Co-authored-by: janniks <[email protected]>
janniks added a commit that referenced this pull request Mar 22, 2024
* feat: split network into object and api opts

* fix: update imports

---------

Co-authored-by: janniks <[email protected]>
janniks added a commit that referenced this pull request Apr 24, 2024
* feat: split network into object and api opts

* fix: update imports

---------

Co-authored-by: janniks <[email protected]>
janniks added a commit that referenced this pull request Oct 25, 2024
* fix!: consolidate poxaddress return types

BREAKING CHANGE:
Convert `version` of PoXAddress from array to number.

* feat: cleanup common files

* refactor: update to correct import path

* feat!: update to new network object (#1623)

* feat: split network into object and api opts

* fix: update imports

---------

Co-authored-by: janniks <[email protected]>

* feat: add new api package

* fix: update remaining packages for api (#1625)

Co-authored-by: janniks <[email protected]>

* refactor: update other packages to new paradigm

* test: fix remaining packages

* chore: add jest config

* chore: resolve circular dependency

* build: update commitlint to allow longer content

* refactor!: change clarity types to be human readable

BREAKING CHANGE:
The `ClarityType` was changed to a readable string, from the previous Number type. This makes it easier to read and construct types when debugging.

* test: add clarity wire format tests

* docs: add migration docs

* docs: pr update

Co-authored-by: Hugo C <[email protected]>

* docs: pr update

Co-authored-by: Hugo C <[email protected]>

* docs: enumerate nets

* feat!: remove wrapped private key type

BREAKING CHANGE:
Remove wrapped `StacksPrivateKey` type in favor of simple type alias for string/Uint8Array.

* test: update bns tests

* chore: update cli (#1656)

Co-authored-by: janniks <[email protected]>

* feat!: Make serialize methods return hex-encoded strings, instead of bytes

* docs: update migration guide

* fix!: Remove legacy CLI methods

* refactor: decrease circular deps in tx package

* build: fix typedoc build

* ci: update pr version detetction

* fix!: Disable legacy triplesec support for mnemonic encryption

BREAKING CHANGE:
Support for encrypting/decrypting mnemonics using `triplesec` has been removed.

* feat: Remove optional anchor mode from transaction options (#1654)

Co-authored-by: janniks <[email protected]>

* ci: update canary publishing

* build: update lerna

* fix: Add `.bootAddress` to network objects

* chore: disable rule correctly

* chore: reduce guessing tx version

* refactor: add addressVersion to network object

* refactor: consolidate address types

* fix: Allow network name in more helper functions

* refactor: move types

* fix: Improve address helper functions

* refactor!: Rename message types

* refactor!: Make StacksTransaction.serialize() return a hex-string instead of bytes

* refactor!: Rename more types to use "Wire" suffix

* refactor!: Remove BN.js compatability

* feat!: Update post-condition representation to human readable types

* refactor: move internal wire types to reduce circular dependencies

* refactor: add internal package for reusing test and other helpers

* feat: Add postConditionToHex helper

* fix: Allow .appendOrigin to be used with unwrapped public key

* feat!: Rename networking/fetch methods to include `fetch` prefix

* fix: Consolidate `is` prefixed boolean methods

* chore: add comment

* feat: Add STX unit helper methods

* feat: Add `Address` namespace

* feat: Add origin post-condition principals

* refactor: minor updates

* fix!: Remove signed option for intToBigInt

* fix!: Move more helper functions to take network parameter

* feat: Reduce wrapping of types for public key appending

* refactor: Remove Serialize prefix from enum keys

* refactor!: Remove wrapper type for message signatures

* fix!: Compressing private key should ensure string format

* refactor: Fix build breaking refactor changes

* fix: Generate compressed private keys by default

* refactor: Add renamed `randomSeedPhrase` method

* refactor: Rename api to client and undo previous StacksNodeAPI changes

* refactor: Continue client rename

* test: Update to succeed tests

* ci: update canary releases

* fix: Remove legacy methods

* chore: update comments

* fix: Fix string parsing in structured signature decode

* chore: Fix example in comment

* refactor: Undo removal

* fix!: Switch to a network and client param solution

* chore: fix imports

* docs: Update migration file

* refactor: Minor refactoring to match common theme

* refactor: Rename make methods

* refactor: Deprecate wallet config

* refactor: Remove unneeded deserialize overloads

* refactor!: Update StacksTransaction constructor to options object

* refactor!: Rename StacksTransaction to StacksTransactionWire

* fix: Update post conditions input in transactions

* chore: add forgotten rename

* docs: Update migration guide

* refactor: Change getStxAddress to use network parameter

* refactor!: Update Cl.serialize to return string instead of bytes

---------

Co-authored-by: janniks <[email protected]>
Co-authored-by: Hugo C <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants