Revert "improve getter tools, don't export optional getters (#1574)"

This reverts commit a7ed0ab.
penumbra-zone · Sep 4, 2024 · 1153a05 · 1153a05
1 parent a7ed0ab
commit 1153a05
Show file tree

Hide file tree

Showing 58 changed files with 284 additions and 444 deletions.
diff --git a/.changeset/khaki-tables-give.md b/.changeset/khaki-tables-give.md
diff --git a/.changeset/slow-seas-fix.md b/.changeset/slow-seas-fix.md
diff --git a/apps/minifront/src/components/dashboard/assets-table/equivalent-values.tsx b/apps/minifront/src/components/dashboard/assets-table/equivalent-values.tsx
@@ -4,7 +4,7 @@ import { getDisplayDenomFromView, getEquivalentValues } from '@penumbra-zone/get
 import { ValueViewComponent } from '@penumbra-zone/ui/components/ui/value';
 
 export const EquivalentValues = ({ valueView }: { valueView?: ValueView }) => {
-  const equivalentValuesAsValueViews = (getEquivalentValues.optional(valueView) ?? []).map(
+  const equivalentValuesAsValueViews = (getEquivalentValues.optional()(valueView) ?? []).map(
     asValueView,
   );
 

diff --git a/apps/minifront/src/components/dashboard/assets-table/index.tsx b/apps/minifront/src/components/dashboard/assets-table/index.tsx
@@ -14,7 +14,7 @@ import { EquivalentValues } from './equivalent-values';
 import { Fragment } from 'react';
 import { PagePath } from '../../metadata/paths';
 import { Link } from 'react-router-dom';
-import { getMetadataFromBalancesResponse } from '@penumbra-zone/getters/balances-response';
+import { getMetadataFromBalancesResponseOptional } from '@penumbra-zone/getters/balances-response';
 import { getAddressIndex } from '@penumbra-zone/getters/address-view';
 import { BalancesByAccount, groupByAccount, useBalancesResponses } from '../../../state/shared';
 import { AbridgedZQueryState } from '@penumbra-zone/zquery/src/types';
@@ -24,7 +24,7 @@ import { LineWave } from 'react-loader-spinner';
 import { cn } from '@penumbra-zone/ui/lib/utils';
 
 const getTradeLink = (balance: BalancesResponse): string => {
-  const metadata = getMetadataFromBalancesResponse.optional(balance);
+  const metadata = getMetadataFromBalancesResponseOptional(balance);
   const accountIndex = getAddressIndex(balance.accountAddress).account;
   const accountQuery = accountIndex ? `&account=${accountIndex}` : '';
   return metadata ? `${PagePath.SWAP}?from=${metadata.symbol}${accountQuery}` : PagePath.SWAP;

diff --git a/apps/minifront/src/components/shared/input-token.tsx b/apps/minifront/src/components/shared/input-token.tsx
@@ -1,7 +1,7 @@
 import { useMemo } from 'react';
 import { BalancesResponse } from '@penumbra-zone/protobuf/penumbra/view/v1/view_pb';
 import { getDisplayDenomExponent } from '@penumbra-zone/getters/metadata';
-import { getMetadataFromBalancesResponse } from '@penumbra-zone/getters/balances-response';
+import { getMetadataFromBalancesResponseOptional } from '@penumbra-zone/getters/balances-response';
 import { BalanceValueView } from '@penumbra-zone/ui/components/ui/balance-value-view';
 import { cn } from '@penumbra-zone/ui/lib/utils';
 import BalanceSelector from './selectors/balance-selector';
@@ -38,7 +38,7 @@ export default function InputToken({
   loading,
 }: InputTokenProps) {
   const tokenExponent = useMemo(() => {
-    return getDisplayDenomExponent.optional(getMetadataFromBalancesResponse.optional(selection));
+    return getDisplayDenomExponent.optional()(getMetadataFromBalancesResponseOptional(selection));
   }, [selection]);
 
   const setInputToBalanceMax = () => {

diff --git a/apps/minifront/src/components/shared/non-native-fee-warning.tsx b/apps/minifront/src/components/shared/non-native-fee-warning.tsx
@@ -24,7 +24,7 @@ const hasTokenBalance = ({
   gasPrices: GasPrices[];
   stakingAssetMetadata?: Metadata;
 }): boolean => {
-  const account = getAddressIndex.optional(source)?.account;
+  const account = getAddressIndex.optional()(source)?.account;
   if (typeof account === 'undefined') {
     return false;
   }
@@ -33,17 +33,17 @@ const hasTokenBalance = ({
   const hasStakingToken = balancesResponses.some(
     asset =>
       getAssetIdFromValueView
-        .optional(asset.balanceView)
-        ?.equals(getAssetId.optional(stakingAssetMetadata)) &&
-      getAddressIndex.optional(asset)?.account === account,
+        .optional()(asset.balanceView)
+        ?.equals(getAssetId.optional()(stakingAssetMetadata)) &&
+      getAddressIndex.optional()(asset)?.account === account,
   );
 
   if (hasStakingToken) {
     return false;
   }
 
   const accountAssets = balancesResponses.filter(
-    balance => getAddressIndex.optional(balance)?.account === account,
+    balance => getAddressIndex.optional()(balance)?.account === account,
   );
   // Finds the alt tokens in the user's account balances that can be used for fees
   const hasAltTokens = accountAssets.some(balance => {
@@ -54,7 +54,7 @@ const hasTokenBalance = ({
     }
 
     return gasPrices.some(price =>
-      price.assetId?.equals(getAssetIdFromBalancesResponse.optional(balance)),
+      price.assetId?.equals(getAssetIdFromBalancesResponse.optional()(balance)),
     );
   });
 

diff --git a/apps/minifront/src/components/shared/selectors/balance-item.tsx b/apps/minifront/src/components/shared/selectors/balance-item.tsx
@@ -1,6 +1,9 @@
 import { BalanceOrMetadata, isBalance, isMetadata } from './helpers';
 import { getAddressIndex } from '@penumbra-zone/getters/address-view';
-import { getMetadataFromBalancesResponse } from '@penumbra-zone/getters/balances-response';
+import {
+  getMetadataFromBalancesResponse,
+  getMetadataFromBalancesResponseOptional,
+} from '@penumbra-zone/getters/balances-response';
 import { useMemo } from 'react';
 import { DialogClose } from '@penumbra-zone/ui/components/ui/dialog';
 import { cn } from '@penumbra-zone/ui/lib/utils';
@@ -19,8 +22,8 @@ export const BalanceItem = ({ asset, value, onSelect }: BalanceItemProps) => {
   const account = isBalance(asset) ? getAddressIndex(asset.accountAddress).account : undefined;
   const metadataFromAsset = isMetadata(asset)
     ? asset
-    : getMetadataFromBalancesResponse.optional(asset);
-  const metadataFromValue = getMetadataFromBalancesResponse.optional(value);
+    : getMetadataFromBalancesResponseOptional(asset);
+  const metadataFromValue = getMetadataFromBalancesResponse.optional()(value);
 
   const isSelected = useMemo(() => {
     if (!value) {

diff --git a/apps/minifront/src/components/shared/selectors/helpers.ts b/apps/minifront/src/components/shared/selectors/helpers.ts
@@ -2,7 +2,7 @@ import { BalancesResponse } from '@penumbra-zone/protobuf/penumbra/view/v1/view_
 import { Metadata } from '@penumbra-zone/protobuf/penumbra/core/asset/v1/asset_pb';
 import {
   getAddressIndex,
-  getMetadataFromBalancesResponse,
+  getMetadataFromBalancesResponseOptional,
 } from '@penumbra-zone/getters/balances-response';
 import { useEffect } from 'react';
 
@@ -22,7 +22,7 @@ export const mergeBalancesAndAssets = (
 ): BalanceOrMetadata[] => {
   const filteredAssets = assets.filter(asset => {
     return !balances.some(balance => {
-      const balanceMetadata = getMetadataFromBalancesResponse.optional(balance);
+      const balanceMetadata = getMetadataFromBalancesResponseOptional(balance);
       return balanceMetadata?.equals(asset);
     });
   });
@@ -43,10 +43,10 @@ export const useSyncSelectedBalance = ({
     if (value) {
       const matchedValue = balances?.find(balance => {
         return (
-          getAddressIndex.optional(balance)?.equals(getAddressIndex.optional(value)) &&
-          getMetadataFromBalancesResponse
-            .optional(balance)
-            ?.equals(getMetadataFromBalancesResponse.optional(value))
+          getAddressIndex.optional()(balance)?.equals(getAddressIndex.optional()(value)) &&
+          getMetadataFromBalancesResponseOptional(balance)?.equals(
+            getMetadataFromBalancesResponseOptional(value),
+          )
         );
       });
       if (matchedValue && !matchedValue.equals(value)) {

diff --git a/apps/minifront/src/components/shared/selectors/search-filters.ts b/apps/minifront/src/components/shared/selectors/search-filters.ts
@@ -7,7 +7,7 @@ import { getValueViewCaseFromBalancesResponse } from '@penumbra-zone/getters/bal
 export const balanceBySearch =
   (search: string) =>
   (balancesResponse: BalancesResponse): boolean =>
-    getValueViewCaseFromBalancesResponse.optional(balancesResponse) === 'knownAssetId' &&
+    getValueViewCaseFromBalancesResponse.optional()(balancesResponse) === 'knownAssetId' &&
     (getDisplayDenomFromView(balancesResponse.balanceView)
       .toLocaleLowerCase()
       .includes(search.toLocaleLowerCase()) ||

diff --git a/...nifront/src/components/staking/account/delegation-value-view/validator-info-component.tsx b/...nifront/src/components/staking/account/delegation-value-view/validator-info-component.tsx
@@ -35,7 +35,7 @@ export const ValidatorInfoComponent = ({
   const showTooltips = useStore(state => !state.staking.loading);
   const validator = getValidator(validatorInfo);
   const identityKey = getIdentityKeyFromValidatorInfo(validatorInfo);
-  const state = getValidatorState.optional(validatorInfo);
+  const state = getValidatorState.optional()(validatorInfo);
 
   return (
     <TooltipProvider>

diff --git a/apps/minifront/src/components/swap/swap-form/output/estimated-output-explanation.tsx b/apps/minifront/src/components/swap/swap-form/output/estimated-output-explanation.tsx
@@ -24,9 +24,9 @@ export const EstimatedOutputExplanation = () => {
 
   const formattedAmount = formatAmount({
     amount: estimatedOutput,
-    exponent: getDisplayDenomExponent.optional(assetOut),
+    exponent: getDisplayDenomExponent.optional()(assetOut),
   });
-  const assetInSymbol = getSymbolFromValueView.optional(assetIn?.balanceView);
+  const assetInSymbol = getSymbolFromValueView.optional()(assetIn?.balanceView);
 
   return (
     <div className='text-xs'>

diff --git a/apps/minifront/src/components/swap/swap-form/price-history.tsx b/apps/minifront/src/components/swap/swap-form/price-history.tsx
@@ -1,4 +1,4 @@
-import { getMetadataFromBalancesResponse } from '@penumbra-zone/getters/balances-response';
+import { getMetadataFromBalancesResponseOptional } from '@penumbra-zone/getters/balances-response';
 import { AbridgedZQueryState } from '@penumbra-zone/zquery/src/types';
 import { Box } from '@penumbra-zone/ui/components/ui/box';
 import { CandlestickPlot } from '@penumbra-zone/ui/components/ui/candlestick-plot';
@@ -12,7 +12,7 @@ import { useStoreShallow } from '../../../utils/use-store-shallow';
 import { Button } from '@penumbra-zone/ui/components/ui/button';
 
 const priceHistorySelector = (state: AllSlices) => ({
-  startMetadata: getMetadataFromBalancesResponse.optional(state.swap.assetIn),
+  startMetadata: getMetadataFromBalancesResponseOptional(state.swap.assetIn),
   endMetadata: state.swap.assetOut,
   historyLimit: state.swap.priceHistory.historyLimit,
   historyStart: state.swap.priceHistory.historyStart,

diff --git a/apps/minifront/src/components/swap/swap-form/simulate-swap-result/index.tsx b/apps/minifront/src/components/swap/swap-form/simulate-swap-result/index.tsx
@@ -25,9 +25,9 @@ const simulateSwapResultSelector = (state: AllSlices) => ({
       value: {
         amount: toBaseUnit(
           new BigNumber(state.swap.amount || 0),
-          getDisplayDenomExponentFromValueView.optional(state.swap.assetIn?.balanceView),
+          getDisplayDenomExponentFromValueView.optional()(state.swap.assetIn?.balanceView),
         ),
-        metadata: getMetadata.optional(state.swap.assetIn?.balanceView),
+        metadata: getMetadata.optional()(state.swap.assetIn?.balanceView),
       },
     },
   }),

diff --git a/apps/minifront/src/components/swap/swap-form/simulate-swap-result/traces/trace/price.tsx b/apps/minifront/src/components/swap/swap-form/simulate-swap-result/traces/trace/price.tsx
@@ -21,8 +21,8 @@ export const Price = ({
     const lastValueMetadata = metadataByAssetId[bech32mAssetId(outputValue.assetId)];
 
     if (firstValueMetadata?.symbol && lastValueMetadata?.symbol) {
-      const inputDisplayDenomExponent = getDisplayDenomExponent.optional(firstValueMetadata) ?? 0;
-      const outputDisplayDenomExponent = getDisplayDenomExponent.optional(lastValueMetadata) ?? 0;
+      const inputDisplayDenomExponent = getDisplayDenomExponent.optional()(firstValueMetadata) ?? 0;
+      const outputDisplayDenomExponent = getDisplayDenomExponent.optional()(lastValueMetadata) ?? 0;
       const formattedInputAmount = formatAmount({
         amount: inputValue.amount,
         exponent: inputDisplayDenomExponent,

diff --git a/apps/minifront/src/components/swap/swap-form/token-swap-input.tsx b/apps/minifront/src/components/swap/swap-form/token-swap-input.tsx
@@ -6,7 +6,7 @@ import { joinLoHiAmount } from '@penumbra-zone/types/amount';
 import {
   getAmount,
   getBalanceView,
-  getMetadataFromBalancesResponse,
+  getMetadataFromBalancesResponseOptional,
 } from '@penumbra-zone/getters/balances-response';
 import { ArrowRight } from 'lucide-react';
 import { useMemo } from 'react';
@@ -43,7 +43,7 @@ const getAssetOutBalance = (
     getAddressIndex(assetIn.accountAddress),
     assetOut,
   );
-  const matchedBalance = getBalanceView.optional(match);
+  const matchedBalance = getBalanceView.optional()(match);
   return matchedBalance ?? zeroValueView(assetOut);
 };
 
@@ -70,10 +70,10 @@ export const TokenSwapInput = () => {
     useStoreShallow(tokenSwapInputSelector);
   const assetOutBalance = getAssetOutBalance(balancesResponses?.data, assetIn, assetOut);
   const assetInExponent = useMemo(() => {
-    return getDisplayDenomExponent.optional(getMetadataFromBalancesResponse.optional(assetIn));
+    return getDisplayDenomExponent.optional()(getMetadataFromBalancesResponseOptional(assetIn));
   }, [assetIn]);
 
-  const maxAmount = getAmount.optional(assetIn);
+  const maxAmount = getAmount.optional()(assetIn);
   const maxAmountAsString = maxAmount ? joinLoHiAmount(maxAmount).toString() : undefined;
 
   const setInputToBalanceMax = () => {

diff --git a/apps/minifront/src/components/v2/dashboard-layout/assets-page/equivalent-values.tsx b/apps/minifront/src/components/v2/dashboard-layout/assets-page/equivalent-values.tsx
@@ -4,7 +4,7 @@ import { getDisplayDenomFromView, getEquivalentValues } from '@penumbra-zone/get
 import { ValueViewComponent } from '@penumbra-zone/ui/ValueViewComponent';
 
 export const EquivalentValues = ({ valueView }: { valueView?: ValueView }) => {
-  const equivalentValuesAsValueViews = (getEquivalentValues.optional(valueView) ?? []).map(
+  const equivalentValuesAsValueViews = (getEquivalentValues.optional()(valueView) ?? []).map(
     asValueView,
   );
 

diff --git a/apps/minifront/src/components/v2/dashboard-layout/assets-page/index.tsx b/apps/minifront/src/components/v2/dashboard-layout/assets-page/index.tsx
@@ -4,7 +4,7 @@ import { BalancesByAccount, groupByAccount, useBalancesResponses } from '../../.
 import { shouldDisplay } from '../../../../fetchers/balances/should-display';
 import { sortByPriorityScore } from '../../../../fetchers/balances/by-priority-score';
 import { BalancesResponse } from '@penumbra-zone/protobuf/penumbra/view/v1/view_pb';
-import { getMetadataFromBalancesResponse } from '@penumbra-zone/getters/balances-response';
+import { getMetadataFromBalancesResponseOptional } from '@penumbra-zone/getters/balances-response';
 import { PagePath } from '../../../metadata/paths';
 import { getAddressIndex } from '@penumbra-zone/getters/address-view';
 import { AbridgedZQueryState } from '@penumbra-zone/zquery/src/types';
@@ -19,7 +19,7 @@ import { ConditionalWrap } from '@penumbra-zone/ui/ConditionalWrap';
 import { LayoutGroup } from 'framer-motion';
 
 const getTradeLink = (balance: BalancesResponse): string => {
-  const metadata = getMetadataFromBalancesResponse.optional(balance);
+  const metadata = getMetadataFromBalancesResponseOptional(balance);
   const accountIndex = getAddressIndex(balance.accountAddress).account;
   const accountQuery = accountIndex ? `&account=${accountIndex}` : '';
   return metadata ? `${PagePath.SWAP}?from=${metadata.symbol}${accountQuery}` : PagePath.SWAP;

diff --git a/apps/minifront/src/fetchers/auction-infos.ts b/apps/minifront/src/fetchers/auction-infos.ts
@@ -31,8 +31,8 @@ export const getAuctionInfos = async function* ({
 
     const auction = DutchAuction.fromBinary(response.auction.value);
 
-    const inputAssetId = getInputAssetId.optional(auction);
-    const outputAssetId = getOutputAssetId.optional(auction);
+    const inputAssetId = getInputAssetId.optional()(auction);
+    const outputAssetId = getOutputAssetId.optional()(auction);
 
     const inputMetadataPromise = inputAssetId
       ? penumbra.service(ViewService).assetMetadataById({ assetId: inputAssetId })

diff --git a/apps/minifront/src/fetchers/balances/by-priority-score.ts b/apps/minifront/src/fetchers/balances/by-priority-score.ts
@@ -1,17 +1,17 @@
 import { BalancesResponse } from '@penumbra-zone/protobuf/penumbra/view/v1/view_pb';
 import {
-  getMetadataFromBalancesResponse,
+  getMetadataFromBalancesResponseOptional,
   getAmount,
   getAddressIndex,
 } from '@penumbra-zone/getters/balances-response';
 import { multiplyAmountByNumber, joinLoHiAmount } from '@penumbra-zone/types/amount';
 
 export const sortByPriorityScore = (a: BalancesResponse, b: BalancesResponse) => {
-  const aScore = getMetadataFromBalancesResponse.optional(a)?.priorityScore ?? 1n;
-  const bScore = getMetadataFromBalancesResponse.optional(b)?.priorityScore ?? 1n;
+  const aScore = getMetadataFromBalancesResponseOptional(a)?.priorityScore ?? 1n;
+  const bScore = getMetadataFromBalancesResponseOptional(b)?.priorityScore ?? 1n;
 
-  const aAmount = getAmount.optional(a);
-  const bAmount = getAmount.optional(b);
+  const aAmount = getAmount.optional()(a);
+  const bAmount = getAmount.optional()(b);
 
   const aPriority = aAmount
     ? joinLoHiAmount(multiplyAmountByNumber(aAmount, Number(aScore)))

diff --git a/apps/minifront/src/state/helpers.ts b/apps/minifront/src/state/helpers.ts
@@ -22,7 +22,7 @@ import { uint8ArrayToHex } from '@penumbra-zone/types/hex';
 import { fromValueView } from '@penumbra-zone/types/amount';
 import { BigNumber } from 'bignumber.js';
 import {
-  getMetadataFromBalancesResponse,
+  getMetadataFromBalancesResponseOptional,
   getValueViewCaseFromBalancesResponse,
 } from '@penumbra-zone/getters/balances-response';
 import { getDisplayDenomExponent } from '@penumbra-zone/getters/metadata';
@@ -201,8 +201,8 @@ export const isIncorrectDecimal = (
     throw new Error('Missing balanceView');
   }
 
-  const exponent = getDisplayDenomExponent.optional(
-    getMetadataFromBalancesResponse.optional(asset),
+  const exponent = getDisplayDenomExponent.optional()(
+    getMetadataFromBalancesResponseOptional(asset),
   );
   const fraction = amountInDisplayDenom.split('.')[1]?.length;
   return typeof exponent !== 'undefined' && typeof fraction !== 'undefined' && fraction > exponent;
@@ -214,4 +214,4 @@ export const isValidAmount = (amount: string, assetIn?: BalancesResponse) =>
   (!assetIn || !isIncorrectDecimal(assetIn, amount));
 
 export const isKnown = (balancesResponse: BalancesResponse) =>
-  getValueViewCaseFromBalancesResponse.optional(balancesResponse) === 'knownAssetId';
+  getValueViewCaseFromBalancesResponse.optional()(balancesResponse) === 'knownAssetId';
diff --git a/apps/minifront/src/state/ibc-out.ts b/apps/minifront/src/state/ibc-out.ts
@@ -282,7 +282,7 @@ export const filterBalancesPerChain = (
   registryAssets: Metadata[],
   stakingTokenMetadata?: Metadata,
 ): BalancesResponse[] => {
-  const penumbraAssetId = getAssetId.optional(stakingTokenMetadata);
+  const penumbraAssetId = getAssetId.optional()(stakingTokenMetadata);
   const assetsWithMatchingChannel = registryAssets
     .filter(a => {
       const match = assetPatterns.ibc.capture(a.base);

diff --git a/apps/minifront/src/state/send/index.ts b/apps/minifront/src/state/send/index.ts
@@ -133,7 +133,7 @@ const assembleRequest = ({ amount, feeTier, recipient, selection, memo }: SendSl
     value: {
       amount: toBaseUnit(
         BigNumber(amount),
-        getDisplayDenomExponentFromValueView.optional(selection?.balanceView),
+        getDisplayDenomExponentFromValueView.optional()(selection?.balanceView),
       ),
       assetId: getAssetIdFromValueView(selection?.balanceView),
     },

diff --git a/apps/minifront/src/state/swap/dutch-auction/assemble-schedule-request.ts b/apps/minifront/src/state/swap/dutch-auction/assemble-schedule-request.ts
@@ -13,7 +13,7 @@ export const assembleScheduleRequest = async ({
   duration,
 }: Pick<SwapSlice, 'amount' | 'assetIn' | 'assetOut' | 'duration'> &
   Pick<DutchAuctionSlice, 'minOutput' | 'maxOutput'>): Promise<TransactionPlannerRequest> => {
-  const source = getAddressIndex.optional(assetIn);
+  const source = getAddressIndex.optional()(assetIn);
 
   return new TransactionPlannerRequest({
     dutchAuctionScheduleActions: await getSubAuctions({

diff --git a/apps/minifront/src/state/swap/dutch-auction/index.ts b/apps/minifront/src/state/swap/dutch-auction/index.ts
@@ -122,7 +122,7 @@ export const createDutchAuctionSlice = (): SliceCreator<DutchAuctionSlice> => (s
         swap.dutchAuction.minOutput = '';
       } else {
         const minMinOutput = getSmallestPossibleAmountAboveZero(get().swap.assetOut);
-        const exponent = getDisplayDenomExponent.optional(get().swap.assetOut) ?? 0;
+        const exponent = getDisplayDenomExponent.optional()(get().swap.assetOut) ?? 0;
         const minOutputAsBaseUnit = Number(minOutput) * 10 ** exponent;
         const outputLimitAsDisplayUnit = (OUTPUT_LIMIT / 10 ** exponent).toString();
 
@@ -144,7 +144,7 @@ export const createDutchAuctionSlice = (): SliceCreator<DutchAuctionSlice> => (s
         swap.dutchAuction.maxOutput = '';
       } else {
         const minMaxOutput = getSmallestPossibleAmountAboveZero(get().swap.assetOut);
-        const exponent = getDisplayDenomExponent.optional(get().swap.assetOut) ?? 0;
+        const exponent = getDisplayDenomExponent.optional()(get().swap.assetOut) ?? 0;
         const maxOutputAsBaseUnit = Number(maxOutput) * 10 ** exponent;
         const outputLimitAsDisplayUnit = (OUTPUT_LIMIT / 10 ** exponent).toString();