Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Remove fixed dependency#149

Closed
MidnightLightning wants to merge 1 commit into
spruceid:v1.1.6from
MidnightLightning:remove-fixed-dependency
Closed

Remove fixed dependency#149
MidnightLightning wants to merge 1 commit into
spruceid:v1.1.6from
MidnightLightning:remove-fixed-dependency

Conversation

@MidnightLightning

Copy link
Copy Markdown

The /packages/siwe/package.json file had the ethers dependency as a fixed requirement (only allowing exactly v5.5.1 to be used). This is in conflict with the parent package.json, which allows minor-version changes (^5.5.1, allowing "Compatible with version" changes, meaning anything 5.x.x greater than or equal to 5.5.1). Since the latest Ethers on the v5 branch is v5.7, having the fixed requirement of v5.5.1 prevented upgrading to that.

This change adds the ^ to the child package.json to allow the flexibility to upgrade to later versions of the Ethers v5 library.

@MidnightLightning MidnightLightning changed the base branch from main to v1.1.6 March 12, 2023 21:21
@MidnightLightning

Copy link
Copy Markdown
Author

Related #116

@MidnightLightning

Copy link
Copy Markdown
Author

This was done on the main branch in #70, but that is the v2 branch. To keep the v1 package usable with the latest versions of ethers while v2 is in development, I recommend adding this change, and releasing as v1.1.7

@jtrein

jtrein commented Mar 27, 2023

Copy link
Copy Markdown

This is also affecting us

@MidnightLightning

MidnightLightning commented Mar 28, 2023

Copy link
Copy Markdown
Author

Pinging @w4ll3 (great avatar, by the way!); is this project/repo active? It seems there's been no activity for five months at this point?

@obstropolos

Copy link
Copy Markdown
Contributor

This was done on the main branch in #70, but that is the v2 branch. To keep the v1 package usable with the latest versions of ethers while v2 is in development, I recommend adding this change, and releasing as v1.1.7

The repository is active, and we're also working on updates we'll be releasing in a v3 of the library (which will require some forms of announcing due to breaking changes).

Noting here, we definitely encourage folks to upgrade to v2 if they use v1.1.6. We'll take a look at this however for existing implementations.

Apologies about the delayed response.

@MidnightLightning

Copy link
Copy Markdown
Author

Thanks for the response @obstropolos! Is v3 under development somewhere else? Because this repo has no recent pushes to any branch. It's rather surprising to me a v3 is in the works, when v2 is still flagged as a "beta". The existing "beta" flag on v2 is why I have not upgraded to it for primary use.

@obstropolos

obstropolos commented Mar 28, 2023

Copy link
Copy Markdown
Contributor

Thanks for the response @obstropolos! Is v3 under development somewhere else? Because this repo has no recent pushes to any branch. It's rather surprising to me a v3 is in the works, when v2 is still flagged as a "beta". The existing "beta" flag on v2 is why I have not upgraded to it for primary use.

Yeah, we've primarily pointed folks to v2.1.3 (after we unified the API with other SIWE libraries in the 2.0 release) in order to have the latest features and we didn't want to necessarily ruin any setups still relying on v1.1.6.

The next items going into 2.1.x will likely be support for the latest ethers version and some dependency fixes.

We're just going through some additional reviews on some items in the works and will likely be announcing the transition over to that latest version with sufficient time.

Edit: - Also that's hysterical that Wall-E is both your profile photos

@MidnightLightning

Copy link
Copy Markdown
Author

we've primarily pointed folks to v2.1.3

So is v2 stable? Why does it still have a "beta" flag on it?

@381e35

381e35 commented Apr 3, 2023

Copy link
Copy Markdown

This is also impacting us -- What version of ethers does v2.1.3 support?

@obstropolos

Copy link
Copy Markdown
Contributor

we've primarily pointed folks to v2.1.3

So is v2 stable? Why does it still have a "beta" flag on it?

It is - this was to update the library with the API changes and not break anyone that auto-updated. We use this version for SSX for example.

@obstropolos

Copy link
Copy Markdown
Contributor

This is also impacting us -- What version of ethers does v2.1.3 support?

^5.5.1 with close work on beginning to incorporate 6.

@MidnightLightning

MidnightLightning commented Apr 3, 2023

Copy link
Copy Markdown
Author

So is v2 stable? Why does it still have a "beta" flag on it?

It is - this was to update the library with the API changes and not break anyone that auto-updated. We use this version for SSX for example.

The latest release of v2 is tagged siwe-v2.1.3-beta, and therefore a npm install siwe won't install that version (NPM detects it as a 'beta': https://www.npmjs.com/package/siwe?activeTab=versions). If your intention is v2 is ready for production use, would you please make a new release package without the "beta" suffix to indicate that?

...and not break anyone that auto-updated

Users who started a project with npm install siwe when there was only a v1 would have gotten a package.json entry like ^1.0.0, which would only auto-update to 1.999.999 (semantic versioning "compatible with"). Only if users have >=1.0.0 would they auto-upgrade to a v2 when it was marked stable (and if they're using that sort of dependency marking, they're accepting that risk of breaking changes). So releasing a new major version shouldn't break anything for those who have properly-marked dependencies.

And you haven't given any indication what the holdup is for this merge request. Do you not consider it a bug (i.e. siwe v1 must use ethers v5.5)? If you're not going to accept changes to the v1 branch any further, please consider marking it deprecated or otherwise making it clear in the documentation that version is no longer maintained.

@w4ll3

w4ll3 commented Apr 5, 2023

Copy link
Copy Markdown
Member

Thanks for the PR and for the considerations, we will be preparing a release for v1 (v1.1.7) shortly after #147 is merged, this should address the issue discussed here and further extend support for v6.

@w4ll3 w4ll3 closed this Apr 5, 2023
@MidnightLightning

Copy link
Copy Markdown
Author

@w4ll3 Pull Request #147 has been merged for two weeks now; do you have any further ETA on when "shortly after" will be, when we can hope to see a v1.1.7 released?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants