docs(api/exchange): add signing type markers to exchange method jsdoc#127
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds explicit signing-type markers to Exchange API JSDoc so developers can quickly tell whether an endpoint requires an L1 action signature or a user-signed EIP-712 payload (helpful for agent-wallet vs master-wallet flows).
Changes:
- Annotate
ExchangeClientmethod JSDoc with signing type (“L1 Action” vs “User-Signed EIP-712”). - Mirror the same signing-type annotations on the underlying
src/api/exchange/_methods/*function JSDoc.
Reviewed changes
Copilot reviewed 52 out of 52 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/api/exchange/client.ts | Adds signing-type markers to ExchangeClient method JSDoc blocks. |
| src/api/exchange/_methods/agentEnableDexAbstraction.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/agentSetAbstraction.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/approveAgent.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/approveBuilderFee.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/batchModify.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/borrowLend.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/cancel.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/cancelByCloid.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/cDeposit.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/cSignerAction.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/cValidatorAction.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/cWithdraw.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/claimRewards.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/convertToMultiSigUser.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/createSubAccount.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/createVault.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/evmUserModify.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/linkStakingUser.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/modify.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/noop.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/order.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/perpDeploy.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/registerReferrer.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/reserveRequestWeight.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/scheduleCancel.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/sendAsset.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/sendToEvmWithData.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/setDisplayName.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/setReferrer.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/spotDeploy.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/spotSend.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/spotUser.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/subAccountModify.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/subAccountSpotTransfer.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/subAccountTransfer.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/tokenDelegate.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/topUpIsolatedOnlyMargin.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/twapCancel.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/twapOrder.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/updateIsolatedMargin.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/updateLeverage.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/usdClassTransfer.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/usdSend.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/userDexAbstraction.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/userPortfolioMargin.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/userSetAbstraction.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/validatorL1Stream.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/vaultDistribute.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/vaultModify.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/vaultTransfer.ts | Adds signing-type marker to method JSDoc. |
| src/api/exchange/_methods/withdraw3.ts | Adds signing-type marker to method JSDoc. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Closes #115