ethereum-optimism / ethereum-optimism/actions

fix: add @param JSDoc to WalletSwapNamespace overrides

Open
#367 0 comments 0 reactions 1 assignee Claimed by @jefr90 View on GitHub
Dominant language
TypeScript
Stars
32
Forks
25
Avg merge
10h 20m
Merged PRs (30d)
16

Description

## Summary

`WalletSwapNamespace.getQuote()` and `WalletSwapNamespace.getQuotes()` override `BaseSwapNamespace` methods but do not carry forward the `@param` JSDoc tags. This causes the auto-generated API reference docs to show empty parameter descriptions for those methods.

## Affected methods

- `WalletSwapNamespace.getQuote(params: SwapQuoteParams)` — override has no `@param` tag; base class has `@param params - Quote parameters (assets, amounts, chain, optional provider)`
- `WalletSwapNamespace.getQuotes(params: SwapQuoteParams)` — same issue

## Expected fix

Add `@param` tags to both overrides in `src/swap/namespaces/WalletSwapNamespace.ts`:

```ts
/**
* Get a swap quote with the wallet address as recipient.
* Ensures calldata is encoded for the real wallet, not a placeholder.
* @param params - Quote parameters (assets, amounts, chain, optional provider)
*/
override async getQuote(params: SwapQuoteParams): Promise
```

## Context

Discovered while generating the Actions SDK swap documentation for [docs.optimism.io](https://docs.optimism.io/app-developers/reference/actions/swap-documentation).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.