Skip to content

Deprecate kit-plugin-payer in favor of kit-plugin-signer#190

Merged
lorisleiva merged 1 commit into
mainfrom
04-13-deprecate_kit-plugin-payer_in_favor_of_kit-plugin-signer_
Apr 14, 2026
Merged

Deprecate kit-plugin-payer in favor of kit-plugin-signer#190
lorisleiva merged 1 commit into
mainfrom
04-13-deprecate_kit-plugin-payer_in_favor_of_kit-plugin-signer_

Conversation

@lorisleiva
Copy link
Copy Markdown
Member

This PR deprecates the @solana/kit-plugin-payer package in favor of @solana/kit-plugin-signer. All five exported functions (payer, generatedPayer, generatedPayerWithSol, payerFromFile, payerOrGeneratedPayer) now carry @deprecated JSDoc tags pointing to their replacements in the new package. The README has been rewritten with a deprecation warning and migration guide including diff snippets, and the package.json description is prefixed with [DEPRECATED].

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 13, 2026

🦋 Changeset detected

Latest commit: 9a94f33

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

This PR includes changesets to release 4 packages
Name Type
@solana/kit-plugin-payer Minor
@solana/kit-client-litesvm Minor
@solana/kit-client-rpc Minor
@solana/kit-plugins Minor

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

@lorisleiva lorisleiva marked this pull request as ready for review April 13, 2026 10:00
@lorisleiva
Copy link
Copy Markdown
Member Author

@trevor-cortex

Copy link
Copy Markdown

@trevor-cortex trevor-cortex left a comment

Choose a reason for hiding this comment

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

Summary

Deprecates @solana/kit-plugin-payer in favor of @solana/kit-plugin-signer. All five exports (payer, generatedPayer, generatedPayerWithSol, payerFromFile, payerOrGeneratedPayer) get @deprecated JSDoc tags pointing to their replacements. The README is rewritten as a migration guide with diff snippets, and the package.json description is prefixed with [DEPRECATED].

Notes

  • Clean deprecation — no logic changes, just JSDoc tags, docs, and metadata.
  • The migration table in the README is clear. payerOrGeneratedPayer getting a dedicated migration section explaining the split into payer() + generatedPayerWithSol() is a nice touch.
  • JSDoc examples are updated to import from the new package, which is helpful since IDEs surface these in autocomplete tooltips.
  • The changeset is minor which makes sense — deprecation is additive (no breaking changes).

LGTM 👍

@lorisleiva lorisleiva requested a review from mcintyre94 April 13, 2026 10:05
Copy link
Copy Markdown
Member

@mcintyre94 mcintyre94 left a comment

Choose a reason for hiding this comment

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

Nice, migration docs look clear to me

Copy link
Copy Markdown
Member Author

lorisleiva commented Apr 14, 2026

Merge activity

  • Apr 14, 5:32 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Apr 14, 5:46 PM UTC: Graphite rebased this pull request as part of a merge.
  • Apr 14, 5:47 PM UTC: @lorisleiva merged this pull request with Graphite.

@lorisleiva lorisleiva changed the base branch from 04-13-add_kit-plugin-signer_package_with_payer_and_identity_plugins to graphite-base/190 April 14, 2026 17:44
@lorisleiva lorisleiva changed the base branch from graphite-base/190 to main April 14, 2026 17:45
This PR deprecates the `@solana/kit-plugin-payer` package in favor of `@solana/kit-plugin-signer`. All five exported functions (`payer`, `generatedPayer`, `generatedPayerWithSol`, `payerFromFile`, `payerOrGeneratedPayer`) now carry `@deprecated` JSDoc tags pointing to their replacements in the new package. The README has been rewritten with a deprecation warning and migration guide including diff snippets, and the package.json description is prefixed with `[DEPRECATED]`.
@lorisleiva lorisleiva force-pushed the 04-13-deprecate_kit-plugin-payer_in_favor_of_kit-plugin-signer_ branch from e16e9ae to 9a94f33 Compare April 14, 2026 17:46
@lorisleiva lorisleiva merged commit c742710 into main Apr 14, 2026
3 checks passed
@github-actions github-actions Bot mentioned this pull request Apr 14, 2026
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.

3 participants