feat: add reserves list command to CLI #205

Trynax · 2025-12-11T14:13:34Z

Hey, good day,
I noticed the cli package and was going through it realized there's a lot more commands that could be added to make it even more useful.

I added reserves list command

The command has flexible query options:

--spoke_id - List reserves for a specific spoke
--hub_id - List reserves for a specific hub
--chain_id - List reserves for a specific chain
--hub_address with --chain_id - List reserves for a hub by address

The command displays infos like:

Asset details (name, symbol)
Location info (spoke, chain)
APY rates (supply and borrow, formatted to 4 decimals for readability)
Liquidity metrics (available liquidity, total borrowed in USD)
Capabilities (Can Supply, Can Borrow, Can use as Collateral)

Follows the existing command structure and patterns used in hubs list and spokes list and updated the cli readme.

screenshot from usage below:

Trynax · 2025-12-11T14:15:45Z

and yes for hub address + chain ID query as well.

Trynax · 2025-12-11T14:50:23Z

The --json flag is currently not supported for the reserves list command due to BigDecimal fields (borrowCap, supplyCap) in the Reserve type that cannot be serialized to JSON.

If JSON output is needed, this could be done by either changing how big decimal types are serialized , or by returning a json-serializable type from the command run() method instead of Reserve[].

Trynax · 2025-12-11T15:17:39Z

thinking of add more commands as well like users(--user address), like user summary, positions, suppplies, borrows.., depends on the feedback here 👀

cesarenaldi · 2025-12-17T08:03:43Z

Hey @Trynax sorry for the late response to this PR.

We are kinda pretty busy on the v4 polishing aspects for the coming mainnet launch, so didn't have a lot of time to look into this PR in detail. From a quick scan, it seems it's overall in order with few things to fix. I'll see if I can put some time aside in the coming days to leave some comments.

Trynax · 2025-12-17T10:16:53Z

Hey @Trynax sorry for the late response to this PR.

We are kinda pretty busy on the v4 polishing aspects for the coming mainnet launch, so didn't have a lot of time to look into this PR in detail. From a quick scan, it seems it's overall in order with few things to fix. I'll see if I can put some time aside in the coming days to leave some comments.

Thanks for the feedback @cesarenaldi

I understand that you've been busy. I'll work on adding more commands to the brandg, so you can probably review them all together, or maybe we should conclude on this one first.👀

cesarenaldi · 2025-12-17T11:08:56Z

@Trynax we do have some plans around the CLI and other commands, can you please open an issue to discuss the commands you intend to add from a pure usage signature perspective?

Just to want to make sure there is not unnecessary overlap and things align with the other work planned for this CLI.

cesarenaldi · 2025-12-17T11:31:03Z

packages/cli/src/commands/reserves/list.ts

+function formatApy(apy: { normalized: unknown }, decimals = 4): string {
+  return `${parseFloat(String(apy.normalized)).toFixed(decimals)}%`;
+}


Suggested change

function formatApy(apy: { normalized: unknown }, decimals = 4): string {

return `${parseFloat(String(apy.normalized)).toFixed(decimals)}%`;

}

function formatApy(apy: PercentNumber, decimals = 4): string {

return `${apy.normalized.toFixed(decimals)}%`;

}

cesarenaldi · 2025-12-17T11:33:20Z

packages/cli/src/commands/reserves/list.ts

+        `$${item.summary.supplied.fiatAmount.value}`,
+        `$${item.summary.borrowed.fiatAmount.value}`,


Suggested change

`$${item.summary.supplied.fiatAmount.value}`,

`$${item.summary.borrowed.fiatAmount.value}`,

`${item.summary.supplied.fiatAmount.symbol}${item.summary.supplied.fiatAmount.value.toFixed(2)}`,

`${item.summary.borrowed.fiatAmount.symbol}${item.summary.borrowed.fiatAmount.value.toFixed(2)}`,

cesarenaldi · 2025-12-17T11:34:18Z

packages/cli/src/commands/reserves/list.ts

Formatting can be fixed with pnpm lint:fix from the root of the repo, or installing Biome.js extension on your IDE to format on save.

Trynax · 2025-12-17T12:39:52Z

Thanks for the review @cesarenaldi , I've addressed the feedbacks.

Note: I had to change the currency formatting to use exchange instead of fiatAmount since the schema was updated.

I'll open an issue regarding the cli soon.

Trynax · 2025-12-17T12:50:53Z

Thanks for the review @cesarenaldi , I've addressed the feedbacks.

Note: I had to change the currency formatting to use exchange instead of fiatAmount since the schema was updated.

I'll open an issue regarding the cli soon.

Also, I'm unable to test the cli commands right now(including the previous ones) looks like the graphql api hasn't been deployed with the new schema yet👀 (getting "Unknown field 'exchange'" errors on both production and staging).

cesarenaldi · 2025-12-17T12:57:34Z

Thanks for the review @cesarenaldi , I've addressed the feedbacks.
Note: I had to change the currency formatting to use exchange instead of fiatAmount since the schema was updated.
I'll open an issue regarding the cli soon.

Also, I'm unable to test the cli commands right now(including the previous ones) looks like the graphql api hasn't been deployed with the new schema yet👀 (getting "Unknown field 'exchange'" errors on both production and staging).

You need to rebased on latest main and update few fields (e.g., fiatAmount > exchange), there was a breaking change to the fragments since you branched.

Also make sure you rebuild the solution since the CLI will use the built version of the subpackages.

Trynax · 2025-12-17T14:06:57Z

Thanks for the review @cesarenaldi , I've addressed the feedbacks.
Note: I had to change the currency formatting to use exchange instead of fiatAmount since the schema was updated.
I'll open an issue regarding the cli soon.

Also, I'm unable to test the cli commands right now(including the previous ones) looks like the graphql api hasn't been deployed with the new schema yet👀 (getting "Unknown field 'exchange'" errors on both production and staging).

You need to rebased on latest main and update few fields (e.g., fiatAmount > exchange), there was a breaking change to the fragments since you branched.

Also make sure you rebuild the solution since the CLI will use the built version of the subpackages.

@cesarenaldi I Just realized the cli default to production, which still has the old schema:

# Production has old schema (
$ curl -s -X POST https://api.v4.aave.com/graphql \
  -H "Content-Type: application/json" \
  -d '{"query":"{ __type(name: \"Erc20Amount\") { fields { name } } }"}' | jq '.data.__type.fields[].name'
"amount"
"fiatAmount"  #  Old field
"fiatRate"        #  Old field
"isWrappedNative"
"token"

# Staging has new schema 
$ curl -s -X POST https://api.v4.staging.aave.com/graphql \
  -H "Content-Type: application/json" \
  -d '{"query":"{ __type(name: \"Erc20Amount\") { fields { name } } }"}' | jq '.data.__type.fields[].name'
"amount"
"exchange"            # New field 
"exchangeRate"    # New field 
"isWrappedNative"
"token"

so I had to hardcode the cli to use staging to test the cli and it works fine, but i suppose the right one should be using the ENVIROMENT set in .env i can add that to the PR if that's fine.

cesarenaldi · 2025-12-17T21:16:12Z

yeah, we should update production at some point this week. Generally speaking staging env is not meant for general usage, it's mostly reserver for development/testing our end.

Would be interesting if we could figure out something with the base class where it adds a --staging flag (maybe hidden from CLI help perspective) or something (like the internal --json works) and then it initialize the client against staging.

Trynax · 2025-12-18T03:58:41Z

yeah, we should update production at some point this week. Generally speaking staging env is not meant for general usage, it's mostly reserver for development/testing our end.

Would be interesting if we could figure out something with the base class where it adds a --staging flag (maybe hidden from CLI help perspective) or something (like the internal --json works) and then it initialize the client against staging.

Yeah think this would be better, implemented it already.

usage would be like:

aave reserves list --chain_id 123456789 --staging
aave hubs list --staging

cesarenaldi · 2025-12-18T14:08:46Z

packages/cli/src/common.ts

+
+BigInt.prototype.toJSON = function () {
+  return this.toString();
+};


@Trynax can you please clarify the reason for this patch?

@Trynax can you please clarify the reason for this patch?

It fix the --json flag error when any response have a bigint value, without it it produce TypeError: Do not know how to seriaize a BigInt

I would rather considering traversing the data structure and return a string in place of BigInt instances instead of patching a global at the module level of one of the modules.

There is a toSuccessJson protected method that could be overridden by any command to achieve this sort of things.

A relatively simple traversing traversing that, no matter the shape of the json: unknown, finds any leaf that are instance of JS BigInt (typeof x === 'bigint') and return the toString of it.

@cesarenaldi Thanks for this.
I've added a func that recursively traverses the data structure

Thank you @Trynax for the change.

… apy values

cesarenaldi · 2025-12-22T08:02:19Z

@Trynax tests are failing due to the lack of secrets/env variables (GH omits them when running on forks). Given the nature of your changes I have no reason to think there is a actual issue under the hood.

I would only need you to add a changeset.

Run (from root folder):

pnpm changeset add

and select @aave/cli with a patch level change (since we are still in @next pre-release it's all part of 4.x).

Write a comment starting with:

**feat:** [copy]
**fix:** [copy]
**chore:** [copy]

as needed, and commit the file.

For example:

**feat:** add reserves list command to CLI

like your PR title is already a good entry.

Trynax · 2025-12-22T08:34:54Z

gm @cesarenaldi, just followed up and added the changeset.

cesarenaldi · 2025-12-22T09:00:20Z

Thank you @Trynax merging this.

Trynax · 2025-12-22T09:31:31Z

Thank you @Trynax merging this.

Nice, thank you😁 hopefully more to come.

Trynax force-pushed the feat/exppand-cli branch from a426c14 to 0d2ec24 Compare December 11, 2025 15:00

cesarenaldi reviewed Dec 17, 2025

View reviewed changes

Trynax mentioned this pull request Dec 17, 2025

Adding more CLI #208

Open

Trynax force-pushed the feat/exppand-cli branch from 8bd5742 to 9cb04fb Compare December 18, 2025 03:53

cesarenaldi reviewed Dec 18, 2025

View reviewed changes

Trynax added 8 commits December 20, 2025 12:44

added reserves list command with a single flag

6411c9d

added hub_id, hub_address and cghain_id flags

e64fbae

added capabilitiees columns can supply, borrow and collatera + format…

01e795d

… apy values

fix nits

17ef88f

environment configuration

c334ea6

added --staging flag and bigint json serialization

962bf70

fix lint

9d992b6

overide tosuccessjson to traverse and convert bigint value

ab8ca11

Trynax force-pushed the feat/exppand-cli branch from ee88f21 to ab8ca11 Compare December 20, 2025 12:09

added changeset for @aave/cli

cca9e91

cesarenaldi approved these changes Dec 22, 2025

View reviewed changes

cesarenaldi merged commit 67b4432 into aave:main Dec 22, 2025

		`$${item.summary.supplied.fiatAmount.value}`,
		`$${item.summary.borrowed.fiatAmount.value}`,

feat: add reserves list command to CLI #205

feat: add reserves list command to CLI #205

Uh oh!

Conversation

Trynax commented Dec 11, 2025

Uh oh!

Trynax commented Dec 11, 2025

Uh oh!

Trynax commented Dec 11, 2025

Uh oh!

Trynax commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cesarenaldi commented Dec 17, 2025

Uh oh!

Trynax commented Dec 17, 2025

Uh oh!

cesarenaldi commented Dec 17, 2025

Uh oh!

cesarenaldi Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cesarenaldi Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

cesarenaldi Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Trynax commented Dec 17, 2025

Uh oh!

Trynax commented Dec 17, 2025

Uh oh!

cesarenaldi commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Trynax commented Dec 17, 2025

Uh oh!

cesarenaldi commented Dec 17, 2025

Uh oh!

Trynax commented Dec 18, 2025

Uh oh!

cesarenaldi Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

Trynax Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

cesarenaldi Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

Trynax Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

cesarenaldi Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

cesarenaldi commented Dec 22, 2025

Uh oh!

Trynax commented Dec 22, 2025

Uh oh!

cesarenaldi commented Dec 22, 2025

Uh oh!

Trynax commented Dec 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Trynax commented Dec 11, 2025 •

edited

Loading

cesarenaldi Dec 17, 2025 •

edited

Loading

cesarenaldi commented Dec 17, 2025 •

edited

Loading