@elizaos/plugin-wallet 2.0.0-beta.1

package/src/analytics/birdeye/constants.ts

@@ -0,0 +1,74 @@
+// @ts-nocheck — legacy code from absorbed plugins (lp-manager, lpinfo, dexscreener, defi-news, birdeye); strict types pending cleanup
+export const DEFAULT_MAX_RETRIES = 3;
+
+export const BIRDEYE_SERVICE_NAME = "birdeye";
+
+export const DEFAULT_SUPPORTED_SYMBOLS = {
+  SOL: "So11111111111111111111111111111111111111112",
+  BTC: "qfnqNqs3nCAHjnyCgLRDbBtq4p2MtHZxw8YjSyYhPoL",
+  ETH: "7vfCXTUXx5WJV5JADk17DUJ4ksgau7utNKj4b963voxs",
+  Example: "2weMjPLLybRMMva1fM3U31goWWrCpF59CHWNhnCJ9Vyh",
+};
+
+export const API_BASE_URL = "https://public-api.birdeye.so";
+
+export const RETRY_DELAY_MS = 2_000;
+
+export const BIRDEYE_ENDPOINTS = {
+  defi: {
+    networks: "/defi/networks", // https://docs.birdeye.so/reference/get_defi-networks
+    price: "/defi/price", // https://docs.birdeye.so/reference/get_defi-price
+    price_multi: "/defi/multi_price", // https://docs.birdeye.so/reference/get_defi-multi-price
+    price_multi_POST: "/defi/multi_price", // https://docs.birdeye.so/reference/post_defi-multi-price
+    history_price: "/defi/history_price", // https://docs.birdeye.so/reference/get_defi-history-price
+    historical_price_unix: "/defi/historical_price_unix", // https://docs.birdeye.so/reference/get_defi-historical-price-unix
+    trades_token: "/defi/txs/token", // https://docs.birdeye.so/reference/get_defi-txs-token
+    trades_pair: "/defi/txs/pair", // https://docs.birdeye.so/reference/get_defi-txs-pair
+    trades_token_seek: "/defi/txs/token/seek_by_time", // https://docs.birdeye.so/reference/get_defi-txs-token-seek-by-time
+    trades_pair_seek: "/defi/txs/pair/seek_by_time", // https://docs.birdeye.so/reference/get_defi-txs-pair-seek-by-time
+    ohlcv: "/defi/ohlcv", // https://docs.birdeye.so/reference/get_defi-ohlcv
+    ohlcv_pair: "/defi/ohlcv/pair", // https://docs.birdeye.so/reference/get_defi-ohlcv-pair
+    ohlcv_base_quote: "/defi/ohlcv/base_quote", // https://docs.birdeye.so/reference/get_defi-ohlcv-base-quote
+    price_volume: "/defi/price_volume/single", // https://docs.birdeye.so/reference/get_defi-price-volume-single
+    price_volume_multi: "/defi/price_volume/multi", // https://docs.birdeye.so/reference/get_defi-price-volume-multi
+    price_volume_multi_POST: "/defi/price_volume/multi", // https://docs.birdeye.so/reference/post_defi-price-volume-multi
+  },
+  token: {
+    list_all: "/defi/tokenlist", // https://docs.birdeye.so/reference/get_defi-tokenlist
+    security: "/defi/token_security", // https://docs.birdeye.so/reference/get_defi-token-security
+    overview: "/defi/token_overview", // https://docs.birdeye.so/reference/get_defi-token-overview
+    creation_info: "/defi/token_creation_info", // https://docs.birdeye.so/reference/get_defi-token-creation-info
+    trending: "/defi/token_trending", // https://docs.birdeye.so/reference/get_defi-token-trending
+    list_all_v2_POST: "/defi/v2/tokens/all", // https://docs.birdeye.so/reference/post_defi-v2-tokens-all
+    new_listing: "/defi/v2/tokens/new_listing", // https://docs.birdeye.so/reference/get_defi-v2-tokens-new-listing
+    top_traders: "/defi/v2/tokens/top_traders", // https://docs.birdeye.so/reference/get_defi-v2-tokens-top-traders
+    all_markets: "/defi/v2/markets", // https://docs.birdeye.so/reference/get_defi-v2-markets
+    metadata_single: "/defi/v3/token/meta-data/single", // https://docs.birdeye.so/reference/get_defi-v3-token-meta-data-single
+    metadata_multi: "/defi/v3/token/meta-data/multiple", // https://docs.birdeye.so/reference/get_defi-v3-token-meta-data-multiple
+    market_data: "/defi/v3/token/market-data", // https://docs.birdeye.so/reference/get_defi-v3-token-market-data
+    trade_data_single: "/defi/v3/token/trade-data/single", // https://docs.birdeye.so/reference/get_defi-v3-token-trade-data-single
+    trade_data_multi: "/defi/v3/token/trade-data/multiple", // https://docs.birdeye.so/reference/get_defi-v3-token-trade-data-multiple
+    holders: "/defi/v3/token/holder", // https://docs.birdeye.so/reference/get_defi-v3-token-holder
+    mint_burn: "/defi/v3/token/mint-burn-txs", // https://docs.birdeye.so/reference/get_defi-v3-token-mint-burn-txs
+  },
+  wallet: {
+    networks: "/v1/wallet/list_supported_chain", // https://docs.birdeye.so/reference/get_v1-wallet-list-supported-chain
+    portfolio: "/v1/wallet/token_list", // https://docs.birdeye.so/reference/get_v1-wallet-token-list
+    portfolio_multichain: "/v1/wallet/multichain_token_list", // https://docs.birdeye.so/reference/get_v1-wallet-multichain-token-list
+    token_balance: "/v1/wallet/token_balance", // https://docs.birdeye.so/reference/get_v1-wallet-token-balance
+    transaction_history: "/v1/wallet/tx_list", // https://docs.birdeye.so/reference/get_v1-wallet-tx-list
+    transaction_history_multichain: "/v1/wallet/multichain_tx_list", // https://docs.birdeye.so/reference/get_v1-wallet-multichain-tx-list
+    transaction_simulation_POST: "/v1/wallet/simulate", // https://docs.birdeye.so/reference/post_v1-wallet-simulate
+  },
+  trader: {
+    gainers_losers: "/trader/gainers-losers", // https://docs.birdeye.so/reference/get_trader-gainers-losers
+    trades_seek: "/trader/txs/seek_by_time", // https://docs.birdeye.so/reference/get_trader-txs-seek-by-time
+  },
+  pair: {
+    overview_multi: "/defi/v3/pair/overview/multiple", // https://docs.birdeye.so/reference/get_defi-v3-pair-overview-multiple
+    overview_single: "/defi/v3/pair/overview/single", // https://docs.birdeye.so/reference/get_defi-v3-pair-overview-single
+  },
+  search: {
+    token_market: "/defi/v3/search", // https://docs.birdeye.so/reference/get_defi-v3-search
+  },
+};

package/src/analytics/birdeye/providers/agent-portfolio-provider.ts

@@ -0,0 +1,18 @@
+// @ts-nocheck — legacy code from absorbed plugins (lp-manager, lpinfo, dexscreener, defi-news, birdeye); strict types pending cleanup
+import {
+  createBirdeyePortfolioProvider,
+  formatPortfolio,
+} from "./portfolio-factory";
+
+/**
+ * Agent portfolio data provider that queries Birdeye API for the agent's wallet address.
+ * When a wallet address is set, this provider fetches current token balances and makes
+ * compact JSON portfolio context available to the planner.
+ */
+export const agentPortfolioProvider = createBirdeyePortfolioProvider({
+  name: "BIRDEYE_WALLET_PORTFOLIO",
+  description: "Birdeye token balances for the agent wallet",
+  descriptionCompressed: "Read Birdeye token balances for wallet.",
+});
+
+export { formatPortfolio };

package/src/analytics/birdeye/providers/market.ts

@@ -0,0 +1,227 @@
+// @ts-nocheck — legacy code from absorbed plugins (lp-manager, lpinfo, dexscreener, defi-news, birdeye); strict types pending cleanup
+import type { IAgentRuntime, Memory, Provider, State } from "@elizaos/core";
+//import { addHeader, composeActionExamples, formatActionNames, formatActions } from '@elizaos/core';
+//import type { IToken } from '../types';
+import { BIRDEYE_SERVICE_NAME } from "../constants";
+import type { CacheWrapper, GetCacheTimedOptions } from "../types/shared";
+import { formatJsonScalar, formatJsonTable } from "../utils";
+
+const MARKET_ROW_LIMIT = 12;
+
+export async function getCacheTimed<T>(
+  runtime: IAgentRuntime,
+  key: string,
+  options: GetCacheTimedOptions = {},
+): Promise<T | undefined> {
+  const wrapper = await runtime.getCache<CacheWrapper<T>>(key);
+  if (!wrapper) return;
+  if (options.notOlderThan) {
+    const diff = Date.now() - wrapper.setAt;
+    //console.log('checking notOlderThan', diff + 'ms', 'setAt', wrapper.setAt, 'asking', options.notOlderThan)
+    if (diff > options.notOlderThan) {
+      // no data
+      return;
+    }
+  }
+  // return data
+  return wrapper.data;
+}
+
+/**
+ * Provider for Birdeye market data
+ *
+ * @typedef {import('./Provider').Provider} Provider
+ * @typedef {import('./Runtime').IAgentRuntime} IAgentRuntime
+ * @typedef {import('./Memory').Memory} Memory
+ * @typedef {import('./State').State} State
+ * @typedef {import('./Action').Action} Action
+ *
+ * @type {Provider}
+ * @property {string} name - The name of the provider
+ * @property {string} description - Description of the provider
+ * @property {number} position - The position of the provider
+ * @property {Function} get - Asynchronous function to get actions that validate for a given message
+ *
+ * @param {IAgentRuntime} runtime - The agent runtime
+ * @param {Memory} message - The message memory
+ * @param {State} state - The state of the agent
+ * @returns {Object} Object containing data, values, and text related to actions
+ */
+export const marketProvider: Provider = {
+  name: "BIRDEYE_CRYPTOCURRENCY_MARKET_DATA",
+  description: "Birdeye get latest cryptocurrencies overview",
+  descriptionCompressed: "Read latest Birdeye cryptocurrency market overview.",
+  dynamic: true,
+  contexts: ["finance", "crypto", "wallet"],
+  contextGate: { anyOf: ["finance", "crypto", "wallet"] },
+  cacheStable: false,
+  cacheScope: "turn",
+  roleGate: { minRole: "USER" },
+  //position: -1,
+  get: async (runtime: IAgentRuntime, _message: Memory, _state: State) => {
+    try {
+      //console.log('BIRDEYE_CRYPTOCURRENCY_MARKET_DATA getting');
+
+      // define the market
+      // FIXME: get out of runtime.getSettings
+      const TOKEN_ADDRESSES = {
+        SOL: "So11111111111111111111111111111111111111112",
+        BTC: "3NZ9JMVBmGAqocybic2c7LQCJScmgsAZ6vQqTDzcqmJh", // wBTC
+        ETH: "7vfCXTUXx5WJV5JADk17DUJ4ksgau7utNKj4b963voxs", // wETH
+      };
+
+      const hardcodedSolanaCA2SymbolMap = {
+        So11111111111111111111111111111111111111112: "SOL",
+        "3NZ9JMVBmGAqocybic2c7LQCJScmgsAZ6vQqTDzcqmJh": "BTC", // wBTC
+        "7vfCXTUXx5WJV5JADk17DUJ4ksgau7utNKj4b963voxs": "ETH", // wETH
+      };
+
+      // get the market
+      const CAs = Object.values(TOKEN_ADDRESSES);
+
+      // get services
+      const birdeyeService = runtime.getService(BIRDEYE_SERVICE_NAME) as
+        | {
+            getTokensMarketData?: (
+              chain: string,
+              addresses: string[],
+            ) => Promise<
+              Record<
+                string,
+                {
+                  symbol: string;
+                  priceUsd: number;
+                  priceChange24h: number;
+                  liquidity: number;
+                }
+              >
+            >;
+          }
+        | undefined;
+      // want this for custom symbols
+      const solanaService = runtime.getService("chain_solana") as
+        | {
+            getTokensSymbols?: (
+              addresses: string[],
+            ) => Promise<Record<string, string>>;
+          }
+        | undefined;
+
+      // Guard Birdeye service before invoking methods
+      if (
+        !birdeyeService ||
+        typeof birdeyeService.getTokensMarketData !== "function"
+      ) {
+        runtime.logger?.error(
+          "Birdeye service is unavailable or does not have getTokensMarketData method",
+        );
+        return {
+          values: {},
+          text: [
+            "birdeye_market_data:",
+            "  status: unavailable",
+            "  reason: missing getTokensMarketData",
+          ].join("\n"),
+          data: {},
+        };
+      }
+
+      // FIXME: cache (how fresh does this have to be? 5 mins? 1 min?)
+      // get data
+      const ps = [birdeyeService.getTokensMarketData("solana", CAs)];
+      if (
+        solanaService &&
+        typeof solanaService.getTokensSymbols === "function"
+      ) {
+        ps.push(solanaService.getTokensSymbols(CAs));
+      }
+
+      const results = await Promise.all(ps);
+
+      const result = results[0]; // birdeye Results
+      const rows = [];
+
+      // FIXME: Market cap column is currently not populated from Birdeye API response
+      // Need to calculate or fetch market cap data separately
+      for (const ca of CAs) {
+        // Check if result[ca] exists before accessing it
+        if (!result[ca]) {
+          rows.push({
+            chain: "solana",
+            address: ca,
+            symbol: "unknown",
+            priceUsd: "unknown",
+            marketCapUsd: "unknown",
+            change24hPct: "unknown",
+            liquidityUsd: "unknown",
+          });
+          continue;
+        }
+
+        const t = result[ca];
+        t.symbol =
+          solanaService && results[1]
+            ? results[1][ca]
+            : (hardcodedSolanaCA2SymbolMap[ca] ?? "(Not available)");
+        // unwrap symbols
+        if (t.symbol === "WBTC") t.symbol = "BTC";
+        if (t.symbol === "WETH") t.symbol = "ETH";
+        //console.log('t', t)
+        rows.push({
+          chain: "solana",
+          address: ca,
+          symbol: t.symbol,
+          priceUsd: t.priceUsd.toFixed(4),
+          marketCapUsd: "unknown",
+          change24hPct: t.priceChange24h.toFixed(2),
+          liquidityUsd: t.liquidity.toFixed(2),
+        });
+      }
+
+      //console.log('BIRDEYE_CRYPTOCURRENCY_MARKET_DATA - birdye market data text', latestTxt)
+
+      const boundedRows = rows.slice(0, MARKET_ROW_LIMIT);
+      const data = {
+        tokens: Object.fromEntries(
+          Object.entries(results[0] ?? {}).slice(0, MARKET_ROW_LIMIT),
+        ),
+      };
+
+      const values = {};
+
+      // Combine all text sections
+      const text = [
+        "birdeye_market_data:",
+        "  status: ok",
+        formatJsonTable("  tokens", boundedRows, [
+          "chain",
+          "address",
+          "symbol",
+          "priceUsd",
+          "marketCapUsd",
+          "change24hPct",
+          "liquidityUsd",
+        ]),
+      ].join("\n");
+
+      return {
+        data,
+        values,
+        text,
+      };
+    } catch (err) {
+      runtime.logger?.error(
+        `Error fetching Birdeye market data: ${err instanceof Error ? err.message : String(err)}`,
+      );
+      return {
+        values: {},
+        text: [
+          "birdeye_market_data:",
+          "  status: error",
+          `  reason: ${formatJsonScalar(err instanceof Error ? err.message : String(err))}`,
+        ].join("\n"),
+        data: {},
+      };
+    }
+  },
+};

package/src/analytics/birdeye/providers/portfolio-factory.test.ts

@@ -0,0 +1,138 @@
+import type { IAgentRuntime, Memory, State } from "@elizaos/core";
+import { describe, expect, it, vi } from "vitest";
+import type { WalletPortfolioResponse } from "../types/api/wallet";
+import {
+  createBirdeyePortfolioProvider,
+  formatPortfolio,
+} from "./portfolio-factory";
+
+const WALLET = "So11111111111111111111111111111111111111112";
+
+function createRuntime(service: unknown): IAgentRuntime {
+  const runtime = {
+    getSetting: vi.fn((key: string) => {
+      if (key === "BIRDEYE_WALLET_ADDR") return WALLET;
+      if (key === "BIRDEYE_CHAIN") return "solana";
+      return undefined;
+    }),
+    getService: vi.fn(() => service),
+    logger: {
+      error: vi.fn(),
+      warn: vi.fn(),
+      log: vi.fn(),
+      debug: vi.fn(),
+    },
+  };
+
+  return runtime as IAgentRuntime;
+}
+
+describe("Birdeye portfolio provider factory", () => {
+  it("creates a portfolio provider that fetches holdings and renders JSON", async () => {
+    const service = {
+      fetchWalletTokenList: vi.fn(async () => ({
+        wallet: WALLET,
+        totalUsd: 250.5,
+        items: [
+          {
+            symbol: "SOL",
+            address: WALLET,
+            uiAmount: 1.23456,
+            priceUsd: 200.123456,
+            valueUsd: 247.11,
+            chainId: "solana",
+          },
+        ],
+      })),
+    };
+    const provider = createBirdeyePortfolioProvider({
+      name: "TEST_PORTFOLIO",
+      description: "Test portfolio",
+      descriptionCompressed: "test birdeye portfolio",
+    });
+
+    const result = await provider.get(
+      createRuntime(service),
+      {} as Memory,
+      {} as State,
+    );
+
+    expect(service.fetchWalletTokenList).toHaveBeenCalledWith(
+      "solana",
+      WALLET,
+      { notOlderThan: 30000 },
+    );
+    expect(result.text).toContain("birdeye_wallet_portfolio:");
+    expect(result.text).toContain(
+      "holdings[1]{symbol,address,amount,priceUsd,valueUsd,chainId}:",
+    );
+    expect(result.text).toContain("SOL");
+    expect(result.text).not.toContain("This is your portfolio");
+  });
+
+  it("creates a trade provider variant from the same factory", async () => {
+    const service = {
+      fetchWalletTokenList: vi.fn(async () => ({
+        wallet: WALLET,
+        totalUsd: 50,
+        items: [],
+      })),
+      fetchWalletTxList: vi.fn(async () => [
+        {
+          txHash: "tx-1",
+          mainAction: "swap",
+          status: true,
+          blockTime: "2026-05-05T12:00:00Z",
+          from: WALLET,
+          to: "market",
+        },
+      ]),
+    };
+    const provider = createBirdeyePortfolioProvider({
+      name: "TEST_TRADES",
+      description: "Test trades",
+      descriptionCompressed: "test birdeye trades",
+      includeTrades: true,
+    });
+
+    const result = await provider.get(
+      createRuntime(service),
+      {} as Memory,
+      {} as State,
+    );
+
+    expect(service.fetchWalletTokenList).toHaveBeenCalledTimes(1);
+    expect(service.fetchWalletTxList).toHaveBeenCalledWith("solana", WALLET, {
+      notOlderThan: 30000,
+    });
+    expect(result.data).toMatchObject({
+      portfolio: { totalUsd: 50 },
+      trades: [{ txHash: "tx-1" }],
+    });
+    expect(result.text).toContain("tradeCount: 1");
+    expect(result.text).toContain(
+      "trades[1]{txHash,action,status,blockTime,from,to}:",
+    );
+  });
+
+  it("formats legacy portfolio wrappers as JSON holdings", () => {
+    const legacy: WalletPortfolioResponse = {
+      success: true,
+      data: {
+        items: [
+          {
+            symbol: "ETH",
+            address: "0x0000000000000000000000000000000000000000",
+            uiAmount: 2,
+            priceUsd: 100,
+            valueUsd: 200,
+            chainId: "ethereum",
+          },
+        ],
+      },
+    };
+    expect(formatPortfolio(legacy)).toContain(
+      "holdings[1]{symbol,address,amount,priceUsd,valueUsd,chainId}:",
+    );
+  });
+});