feat: generated method-action-types

Author: Matt561

packages/money-account-balance-service/src/money-account-balance-service-method-action-types.ts

@@ -8,7 +8,7 @@ import type { MoneyAccountBalanceService } from './money-account-balance-service
 /**
  * Fetches the mUSD ERC-20 balance for the given account address via RPC.
  *
- * @param accountAddress - The Money account's address.
+ * @param accountAddress - The Money account's Ethereum address.
  * @returns The mUSD balance as a raw uint256 string.
  */
 export type MoneyAccountBalanceServiceGetMusdBalanceAction = {
@@ -20,7 +20,7 @@ export type MoneyAccountBalanceServiceGetMusdBalanceAction = {
  * Fetches the musdSHFvd (Veda vault share) ERC-20 balance for the given
  * account address via RPC.
  *
- * @param accountAddress - The Money account's address.
+ * @param accountAddress - The Money account's Ethereum address.
  * @returns The musdSHFvd balance as a raw uint256 string.
  */
 export type MoneyAccountBalanceServiceGetMusdSHFvdBalanceAction = {
@@ -29,8 +29,12 @@ export type MoneyAccountBalanceServiceGetMusdSHFvdBalanceAction = {
 };
 
 /**
- * Fetches the current exchange rate from the Veda Accountant contract via RPC.
+ * Fetches the current exchange rate from the Veda Accountant contract via
+ * RPC. The rate represents the conversion factor from musdSHFvd shares to
+ * the underlying mUSD asset.
  *
+ * @param options - The options for the query.
+ * @param options.staleTime - The stale time for the query. Defaults to 30 seconds.
  * @returns The exchange rate as a raw uint256 string.
  */
 export type MoneyAccountBalanceServiceGetExchangeRateAction = {
@@ -41,10 +45,12 @@ export type MoneyAccountBalanceServiceGetExchangeRateAction = {
 /**
  * Computes the mUSD-equivalent value of the account's musdSHFvd holdings.
  * Internally fetches the musdSHFvd balance and exchange rate (using cached
- * values when available), then multiplies them.
+ * values when available within their staleTime windows), then multiplies
+ * them.
  *
- * @param accountAddress - The Money account's address.
- * @returns The musdSHFvd balance, exchange rate, and computed mUSD-equivalent value.
+ * @param accountAddress - The Money account's Ethereum address.
+ * @returns The musdSHFvd balance, exchange rate, and computed
+ * mUSD-equivalent value as raw uint256 strings.
  */
 export type MoneyAccountBalanceServiceGetMusdEquivalentValueAction = {
   type: `MoneyAccountBalanceService:getMusdEquivalentValue`;
@@ -54,7 +60,7 @@ export type MoneyAccountBalanceServiceGetMusdEquivalentValueAction = {
 /**
  * Fetches the vault's APY and fee breakdown from the Veda performance REST API.
  *
- * @returns The 7-day trailing net APY, fees, and per-position breakdown.
+ * @returns The normalized vault APY response.
  */
 export type MoneyAccountBalanceServiceGetVaultApyAction = {
   type: `MoneyAccountBalanceService:getVaultApy`;