@moonwell-fi/moonwell-sdk 0.12.1 → 0.13.0

package/actions/morpho/user-rewards/getMorphoUserRewards.ts

@@ -4,13 +4,41 @@ import { getEnvironmentsFromArgs } from "../../../common/index.js";
 import type { OptionalNetworkParameterType } from "../../../common/types.js";
 import type { Chain } from "../../../environments/index.js";
 import type { MorphoUserReward } from "../../../types/morphoUserReward.js";
-import { getUserMorphoRewardsData } from "./common.js";
+import { MerklApiError, getUserMorphoRewardsData } from "./common.js";
+
+/**
+ * AggregateError thrown by `getMorphoUserRewards` when one or more chains
+ * fail and `throwOnExternalApiError` is `true`. The `rewards` property
+ * carries the rewards from any chains that succeeded so callers can still
+ * surface partial results alongside the per-chain failures in `errors`.
+ */
+export class MorphoUserRewardsAggregateError extends AggregateError {
+  readonly rewards: MorphoUserReward[];
+
+  constructor(errors: Error[], message: string, rewards: MorphoUserReward[]) {
+    super(errors, message);
+    this.name = "MorphoUserRewardsAggregateError";
+    this.rewards = rewards;
+  }
+}
 
 export type GetMorphoUserRewardsParameters<
   environments,
   network extends Chain | undefined,
 > = OptionalNetworkParameterType<environments, network> & {
   userAddress: Address;
+  /**
+   * When true, errors from the external Merkl API are propagated to the
+   * caller instead of being swallowed and returning `[]`. Default `false`
+   * preserves the historical behavior for existing consumers.
+   *
+   * If multiple environments are queried and at least one fails while others
+   * succeed, this throws a `MorphoUserRewardsAggregateError` whose `errors`
+   * array contains the per-chain failures and whose `rewards` property
+   * carries the successful chains' rewards so the caller can still display
+   * partial results.
+   */
+  throwOnExternalApiError?: boolean;
 };
 
 export type GetMorphoUserRewardsReturnType = Promise<MorphoUserReward[]>;
@@ -22,18 +50,55 @@ export async function getMorphoUserRewards<
   client: MoonwellClient,
   args: GetMorphoUserRewardsParameters<environments, Network>,
 ): GetMorphoUserRewardsReturnType {
-  const environments = getEnvironmentsFromArgs(client, args);
-
-  const environmentsUserRewards = await Promise.all(
-    environments
-      .filter((environment) => environment.contracts.morphoViews !== undefined)
-      .map((environment) => {
-        return getUserMorphoRewardsData({
-          environment,
-          account: args.userAddress,
-        });
+  const targetEnvironments = getEnvironmentsFromArgs(client, args).filter(
+    (environment) => environment.contracts.morphoViews !== undefined,
+  );
+
+  const settled = await Promise.allSettled(
+    targetEnvironments.map((environment) =>
+      getUserMorphoRewardsData({
+        environment,
+        account: args.userAddress,
+        ...(args.throwOnExternalApiError !== undefined && {
+          throwOnExternalApiError: args.throwOnExternalApiError,
+        }),
       }),
+    ),
   );
 
-  return environmentsUserRewards.flat();
+  const fulfilled: MorphoUserReward[] = [];
+  const failures: Error[] = [];
+  const failedChainIds: number[] = [];
+  for (const [i, result] of settled.entries()) {
+    const environment = targetEnvironments[i];
+    if (result.status === "fulfilled") {
+      fulfilled.push(...result.value);
+      continue;
+    }
+    const reason = result.reason;
+    if (reason instanceof MerklApiError) {
+      failures.push(reason);
+      failedChainIds.push(reason.chainId);
+      continue;
+    }
+    const baseError =
+      reason instanceof Error ? reason : new Error(String(reason));
+    failures.push(
+      new Error(
+        `getMorphoUserRewards failed for chain ${environment.chainId}: ${baseError.message}`,
+        { cause: baseError },
+      ),
+    );
+    failedChainIds.push(environment.chainId);
+  }
+
+  if (failures.length > 0 && args.throwOnExternalApiError === true) {
+    throw new MorphoUserRewardsAggregateError(
+      failures,
+      `getMorphoUserRewards failed for chains: ${failedChainIds.join(", ")}`,
+      fulfilled,
+    );
+  }
+
+  return fulfilled;
 }

package/environments/definitions/ethereum/contracts.ts

@@ -0,0 +1,10 @@
+import { createContractsConfig } from "../../types/config.js";
+import { tokens } from "./tokens.js";
+
+export const contracts = createContractsConfig({
+  tokens,
+  contracts: {
+    // `stakingToken` is intentionally omitted until Ethereum staking contracts ship.
+    governanceToken: "WELL",
+  },
+});

package/environments/definitions/ethereum/custom.ts

@@ -0,0 +1,15 @@
+import { createCustomConfig } from "../../types/config.js";
+
+export const custom = createCustomConfig({
+  governance: {
+    token: "WELL",
+    chainIds: [],
+  },
+  wormhole: {
+    chainId: 2,
+    tokenBridge: { address: "0x3ee18B2214AFF97000D974cf647E654bB5f1d8A8" },
+  },
+  xWELL: {
+    bridgeAdapter: { address: "0x734AbBCe07679C9A6B4Fe3bC16325e028fA6DbB7" },
+  },
+});

package/environments/definitions/ethereum/environment.ts

@@ -1,15 +1,22 @@
-import { http, fallback } from "viem";
-import { mainnet as ethereum } from "viem/chains";
+import { http, defineChain, fallback } from "viem";
+import { mainnet } from "viem/chains";
 import {
   type Environment,
   createEnvironmentConfig,
 } from "../../types/config.js";
+import { contracts } from "./contracts.js";
+import { custom } from "./custom.js";
 import { tokens } from "./tokens.js";
 
+// viem's `mainnet` chain leaves `testnet` undefined; consumers
+// (e.g. the bridge modal) check `env.chain.testnet === false` strictly.
+const ethereum = defineChain({ ...mainnet, testnet: false });
+
 const createEnvironment = (
   rpcUrls?: string[],
   governanceIndexerUrl?: string,
-): Environment<typeof tokens, {}, {}, {}, {}> =>
+  lunarIndexerUrl?: string,
+): Environment<typeof tokens, {}, {}, typeof contracts, typeof custom> =>
   createEnvironmentConfig({
     key: "ethereum",
     name: "Ethereum",
@@ -25,12 +32,14 @@ const createEnvironment = (
     governanceIndexerUrl:
       governanceIndexerUrl ||
       "https://lunar-services-worker.moonwell.workers.dev",
+    lunarIndexerUrl:
+      lunarIndexerUrl || "https://lunar-services-worker.moonwell.workers.dev",
     tokens,
     markets: {},
     vaults: {},
     morphoMarkets: {},
-    contracts: {},
-    custom: {},
-  }) as Environment<typeof tokens, {}, {}, {}, {}>;
+    contracts,
+    custom,
+  }) as Environment<typeof tokens, {}, {}, typeof contracts, typeof custom>;
 
 export { createEnvironment, ethereum, tokens };

package/environments/definitions/ethereum/tokens.ts

@@ -14,4 +14,16 @@ export const tokens = createTokenConfig({
     name: "USD Coin",
     symbol: "USDC",
   },
+  WELL: {
+    address: "0xA88594D404727625A9437C3f886C7643872296AE",
+    decimals: 18,
+    name: "Moonwell",
+    symbol: "WELL",
+  },
+  stkWELL: {
+    address: "0xb3a9E0DCf37658a48aa9f018C44f90378ddD4357",
+    decimals: 18,
+    name: "Moonwell Staked WELL",
+    symbol: "stkWELL",
+  },
 });

package/environments/definitions/governance.ts

@@ -1,4 +1,4 @@
-import { base, moonbeam, moonriver, optimism } from "viem/chains";
+import { base, mainnet, moonbeam, moonriver, optimism } from "viem/chains";
 
 export interface GovernanceTokenInfo {
   id: string;
@@ -30,7 +30,7 @@ export const GovernanceTokensConfig = createGovernanceTokensConfig({
     id: "WELL",
     symbol: "WELL",
     name: "WELL",
-    chainIds: [moonbeam.id, base.id, optimism.id] as number[],
+    chainIds: [moonbeam.id, base.id, optimism.id, mainnet.id] as number[],
     testnet: false,
   },
   MFAM: {

package/errors/version.ts

@@ -1 +1 @@
-export const version = '0.12.1'
+export const version = '0.13.0'

package/index.ts

@@ -3,6 +3,9 @@ export {
   type MoonwellClient,
 } from "./client/createMoonwellClient.js";
 
+export { MerklApiError } from "./actions/morpho/user-rewards/common.js";
+export { MorphoUserRewardsAggregateError } from "./actions/morpho/user-rewards/getMorphoUserRewards.js";
+
 export type {
   MarketConfig,
   MorphoMarketConfig,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@moonwell-fi/moonwell-sdk",
   "description": "TypeScript Interface for Moonwell",
-  "version": "0.12.1",
+  "version": "0.13.0",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",