Repository navigation
feat(API): refactor merge rpc - #6977
Merged
kuny0707 merged 6 commits intoOct 13, 2026
Merged
Conversation
github-actions
Bot
requested review from
0xbigapple,
bladehan1 and
waynercheung
September 17, 2026 07:06
317787106
reviewed
Sep 23, 2026
317787106
reviewed
Sep 23, 2026
bladehan1
reviewed
Oct 8, 2026
halibobo1205
approved these changes
Oct 10, 2026
waynercheung
left a comment
Collaborator
There was a problem hiding this comment.
Reviewed 90db120. I did not find a production correctness regression in the audited synchronous read paths.
- [SHOULD] The branch conflicts with
release_v4.8.3inRpcApiServiceOnSolidity.java: #6999 modified thetransaction2Extentionhelper that this PR removes. Resolve both conflict hunks in favor of this PR, dropping the release-branch side entirely (thetransaction2Extention/block2Extentionhelpers, the old innerDatabaseApi/WalletSolidityApiclasses, and their imports) while retaining this PR's shared-service registrations. Please rerun CI; the resolution will need review on the updated HEAD. - [SHOULD] Please strengthen the cursor-wiring and checked-exception error-path tests as noted in the review threads.
- [DISCUSS] In #6927, we agreed to separate the missing-
returnfixes for independent backporting. Please confirm which release lines need these fixes and how they will be delivered if the changes remain combined. - [SHOULD] Please add a compatibility/release note for
getPaginatedNowWitnessListandgetTransactionInfoByBlockNumon the PBFT port. They change from UNIMPLEMENTED to implemented responses, which may affect clients using that status to identify endpoint capabilities.
Remove the duplicated wallet-solidity gRPC stack by serving the solidity and PBFT surfaces from the shared service instances, with a cursor interceptor selecting the store each call reads from. - Add cursor server interceptors for the solidity and PBFT ports and bind them to the shared services. - Serve solidity and PBFT gRPC through the shared service instances instead of separate handler implementations. - Deduplicate the remaining wallet-solidity read handlers. - Return after onError so a failed call is closed exactly once. - Document that the wallet-solidity API is the read-only subset of wallet, and assert that subset relationship in tests. - Cover the error path, cursor wiring and PBFT reads; drop probe tests that guarded nothing.
- CursorInterceptorScopeTest read the cursor on thread A right after interceptCall, before thread B ran onHalfClose, so it passed even when the cursor was never reset. Model the cursor as a ThreadLocal, as Chainbase does, and read it on thread B after onHalfClose returns. - CursorInterceptorServerTest asserted the reset as soon as the blocking call returned, but the client can get the response before the server leaves onHalfClose's finally block. Wait for the reset on a latch.
Little-Peony
force-pushed
the
refactor_merge_rpc
branch
from
October 12, 2026 06:42
90db120 to
d280440
Compare
Contributor
Author
All fixed, please help review again. |
SeriousCoding789
requested review from
317787106,
bladehan1,
halibobo1205 and
waynercheung
October 12, 2026 06:42
bladehan1
approved these changes
Oct 12, 2026
halibobo1205
approved these changes
Oct 12, 2026
* release_v4.8.3: fix(jsonrpc): normalize error responses and fatal handling (tronprotocol#6985) fix(jsonrpc): handle null parameters consistently (tronprotocol#6984)
waynercheung
approved these changes
Oct 12, 2026
waynercheung
left a comment
Collaborator
There was a problem hiding this comment.
Re-reviewed 89c5584b50. All 11 PR files are unchanged from the locally validated 082d99b99b. The previous code-side findings are addressed, and CI is green. Mutation checks confirmed that the updated tests detect the previously missed wiring and checked-exception regressions.
Approving. The following follow-ups are non-blocking:
- [NIT] Please refresh the outdated diff/test counts in the PR description: 11 files, +892/-1264;
RpcApiServicesTest: 119;CursorInterceptorScopeTest: 1;RpcApiServiceErrorPathTest: 3. Please also remove the reference to the nonexistentCursorFilterInstallationTest. - [SHOULD] Please add an explicit compatibility note for the two PBFT additions,
getPaginatedNowWitnessListandgetTransactionInfoByBlockNum: clients relying onUNIMPLEMENTEDto identify PBFT endpoints may need adjustment. - [DISCUSS] Please confirm the backport decision for the missing-return fixes, including the target release lines if needed. If none require backporting, an explicit "no backport needed" is sufficient.
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
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.
What does this PR do?
Implements #6927 — the gRPC counterpart of the HTTP servlet dedup in #6922.
RpcApiServiceOnSolidityandRpcApiServiceOnPBFTeach re-declare the whole read surface as per-method delegations whose only job is to switch the per-thread read cursor:There are exactly 100 of these — 51 in the Solidity service, 49 in the PBFT one — spread over four inner service classes. This PR replaces them with a cursor-parameterized
ServerInterceptor:CursorServerInterceptorwithSolidityCursorInterceptor/PbftCursorInterceptor. It bracketsListener.onHalfClose()— the callback gRPC runs a unary handler inline from — setting the cursor before and restoring it in afinally.DatabaseApi/WalletSolidityApisingletons directly, wrapped inServerInterceptors.intercept(...).RpcApiServiceOnSoliditygoes from 488 lines to 36,RpcApiServiceOnPBFTfrom 495 to 36.RpcApiServiceitself:WalletSolidityApi(servingprotocol.WalletSolidity) re-implements read handlersWalletApi(servingprotocol.Wallet) already has. 41 of its 47 methods now delegate to the sharedWalletApisingleton; the remaining 6 already routed through shared*Common/callContracthelpers, so no duplicated handler body is left. Java is single-inheritance and gRPC generates oneImplBaseper proto service, so both classes have to stay — only the bodies go.responseObserver.onError(...)and then falls through toresponseObserver.onCompleted()closes the call twice; the secondclose()hitscheckState(!closeCalled, "call already closed")in gRPC'sServerCallImpland throws.RpcApiServicehad 32 handlers shaped that way ondevelop— 8 disappear with the duplicatedWalletSolidityApibodies, and the remaining 24 get an explicitreturn, the shape the file already used elsewhere. The file now has none.10 files changed, +945 / −1267.
Why are these changes required?
A read handler currently lives in up to four places, so one RPC change has to be mirrored four times, and missing one makes the same RPC behave differently depending on which port a client hits.
That has already happened. Of the 41 handlers being dedup'd inside
RpcApiService, 23 are byte-identical between the two copies ondevelopand 18 differ. Of those 18:WalletApi— it gained areturnafterresponseObserver.onError(...)andWalletSolidityApidid not, so on the error path the copy serving the Solidity and PBFT ports falls through toonCompleted()and terminates the call twice (getMerkleTreeVoucherInfo,isSpend,scanAndMarkNoteByIvk,scanNoteByIvk,scanNoteByOvk,isShieldedTRC20ContractNoteSpent,scanShieldedTRC20NotesByIvk,scanShieldedTRC20NotesByOvk). The last two additionally have aBadItemException | ZksnarkExceptionbranch with logging that onlyWalletApiever received.getBlockByNum,getBlockByNum2) drifted the other way:WalletSolidityApihas anum >= 0guardWalletApilacks.None of that was written deliberately; it is what happens when the same handler exists four times.
Lining the two copies up also showed that the
returnhardening was never finished onWalletApieither — 24 more handlers in the same file still fall through — so this PR completes it rather than leaving the file in two states.Behaviour differences vs
developMethod sets, per port. The base
WalletSolidityApi(47 methods) andDatabaseApi(4) expose exactly the same methods before and after — only bodies changed.RpcApiService)The PBFT port gains
getPaginatedNowWitnessListandgetTransactionInfoByBlockNum— the only two methodsRpcApiServiceOnPBFTnever mirrored fromRpcApiServiceOnSolidity; they returnedUNIMPLEMENTEDthere before. Both are ordinary reads and resolve against the PBFT snapshot like every other read on that port.Handler bodies. Only three
WalletApibodies changed beyond the addedreturns:getBlockByNum/getBlockByNum2adopt the solidity copy'snum >= 0guard. No response change —Wallet#getBlockByNumalready catches theStoreExceptionand returnsnullfor a negative number, so both paths reachonNext(null); the guard only skips a futile store lookup and its log line.getAssetIssueByNamedrops the"FullNode "prefix from onelogger.debugline, which was the only difference between the two copies.Error paths. Every handler that used to emit
onErrorfollowed byonCompletednow emits a single terminal event, on all three ports. Not visible to clients —onErrorhad already closed the call with the error status and the secondclose()threw before sending anything; what goes away is one server-sideIllegalStateExceptionper failed call. Two groups:WalletischeckAllowShieldedTransactionApi(), andnode.allowShieldedTransactionApidefaults tofalse, so on a default node every such call took the double-close path.WalletApi(getPaginatedNowWitnessList,getTransactionInfoByBlockNum,getDelegatedResourceV2,getDelegatedResourceAccountIndex,getDelegatedResourceAccountIndexV2,getCanDelegatedMaxSize,getCanWithdrawUnfreezeAmount,getAvailableUnfreezeCount,getBandwidthPrices,getEnergyPrices,getMemoFee,getNodeInfo,getMarketOrderByAccount,getMarketOrderById,getMarketOrderListByPair,getMarketPriceByPair,getMarketPairList) and 7 shared helpers reachable from both services (getBlockCommon,getRewardInfoCommon,getBrokerageInfoCommon,getBurnTrxCommon,getPendingSizeCommon,getTransactionFromPendingCommon,getTransactionListFromPendingCommon).Cursor semantics are unchanged.
Manager#setCursorstill computes theheadNum - pbftNumoffset for PBFT, exactly asWalletOnPBFT.futureGetdid.Scope. gRPC only.
WalletOnCursor/WalletOnSolidity/WalletOnPBFTstay, because the HTTP and JSON-RPC servlets still callfutureGet; removing those is a separate change. Ports, switches, proto definitions and the server-level interceptor chain (rate limiter, api access, lite-fullnode filter, prometheus) are untouched.This PR has been tested by:
CursorInterceptorScopeTest(2) drivesinterceptCall()on one thread and the returned listener'sonHalfClose()on another — which is what gRPC'sSerializingExecutoris free to do. An implementation that scoped the cursor aroundinterceptCallfails here by construction rather than by luck. Also covers thefinallyreset when the handler throws.CursorInterceptorServerTest(1) runs the production interceptor behind a real gRPC server and asserts the cursor is set and restored exactly once, on the handler's own thread. This is the end-to-end half: the whole design rests on gRPC running the handler inline fromonHalfClose, and if that stops holding the cursor never reaches the read path and the port serves HEAD data with no error.CursorInterceptorWiringTest(2) runs the realaddServiceof both cursor services against a mock builder and asserts each shared read service is registered as an intercepted definition. DroppingServerInterceptors.interceptleaves every other test green while the port silently serves HEAD, so this is the gRPC counterpart ofCursorFilterInstallationTest.RpcApiServiceErrorPathTest(2) drives every unary handler ofWalletApiandWalletSolidityApiwith collaborators that throw, and asserts none of them terminates the call more than once. Reverting the addedreturns makes it fail ongetDelegatedResourceV2,getPendingSizeandgetBlock, so it reaches the shared*Commonhelpers as well.RpcApiServicesTest— the existing suite drives all three ports end to end over 129 tests; it now also callsgetPaginatedNowWitnessListandgetTransactionInfoByBlockNumon the PBFT stub, pinning the one intentional behaviour change.