docs: add inline @deprecated tags and docs/deprecated.md - #397
Merged
BigBen-7 merged 2 commits intoJul 26, 2026
Merged
Conversation
…s#279) Adds @deprecated JSDoc annotations to all patterns identified during source audit: - buildContractCall(): marks the unused 'server' parameter as deprecated (silently ignored; will be removed in 0.3.0 — pass server to simulateTransaction) - SplitterModule.createRevenueSplit(): deprecated in favour of the generic createSplit({ recipients, totalAmount }) which accepts any number of recipients - RevenueSplitParams interface: deprecated alongside createRevenueSplit(); callers should use SplitRecipient[] + CreateSplitParams directly - WatchOptions re-export from './client' in index.ts: removes duplicate export (canonical source is types/index.ts; no consumer-facing impact) Creates docs/deprecated.md cataloguing all deprecated symbols with: - Deprecated-in / removed-in version numbers (0.2.0 / 0.3.0) - Migration code examples for each deprecated pattern - Summary table Closes Lead-Studios#279
|
@BashMan11 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Performs a source audit to identify all deprecated patterns and adds
@deprecatedJSDoc annotations, then createsdocs/deprecated.mdas the authoritative catalogue.Changes
@deprecatedtags addedsrc/utils/transaction.ts—buildContractCallserverparameterThe first
server: SorobanRpc.Serverparameter is silently ignored inside the function body (onlysimulateTransactionneeds the server reference). Marked deprecated with a migration note to stop passing this argument.src/modules/splitter.ts—createRevenueSplit()Thin wrapper that hard-codes a three-party split. The generic
createSplit({ recipients, totalAmount })is strictly more powerful and is the recommended replacement.src/types/index.ts—RevenueSplitParamsinterfaceCompanion type for the deprecated
createRevenueSplit(). Callers should useSplitRecipient[]+CreateSplitParamsdirectly.src/index.ts— duplicateWatchOptionsre-exportWatchOptionswas exported twice: once from./clientand once from./types/index. Removed the redundant re-export from./client(the canonical source istypes/index.ts).New file:
docs/deprecated.mdLists all deprecated symbols with:
0.2.0/0.3.0)Files touched
src/utils/transaction.tssrc/modules/splitter.tssrc/types/index.tssrc/index.tsdocs/deprecated.md(new)Testing
Source-only change (JSDoc + docs). All existing tests continue to pass — no runtime behaviour was changed.
Closes #279