Conversation
WalkthroughThis PR updates the broker package version from 0.2.4 to 0.2.5 across build and package configuration. It adds FetchFees schema validation with boolean flag coercion and significantly refactors server-side FetchFees handling to support multiple fee sources and context-aware response structures. Changes
Sequence DiagramsequenceDiagram
participant Client
participant Server
participant BrokerAPI as Broker API
participant MarketData as Market Data
Client->>Server: FetchFees Request<br/>(symbol, includeAllFees, includeFundingFees)
Server->>Server: Validate payload<br/>against FetchFeesPayloadSchema
alt Market Symbol
Server->>MarketData: Fetch market data
MarketData-->>Server: Market info (base, quote)
alt includeAllFees OR includeFundingFees
Server->>BrokerAPI: fetchDepositWithdrawFees<br/>(currency codes)
alt Fees Available
BrokerAPI-->>Server: fundingFeesByCurrency
Server->>Server: Set source: fetchDepositWithdrawFees
else Fallback
Server->>BrokerAPI: fetchCurrencies()
BrokerAPI-->>Server: Currency metadata
Server->>Server: Extract fees, set source: currencies
end
Server-->>Client: Market + Funding Fees<br/>(generalFee, feeStatus, fundingFees)
else Summary Only
Server-->>Client: Market Summary<br/>(generalFee, feeStatus)
end
else Token Symbol
Server->>BrokerAPI: fetchDepositWithdrawFees<br/>(token code)
alt Fees Available
BrokerAPI-->>Server: fundingFeesByCurrency
Server->>Server: Set source: fetchDepositWithdrawFees
else Fallback
Server->>BrokerAPI: fetchCurrencies()
BrokerAPI-->>Server: Currency metadata
Server->>Server: Extract fees, set source: currencies
end
Server-->>Client: Token Fees<br/>(feeScope: token, fundingFees)
end
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
src/server.ts (2)
360-443: Response structure differs between fee sources.The
fundingFeesByCurrencyobject has different shapes depending on the source:
- From
fetchDepositWithdrawFees(lines 394-398):depositandwithdrawcontain the raw fee structures or a{ fee, percentage }fallback.- From
currenciesfallback (lines 419-428):depositcontains{ enabled }andwithdrawcontains{ enabled, fee, limits }.Consumers may need to handle both shapes. Consider normalizing to a consistent structure, or ensure downstream code and documentation account for this variation.
♻️ Example normalization for the currencies fallback
fundingFeesByCurrency[code] = { - deposit: { - enabled: currency.deposit ?? null, - }, - withdraw: { - enabled: currency.withdraw ?? null, - fee: currency.fee ?? null, - limits: currency.limits?.withdraw ?? null, - }, + deposit: currency.deposit !== undefined + ? { fee: null, percentage: null, enabled: currency.deposit } + : null, + withdraw: currency.withdraw !== undefined + ? { fee: currency.fee ?? null, percentage: null, enabled: currency.withdraw, limits: currency.limits?.withdraw ?? null } + : null, networks: currency.networks ?? {}, };🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/server.ts` around lines 360 - 443, fetchFundingFees produces inconsistent fundingFeesByCurrency shapes between the fetchDepositWithdrawFees branch and the fetchCurrencies fallback; normalize the structure so every currency entry has the same keys (e.g., deposit: { enabled, fee, percentage, limits?, networks? }, withdraw: { enabled, fee, percentage, limits?, networks? }, networks: {...}) by mapping/transforming the outputs in both places inside fetchFundingFees (the loop that assigns fundingFeesByCurrency in the fetchDepositWithdrawFees handling and the loop in the fetchCurrencies fallback) to populate the unified keys consistently; alternatively, if you keep both shapes, update downstream consumers to accept both by centralizing a normalizer function called from fetchFundingFees.
355-357: Consider clarifying the flag relationship.The logic
includeAllFees || includeFundingFees === trueeffectively treatsincludeFundingFees=trueas equivalent toincludeAllFees=true. If this is intentional, consider adding a brief comment explaining whyincludeFundingFeestriggers the full fee response, or consider ifincludeFundingFeesshould have distinct behavior (e.g., only fetching funding fees without market details).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/server.ts` around lines 355 - 357, The current line conflates two flags—parsedPayload.data.includeAllFees and parsedPayload.data.includeFundingFees—by treating includeFundingFees === true as equivalent to includeAllFees; either add an inline comment explaining that includeFundingFees intentionally implies full fee data, or split them so includeAllFees = Boolean(parsedPayload.data.includeAllFees) and const includeFundingFees = parsedPayload.data.includeFundingFees === true (and update any downstream checks to consult includeFundingFees when only funding fees are needed); update usages of includeAllFees in the request-handling logic to use the new includeFundingFees variable where appropriate.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
.sandbox/Dockerfilepackage.jsonsrc/schemas/action-payloads.tssrc/server.ts
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-01-29T17:09:55.684Z
Learnt from: victorshevtsov
Repo: usherlabs/cex-broker PR: 23
File: src/client.dev.ts:72-76
Timestamp: 2026-01-29T17:09:55.684Z
Learning: In the cex-broker codebase, Action.FetchAccountId must remain implemented in src/server.ts to support external consumers like fiet-prover that depend on fetching account IDs from CEX endpoints; removing or replacing this handler breaks backward compatibility.
Applied to files:
src/server.ts
🧬 Code graph analysis (1)
src/server.ts (2)
src/schemas/action-payloads.ts (1)
FetchFeesPayloadSchema(82-85)src/helpers/logger.ts (1)
log(40-40)
🔇 Additional comments (7)
package.json (1)
3-3: LGTM!Version bump to 0.2.5 aligns with the new FetchFees feature additions.
.sandbox/Dockerfile (1)
9-9: LGTM!Dockerfile version correctly aligned with package.json version 0.2.5.
src/schemas/action-payloads.ts (2)
68-85: LGTM!The
booleanLikeSchemapreprocessing correctly handles common string boolean representations ("true"/"1"/"yes" and "false"/"0"/"no") with case-insensitive matching. Invalid inputs appropriately pass through to failz.boolean()validation.The
FetchFeesPayloadSchemastructure is well-defined with sensible defaults.
98-98: LGTM!Type export correctly inferred from the schema.
src/server.ts (3)
30-30: LGTM!Import correctly added for the new schema.
445-483: LGTM!Market symbol handling is well-structured:
- Properly distinguishes market symbols (containing "/") from token symbols
- Includes early return optimization when
includeAllFeesis false- Correctly extracts base/quote currencies for funding fee lookup
- Response structure clearly indicates scope via
feeScopefield
485-496: LGTM!Token symbol handling correctly normalizes to uppercase and returns a consistent response structure with
feeScope: "token".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@src/server.ts`:
- Around line 360-443: fetchFundingFees produces inconsistent
fundingFeesByCurrency shapes between the fetchDepositWithdrawFees branch and the
fetchCurrencies fallback; normalize the structure so every currency entry has
the same keys (e.g., deposit: { enabled, fee, percentage, limits?, networks? },
withdraw: { enabled, fee, percentage, limits?, networks? }, networks: {...}) by
mapping/transforming the outputs in both places inside fetchFundingFees (the
loop that assigns fundingFeesByCurrency in the fetchDepositWithdrawFees handling
and the loop in the fetchCurrencies fallback) to populate the unified keys
consistently; alternatively, if you keep both shapes, update downstream
consumers to accept both by centralizing a normalizer function called from
fetchFundingFees.
- Around line 355-357: The current line conflates two
flags—parsedPayload.data.includeAllFees and
parsedPayload.data.includeFundingFees—by treating includeFundingFees === true as
equivalent to includeAllFees; either add an inline comment explaining that
includeFundingFees intentionally implies full fee data, or split them so
includeAllFees = Boolean(parsedPayload.data.includeAllFees) and const
includeFundingFees = parsedPayload.data.includeFundingFees === true (and update
any downstream checks to consult includeFundingFees when only funding fees are
needed); update usages of includeAllFees in the request-handling logic to use
the new includeFundingFees variable where appropriate.
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
1 participant
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.
… token symbol
Summary by CodeRabbit
New Features
Chores