JSDoc examples show wrong field names (supplier/borrower instead of sender)
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 76/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- typescript
- Domain
- documentation
Research direction
Inspect the JSDoc examples for supply(), withdraw(), borrow(), and repay(), then compare their parameter fields with the actual TypeScript types. Update the examples to use sender instead of supplier or borrower, and verify that each example matches the types used by @aave/client 0.9.2.
Written by the indexing model from the issue text.
Description
The JSDoc examples for supply(), withdraw(), borrow(), and repay() show using supplier or borrower fields, but the actual TypeScript types require sender. Took me a bit to figure out why my code wasn't working.
Example from JSDoc:
supply({ supplier: evmAddress('0x...'), ... })
What actually works:
supply({ sender: evmAddress('0x...'), ... })
Using @aave/client 0.9.2
- Dominant language
- TypeScript
- Stars
- 31
- Forks
- 22
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from aave/aave-sdk
Similar issues
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100