@w3lib/evm-batch-call 0.5.0 → 0.7.0

package/src/subpaths/fees.ts

@@ -0,0 +1,43 @@
+/**
+ * 手续费估算（子路径 `@w3lib/evm-batch-call/fees`）：EIP-1559 的三档费用建议、一笔交易的手续费（含 L1 数据费），
+ * Tron 按能量 / 带宽和账户剩余的资源算要烧的 TRX。不放在主入口，不用时打包不会带上这部分代码。
+ *
+ * ```ts
+ * import { getCostEstimate, getFeeEstimate } from '@w3lib/evm-batch-call/fees'
+ *
+ * await getFeeEstimate({ chainId: 1 })
+ * await getCostEstimate({ from: user, to: USDT, data }, { chainId: 728126428 })
+ * ```
+ */
+import { estimateCost, estimateFees, type CostCall, type CostEstimate, type EstimateCostOptions, type EstimateFeesOptions, type FeeEstimate } from '../fees.js'
+import { resolve, type ShortcutProviderOptions } from '../shortcuts.js'
+
+export {
+  estimateCost,
+  estimateFees,
+  type CostCall,
+  type CostEstimate,
+  type EstimateCostOptions,
+  type EstimateFeesOptions,
+  type EvmCostEstimate,
+  type FeeEstimate,
+  type FeeLevel,
+  type FeeLevelEstimate,
+  type TronCost,
+} from '../fees.js'
+
+export interface GetFeeEstimateOptions extends EstimateFeesOptions, ShortcutProviderOptions {}
+
+/** 当前的三档手续费建议（EVM 链），节点参数与 getBalances 相同 */
+export function getFeeEstimate(options: GetFeeEstimateOptions = {}): Promise<FeeEstimate> {
+  const { provider, own } = resolve(options, ['blocks', 'percentiles', 'baseFeeMultiplier'])
+  return estimateFees(provider, own)
+}
+
+export interface GetCostEstimateOptions extends EstimateCostOptions, ShortcutProviderOptions {}
+
+/** 一笔交易的手续费（EVM：gas × 价格 + L1 数据费；Tron：要烧的 TRX） */
+export function getCostEstimate(call: CostCall, options: GetCostEstimateOptions = {}): Promise<CostEstimate> {
+  const { provider, own } = resolve(options, ['blocks', 'percentiles', 'baseFeeMultiplier', 'level', 'fees'])
+  return estimateCost(provider, call, own)
+}

package/src/subpaths/liquidity.ts

@@ -0,0 +1,52 @@
+/**
+ * 添加 / 移除流动性（子路径 `@w3lib/evm-batch-call/liquidity`）：V2（Router）、V3（仓位 NFT）、Uniswap V4（PositionManager + Permit2），
+ * 包括 Tron 上的 SunSwap V2 / V3。不放在主入口，不用时打包不会带上这部分代码。
+ *
+ * - build*：只读取、不签名，返回预计的数量和要按顺序发送的交易（授权在前），可以当作报价，也可以交给钱包自己发送
+ * - addLiquidity / removeLiquidity / collectFees：构建后用私钥 / ethers Signer / 浏览器钱包签名发送（同 /write 的 batchCall）
+ *
+ * ```ts
+ * import { getLpPositions } from '@w3lib/evm-batch-call/lp'
+ * import { addLiquidity, buildAddLiquidity, removeLiquidity } from '@w3lib/evm-batch-call/liquidity'
+ *
+ * const plan = await buildAddLiquidity(multi, owner, { protocol: 'pancakeswap-v3', tokenA: WBNB, tokenB: USDT, fee: 500, priceLower: 550, priceUpper: 650, amountAFormatted: '1' })
+ * await addLiquidity(multi, privateKey, { protocol: 'pancakeswap-v2', tokenA: NATIVE_TOKEN, tokenB: USDT, amountAFormatted: '0.1' })
+ * const [position] = await getLpPositions(owner, { chainId: 56 })
+ * await removeLiquidity(multi, privateKey, { position, percent: 50 })
+ * ```
+ */
+export {
+  addLiquidity,
+  buildAddLiquidity,
+  buildCollectFees,
+  buildRemoveLiquidity,
+  collectFees,
+  removeLiquidity,
+} from '../liquidity/index.js'
+export { PERMIT2_ADDRESS } from '../liquidity/common.js'
+export type {
+  AddLiquidityParams,
+  CollectFeesParams,
+  IncreaseLiquidityParams,
+  LiquidityOptions,
+  LiquidityPlan,
+  LiquidityResult,
+  LiquiditySendOptions,
+  LiquidityTx,
+  LiquidityTxResult,
+  NewPositionParams,
+  PositionRef,
+  RemoveLiquidityParams,
+} from '../liquidity/types.js'
+export {
+  getLiquidityForAmounts,
+  getMaxAmounts,
+  getMinAmounts,
+  getMintAmounts,
+  getTickAtSqrtRatio,
+  nearestUsableTick,
+  priceToSqrtPriceX96,
+  priceToTick,
+} from '../lpMath.js'
+export type { LpPosition, LpProtocol, LpToken } from '../lp.js'
+export type { SignerInput, WriteResult, WriteStatus } from '../subpaths/write.js'

package/src/subpaths/lp.ts

@@ -35,7 +35,26 @@ export {
   type V4ScanOptions,
   type V4ScanProgress,
 } from '../lpV4.js'
-export { MAX_TICK, MIN_TICK, getAmountsForLiquidity, getFeeGrowthInside, getFeesEarned, getSqrtRatioAtTick, sqrtPriceToPrice, tickToPrice } from '../lpMath.js'
+export {
+  MAX_SQRT_RATIO,
+  MAX_TICK,
+  MIN_SQRT_RATIO,
+  MIN_TICK,
+  getAmountsForLiquidity,
+  getFeeGrowthInside,
+  getFeesEarned,
+  getLiquidityForAmounts,
+  getMaxAmounts,
+  getMinAmounts,
+  getMintAmounts,
+  getSqrtRatioAtTick,
+  getTickAtSqrtRatio,
+  nearestUsableTick,
+  priceToSqrtPriceX96,
+  priceToTick,
+  sqrtPriceToPrice,
+  tickToPrice,
+} from '../lpMath.js'
 export { defillamaPrices, type PriceSource } from '../owner.js'
 
 export interface GetLpPositionsOptions extends LpPositionsOptions, ShortcutProviderOptions {}

package/src/subpaths/names.ts

@@ -0,0 +1,43 @@
+/**
+ * 域名解析（子路径 `@w3lib/evm-batch-call/names`）：ENS、SPACE ID（.bnb）、Basenames（.base.eth），名字 → 地址、地址 → 名字。
+ * 不放在主入口，不用时打包不会带上这部分代码。
+ *
+ * ```ts
+ * import { getAddressNames, getNameAddresses } from '@w3lib/evm-batch-call/names'
+ *
+ * await getNameAddresses(['vitalik.eth'], { chainId: 1 })
+ * await getAddressNames([user], { chainId: 56 })
+ * ```
+ */
+import { lookupAddresses, resolveNames, type AddressName, type NamesOptions, type ResolvedName } from '../names.js'
+import { resolve, type ShortcutProviderOptions } from '../shortcuts.js'
+
+export { NAME_SERVICES, lookupAddresses, resolveNames, type AddressName, type NameService, type NamesOptions, type ResolvedName } from '../names.js'
+
+export interface GetNamesOptions extends NamesOptions, ShortcutProviderOptions {}
+
+/**
+ * 名字 → 地址，节点参数与 getBalances 相同（用这条链的域名服务：Ethereum 是 ENS，BSC 是 SPACE ID，Base 是 Basenames）。
+ *
+ * ```ts
+ * await getNameAddresses(['vitalik.eth', 'nick.eth'], { chainId: 1 })
+ * // [{ name: 'vitalik.eth', normalized: 'vitalik.eth', address: '0xd8dA…6045', service: 'ens' }, …]
+ * ```
+ */
+export function getNameAddresses(names: readonly string[], options: GetNamesOptions = {}): Promise<ResolvedName[]> {
+  const { provider, own } = resolve(options, ['services'])
+  return resolveNames(provider, names, own)
+}
+
+/**
+ * 地址 → 名字（反查的主名字，正查核对过）。
+ *
+ * ```ts
+ * await getAddressNames(['0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'], { chainId: 1 })
+ * // [{ address: '0xd8dA…', name: 'vitalik.eth', service: 'ens' }]
+ * ```
+ */
+export function getAddressNames(addresses: readonly string[], options: GetNamesOptions = {}): Promise<AddressName[]> {
+  const { provider, own } = resolve(options, ['services'])
+  return lookupAddresses(provider, addresses, own)
+}

package/src/subpaths/price.ts

@@ -0,0 +1,60 @@
+/**
+ * 价格（子路径 `@w3lib/evm-batch-call/price`）：代币的美元价格（DefiLlama 当前 / 历史价格，没有收录的从链上 V2 / V3 池子算）、
+ * 组合价格源、地址的资产总值。不放在主入口，不用时打包不会带上这部分代码。
+ *
+ * ```ts
+ * import { getTokenPrices, getPortfolio } from '@w3lib/evm-batch-call/price'
+ *
+ * await getTokenPrices([NATIVE_TOKEN, USDT, newToken], { chainId: 56 })
+ * await getPortfolio(user, { chainId: 56, tokens: [NATIVE_TOKEN, USDT], lp: true })
+ * ```
+ */
+import { portfolio, type Portfolio, type PortfolioOptions } from '../portfolio.js'
+import { tokenPrices, type TokenPrice, type TokenPricesOptions } from '../price.js'
+import { resolve, type ShortcutProviderOptions } from '../shortcuts.js'
+
+export { portfolio, type Portfolio, type PortfolioOptions, type PortfolioToken } from '../portfolio.js'
+export {
+  DEFILLAMA_CHAINS,
+  STABLECOINS,
+  combinePrices,
+  defillamaPrices,
+  onchainPrices,
+  priceKeyOf,
+  tokenPrices,
+  type DefillamaPriceOptions,
+  type OnchainPriceOptions,
+  type PriceSource,
+  type PriceSourceContext,
+  type TokenPrice,
+  type TokenPricesOptions,
+} from '../price.js'
+
+export interface GetTokenPricesOptions extends TokenPricesOptions, ShortcutProviderOptions {}
+
+/**
+ * 查代币的美元价格（主币用 NATIVE_TOKEN），节点参数与 getBalances 相同。
+ *
+ * ```ts
+ * await getTokenPrices([NATIVE_TOKEN, USDT], { chainId: 56 })
+ * // [{ token: '0xEeee…', native: true, price: 612.3, source: 'defillama' }, { token: USDT, …, price: 1, source: 'defillama' }]
+ * ```
+ */
+export function getTokenPrices(tokens: readonly string[], options: GetTokenPricesOptions = {}): Promise<TokenPrice[]> {
+  const { provider, own } = resolve(options, ['sources', 'onError', 'fetch'])
+  return tokenPrices(provider, tokens, own)
+}
+
+export interface GetPortfolioOptions extends PortfolioOptions, ShortcutProviderOptions {}
+
+/**
+ * 地址的资产总值：传入代币的余额 × 价格，可选加上 LP 仓位（lp: true）。
+ *
+ * ```ts
+ * const p = await getPortfolio(user, { chainId: 56, tokens: [NATIVE_TOKEN, USDT, CAKE], lp: true })
+ * ```
+ */
+export function getPortfolio(owner: string, options: GetPortfolioOptions): Promise<Portfolio> {
+  const { provider, own } = resolve(options, ['tokens', 'sources', 'lp', 'minUsd', 'onPriceError', 'fetch'])
+  return portfolio(provider, owner, own as PortfolioOptions)
+}

package/src/subpaths/risk.ts

@@ -0,0 +1,23 @@
+/**
+ * 代币风险检查（子路径 `@w3lib/evm-batch-call/risk`）：模拟买入 / 转账 / 卖出，算出买卖税、判断貔貅盘，看是不是可升级代理、owner 有没有放弃。
+ * 不放在主入口，不用时打包不会带上这部分代码（含约 2.7KB 的探测合约字节码）。
+ *
+ * ```ts
+ * import { getTokenRisks } from '@w3lib/evm-batch-call/risk'
+ *
+ * const [risk] = await getTokenRisks([token], { chainId: 56 })
+ * if (risk.honeypot) alert('卖不出')
+ * ```
+ */
+import { tokenRisks, type TokenRisk, type TokenRiskOptions } from '../risk.js'
+import { resolve, type ShortcutProviderOptions } from '../shortcuts.js'
+
+export { tokenRisks, type ProbeStage, type TokenRisk, type TokenRiskOptions } from '../risk.js'
+
+export interface GetTokenRisksOptions extends TokenRiskOptions, ShortcutProviderOptions {}
+
+/** 检查代币的风险，节点参数与 getBalances 相同 */
+export function getTokenRisks(tokens: readonly string[], options: GetTokenRisksOptions = {}): Promise<TokenRisk[]> {
+  const { provider, own } = resolve(options, ['amount', 'protocols'])
+  return tokenRisks(provider, tokens, own)
+}

package/src/subpaths/swap.ts

@@ -0,0 +1,36 @@
+/**
+ * 兑换（子路径 `@w3lib/evm-batch-call/swap`）：在内置协议的 V2 / V3 池子里找最好的路线（直接或两跳），报价并构建 / 发送兑换交易。
+ * 不放在主入口，不用时打包不会带上这部分代码；发送的代码按需加载。
+ *
+ * ```ts
+ * import { getSwapQuote, swap } from '@w3lib/evm-batch-call/swap'
+ *
+ * const plan = await getSwapQuote(user, { tokenIn: NATIVE_TOKEN, tokenOut: USDT, amountInFormatted: '0.1' }, { chainId: 56 })
+ * await swap(provider, key, { tokenIn: NATIVE_TOKEN, tokenOut: USDT, amountInFormatted: '0.1' })
+ * ```
+ */
+import { buildSwap, type SwapOptions, type SwapParams, type SwapPlan } from '../swap.js'
+import { resolve, type ShortcutProviderOptions } from '../shortcuts.js'
+
+export {
+  V3_SWAP_CONTRACTS,
+  buildSwap,
+  swap,
+  swapProtocols,
+  type SwapOptions,
+  type SwapParams,
+  type SwapPlan,
+  type SwapResult,
+  type SwapRoute,
+  type SwapSendOptions,
+  type SwapTx,
+  type SwapTxResult,
+} from '../swap.js'
+
+export interface GetSwapQuoteOptions extends SwapOptions, ShortcutProviderOptions {}
+
+/** 报价并构建兑换的交易（同 buildSwap），节点参数与 getBalances 相同 */
+export function getSwapQuote(owner: string, params: SwapParams, options: GetSwapQuoteOptions = {}): Promise<SwapPlan> {
+  const { provider, overrides, own } = resolve(options, ['slippage', 'deadline', 'recipient', 'approve', 'protocols', 'intermediates', 'route'])
+  return buildSwap(provider, owner, params, { ...own, ...(overrides.blockTag === undefined ? {} : { blockTag: overrides.blockTag }) })
+}