akanoce / react-aave-sdk Goto Github PK

View Code? Open in Web Editor NEW

3.0 1.0 1.0 2.05 MB

Collections of hooks and providers to make development on top of the AAVE contracts and pools a breeze.

JavaScript 3.84% HTML 0.37% TypeScript 95.79%

aave aave-lending aave-protocol aave-v3 blockchain defi ethereum react reactjs sdk

react-aave-sdk's Introduction

Aave SDK

Aave V3 React is out!

Collections of hooks and providers to make development on top of the aave contracts and pools a breeze.

Development

Install the packages

yarn

Run the example apps

yarn dev

Contribute to the sdk

The core hooks and logics of the sdk are located unders /packages/react-sdk.

While running yarn dev, any edit to the files should be reflected in real-time in the example apps.

Committing

This repo uses conventional commits via commitlint. commitlint is enforced via an husky pre-commit hook.

This means all the commits have to follow a specific structure like:

feat(sdk): add new feature;
fix(vite-app): avoid re-render;

react-aave-sdk's People

Contributors

Stargazers

Watchers

Forkers

defispartan

react-aave-sdk's Issues

test(sdk): aim to 100% coverage

Aim to 100% coverage for every hook, provider or util exported by the sdk

The MVP should be unit tests with vitest + react-testing-library ensuring every hook behaves correctly in all possible scenarios.

For read-only hooks, we can avoid mocking the requests to the nodes and ensuring the data returned matched a specific object structure and types;
For write hooks, we could instead mock the methods to create and submit the tx, ensuring the state of the mutation hook updates corectly;

test(apps): integration test for the hooks

Perform integration + render test of the hooks

This could help detect if new versions of viem/wagmi/utilities have incompatibilities with the sdk

feat(vite-app): integrate useUserReserves

feat(sdk): useRepayWithCollateral

https://github.com/aave/aave-utilities?tab=readme-ov-file#repaywithcollateral-v3

chore: lint + fix on husky pre-commit hook

feat(sdk): useSupplyWithPermit

https://github.com/aave/aave-utilities?tab=readme-ov-file#supplywithpermit

docs: gitbook

Add gitbook with proper documentation for every hook, and usage with every framework

feat(vite-app): integrate useUserReservesIncentives

feat(vite-app): integrate useReservesIncentives

chore(ci): check linting + build on actions

feat(sdk): extract and publish aave-v3 sdk

Given the current setup, we can easily extract the getter and builder methods inside the hooks in a dedicated package to be published under the name of aave-v3 or aave-v3-js

It's gonna work something like this

const v3 = AaveV3(chainId, provider, signer);

const reserves = v3.getReserves()

const receipt = v3.supply(reserve, amount, waitForConfirmation?);

The benefit of this is increased DX when developing on pure JS (also node and similar environments)

The package, is gonna handle automatic address resolutions based on the chainId, and using provider/signer to get/send data.

feat(sdk): useSupplyBundle

https://github.com/aave/aave-utilities?tab=readme-ov-file#supplybundle

feat(sdk): useLiquidationCall

https://github.com/aave/aave-utilities?tab=readme-ov-file#liquidationcall-v3