@gearbox-protocol/sdk 14.12.0-next.80 → 14.12.0-next.82

package/dist/types/sdk/opportunities/MultichainOpportunitiesService.d.ts

@@ -1,40 +1,37 @@
-import { MultichainResult } from "../types/multichain.js";
 import { PluginsMap } from "../plugins/types.js";
 import "../plugins/index.js";
 import { Opportunity, OpportunityFilter, PoolOpportunityDetail, PoolOpportunityKey, StrategyOpportunityDetail, StrategyOpportunityKey } from "../../model/opportunities.js";
+import { DataResponse } from "../../model/response.js";
 import "../../model/index.js";
-import "../types/index.js";
 import { MultichainConstruct } from "../base/MultichainConstruct.js";
 import "../base/index.js";
 //#region src/sdk/opportunities/MultichainOpportunitiesService.d.ts
 /**
- * Cross-chain counterpart of {@link OpportunitiesService}.
- *
- * Fans out over every chain configured in {@link MultichainSDK}. A chain that
- * fails is logged and skipped so one dead RPC does not empty the list; its
- * failure is reported in {@link MultichainResult.meta}.
- *
- * Detail reads need no fan-out: an opportunity key names its chain.
+ * Cross-chain counterpart of {@link OpportunitiesService}. Every read walks
+ * loaded market state, so the block it reports is the SDK's snapshot.
  *
  * @typeParam Plugins - Map of attached plugin types.
  **/
 declare class MultichainOpportunitiesService<const Plugins extends PluginsMap = {}> extends MultichainConstruct<Plugins> {
-  #private;
   /**
    * Opportunities of all queried chains, see {@link OpportunitiesService.list}.
-   *
-   * A filter that names chains narrows the fan-out itself, so chains whose rows
-   * would be discarded are never queried and never appear in the meta.
+   * A filter that names chains narrows the fan-out itself, so a chain whose
+   * rows would be discarded is never queried and never appears in the meta.
    **/
-  list(filter?: OpportunityFilter): Promise<MultichainResult<Opportunity[]>>;
+  list(filter?: OpportunityFilter): Promise<DataResponse<Opportunity[]>>;
   /**
    * {@inheritDoc OpportunitiesService.getPool}
+   *
+   * The key names its chain, so there is no fan-out. Throws when that chain
+   * cannot answer.
    **/
-  getPool(key: PoolOpportunityKey): Promise<PoolOpportunityDetail>;
+  getPool(key: PoolOpportunityKey): Promise<DataResponse<PoolOpportunityDetail>>;
   /**
    * {@inheritDoc OpportunitiesService.getStrategy}
+   *
+   * See {@link MultichainOpportunitiesService.getPool}.
    **/
-  getStrategy(key: StrategyOpportunityKey): Promise<StrategyOpportunityDetail>;
+  getStrategy(key: StrategyOpportunityKey): Promise<DataResponse<StrategyOpportunityDetail>>;
 }
 //#endregion
 export { MultichainOpportunitiesService };

package/dist/types/sdk/pools/types.d.ts

@@ -100,6 +100,10 @@ interface ListPoolPositionsProps {
    * Wallet whose pool shares to describe.
    **/
   wallet: Address;
+  /**
+   * Block to read at. Defaults to the latest block.
+   **/
+  blockNumber?: bigint;
 }
 /**
  * Service interface for pool liquidity operations.

package/dist/types/sdk/positions/MultichainPositionsService.d.ts

@@ -1,33 +1,23 @@
-import { MultichainResult } from "../types/multichain.js";
 import { PluginsMap } from "../plugins/types.js";
 import "../plugins/index.js";
 import { Position } from "../../model/positions.js";
+import { DataResponse } from "../../model/response.js";
 import "../../model/index.js";
 import { ListPositionsProps } from "./types.js";
-import "../types/index.js";
 import { MultichainConstruct } from "../base/MultichainConstruct.js";
 import "../base/index.js";
 //#region src/sdk/positions/MultichainPositionsService.d.ts
 /**
  * Cross-chain counterpart of {@link PositionsService}.
  *
- * Fans out over every chain configured in {@link MultichainSDK}. A chain that
- * fails is logged and skipped so one dead RPC does not hide the positions a
- * wallet holds elsewhere; its failure is reported in
- * {@link MultichainResult.meta}.
- *
  * @typeParam Plugins - Map of attached plugin types.
  **/
 declare class MultichainPositionsService<const Plugins extends PluginsMap = {}> extends MultichainConstruct<Plugins> {
-  #private;
   /**
    * Positions of a wallet on all queried chains, see
    * {@link PositionsService.list}.
-   *
-   * A filter that names chains narrows the fan-out itself, so chains whose rows
-   * would be discarded are never queried and never appear in the meta.
    **/
-  list(props: ListPositionsProps): Promise<MultichainResult<Position[]>>;
+  list(props: ListPositionsProps<true>): Promise<DataResponse<Position[]>>;
 }
 //#endregion
 export { MultichainPositionsService };

package/dist/types/sdk/positions/index.d.ts

@@ -1,4 +1,4 @@
-import { ListPositionsProps } from "./types.js";
+import { ListPositionsProps, ListPositionsPropsBase } from "./types.js";
 import { MultichainPositionsService } from "./MultichainPositionsService.js";
 import { PositionsService } from "./PositionsService.js";
-export { ListPositionsProps, MultichainPositionsService, PositionsService };
+export { ListPositionsProps, ListPositionsPropsBase, MultichainPositionsService, PositionsService };

package/dist/types/sdk/positions/types.d.ts

@@ -1,15 +1,16 @@
+import { WithBlock } from "../types/multichain.js";
 import { PositionFilter } from "../../model/positions.js";
 import "../../model/index.js";
+import "../types/index.js";
 import { Address } from "viem";
 //#region src/sdk/positions/types.d.ts
 /**
- * Props for {@link PositionsService.list}.
+ * Chain-independent part of {@link ListPositionsProps}.
  *
  * Chain scoping is expressed by {@link PositionFilter.chainIds} rather than by
- * the `networks` prop of the other multichain services, so the props are the
- * same on both, see {@link MultichainPositionsService.list}.
+ * the `networks` prop of the other multichain services.
  **/
-interface ListPositionsProps {
+interface ListPositionsPropsBase {
   /**
    * Wallet whose positions to list. Every kind of position belongs to a wallet:
    * pool shares and credit accounts to their holder, delayed withdrawals to the
@@ -21,5 +22,13 @@ interface ListPositionsProps {
    **/
   filter?: PositionFilter;
 }
+/**
+ * Props for {@link PositionsService.list}.
+ *
+ * {@link BlockNumberProps.blockNumber} is only on the single-chain form: a
+ * height is not shared across the networks of the fan-out, see
+ * {@link MultichainPositionsService.list}.
+ **/
+type ListPositionsProps<Multichain extends boolean = false> = ListPositionsPropsBase & WithBlock<Multichain>;
 //#endregion
-export { ListPositionsProps };
+export { ListPositionsProps, ListPositionsPropsBase };

package/dist/types/sdk/types/index.d.ts

@@ -1,6 +1,6 @@
 import { ILogger, LogFn } from "./logger.js";
-import { MultichainNetworkMeta, MultichainNetworkProps, MultichainNetworksProps, MultichainResult, WithMultichain } from "./multichain.js";
+import { BlockNumberProps, MultichainChainIdsProps, MultichainNetworkProps, WithBlock, WithMultichain } from "./multichain.js";
 import { AddressProviderV3StateHuman, AliasLossPolicyStateHuman, AssetPriceFeedStateHuman, BalancerWeightedPriceFeedStateHuman, BaseContractStateHuman, BasePriceFeedStateHuman, BotListStateHuman, BoundedOracleStateHuman, ConstantOracleStateHuman, CoreStateHuman, CreditConfiguratorStateHuman, CreditFacadeStateHuman, CreditManagerDebtParamsHuman, CreditManagerStateHuman, CreditSuiteStateHuman, GaugeParamsHuman, GaugeStateHuman, GearStakingV3StateHuman, GearboxStateHuman, InterestRateModelStateHuman, LPPriceFeedStateHuman, LinearInterestRateModelStateHuman, LossPolicyStateHuman, MarketStateHuman, MultichainStateHuman, PoolQuotaKeeperStateHuman, PoolStateHuman, PoolSuiteStateHuman, PriceFeedStateHuman, PriceOracleStateHuman, QuotaParamsHuman, RateKeeperStateHuman, RedstonePriceFeedStateHuman, TumblerStateHuman, ZapperStateHuman } from "./state-human.js";
 import { ContractMethod, IPriceUpdateTx, MultiCall, RawTx } from "./transactions.js";
 import { GearboxState, MultichainState } from "./state.js";
-export type { AddressProviderV3StateHuman, AliasLossPolicyStateHuman, AssetPriceFeedStateHuman, BalancerWeightedPriceFeedStateHuman, BaseContractStateHuman, BasePriceFeedStateHuman, BotListStateHuman, BoundedOracleStateHuman, ConstantOracleStateHuman, ContractMethod, CoreStateHuman, CreditConfiguratorStateHuman, CreditFacadeStateHuman, CreditManagerDebtParamsHuman, CreditManagerStateHuman, CreditSuiteStateHuman, GaugeParamsHuman, GaugeStateHuman, GearStakingV3StateHuman, GearboxState, GearboxStateHuman, ILogger, IPriceUpdateTx, InterestRateModelStateHuman, LPPriceFeedStateHuman, LinearInterestRateModelStateHuman, LogFn, LossPolicyStateHuman, MarketStateHuman, MultiCall, MultichainNetworkMeta, MultichainNetworkProps, MultichainNetworksProps, MultichainResult, MultichainState, MultichainStateHuman, PoolQuotaKeeperStateHuman, PoolStateHuman, PoolSuiteStateHuman, PriceFeedStateHuman, PriceOracleStateHuman, QuotaParamsHuman, RateKeeperStateHuman, RawTx, RedstonePriceFeedStateHuman, TumblerStateHuman, WithMultichain, ZapperStateHuman };
+export type { AddressProviderV3StateHuman, AliasLossPolicyStateHuman, AssetPriceFeedStateHuman, BalancerWeightedPriceFeedStateHuman, BaseContractStateHuman, BasePriceFeedStateHuman, BlockNumberProps, BotListStateHuman, BoundedOracleStateHuman, ConstantOracleStateHuman, ContractMethod, CoreStateHuman, CreditConfiguratorStateHuman, CreditFacadeStateHuman, CreditManagerDebtParamsHuman, CreditManagerStateHuman, CreditSuiteStateHuman, GaugeParamsHuman, GaugeStateHuman, GearStakingV3StateHuman, GearboxState, GearboxStateHuman, ILogger, IPriceUpdateTx, InterestRateModelStateHuman, LPPriceFeedStateHuman, LinearInterestRateModelStateHuman, LogFn, LossPolicyStateHuman, MarketStateHuman, MultiCall, MultichainChainIdsProps, MultichainNetworkProps, MultichainState, MultichainStateHuman, PoolQuotaKeeperStateHuman, PoolStateHuman, PoolSuiteStateHuman, PriceFeedStateHuman, PriceOracleStateHuman, QuotaParamsHuman, RateKeeperStateHuman, RawTx, RedstonePriceFeedStateHuman, TumblerStateHuman, WithBlock, WithMultichain, ZapperStateHuman };

package/dist/types/sdk/types/multichain.d.ts

@@ -1,3 +1,4 @@
+import { ChainId } from "../../model/primitives.js";
 import { NetworkType } from "../chain/chains.js";
 //#region src/sdk/types/multichain.d.ts
 /**
@@ -12,54 +13,33 @@ interface MultichainNetworkProps {
 /**
  * Restricts which chains a multichain list method queries.
  **/
-interface MultichainNetworksProps {
+interface MultichainChainIdsProps {
   /**
-   * Networks to query. All chains configured in {@link MultichainSDK} when
-   * omitted.
+   * Chains to query. All chains configured in {@link MultichainSDK} when
+   * omitted, and one the SDK is not configured for is dropped.
+   *
+   * A caller who thinks in network labels converts with {@link toChainIds}.
    **/
-  networks?: NetworkType[];
+  chainIds?: ChainId[];
 }
 /**
  * Adds chain-scoping props `T` only when the service spans multiple chains.
  **/
 type WithMultichain<Multichain extends boolean, T extends object> = Multichain extends true ? T : {};
 /**
- * Outcome of a fan-out request on a single chain.
+ * Pins a live read to a block. Only meaningful on one chain: a height is not
+ * a shared moment across networks.
  **/
-interface MultichainNetworkMeta {
+interface BlockNumberProps {
   /**
-   * Network the request was sent to.
+   * Block to read at. Defaults to the latest block.
    **/
-  network: NetworkType;
-  /**
-   * Whether the per-chain request succeeded.
-   **/
-  status: "success" | "error";
-  /**
-   * Rejection reason of the per-chain request. Only set when
-   * {@link status} is `"error"`.
-   **/
-  error?: unknown;
+  blockNumber?: bigint;
 }
 /**
- * Result of a multichain fan-out request: the combined payload of all
- * successful chains plus the outcome of every queried chain.
- *
- * Methods with no payload use `MultichainResult<void>`, i.e. `result` is
- * `undefined` and only {@link meta} carries information.
- *
- * @typeParam T - Combined payload type.
+ * Adds {@link BlockNumberProps} only for a single-chain call. Fan-out methods
+ * omit it so a caller cannot pass one height to every network.
  **/
-interface MultichainResult<T> {
-  /**
-   * Combined payload of the chains that responded successfully. Chains that
-   * failed contribute nothing and are reported in {@link meta}.
-   **/
-  result: T;
-  /**
-   * Per-chain request outcome, one entry per queried chain.
-   **/
-  meta: MultichainNetworkMeta[];
-}
+type WithBlock<Multichain extends boolean> = Multichain extends true ? {} : BlockNumberProps;
 //#endregion
-export { MultichainNetworkMeta, MultichainNetworkProps, MultichainNetworksProps, MultichainResult, WithMultichain };
+export { BlockNumberProps, MultichainChainIdsProps, MultichainNetworkProps, WithBlock, WithMultichain };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "14.12.0-next.80",
+  "version": "14.12.0-next.82",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {