keyring-agent-core 0.2.1 → 0.2.3

package/dist/tools/builtin/wallet-action/BuyTokenTool.d.ts

@@ -1,240 +0,0 @@
-import { BaseTool } from '../../BaseTool';
-import { type MoralisServiceConfig } from '../../../services/MoralisService';
-import type { ToolKind, ToolParameter, ToolResult, UIPayload, UserContext } from '../../../types';
-/**
- * Tool: open-buy-token-form
- *
- * A STANDALONE wallet-action tool (NOT a `BaseWalletActionTool`): instead of
- * emitting the shared form payload, it does the quote + approval work itself and
- * ships a custom `BuyTokenConfirmTx` UI payload the FE executes directly. That's
- * why `buy_token` is intentionally NOT a member of `WalletActionType`.
- *
- * Branches, picked deterministically from the args:
- *
- *  0. **Trending picker** — the user wants to buy but did NOT name a token
- *     (`token_symbol` empty). The tool fetches the chain's live trending list
- *     and emits `actionButtons` so the user picks one. A click submits a new
- *     prompt like `"buy PEPE"` which routes back here for the standard flow.
- *
- *  1. **Pay-token picker** — the user named the dest token only (`token_symbol`)
- *     but not the pay token. The tool fetches the wallet's native + ERC-20
- *     holdings and emits `actionButtons` so the user picks the pay token.
- *
- *  1.4 **Balance check** — the user named a pay token (amount optional). Runs
- *     first so we never proceed with a token the user can't fund: if the wallet
- *     holds NONE of it, the tool reports that and offers the tokens the user
- *     DOES hold as alternatives (pay-token picker); if it holds SOME but less
- *     than the requested amount, it reports the shortfall and emits
- *     25/50/75/100% buttons sized off the real balance. Skipped for the native
- *     pay token and when balances can't be read.
- *
- *  1.5 **Amount picker** — dest + pay token are known but no amount was given.
- *     The tool reads the pay-token balance and emits 25/50/75/100% buttons so
- *     the user sizes the spend in one tap (or types a custom amount).
- *
- *  1.75 **Confirm tx** — dest + pay token + a PAY-TOKEN amount are all known.
- *     The tool fetches a swap quote (estimated receive amount + the raw swap
- *     tx), checks allowance, and emits a `BuyTokenConfirmTx` payload bundling
- *     the estimate, the raw swap transaction, and the approve transaction (when
- *     one is needed). The FE executes approve (if any) then swap itself.
- *
- *  When none of the above produces a result (couldn't resolve the dest token,
- *  quote failed, amount given only on the buy side, …) the tool returns an
- *  error/_instructions object — it never opens a generic form.
- *
- * Amount disambiguation mirrors the chatbot SDK:
- *   - "buy PEPE with 10 USDC"  → pay_with_amount = "10"
- *   - "buy 0.02 PCM with USDC" → buy_amount = "0.02"
- */
-export declare class BuyTokenTool extends BaseTool {
-    name: string;
-    kind: ToolKind;
-    category: string;
-    noSuggestions: boolean;
-    private readonly moralis?;
-    /** Trending tokens come from Pantograph (top-gainers), not Moralis. */
-    private readonly pantograph?;
-    /** Branch-tracing on/off — shares AgentCore's `debug` flag (passed in). */
-    private readonly debug;
-    constructor(config?: MoralisServiceConfig, options?: {
-        debug?: boolean;
-    });
-    /**
-     * Branch-tracing logger. Prints which branch the tool takes and the key
-     * values feeding that decision. Enabled by AgentCore's shared `debug` flag
-     * (so one switch covers the LLM trace and this tool). Kept terse.
-     */
-    private dbg;
-    description: string;
-    parameters: ToolParameter[];
-    execute(args: Record<string, unknown>, userContext?: UserContext): Promise<ToolResult>;
-    protected run(args: Record<string, unknown>, userContext?: UserContext): Promise<{
-        actionButtons: {
-            label: string;
-            prompt: string;
-        }[];
-        _instructions: string;
-    } | {
-        ui: UIPayload;
-        _instructions: string;
-    } | {
-        error: string;
-        _instructions: string;
-    }>;
-    private buildResult;
-    private normaliseAddress;
-    private normaliseAmount;
-    private requireChain;
-    /**
-     * Resolve a token reference (symbol "USDC" or address "0x…") on a chain.
-     * Wallet balances first (most reliable), then Pantograph search. Decimals come
-     * from the API — never from the LLM.
-     */
-    private resolveContractAddress;
-    /**
-     * Resolve one side of the buy (dest or pay). Honours the `"native"` sentinel
-     * the swap providers expect. Never errors — a side that can't be resolved
-     * just comes back with `address: null`.
-     */
-    private resolveSide;
-    /**
-     * Pay token + dest token + a pay-token amount are known. Fetch a swap quote
-     * (estimated receive amount + raw swap tx), check approval, and return a
-     * `BuyTokenConfirmTx` UI payload the FE executes itself. Returns `null` when
-     * anything we need can't be produced (bad chain, quote failed, non-EVM tx).
-     */
-    private buildConfirmTx;
-    /**
-     * deBridge only quotes EXACT_INPUT, so a "buy X of the dest token" request has
-     * no input amount to seed the quote. Convert the desired output into a pay-token
-     * amount using each side's live USD price:
-     *
-     *   payAmount ≈ (buyAmount × destPriceUsd) / payPriceUsd × (1 + buffer)
-     *
-     * The +2% buffer covers slippage + fees so the user receives AT LEAST roughly
-     * the requested amount (the confirm panel still shows the REAL estimate from
-     * the quote, not this derived figure). Returns `null` when either token's USD
-     * price can't be fetched — the caller then asks for a pay amount instead.
-     */
-    private derivePayAmountFromBuy;
-    /**
-     * Best-effort live USD price for one side of the swap, sourced from
-     * Pantograph (via `MoralisService.getTokenMetadata`, which queries Pantograph
-     * first). The native coin (`'native'`) is looked up with the zero address —
-     * the Pantograph token endpoint returns the native row for it. Returns `null`
-     * when no positive price is available so the caller can degrade gracefully.
-     */
-    private getUsdPrice;
-    /**
-     * Resolve the PAY-side amount, which may be plain ("10"), a PERCENT of the
-     * held pay-token balance ("50%"), or a USD value ("5$"). Percent reads the
-     * wallet's pay-token balance; usd divides by the pay token's USD price. Returns
-     * a plain token amount string, or `null` when nothing usable was given / the
-     * balance or price needed for a percent/usd couldn't be fetched (the caller's
-     * existing "needs amount" / amount-picker branches then take over).
-     */
-    private resolvePayAmountSpec;
-    /**
-     * Resolve the BUY-side amount, which may be plain ("5") or a USD value ("5$",
-     * "buy $5 of PEPE"). USD divides by the DEST token's price to get how many
-     * dest tokens "$X worth" is — that token figure then flows through Branch 1.3
-     * to derive the pay amount. A PERCENT on the buy side is meaningless (percent
-     * of what?), so it's ignored (returns null). Returns a plain token amount
-     * string or `null`.
-     */
-    private resolveBuyAmountSpec;
-    /**
-     * Check whether the pay token needs an allowance for this swap and, if so,
-     * return a ready-to-sign ERC-20 approve tx. Relay bundles the approve step in
-     * the quote (`approvalData` is the tx); deBridge only reports the spender
-     * (`tx.to`), so we encode the approve calldata ourselves.
-     */
-    private buildApproveTx;
-    /** Human amount → smallest-unit decimal string (no float drift via BigInt). */
-    private toRawAmount;
-    /**
-     * Pull a human-readable failure reason out of a failed quote. Adapters set
-     * `errorMessage` (string) and `error` (string or a provider object). deBridge
-     * also nests a reason in `raw.errorMessage` / `raw.error`. Falls back to a
-     * generic line so the caller always has something to show.
-     */
-    private extractQuoteError;
-    /**
-     * Estimated receive amount in the dest token's smallest units. Shape differs
-     * per provider — deBridge same-chain: `raw.tokenOut.minAmount`; deBridge
-     * cross-chain: `raw.estimation.dstChainTokenOut.amount`; Relay:
-     * `raw.details.currencyOut.{amount|minimumAmount}`.
-     */
-    private extractOutRaw;
-    private buildPayWithPicker;
-    /**
-     * Guard the buy flow against a pay token the user can't fund. Returns:
-     *   - `null` when the user holds enough (or no amount yet, or balances can't be read).
-     *   - `no_pay_balance` (+ picker buttons) when the wallet holds none of it.
-     *   - `insufficient_pay_balance` (+ percentage buttons) when it holds some but
-     *     less than the requested amount.
-     */
-    private checkPayBalance;
-    /**
-     * Read the connected wallet's balance of the pay token. Returns the held
-     * amount + on-chain symbol, or `null` when balances can't be fetched / the
-     * token isn't held (zero balance or not held at all).
-     *
-     * For the NATIVE pay coin the returned balance is the SPENDABLE figure — the
-     * held balance minus a silently-estimated swap gas reserve (gasLimit
-     * 1_000_000 × gasPrice) — so the percent buttons, amount picker, and balance
-     * check stay within what the user can actually spend while still covering gas.
-     * The reserve is never surfaced; callers only ever expose the spendable
-     * number. ERC-20 pay tokens are returned at their raw held balance (gas is
-     * paid in the native coin, not the pay token).
-     */
-    private readPayBalance;
-    /**
-     * 25/50/75/100% quick-spend buttons sized off a held balance. 100% spends the
-     * EXACT held string; the partial fractions are float-trimmed. The amount rides
-     * in the prompt; the label is a bare percent.
-     */
-    private percentSpendButtons;
-    private buildAmountPicker;
-    /**
-     * Trim IEEE-754 noise from a computed amount (≤8 significant digits) and
-     * ALWAYS return plain decimal notation — never exponential ("1.5e-7").
-     */
-    private trimAmount;
-    /** Format a number as a plain decimal string, expanding any e-notation. */
-    private toPlainDecimal;
-    /**
-     * Sanitize an amount STRING from an external source (e.g. Moralis
-     * `balance_formatted`): expand e-notation to plain decimal; else pass through.
-     */
-    private cleanAmountString;
-    /**
-     * Build the trending-picker click-prompt ("buy {token}") from the
-     * LLM-supplied, already-localized template. The click-prompt is re-submitted
-     * as a fresh user turn, so keeping it in the user's language keeps that turn
-     * in the same language. Falls back to English when the LLM omits a template.
-     */
-    private buildBuyPrompt;
-    /**
-     * Build the "buy X with Y" click-prompt from the LLM-supplied, already-
-     * localized template by substituting placeholders:
-     *   {token} → token bought    {pay} → payment token
-     *   {buy_amount} → quantity bought (next to {token})
-     *   {pay_amount} → quantity paid  (next to {pay})
-     * The localized verb and "with" preposition live INSIDE the template, so we
-     * only substitute concrete values. Only one side ever carries an amount; the
-     * unused amount placeholder is replaced with '' (no preposition is attached
-     * to it, so nothing dangles). Falls back to an English template when the LLM
-     * omits one.
-     */
-    private buildBuyWithPrompt;
-    private buildTrendingPicker;
-    /**
-     * Format a 24h price-change percentage: ~6 significant digits, no trailing
-     * noise, and always plain decimal (never exponential for a tiny change).
-     */
-    private formatPercent;
-    /** Compact price string: e.g. 0.00001234 → "0.00001234", 1234.5 → "1,234.50". */
-    private formatPrice;
-}
-//# sourceMappingURL=BuyTokenTool.d.ts.map

package/dist/tools/builtin/wallet-action/BuyTokenTool.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"BuyTokenTool.d.ts","sourceRoot":"","sources":["../../../../src/tools/builtin/wallet-action/BuyTokenTool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,OAAO,EAAkB,KAAK,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAI7F,OAAO,KAAK,EAGV,QAAQ,EACR,aAAa,EACb,UAAU,EACV,SAAS,EAET,WAAW,EACZ,MAAM,gBAAgB,CAAC;AAcxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,qBAAa,YAAa,SAAQ,QAAQ;IACxC,IAAI,SAAyB;IAC7B,IAAI,EAAE,QAAQ,CAAY;IAC1B,QAAQ,SAAmB;IAE3B,aAAa,UAAQ;IAErB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAiB;IAC1C,uEAAuE;IACvE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAoB;IAChD,2EAA2E;IAC3E,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAU;gBAEpB,MAAM,CAAC,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE;IASxE;;;;OAIG;IACH,OAAO,CAAC,GAAG;IAOX,WAAW,SAQ0F;IAErG,UAAU,EAAE,aAAa,EAAE,CA4FzB;IAKI,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;cAkC5E,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,EAAE,WAAW;uBAmoCvD;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,EAAE;uBAAiB,MAAM;;YArwB7D,SAAS;uBAAiB,MAAM;;;;;YA3VpC,WAAW;IA0NzB,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,eAAe;IASvB,OAAO,CAAC,YAAY;IAMpB;;;;OAIG;YACW,sBAAsB;IA2CpC;;;;OAIG;YACW,WAAW;IAuCzB;;;;;OAKG;YACW,cAAc;IA0H5B;;;;;;;;;;;OAWG;YACW,sBAAsB;IA4BpC;;;;;;OAMG;YACW,WAAW;IAWzB;;;;;;;OAOG;YACW,oBAAoB;IAgClC;;;;;;;OAOG;YACW,oBAAoB;IAmBlC;;;;;OAKG;YACW,cAAc;IA0C5B,+EAA+E;IAC/E,OAAO,CAAC,WAAW;IAanB;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAuBzB;;;;;OAKG;IACH,OAAO,CAAC,aAAa;YAmBP,kBAAkB;IAyFhC;;;;;;OAMG;YACW,eAAe;IAoG7B;;;;;;;;;;;;OAYG;YACW,cAAc;IAsD5B;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;YAwBb,iBAAiB;IA+B/B;;;OAGG;IACH,OAAO,CAAC,UAAU;IAKlB,2EAA2E;IAC3E,OAAO,CAAC,cAAc;IAwBtB;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAMzB;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IAQtB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,kBAAkB;YAuBZ,mBAAmB;IA6DjC;;;OAGG;IACH,OAAO,CAAC,aAAa;IAKrB,iFAAiF;IACjF,OAAO,CAAC,WAAW;CAOpB"}