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

Transition from @bundlr-network/client to @irys/sdk #91

Merged

Conversation

JesseTheRobot
Copy link
Contributor

@JesseTheRobot JesseTheRobot commented Oct 4, 2023

Note: This PR (a spiritual copy of this PR) seeks to accomplish the same goals for the same reasons.

Context: Bundlr rebranded as Irys earlier today, and the GH org rename caused issues with users due to the AVSC git dependency the old version of the js-client being used.
To fix this, this PR transitions from a deprecated Bundlr js sdk version to the latest Irys SDK, and includes all relevant changes/renaming, including README & test changes.

Notes:

  • This PR is a complete rename and will create a seperate/new package - if you'd rather the renaming isn't as complete, I can make changes as required.
  • I wasn't able to figure out how to get most monorepo-wide test cases to pass, I assume there's a testing endpoint I need to set up - but all the tests I was able to get working pass (including the Irys specific ones)

@changeset-bot
Copy link

changeset-bot bot commented Oct 4, 2023

🦋 Changeset detected

Latest commit: 4f5653f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@metaplex-foundation/umi-uploader-irys Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@JesseTheRobot JesseTheRobot changed the title Feat/bundlr to irys Transition from @bundlr-network/client to @irys/sdk Oct 4, 2023
@JesseTheRobot JesseTheRobot changed the title Transition from @bundlr-network/client to @irys/sdk Transition from @bundlr-network/client to @irys/sdk Oct 4, 2023
@JesseTheRobot
Copy link
Contributor Author

A known fix to this issue in the meantime is to update/refresh lockfiles - I released a backported version with a fixed git repo URL, and the lockfile refresh seems to have worked for all the users having issues thusfar.

@lorisleiva
Copy link
Collaborator

Hi there. This PR is a real help, thanks for that!

The only thing I would say is it's probably best to add another package and marking the old one has deprecated instead of replacing it.

We'll also need a changeset so it can tricker a publish. I'd say a patch update would be enough since we'd be adding a new plugin and therefore not introducing any breaking change.

@JesseTheRobot
Copy link
Contributor Author

hey @lorisleiva , apologies for the long stint of inactivity.
regarding the old umi-uploader-bundlr package, how would I go about marking it as deprecated?

@lorisleiva
Copy link
Collaborator

I would just replace it on the umi-bundle-default package so it uses this one by default instead of the old one.

I would also add a new line of the implementation table (instead of replacing it) and mark the old line as deprecated by just suffixing it's name by (deprecated).

@JesseTheRobot
Copy link
Contributor Author

As far as I could tell, umi-bundle-defaults isn't using umi-uploader-bundlr, but I've implemented the other requested changes.

@lorisleiva
Copy link
Collaborator

Ah yeah sorry I was being silly. The last thing I noticed before merging this is that the CHANGELOG file was copy/pasted from the Bundlr package when I think it should be removed as this package will have it's own history starting from now.

@JesseTheRobot
Copy link
Contributor Author

Changelog has been removed

@JesseTheRobot
Copy link
Contributor Author

@lorisleiva is there anything else I need to do?

@lorisleiva
Copy link
Collaborator

Ugh linting again here. Could you do pnpm run lint:fix && pnpm run format:fix to see if that makes you commit anything?

@JesseTheRobot
Copy link
Contributor Author

@lorisleiva done

Copy link
Collaborator

@lorisleiva lorisleiva left a comment

Choose a reason for hiding this comment

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

Thanks

@lorisleiva lorisleiva merged commit 44d33c5 into metaplex-foundation:main Nov 10, 2023
6 checks passed
@github-actions github-actions bot mentioned this pull request Nov 10, 2023
@JesseTheRobot JesseTheRobot deleted the feat/bundlr-to-irys branch November 10, 2023 10:30
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.

2 participants