@aave/cli 4.1.0-next.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Aave Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,76 @@
+@aave/cli
+=================
+
+CLI to interact with AaveKit API
+
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/@aave/cli.svg)](https://npmjs.org/package/@aave/cli)
+[![Downloads/week](https://img.shields.io/npm/dw/@aave/cli.svg)](https://npmjs.org/package/@aave/cli)
+
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @aave/cli
+$ aave COMMAND
+running command...
+$ aave (--version)
+@aave/cli/4.1.0-next.0 darwin-arm64 node-v22.17.0
+$ aave --help [COMMAND]
+USAGE
+  $ aave COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`aave hubs list`](#aave-hubs-list)
+* [`aave spokes list`](#aave-spokes-list)
+
+## `aave hubs list`
+
+List Aave v4 liquidity hubs
+
+```
+USAGE
+  $ aave hubs list [--json] [-c <chain-id>]
+
+FLAGS
+  -c, --chain=<chain-id>  The chain ID (e.g. 1, 137, 42161)
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+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.0/src/commands/hubs/list.ts)_
+
+## `aave spokes list`
+
+List Aave v4 spokes
+
+```
+USAGE
+  $ aave spokes list [--json] [-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…)
+      --hub_address=<evm-address>  The hub address (e.g. 0x123…)
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List Aave v4 spokes
+```
+
+_See code: [src/commands/spokes/list.ts](https://github.com/aave/aave-v4-sdk/blob/v4.1.0-next.0/src/commands/spokes/list.ts)_
+<!-- commandsstop -->

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S node --import tsx/esm --disable-warning=ExperimentalWarning
+
+import { execute } from '@oclif/core';
+
+await execute({ development: true, dir: import.meta.url });

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { execute } from '@oclif/core';
+
+await execute({ dir: import.meta.url });

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

@@ -0,0 +1,13 @@
+import { type Hub } from '@aave/client';
+import * as common from '../../common.js';
+export default class ListHubs extends common.V4Command {
+    static description: string;
+    static flags: {
+        chain: import("@oclif/core/interfaces").OptionFlag<import("@aave/types").ChainId | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    headers: {
+        value: string;
+    }[];
+    private getHubsRequest;
+    run(): Promise<Hub[]>;
+}

package/dist/commands/hubs/list.js

@@ -0,0 +1,46 @@
+import { ChainsFilter, InvariantError, ok, ResultAsync, } from '@aave/client';
+import { chains, hubs } from '@aave/client/actions';
+import * as common from '../../common.js';
+export default class ListHubs extends common.V4Command {
+    static description = 'List Aave v4 liquidity hubs';
+    static flags = {
+        chain: common.chain(),
+    };
+    headers = [
+        { value: 'Hub' },
+        { value: 'Address' },
+        { value: 'Chain' },
+        { value: 'ID' },
+    ];
+    getHubsRequest() {
+        return ResultAsync.fromPromise(this.parse(ListHubs), (error) => new InvariantError(String(error))).andThen(({ flags }) => {
+            if (flags.chain) {
+                return ok({
+                    query: {
+                        chainIds: [flags.chain],
+                    },
+                });
+            }
+            return chains(this.client, {
+                query: { filter: ChainsFilter.ALL },
+            }).andThen((items) => ok({
+                query: {
+                    chainIds: items.map((item) => item.chainId),
+                },
+            }));
+        });
+    }
+    async run() {
+        const result = await this.getHubsRequest().andThen((request) => hubs(this.client, request));
+        if (result.isErr()) {
+            this.error(result.error);
+        }
+        this.display(result.value.map((item) => [
+            item.name,
+            item.address,
+            `${item.chain.name} (id=${item.chain.chainId})`,
+            `${item.id}`,
+        ]));
+        return result.value;
+    }
+}

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

@@ -0,0 +1,15 @@
+import { type Spoke } from '@aave/client';
+import * as common from '../../common.js';
+export default class ListSpokes extends common.V4Command {
+    static description: string;
+    static flags: {
+        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 getSpokesRequest;
+    run(): Promise<Spoke[]>;
+}

package/dist/commands/spokes/list.js

@@ -0,0 +1,79 @@
+import { InvariantError, invariant, ok, ResultAsync, } from '@aave/client';
+import { spokes } from '@aave/client/actions';
+import * as common from '../../common.js';
+export default class ListSpokes extends common.V4Command {
+    static description = 'List Aave v4 spokes';
+    static flags = {
+        hub_id: common.hub({
+            relationships: [
+                {
+                    type: 'none',
+                    flags: ['chain_id', 'hub_address'],
+                },
+            ],
+        }),
+        chain_id: common.chain({
+            required: false,
+            relationships: [
+                {
+                    type: 'none',
+                    flags: ['hub_id'],
+                },
+            ],
+        }),
+        hub_address: common.address({
+            name: 'hub_address',
+            description: 'The hub address (e.g. 0x123…)',
+            relationships: [
+                {
+                    type: 'none',
+                    flags: ['hub_id'],
+                },
+                {
+                    type: 'all',
+                    flags: ['chain_id'],
+                },
+            ],
+            dependsOn: ['chain_id'],
+        }),
+    };
+    headers = [
+        { value: 'Spoke' },
+        { value: 'Address' },
+        { value: 'Chain' },
+        { value: 'ID' },
+    ];
+    getSpokesRequest() {
+        return ResultAsync.fromPromise(this.parse(ListSpokes), (error) => new InvariantError(String(error))).andThen(({ flags }) => {
+            if (flags.chain_id && flags.hub_address) {
+                return ok({
+                    query: {
+                        hub: {
+                            address: flags.hub_address,
+                            chainId: flags.chain_id,
+                        },
+                    },
+                });
+            }
+            invariant(flags.hub_id, 'You must provide a <hub> or <hub_address> and <chain>');
+            return ok({
+                query: {
+                    hubId: flags.hub_id,
+                },
+            });
+        });
+    }
+    async run() {
+        const result = await this.getSpokesRequest().andThen((request) => spokes(this.client, request));
+        if (result.isErr()) {
+            this.error(result.error);
+        }
+        this.display(result.value.map((item) => [
+            item.name,
+            item.address,
+            `${item.chain.name} (id=${item.chain.chainId})`,
+            item.id,
+        ]));
+        return result.value;
+    }
+}

package/dist/common.d.ts

@@ -0,0 +1,21 @@
+import { AaveClient, type ChainId, type EvmAddress, type HubId } 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, {
+    multiple: false;
+    requiredOrDefaulted: false;
+}>;
+export declare const hub: import("@oclif/core/interfaces").FlagDefinition<HubId, 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;
+}>;
+export declare abstract class V4Command extends Command {
+    protected headers: TtyTable.Header[];
+    static enableJsonFlag: boolean;
+    protected client: AaveClient;
+    protected display(rows: unknown[]): void;
+}

package/dist/common.js

@@ -0,0 +1,30 @@
+import { AaveClient, chainId, evmAddress, hubId, } from '@aave/client';
+import { Command, Flags } from '@oclif/core';
+import TtyTable from 'tty-table';
+export const chain = Flags.custom({
+    char: 'c',
+    name: 'chain',
+    description: 'The chain ID (e.g. 1, 137, 42161)',
+    helpValue: '<chain-id>',
+    parse: async (input) => chainId(Number(input)),
+});
+export const hub = Flags.custom({
+    char: 'h',
+    name: 'hub',
+    description: 'The hub ID (e.g. SGVsbG8h…)',
+    helpValue: '<hub-id>',
+    parse: async (input) => hubId(input),
+});
+export const address = Flags.custom({
+    parse: async (input) => evmAddress(input),
+    helpValue: '<evm-address>',
+});
+export class V4Command extends Command {
+    headers = [];
+    static enableJsonFlag = true;
+    client = AaveClient.create();
+    display(rows) {
+        const out = TtyTable(this.headers, rows).render();
+        this.log(out);
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/index.js

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/oclif.manifest.json

@@ -0,0 +1,133 @@
+{
+  "commands": {
+    "hubs:list": {
+      "aliases": [],
+      "args": {},
+      "description": "List Aave v4 liquidity hubs",
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "chain": {
+          "char": "c",
+          "description": "The chain ID (e.g. 1, 137, 42161)",
+          "name": "chain",
+          "hasDynamicHelp": false,
+          "helpValue": "<chain-id>",
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "hubs:list",
+      "pluginAlias": "@aave/cli",
+      "pluginName": "@aave/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "hubs",
+        "list.js"
+      ]
+    },
+    "spokes:list": {
+      "aliases": [],
+      "args": {},
+      "description": "List Aave v4 spokes",
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "hub_id": {
+          "char": "h",
+          "description": "The hub ID (e.g. SGVsbG8h…)",
+          "name": "hub_id",
+          "relationships": [
+            {
+              "type": "none",
+              "flags": [
+                "chain_id",
+                "hub_address"
+              ]
+            }
+          ],
+          "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": [
+                "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": [
+                "hub_id"
+              ]
+            },
+            {
+              "type": "all",
+              "flags": [
+                "chain_id"
+              ]
+            }
+          ],
+          "hasDynamicHelp": false,
+          "helpValue": "<evm-address>",
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "spokes:list",
+      "pluginAlias": "@aave/cli",
+      "pluginName": "@aave/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "spokes",
+        "list.js"
+      ]
+    }
+  },
+  "version": "4.1.0-next.0"
+}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@aave/cli",
+  "version": "4.1.0-next.0",
+  "description": "CLI to interact with AaveKit API",
+  "keywords": [
+    "aave",
+    "cli"
+  ],
+  "repository": {
+    "directory": "packages/cli",
+    "type": "git",
+    "url": "git://github.com/aave/aave-v4-sdk.git"
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "aave": "./bin/run.js"
+  },
+  "engines": {
+    "node": ">=22.17.0"
+  },
+  "files": [
+    "./bin",
+    "./dist",
+    "./oclif.manifest.json"
+  ],
+  "dependencies": {
+    "@oclif/core": "^4",
+    "@oclif/plugin-help": "^6",
+    "@oclif/plugin-plugins": "^5",
+    "tty-table": "^5.0.0",
+    "@aave/client": "4.0.0-next.7"
+  },
+  "devDependencies": {
+    "@oclif/test": "^4",
+    "@types/node": "^24",
+    "oclif": "^4",
+    "rimraf": "^6.1.2",
+    "tsx": "^4.20.3",
+    "typescript": "^5"
+  },
+  "oclif": {
+    "bin": "aave",
+    "dirname": "aave",
+    "commands": "./dist/commands",
+    "topicSeparator": " ",
+    "topics": {
+      "hubs": {
+        "description": "List available liquidity hubs"
+      },
+      "spokes": {
+        "description": "List available spokes"
+      }
+    }
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "rimraf dist && tsc -b",
+    "version": "oclif readme && git add README.md"
+  }
+}