@aave/cli 4.1.0-next.3 → 4.1.0-next.5

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @aave/cli
 $ aave COMMAND
 running command...
 $ aave (--version)
-@aave/cli/4.1.0-next.3 darwin-arm64 node-v22.17.0
+@aave/cli/4.1.0-next.5 darwin-arm64 node-v22.17.0
 $ aave --help [COMMAND]
 USAGE
   $ aave COMMAND
@@ -30,6 +30,7 @@ USAGE
 # Commands
 <!-- commands -->
 * [`aave hubs list`](#aave-hubs-list)
+* [`aave reserves list`](#aave-reserves-list)
 * [`aave spokes list`](#aave-spokes-list)
 
 ## `aave hubs list`
@@ -50,7 +51,30 @@ DESCRIPTION
   List Aave v4 liquidity hubs
 ```
 
-_See code: [src/commands/hubs/list.ts](https://github.com/aave/aave-v4-sdk/blob/v4.1.0-next.3/src/commands/hubs/list.ts)_
+_See code: [src/commands/hubs/list.ts](https://github.com/aave/aave-v4-sdk/blob/v4.1.0-next.5/src/commands/hubs/list.ts)_
+
+## `aave reserves list`
+
+List Aave v4 reserves
+
+```
+USAGE
+  $ aave reserves list [--json] [-s <spoke-id>] [-h <hub-id>] [--hub_address <evm-address> -c <chain-id>]
+
+FLAGS
+  -c, --chain_id=<chain-id>        The chain ID (e.g. 1, 137, 42161)
+  -h, --hub_id=<hub-id>            The hub ID (e.g. SGVsbG8h…)
+  -s, --spoke_id=<spoke-id>        The spoke ID (e.g. SGVsbG8h…)
+      --hub_address=<evm-address>  The hub address (e.g. 0x123…)
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List Aave v4 reserves
+```
+
+_See code: [src/commands/reserves/list.ts](https://github.com/aave/aave-v4-sdk/blob/v4.1.0-next.5/src/commands/reserves/list.ts)_
 
 ## `aave spokes list`
 
@@ -72,5 +96,5 @@ DESCRIPTION
   List Aave v4 spokes
 ```
 
-_See code: [src/commands/spokes/list.ts](https://github.com/aave/aave-v4-sdk/blob/v4.1.0-next.3/src/commands/spokes/list.ts)_
+_See code: [src/commands/spokes/list.ts](https://github.com/aave/aave-v4-sdk/blob/v4.1.0-next.5/src/commands/spokes/list.ts)_
 <!-- commandsstop -->

package/dist/commands/reserves/list.d.ts

@@ -0,0 +1,16 @@
+import { type Reserve } from '@aave/client';
+import * as common from '../../common.js';
+export default class ListReserves extends common.V4Command {
+    static description: string;
+    static flags: {
+        spoke_id: import("@oclif/core/interfaces").OptionFlag<import("@aave/graphql").SpokeId | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        hub_id: import("@oclif/core/interfaces").OptionFlag<import("@aave/graphql").HubId | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        chain_id: import("@oclif/core/interfaces").OptionFlag<import("@aave/types").ChainId | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        hub_address: import("@oclif/core/interfaces").OptionFlag<import("@aave/types").EvmAddress | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    protected headers: {
+        value: string;
+    }[];
+    private getReservesRequest;
+    run(): Promise<Reserve[]>;
+}

package/dist/commands/reserves/list.js

@@ -0,0 +1,118 @@
+import { InvariantError, invariant, ok, ResultAsync, } from '@aave/client';
+import { reserves } from '@aave/client/actions';
+import * as common from '../../common.js';
+function formatApy(apy, decimals = 4) {
+    return `${apy.normalized.toFixed(decimals)}%`;
+}
+export default class ListReserves extends common.V4Command {
+    static description = 'List Aave v4 reserves';
+    static flags = {
+        spoke_id: common.spoke({
+            required: false,
+            relationships: [
+                {
+                    type: 'none',
+                    flags: ['hub_id', 'chain_id', 'hub_address'],
+                },
+            ],
+        }),
+        hub_id: common.hub({
+            required: false,
+            relationships: [
+                {
+                    type: 'none',
+                    flags: ['spoke_id', 'chain_id', 'hub_address'],
+                },
+            ],
+        }),
+        chain_id: common.chain({
+            required: false,
+            relationships: [
+                {
+                    type: 'none',
+                    flags: ['spoke_id', 'hub_id'],
+                },
+            ],
+        }),
+        hub_address: common.address({
+            name: 'hub_address',
+            description: 'The hub address (e.g. 0x123…)',
+            relationships: [
+                {
+                    type: 'none',
+                    flags: ['spoke_id', 'hub_id'],
+                },
+                {
+                    type: 'all',
+                    flags: ['chain_id'],
+                },
+            ],
+            dependsOn: ['chain_id'],
+        }),
+    };
+    headers = [
+        { value: 'Asset' },
+        { value: 'Symbol' },
+        { value: 'Spoke' },
+        { value: 'Chain' },
+        { value: 'Supply APY' },
+        { value: 'Borrow APY' },
+        { value: 'Available Liquidity' },
+        { value: 'Total Borrowed' },
+        { value: 'Can Supply' },
+        { value: 'Can Borrow' },
+        { value: 'Collateral' },
+        { value: 'ID' },
+    ];
+    getReservesRequest() {
+        return ResultAsync.fromPromise(this.parse(ListReserves), (error) => new InvariantError(String(error))).andThen(({ flags }) => {
+            if (flags.spoke_id) {
+                return ok({
+                    query: { spokeId: flags.spoke_id },
+                });
+            }
+            if (flags.hub_id) {
+                return ok({
+                    query: { hubId: flags.hub_id },
+                });
+            }
+            if (flags.chain_id && flags.hub_address) {
+                return ok({
+                    query: {
+                        hub: {
+                            address: flags.hub_address,
+                            chainId: flags.chain_id,
+                        },
+                    },
+                });
+            }
+            if (flags.chain_id) {
+                return ok({
+                    query: { chainIds: [flags.chain_id] },
+                });
+            }
+            invariant(false, 'You must provide --spoke_id, --hub_id, --chain_id, or (--hub_address and --chain_id)');
+        });
+    }
+    async run() {
+        const result = await this.getReservesRequest().andThen((request) => reserves(this.client, request));
+        if (result.isErr()) {
+            this.error(result.error);
+        }
+        this.display(result.value.map((item) => [
+            item.asset.underlying.info.name,
+            item.asset.underlying.info.symbol,
+            item.spoke.name,
+            `${item.chain.name} (${item.chain.chainId})`,
+            formatApy(item.summary.supplyApy),
+            formatApy(item.summary.borrowApy),
+            `${item.summary.supplied.exchange.symbol}${item.summary.supplied.exchange.value.toFixed(2)}`,
+            `${item.summary.borrowed.exchange.symbol}${item.summary.borrowed.exchange.value.toFixed(2)}`,
+            item.canSupply ? 'Yes' : 'No',
+            item.canBorrow ? 'Yes' : 'No',
+            item.canUseAsCollateral ? 'Yes' : 'No',
+            item.id,
+        ]));
+        return result.value;
+    }
+}

package/dist/common.d.ts

@@ -1,4 +1,4 @@
-import { AaveClient, type ChainId, type EvmAddress, type HubId } from '@aave/client';
+import { AaveClient, type ChainId, type EvmAddress, type HubId, type SpokeId } from '@aave/client';
 import { Command } from '@oclif/core';
 import TtyTable from 'tty-table';
 export declare const chain: import("@oclif/core/interfaces").FlagDefinition<ChainId, import("@oclif/core/interfaces").CustomOptions, {
@@ -9,6 +9,10 @@ export declare const hub: import("@oclif/core/interfaces").FlagDefinition<HubId,
     multiple: false;
     requiredOrDefaulted: false;
 }>;
+export declare const spoke: import("@oclif/core/interfaces").FlagDefinition<SpokeId, import("@oclif/core/interfaces").CustomOptions, {
+    multiple: false;
+    requiredOrDefaulted: false;
+}>;
 export declare const address: import("@oclif/core/interfaces").FlagDefinition<EvmAddress, import("@oclif/core/interfaces").CustomOptions, {
     multiple: false;
     requiredOrDefaulted: false;
@@ -16,6 +20,11 @@ export declare const address: import("@oclif/core/interfaces").FlagDefinition<Ev
 export declare abstract class V4Command extends Command {
     protected headers: TtyTable.Header[];
     static enableJsonFlag: boolean;
+    static baseFlags: {
+        staging: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
     protected client: AaveClient;
+    init(): Promise<void>;
     protected display(rows: unknown[]): void;
+    protected toSuccessJson(result: unknown): unknown;
 }

package/dist/common.js

@@ -1,4 +1,4 @@
-import { AaveClient, chainId, evmAddress, hubId, } from '@aave/client';
+import { AaveClient, chainId, evmAddress, hubId, production, spokeId, staging, } from '@aave/client';
 import { Command, Flags } from '@oclif/core';
 import TtyTable from 'tty-table';
 export const chain = Flags.custom({
@@ -15,16 +15,55 @@ export const hub = Flags.custom({
     helpValue: '<hub-id>',
     parse: async (input) => hubId(input),
 });
+export const spoke = Flags.custom({
+    char: 's',
+    name: 'spoke',
+    description: 'The spoke ID (e.g. SGVsbG8h…)',
+    helpValue: '<spoke-id>',
+    parse: async (input) => spokeId(input),
+});
 export const address = Flags.custom({
     parse: async (input) => evmAddress(input),
     helpValue: '<evm-address>',
 });
+function convertBigIntsToStrings(obj) {
+    if (typeof obj === 'bigint') {
+        return obj.toString();
+    }
+    if (Array.isArray(obj)) {
+        return obj.map(convertBigIntsToStrings);
+    }
+    if (obj !== null && typeof obj === 'object') {
+        const result = {};
+        for (const [key, value] of Object.entries(obj)) {
+            result[key] = convertBigIntsToStrings(value);
+        }
+        return result;
+    }
+    return obj;
+}
 export class V4Command extends Command {
     headers = [];
     static enableJsonFlag = true;
-    client = AaveClient.create();
+    static baseFlags = {
+        staging: Flags.boolean({
+            hidden: true,
+            description: 'Use staging environment',
+            default: false,
+        }),
+    };
+    client;
+    async init() {
+        await super.init();
+        const { flags } = await this.parse(this.constructor);
+        const environment = flags.staging ? staging : production;
+        this.client = AaveClient.create({ environment });
+    }
     display(rows) {
         const out = TtyTable(this.headers, rows).render();
         this.log(out);
     }
+    toSuccessJson(result) {
+        return convertBigIntsToStrings(result);
+    }
 }

package/oclif.manifest.json

@@ -12,6 +12,13 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "staging": {
+          "description": "Use staging environment",
+          "hidden": true,
+          "name": "staging",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "chain": {
           "char": "c",
           "description": "The chain ID (e.g. 1, 137, 42161)",
@@ -38,6 +45,127 @@
         "list.js"
       ]
     },
+    "reserves:list": {
+      "aliases": [],
+      "args": {},
+      "description": "List Aave v4 reserves",
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "staging": {
+          "description": "Use staging environment",
+          "hidden": true,
+          "name": "staging",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "spoke_id": {
+          "char": "s",
+          "description": "The spoke ID (e.g. SGVsbG8h…)",
+          "name": "spoke_id",
+          "relationships": [
+            {
+              "type": "none",
+              "flags": [
+                "hub_id",
+                "chain_id",
+                "hub_address"
+              ]
+            }
+          ],
+          "required": false,
+          "hasDynamicHelp": false,
+          "helpValue": "<spoke-id>",
+          "multiple": false,
+          "type": "option"
+        },
+        "hub_id": {
+          "char": "h",
+          "description": "The hub ID (e.g. SGVsbG8h…)",
+          "name": "hub_id",
+          "relationships": [
+            {
+              "type": "none",
+              "flags": [
+                "spoke_id",
+                "chain_id",
+                "hub_address"
+              ]
+            }
+          ],
+          "required": false,
+          "hasDynamicHelp": false,
+          "helpValue": "<hub-id>",
+          "multiple": false,
+          "type": "option"
+        },
+        "chain_id": {
+          "char": "c",
+          "description": "The chain ID (e.g. 1, 137, 42161)",
+          "name": "chain_id",
+          "relationships": [
+            {
+              "type": "none",
+              "flags": [
+                "spoke_id",
+                "hub_id"
+              ]
+            }
+          ],
+          "required": false,
+          "hasDynamicHelp": false,
+          "helpValue": "<chain-id>",
+          "multiple": false,
+          "type": "option"
+        },
+        "hub_address": {
+          "dependsOn": [
+            "chain_id"
+          ],
+          "description": "The hub address (e.g. 0x123…)",
+          "name": "hub_address",
+          "relationships": [
+            {
+              "type": "none",
+              "flags": [
+                "spoke_id",
+                "hub_id"
+              ]
+            },
+            {
+              "type": "all",
+              "flags": [
+                "chain_id"
+              ]
+            }
+          ],
+          "hasDynamicHelp": false,
+          "helpValue": "<evm-address>",
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "reserves:list",
+      "pluginAlias": "@aave/cli",
+      "pluginName": "@aave/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "reserves",
+        "list.js"
+      ]
+    },
     "spokes:list": {
       "aliases": [],
       "args": {},
@@ -50,6 +178,13 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "staging": {
+          "description": "Use staging environment",
+          "hidden": true,
+          "name": "staging",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "hub_id": {
           "char": "h",
           "description": "The hub ID (e.g. SGVsbG8h…)",
@@ -129,5 +264,5 @@
       ]
     }
   },
-  "version": "4.1.0-next.3"
+  "version": "4.1.0-next.5"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aave/cli",
-  "version": "4.1.0-next.3",
+  "version": "4.1.0-next.5",
   "description": "CLI to interact with AaveKit API",
   "keywords": [
     "aave",
@@ -30,7 +30,7 @@
     "@oclif/plugin-help": "^6",
     "@oclif/plugin-plugins": "^5",
     "tty-table": "^5.0.0",
-    "@aave/client": "4.0.0-next.10"
+    "@aave/client": "4.0.0-next.12"
   },
   "devDependencies": {
     "@oclif/test": "^4",