@moonwell-fi/moonwell-sdk 0.2.0 → 0.3.2

package/environments/index.ts

@@ -33,36 +33,79 @@ import {
   type tokens as optimismTokens,
 } from "./definitions/optimism/environment.js";
 
+import {
+  createEnvironment as createEthereumEnvironment,
+  ethereum,
+  type tokens as ethereumTokens,
+} from "./definitions/ethereum/environment.js";
+
+import {
+  avalanche,
+  type tokens as avalancheTokens,
+  createEnvironment as createAvalancheEnvironment,
+} from "./definitions/avalanche/environment.js";
+
+import {
+  arbitrum,
+  type tokens as arbitrumTokens,
+  createEnvironment as createArbitrumEnvironment,
+} from "./definitions/arbitrum/environment.js";
+
+import {
+  createEnvironment as createPolygonEnvironment,
+  polygon,
+  type tokens as polygonTokens,
+} from "./definitions/polygon/environment.js";
+
 import { moonbeam, moonriver, optimism } from "viem/chains";
 import type { Environment, TokenConfig } from "./types/config.js";
 
+export {
+  arbitrum,
+  avalanche,
+  base,
+  ethereum,
+  GovernanceTokensConfig,
+  moonbeam,
+  moonriver,
+  optimism,
+  polygon,
+  supportedChains,
+  supportedChainsIds,
+};
 export type {
+  Chain,
+  Environment,
   GovernanceToken,
   GovernanceTokenInfo,
   GovernanceTokensType,
-  Environment,
-  Chain,
   Prettify,
-  Transport,
   SupportedChains,
   SupportedChainsIds,
   TokenConfig,
+  Transport,
 };
-export {
-  base,
-  GovernanceTokensConfig,
-  moonbeam,
-  moonriver,
-  optimism,
-  supportedChains,
+
+const supportedChains = {
+  base: base,
+  optimism: optimism,
+  moonriver: moonriver,
+  moonbeam: moonbeam,
+  ethereum: ethereum,
+  avalanche: avalanche,
+  arbitrum: arbitrum,
+  polygon: polygon,
 };
 
-const supportedChains = { base, optimism, moonriver, moonbeam };
-const supportedChainsIds = {
-  [base.id]: base,
-  [optimism.id]: optimism,
-  [moonriver.id]: moonriver,
-  [moonbeam.id]: moonbeam,
+const supportedChainsIds: { [id: number]: keyof typeof supportedChains } = {
+  [base.id]: "base",
+  [optimism.id]: "optimism",
+  [moonriver.id]: "moonriver",
+  [moonbeam.id]: "moonbeam",
+  [ethereum.id]: "ethereum",
+  [avalanche.id]: "avalanche",
+  [arbitrum.id]: "arbitrum",
+  [polygon.id]: "polygon",
 };
 
 type SupportedChains = Prettify<keyof typeof supportedChains>;
@@ -74,6 +117,12 @@ export type MoonriverEnvironment = ReturnType<
   typeof createMoonriverEnvironment
 >;
 export type OptimismEnvironment = ReturnType<typeof createOptimismEnvironment>;
+export type EthereumEnvironment = ReturnType<typeof createEthereumEnvironment>;
+export type AvalancheEnvironment = ReturnType<
+  typeof createAvalancheEnvironment
+>;
+export type ArbitrumEnvironment = ReturnType<typeof createArbitrumEnvironment>;
+export type PolygonEnvironment = ReturnType<typeof createPolygonEnvironment>;
 
 export type GetEnvironment<chain> = chain extends typeof base
   ? BaseEnvironment
@@ -83,7 +132,15 @@ export type GetEnvironment<chain> = chain extends typeof base
       ? MoonriverEnvironment
       : chain extends typeof optimism
         ? OptimismEnvironment
-        : undefined;
+        : chain extends typeof ethereum
+          ? EthereumEnvironment
+          : chain extends typeof avalanche
+            ? AvalancheEnvironment
+            : chain extends typeof arbitrum
+              ? ArbitrumEnvironment
+              : chain extends typeof polygon
+                ? PolygonEnvironment
+                : undefined;
 
 export const createEnvironment = <const chain extends Chain>(config: {
   chain: chain;
@@ -111,6 +168,26 @@ export const createEnvironment = <const chain extends Chain>(config: {
         config.rpcUrls,
         config.indexerUrl,
       ) as GetEnvironment<chain>;
+    case ethereum.id:
+      return createEthereumEnvironment(
+        config.rpcUrls,
+        config.indexerUrl,
+      ) as GetEnvironment<chain>;
+    case avalanche.id:
+      return createAvalancheEnvironment(
+        config.rpcUrls,
+        config.indexerUrl,
+      ) as GetEnvironment<chain>;
+    case arbitrum.id:
+      return createArbitrumEnvironment(
+        config.rpcUrls,
+        config.indexerUrl,
+      ) as GetEnvironment<chain>;
+    case polygon.id:
+      return createPolygonEnvironment(
+        config.rpcUrls,
+        config.indexerUrl,
+      ) as GetEnvironment<chain>;
     default:
       throw new Error("Unsupported chainId");
   }
@@ -121,6 +198,10 @@ export const publicEnvironments = {
   moonbeam: createMoonbeamEnvironment(),
   moonriver: createMoonriverEnvironment(),
   optimism: createOptimismEnvironment(),
+  ethereum: createEthereumEnvironment(),
+  avalanche: createAvalancheEnvironment(),
+  arbitrum: createArbitrumEnvironment(),
+  polygon: createPolygonEnvironment(),
 };
 
 export type TokensType<environment> = environment extends BaseEnvironment
@@ -131,7 +212,15 @@ export type TokensType<environment> = environment extends BaseEnvironment
       ? typeof moonriverTokens
       : environment extends OptimismEnvironment
         ? typeof optimismTokens
-        : undefined;
+        : environment extends EthereumEnvironment
+          ? typeof ethereumTokens
+          : environment extends AvalancheEnvironment
+            ? typeof avalancheTokens
+            : environment extends ArbitrumEnvironment
+              ? typeof arbitrumTokens
+              : environment extends PolygonEnvironment
+                ? typeof polygonTokens
+                : undefined;
 
 export type MarketsType<environment> = environment extends BaseEnvironment
   ? typeof baseMarkets

package/environments/types/config.ts

@@ -6,6 +6,7 @@ import {
   type Hex,
   type Narrow,
   type Prettify,
+  type PublicClient,
   type Transport,
   createPublicClient,
   getContract,
@@ -50,6 +51,7 @@ import type {
   StakingTokenContractReturnType,
   TemporalGovernorContractReturnType,
   TokenContractReturnType,
+  TokenSaleContractReturnType,
   VoteCollectorContractReturnType,
   WrappedNativeTokenContractReturnType,
 } from "./contracts.js";
@@ -80,11 +82,12 @@ export type MorphoMarketConfig<tokens> = {
 };
 
 export type ContractConfig<tokens> = {
-  stakingToken: keyof tokens;
-  governanceToken: keyof tokens;
-  wrappedNativeToken: keyof tokens;
-  comptroller: Address;
-  views: Address;
+  stakingToken?: keyof tokens;
+  governanceToken?: keyof tokens;
+  wrappedNativeToken?: keyof tokens;
+  comptroller?: Address;
+  views?: Address;
+  tokenSale?: Address;
   morphoViews?: Address;
   multiRewardDistributor?: Address;
   temporalGovernor?: Address;
@@ -104,6 +107,7 @@ export type ContractsConfigReturnType = {
   wrappedNativeToken: TokenContractReturnType;
   comptroller: ComptrollerContractReturnType;
   views: CoreViewsContractReturnType;
+  tokenSale: TokenSaleContractReturnType;
   morphoViews: MorphoViewsContractReturnType;
   multiRewardDistributor: MultiRewardDistributorContractReturnType;
   temporalGovernor: TemporalGovernorContractReturnType;
@@ -197,6 +201,7 @@ export const createEnvironmentConfig = <
   contracts,
   custom,
 >(config: {
+  key: string;
   name: string;
   chain: Chain;
   transport: Transport;
@@ -373,6 +378,11 @@ export const createEnvironmentConfig = <
         name,
         "views"
       >]: CoreViewsContractReturnType;
+    } & {
+      [name in keyof contracts as Extract<
+        name,
+        "tokenSale"
+      >]: TokenSaleContractReturnType;
     } & {
       [name in keyof contracts as Extract<
         name,
@@ -432,6 +442,7 @@ export const createEnvironmentConfig = <
   >;
 
   return {
+    key: config.key,
     name: config.name,
     chainId: config.chain.id,
     chain: config.chain,
@@ -456,6 +467,7 @@ export const createEnvironmentConfig = <
       },
       contracts: config.contracts,
     },
+    publicClient,
   } as Environment<tokens, markets, vaults, contracts, custom>;
 };
 
@@ -466,6 +478,7 @@ export type Environment<
   contracts = Partial<ContractsConfigReturnType>,
   custom = CustomConfigType,
 > = {
+  key: string;
   name: string;
   chainId: number;
   chain: Chain;
@@ -505,6 +518,11 @@ export type Environment<
         name,
         "views"
       >]: CoreViewsContractReturnType;
+    } & {
+      [name in keyof contracts as Extract<
+        name,
+        "tokenSale"
+      >]: TokenSaleContractReturnType;
     } & {
       [name in keyof contracts as Extract<
         name,
@@ -578,4 +596,5 @@ export type Environment<
     };
     contracts: ContractConfig<Record<string, any>>;
   };
+  publicClient: PublicClient;
 };

package/environments/types/contracts.ts

@@ -17,6 +17,7 @@ import type {
   StakingTokenAbi,
   TemporalGovernorAbi,
   TokenAbi,
+  TokenSaleAbi,
   VoteCollectorAbi,
   WrappedNativeTokenAbi,
 } from "../abis/index.js";
@@ -69,6 +70,11 @@ export type CoreViewsContractReturnType = GetContractReturnType<
   Address
 >;
 
+export type TokenSaleContractReturnType = GetContractReturnType<
+  typeof TokenSaleAbi,
+  PublicClient,
+  Address
+>;
 export type TemporalGovernorContractReturnType = GetContractReturnType<
   typeof TemporalGovernorAbi,
   PublicClient,

package/errors/version.ts

@@ -1 +1 @@
-export const version = '0.2.0'
+export const version = '0.3.2'

package/index.ts

@@ -1,11 +1,18 @@
 export {
-  type MoonwellClient,
   createMoonwellClient,
+  type MoonwellClient,
 } from "./client/createMoonwellClient.js";
 
+export type {
+  MarketConfig,
+  MorphoMarketConfig,
+  TokenConfig,
+  VaultConfig,
+} from "./environments/types/config.js";
+export type { CirculatingSupplySnapshot } from "./types/circulatingSupply.js";
 export type { Delegate } from "./types/delegate.js";
 export type { Discussion } from "./types/discussion.js";
-export type { Market, MarketReward } from "./types/market.js";
+export type { Market, MarketReward, MarketSnapshot } from "./types/market.js";
 export type {
   MorphoMarket,
   MorphoMarketParamsType,
@@ -13,15 +20,15 @@ export type {
 } from "./types/morphoMarket.js";
 export type { MorphoReward } from "./types/morphoReward.js";
 export type {
-  MorphoVaultUserPosition,
   MorphoMarketUserPosition,
+  MorphoVaultUserPosition,
 } from "./types/morphoUserPosition.js";
 export type { MorphoUserReward } from "./types/morphoUserReward.js";
-export type { MorphoVault } from "./types/morphoVault.js";
-export type {
-  Proposal,
-  ProposalState,
+export type { MorphoVault, MorphoVaultMarket } from "./types/morphoVault.js";
+export {
   MultichainProposalState,
+  ProposalState,
+  type Proposal,
 } from "./types/proposal.js";
 export type { SnapshotProposal } from "./types/snapshotProposal.js";
 export type {

package/logger/console.ts

@@ -0,0 +1,51 @@
+import { uniqueId } from "lodash";
+
+const messages: Record<
+  string,
+  {
+    id: string;
+    start: Date;
+    end?: Date;
+    duration?: number;
+    action: string;
+    message: string;
+  }
+> = {};
+
+export function start(action: string, message: string) {
+  if (window) {
+    const id = uniqueId();
+
+    messages[id] = {
+      id,
+      start: new Date(),
+      action,
+      message,
+    };
+
+    window.dispatchEvent(
+      new CustomEvent("moonwell-sdk", {
+        detail: messages[id],
+      }),
+    );
+
+    return id;
+  }
+  return undefined;
+}
+
+export function end(id?: string) {
+  if (window && id) {
+    const message = messages[id];
+    if (message) {
+      message.end = new Date();
+      message.duration = message.end.getTime() - message.start.getTime();
+      window.dispatchEvent(
+        new CustomEvent("moonwell-sdk", {
+          detail: message,
+        }),
+      );
+    }
+  }
+  return undefined;
+}

package/package.json

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

package/types/circulatingSupply.ts

@@ -0,0 +1,7 @@
+import type { TokenConfig } from "../environments/index.js";
+export type CirculatingSupplySnapshot = {
+  chainId: number;
+  token: TokenConfig;
+  circulatingSupply: number;
+  timestamp: number;
+};

package/types/market.ts

@@ -2,8 +2,11 @@ import type { Amount } from "../common/index.js";
 import type { TokenConfig } from "../environments/index.js";
 
 export type Market = {
+  marketKey: string;
   chainId: number;
   deprecated: boolean;
+  mintPaused: boolean;
+  borrowPaused: boolean;
   seizePaused: boolean;
   transferPaused: boolean;
   marketToken: TokenConfig;
@@ -35,3 +38,15 @@ export type MarketReward = {
   supplyApr: number;
   borrowApr: number;
 };
+
+export type MarketSnapshot = {
+  chainId: number;
+  marketId: string;
+  totalSupply: number;
+  totalSupplyUsd: number;
+  totalBorrows: number;
+  totalBorrowsUsd: number;
+  totalLiquidity: number;
+  totalLiquidityUsd: number;
+  timestamp: number;
+};

package/types/morphoMarket.ts

@@ -6,6 +6,7 @@ import type { MorphoReward } from "./morphoReward.js";
 export type MorphoMarket = {
   chainId: number;
   marketId: string;
+  marketKey: string;
   deprecated: boolean;
   loanToValue: number;
   performanceFee: number;
@@ -22,7 +23,9 @@ export type MorphoMarket = {
   availableLiquidityUsd: number;
   marketParams: MorphoMarketParamsType;
   baseSupplyApy: number;
+  rewardsSupplyApy: number;
   baseBorrowApy: number;
+  rewardsBorrowApy: number;
   totalSupplyApr: number;
   totalBorrowApr: number;
   rewards: Required<MorphoReward>[];

package/types/morphoVault.ts

@@ -4,6 +4,7 @@ import type { MorphoReward } from "./morphoReward.js";
 
 export type MorphoVault = {
   chainId: number;
+  vaultKey: string;
   vaultToken: TokenConfig;
   underlyingToken: TokenConfig;
   vaultSupply: Amount;
@@ -13,15 +14,16 @@ export type MorphoVault = {
   totalLiquidityUsd: number;
   underlyingPrice: number;
   baseApy: number;
+  rewardsApy: number;
   totalApy: number;
   performanceFee: number;
   curators: string[];
   timelock: number;
-  markets: MorphoVaultMarkets[];
+  markets: MorphoVaultMarket[];
   rewards: Omit<MorphoReward, "marketId">[];
 };
 
-export type MorphoVaultMarkets = {
+export type MorphoVaultMarket = {
   allocation: number;
   marketId: string;
   marketCollateral: TokenConfig;

package/types/proposal.ts

@@ -33,10 +33,6 @@ export type Proposal = {
     blockNumber: number;
     transactionHash: string;
     state: string;
-    messages: {
-      timestamp: number;
-      sequence: number;
-    }[];
   }[];
 };
 
@@ -86,9 +82,5 @@ export type ExtendedProposalData = {
     blockNumber: number;
     transactionHash: string;
     state: string;
-    messages: {
-      timestamp: number;
-      sequence: number;
-    }[];
   }[];
 };