@goodaofi/bonds-sdk 3.0.123

package/dist/utils/displayHelpers.d.ts

@@ -0,0 +1,31 @@
+import { UserBill } from '../types/yourbonds';
+import { BondsData } from '../types/bonds';
+import { BillsConfig, LaunchBondTiers } from '@ape.swap/apeswap-lists';
+export declare const claimable: (userBill: UserBill) => number;
+export declare const claimableUSD: (userBill: UserBill) => number;
+export declare const earnTokenPrice: (bond: BondsData) => string;
+export declare const totalPending: (userBill: UserBill) => number;
+export declare const totalPendingUSD: (userBill: UserBill) => number;
+export declare const vestingTimeRemaining: (userBill: UserBill) => {
+    years: number;
+    months: number;
+    days: number;
+    hours: number;
+    minutes: number;
+    seconds: number;
+};
+export declare const vestingTimeRemainingString: (userBill?: UserBill) => string;
+export declare const getPendingVestingString: (bond?: UserBill) => string;
+export declare const getVestingTermsString: (bond?: BondsData | BillsConfig) => string;
+export declare const getVestingTermsTooltipString: (bond?: BondsData | BillsConfig) => string | undefined;
+export declare const discountEarnTokenPrice: (bond: BondsData, useTiers?: boolean) => string;
+export declare const discountEarnTokenPriceForUser: (bond: BondsData, useTiers?: boolean, userTier?: LaunchBondTiers) => string;
+export declare const maxBuy: (bond: BondsData, allowLowValueBonds: boolean) => BigNumber;
+export declare function formatNumber(input: string): string;
+export declare function formatUSDNumber(input: string): string;
+export declare const youSpendUSD: (bond: BondsData, inputValue: string) => string;
+export declare const getPayoutAmount: (bond?: BondsData, inputValue?: string, userPoints?: string) => number;
+export declare const youGetUSD: (bond: BondsData, inputValue: string, userPoints: string) => string;
+export declare const getRawBonus: (bond?: BondsData, inputValue?: string, userPoints?: string) => string;
+export declare const getFeeAmount: (bond?: BondsData, inputValue?: string, userPoints?: string) => number;
+export declare const getBonusColor: (premiumString: string) => string;

package/dist/utils/formatNumber.d.ts

@@ -0,0 +1,3 @@
+export declare const formatNumber: (number: number, minPrecision?: number, maxPrecision?: number) => string;
+export declare const formatNumberSI: (num: number | string, digits?: number) => string;
+export declare const formatUSDNumber: (input: string | number) => string;

package/dist/utils/formatNumbers.d.ts

@@ -0,0 +1,33 @@
+interface FormatDollarArgs {
+    num: number | undefined | null;
+    isPrice?: boolean;
+    lessPreciseStablecoinValues?: boolean;
+    digits?: number;
+    round?: boolean;
+}
+/**
+ * Returns a USD dollar or equivalent denominated numerical value formatted
+ * in human readable string for use in template.
+ *
+ * Adheres to guidelines for prices and other numbers defined here:
+ * https://www.notion.so/uniswaplabs/Number-standards-fbb9f533f10e4e22820722c2f66d23c0
+ * @param num numerical value denominated in USD or USD equivalent
+ * @param isPrice whether the amount represents a price or not
+ * @param lessPreciseStablecoinValues whether or not we should show less precise values for
+ * stablecoins (around 1$ in value always) for the sake of readability
+ * @param digits number of digits after the decimal for non-price amounts
+ * @param round whether or not to round up non-price amounts
+ */
+export declare const formatDollar: ({ num, isPrice, lessPreciseStablecoinValues, digits, round, }: FormatDollarArgs) => string;
+export declare const formatValue: ({ num, digits, round }: any) => string;
+/**
+ * Returns a numerical amount of any token formatted in human readable string for use in template.
+ *
+ * For transaction review numbers, such as token quantities, NFT price (token-denominated),
+ *  network fees, transaction history items. Adheres to guidelines defined here:
+ * https://www.notion.so/uniswaplabs/Number-standards-fbb9f533f10e4e22820722c2f66d23c0
+ * @param num numerical value denominated in any token
+ * @param maxDigits the maximum number of digits that should be shown for the quantity
+ */
+export declare const formatTransactionAmount: (num: number | undefined | null, maxDigits?: number) => string;
+export {};

package/dist/utils/getBalanceNumber.d.ts

@@ -0,0 +1,2 @@
+import BigNumber from 'bignumber.js';
+export declare const getBalanceNumber: (balance: BigNumber, decimals?: number) => number;

package/dist/utils/getDotPos.d.ts

@@ -0,0 +1 @@
+export declare const getDotPos: (index: number, carouselLength?: number) => number;

package/dist/utils/getNativeTicker.d.ts

@@ -0,0 +1,2 @@
+import { ChainId, Token } from '@ape.swap/apeswap-lists';
+export declare const getSymbol: (token?: Token | "NATIVE", chainId?: ChainId) => string | undefined;

package/dist/utils/getTimePeriods.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Format number of seconds into year, month, day, hour, minute, seconds
+ *
+ * @param seconds
+ */
+declare const getTimePeriods: (seconds: number, days?: boolean) => {
+    years: number;
+    months: number;
+    days: number;
+    hours: number;
+    minutes: number;
+    seconds: number;
+};
+export default getTimePeriods;

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+export declare function isAddress(value: any): string | false;

package/dist/utils/localStorageHelpers.d.ts

@@ -0,0 +1,3 @@
+export declare const getLocalStorage: (key: string) => any;
+export declare const setLocalStorage: (key: string, value: any) => void;
+export declare const removeLocalStorage: (key: string) => void;

package/dist/utils/multicall.d.ts

@@ -0,0 +1,7 @@
+export interface Call {
+    address: string;
+    name: string;
+    params?: any[];
+}
+declare const multicall: (chainId: number, abi: any[], calls: Call[], batch?: boolean, batchSize?: number) => Promise<any>;
+export default multicall;

package/dist/utils/numbers.d.ts

@@ -0,0 +1,5 @@
+export declare const isNumber: (s: string) => boolean;
+export declare const floorFormatter: (n: number) => string;
+export declare const volumeFormatter: (n: number) => string;
+export declare const quantityFormatter: (n: number) => string;
+export declare const roundWholePercentage: (n: number) => string;

package/dist/utils/remove0xPrefix.d.ts

@@ -0,0 +1 @@
+export declare const remove0xPrefix: (str?: string) => string | undefined;

package/dist/utils/reportError.d.ts

@@ -0,0 +1,8 @@
+export declare function reportError({ apiUrl, error, extraInfo, chainId, account, rpc, }: {
+    apiUrl?: string;
+    error: unknown;
+    extraInfo?: Record<string, any>;
+    chainId?: number;
+    account?: string;
+    rpc?: string;
+}): Promise<void>;

package/dist/utils/roundNumber.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Rounds a number to precision amount of signifant numbers
+ * @param n the number
+ * @param precision how many significant numbers to show
+ * @returns @number
+ */
+export declare const getFirstNonZeroDigits: (numberToParse: number, precision?: number) => string;

package/dist/utils/track.d.ts

@@ -0,0 +1,7 @@
+declare function track({ event, chain, data, value, }: {
+    event: string;
+    chain: number | undefined | string;
+    data: any;
+    value?: number | string;
+}): void;
+export default track;

package/dist/views/Bonds/Bonds.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+type SortableKeys = 'bonus' | 'arr' | 'terms' | 'tokensRemaining';
+type SortDirection = 'asc' | 'desc';
+export interface SortOptions {
+    key: SortableKeys;
+    direction: SortDirection;
+}
+declare const Bonds: () => React.JSX.Element;
+export default Bonds;

package/dist/views/Bonds/components/BannerTestnet/BannerTestnet.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+interface BannerTestnetProps {
+    chainId: number;
+}
+declare const BannerTestnet: React.FC<BannerTestnetProps>;
+export default BannerTestnet;

package/dist/views/Bonds/components/BondRows/BondRow.d.ts

@@ -0,0 +1,24 @@
+import React from 'react';
+import { TrueBondPrices } from '../../../../types/bonds';
+import { ChainId, LaunchBondTiers, Token } from '@ape.swap/apeswap-lists';
+interface BondRowProps {
+    bondAddress: string;
+    bondChain: ChainId;
+    payoutToken: Token;
+    billType: string;
+    tag?: string;
+    bondSoldOut?: boolean;
+    trueBondPrices?: TrueBondPrices[];
+    minTier?: LaunchBondTiers;
+    bonus?: string;
+    airdropTooltip?: string;
+    vestingTermString: string;
+    vestingCliffString?: string;
+    percentageAvailable: number;
+    remainingTokensString: string;
+    projectURL?: string;
+    twitterURL?: string;
+    auditURL?: string;
+}
+declare const BondRow: React.FC<BondRowProps>;
+export default BondRow;

package/dist/views/Bonds/components/BondRows/BondRowsByChain.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import { BondsData } from '../../../../types/bonds';
+import { BaseBondConfig } from '@ape.swap/apeswap-lists';
+export interface BondRowsByChainProps {
+    bonds: (BondsData | BaseBondConfig)[];
+    hideTitles: boolean;
+}
+declare const BondRowsByChain: React.FC<BondRowsByChainProps>;
+export default BondRowsByChain;

package/dist/views/Bonds/components/BondRows/BondRowsWithTitle.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { BondsData } from '../../../../types/bonds';
+import { BaseBondConfig } from '@ape.swap/apeswap-lists';
+export interface BondRowsWithTitleProps {
+    chain: number;
+    bonds: (BondsData | BaseBondConfig)[];
+    showHotBonds: boolean;
+}
+declare const BondRowsWithTitle: React.FC<BondRowsWithTitleProps>;
+export default BondRowsWithTitle;

package/dist/views/Bonds/components/BondRows/ChainTitle.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+declare const ChainTitle: ({ chain, pt, hideTitles, isOpen, }: {
+    chain: number;
+    pt: string;
+    hideTitles?: boolean;
+    isOpen: boolean;
+}) => React.JSX.Element;
+export default ChainTitle;

package/dist/views/Bonds/components/BondRows/ModalHandler.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+declare const ModalHandler: ({ onDismiss, bondAddress, bondChain, }: {
+    onDismiss?: () => void;
+    bondAddress: string;
+    bondChain: number;
+}) => React.JSX.Element;
+export default ModalHandler;

package/dist/views/Bonds/components/BondsMenu/BondsMenu.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+interface BondRowHeaderProps {
+    searchQuery: string;
+    setSearchQuery: (value: string) => void;
+    setChainFilterOption: (newValue: string[]) => void;
+    chainFilterOption: string[];
+    filterOptions: string[];
+    filterOption: string;
+    setFilterOption: (newOption: string) => void;
+    onSort: (key: 'bonus' | 'arr' | 'terms' | 'tokensRemaining') => void;
+}
+declare const BondsMenu: React.FC<BondRowHeaderProps>;
+export default BondsMenu;

package/dist/views/Bonds/components/BonusComponents/BonusComponent.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import { TrueBondPrices } from '../../../../types/bonds';
+import { LaunchBondTiers } from '@ape.swap/apeswap-lists';
+declare const BonusComponent: ({ trueBondPrices, minTier, bonus, airdropTooltip, tooltipPosition, }: {
+    trueBondPrices?: TrueBondPrices[];
+    minTier?: LaunchBondTiers;
+    bonus?: string;
+    airdropTooltip?: string;
+    tooltipPosition: "bottomRight" | "bottomLeft";
+}) => React.JSX.Element;
+export default BonusComponent;

package/dist/views/Bonds/components/BonusComponents/BonusContainer.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import { LaunchBondTiers } from '@ape.swap/apeswap-lists';
+import { TrueBondPrices } from '../../../../types/bonds';
+declare const BonusContainer: ({ trueBondPrices, minTier, bonus, airdropTooltip, tooltipPosition, }: {
+    trueBondPrices?: TrueBondPrices[];
+    minTier?: LaunchBondTiers;
+    bonus?: string;
+    airdropTooltip?: string;
+    tooltipPosition?: "bottomRight" | "bottomLeft";
+}) => React.JSX.Element;
+export default BonusContainer;

package/dist/views/Bonds/components/BonusComponents/BonusTable.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import { TrueBondPrices } from '../../../../types/bonds';
+import { LaunchBondTiers } from '@ape.swap/apeswap-lists';
+declare const BonusTable: ({ trueBondPrices, minTier, hideTitle, }: {
+    trueBondPrices?: TrueBondPrices[];
+    minTier?: LaunchBondTiers;
+    hideTitle?: boolean;
+}) => React.JSX.Element;
+export default BonusTable;

package/dist/views/Bonds/components/BuyAgainRow/index.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const BuyAgainRow: () => React.JSX.Element | null;
+export default BuyAgainRow;

package/dist/views/Bonds/components/CheckURL/index.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+/** CheckURL purpose is to open the buy bond modal ONLY IF a user has opened the site with a custom URL  */
+declare const CheckUrl: () => React.JSX.Element;
+export default CheckUrl;

package/dist/views/Bonds/components/HotBondCards/HotBondCard.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import { BondsData } from '../../../../types/bonds';
+declare const HotBondCard: ({ bond }: {
+    bond: BondsData;
+}) => React.JSX.Element;
+export default HotBondCard;

package/dist/views/Bonds/components/HotBondCards/index.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import 'swiper/swiper.min.css';
+declare const HotBondCards: () => React.JSX.Element;
+export default HotBondCards;

package/dist/views/Bonds/components/HotBondCards/styles.d.ts

@@ -0,0 +1,2 @@
+import { ThemeUIStyleObject } from 'theme-ui';
+export declare const styles: Record<string, ThemeUIStyleObject>;

package/dist/views/Bonds/components/RecommendationCards/SmallRecommendationCard.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+import { ChainId } from '@ape.swap/apeswap-lists';
+export interface SmallCardBond {
+    vestingTerm: number;
+    payoutTokenName: string;
+    contractAddress: string;
+    bonus: number;
+    chainId: ChainId;
+}
+declare const SmallRecommendationCard: ({ recommendation }: {
+    recommendation: SmallCardBond;
+}) => React.JSX.Element;
+export default SmallRecommendationCard;

package/dist/views/Bonds/components/RecommendationCards/index.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import { ChainId } from '@ape.swap/apeswap-lists';
+export interface SmallCardBond {
+    vestingTerm: number;
+    payoutTokenName: string;
+    contractAddress: string;
+    bonus: number;
+    chainId: ChainId;
+}
+declare const RecommendationCards: () => React.JSX.Element;
+export default RecommendationCards;

package/dist/views/Bonds/components/RecommendationCards/styles.d.ts

@@ -0,0 +1,2 @@
+import { ThemeUIStyleObject } from 'theme-ui';
+export declare const styles: Record<'smallCardContainer' | 'subTitle', ThemeUIStyleObject>;

package/dist/views/Bonds/index.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { SDKPropsDTO } from '../../state/useSDKConfig';
+declare const BondsWithProviders: React.FC<SDKPropsDTO>;
+export default BondsWithProviders;

package/dist/views/Bonds/utils.d.ts

@@ -0,0 +1,18 @@
+import { BondsData } from '../../types/bonds';
+import { SortOptions } from './Bonds';
+import { BillsConfig } from '@ape.swap/apeswap-lists';
+export declare const isBondSoldOut: (bill: BondsData, showLowValueBonds?: boolean) => boolean;
+export declare const sortBonds: (sortConfig?: SortOptions, bonds?: BondsData[]) => BondsData[];
+export declare const vestingTime: (vestingTerm?: number) => {
+    years: number;
+    months: number;
+    days: number;
+    hours: number;
+    minutes: number;
+    seconds: number;
+};
+export declare const remainingPercentage: (bond: BondsData) => number;
+export declare const getDiscountColor: (discount?: number) => string;
+export declare const calculateARR: (bond: BondsData | BillsConfig, useTiers: boolean) => string;
+export declare const isBondSupported: (SDKVersion: string, bondVersion: string) => boolean;
+export declare const getRemainingTokensString: (bond: BondsData | BillsConfig) => string;

package/dist/views/BuyBond/BuyBond.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+export interface BuyBondProps {
+    onDismiss?: () => void;
+    bondAddress?: string;
+    bondChain?: number;
+    handlePurchasedBond?: (hash: string) => void;
+    isProjectView?: boolean;
+}
+declare const BuyBond: React.FC<BuyBondProps>;
+export default BuyBond;

package/dist/views/BuyBond/BuyBondModal.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { BuyBondProps } from './BuyBond';
+declare const BuyBondModal: React.FC<BuyBondProps>;
+export default BuyBondModal;

package/dist/views/BuyBond/components/BondCards.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import { BondsData } from '../../../types/bonds';
+declare const BondCards: ({ bondData }: {
+    bondData: BondsData;
+}) => React.JSX.Element;
+export default BondCards;

package/dist/views/BuyBond/components/BondModalHeader.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { BondsData } from '../../../types/bonds';
+declare const BondModalHeader: ({ bondData, onDismiss, showProjectInfoButton, }: {
+    bondData: BondsData;
+    onDismiss?: () => void;
+    showProjectInfoButton?: boolean;
+}) => React.JSX.Element;
+export default BondModalHeader;

package/dist/views/BuyBond/components/BondModalMinTierHeader.d.ts

@@ -0,0 +1,5 @@
+import { LaunchBondTiers } from '@ape.swap/apeswap-lists';
+declare const BondModalMinTierHeader: ({ minTier }: {
+    minTier: LaunchBondTiers | null;
+}) => import("react").JSX.Element;
+export default BondModalMinTierHeader;

package/dist/views/BuyBond/components/Estimations.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import { BondsData } from '../../../types/bonds';
+declare const Estimations: ({ depositAmount, bondData, youSpendString, isZap, fetchingZapQuote, zapError, }: {
+    depositAmount: string;
+    bondData: BondsData;
+    youSpendString?: string;
+    isZap?: boolean;
+    fetchingZapQuote?: boolean;
+    zapError?: boolean;
+}) => React.JSX.Element;
+export default Estimations;

package/dist/views/BuyBond/components/ExpandedViewButton.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+declare const ExpandedViewButton: ({ handleNavigation, rightPos }: {
+    handleNavigation: () => void;
+    rightPos?: string;
+}) => React.JSX.Element;
+export default ExpandedViewButton;

package/dist/views/BuyBond/components/GetUpToComponent/GetUpToComponent.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { BondsData } from '../../../../types/bonds';
+interface GetUpToComponentProps {
+    bond: BondsData;
+    depositAmount: string;
+}
+declare const GetUpToComponent: React.FC<GetUpToComponentProps>;
+export default GetUpToComponent;

package/dist/views/BuyBond/components/NewRateModal/NewRateModal.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+import { BondsData } from '../../../../types/bonds';
+declare const NewRateModal: ({ bond, zapTrueBondPrice, depositAmount, youSpendString, fetchingZapQuote, zapError, onDismiss, }: {
+    bond?: BondsData;
+    zapTrueBondPrice?: string;
+    depositAmount: string;
+    youSpendString?: string;
+    fetchingZapQuote?: boolean;
+    zapError?: boolean;
+    onDismiss?: () => void;
+}) => React.JSX.Element;
+export default NewRateModal;

package/dist/views/BuyBond/components/NoBonusModal/NoBonusModal.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+interface NoBonusModalProps {
+    showcaseTokenName?: string;
+    onAcknowledge: () => void;
+}
+declare const NoBonusModal: React.FC<NoBonusModalProps>;
+export default NoBonusModal;

package/dist/views/BuyBond/components/ProjectDescription.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+declare const ProjectDescription: ({ description, isProjectView }: {
+    description?: string;
+    isProjectView?: boolean;
+}) => React.JSX.Element;
+export default ProjectDescription;

package/dist/views/BuyBond/findHighestTrueBondPrice.d.ts

@@ -0,0 +1,15 @@
+import { BondsData, TrueBondPrices } from '../../types/bonds';
+/**
+ * Finds the highest TrueBondPrices element where userPoints is higher than points in the array.
+ * @param userPoints - The user's points as a string representing a BigNumber.
+ * @param bondData - Bond Data containing an array of TrueBondPrices to analyze.
+ * @returns The highest TrueBondPrices element where userPoints is higher than the item's points, or `undefined` if none matches.
+ */
+export declare const findHighestTrueBondPrice: (userPoints?: string | null, bondData?: BondsData) => TrueBondPrices | undefined;
+export declare const findHighestTrueBondPrices: (userPoints?: string | null, trueBondPrices?: TrueBondPrices[]) => TrueBondPrices | undefined;
+/**
+ * Finds the TrueBondPrices element with the highest points in the array, regardless of user points.
+ * @param bondData - Bond Data containing an array of TrueBondPrices to analyze.
+ * @returns The TrueBondPrices element with the highest points, or `undefined` if no data is available.
+ */
+export declare const findHighestTrueBondPriceUserAgnostic: (bondData?: BondsData) => TrueBondPrices | undefined;

package/dist/views/BuyBond/index.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { BuyBondProps } from './BuyBond';
+import { SDKProps } from '../../state/useSDKConfig';
+interface Props extends SDKProps, BuyBondProps {
+}
+declare const BuyBondModalWithProviders: React.FC<Props>;
+export default BuyBondModalWithProviders;

package/dist/views/FullBondsView/FullBondsView.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+export declare enum BondsViewOptions {
+    BONDSMARKET = "Bonds Market",
+    YOURBONDS = "Your Bonds"
+}
+declare const FullBondsView: () => React.JSX.Element;
+export default FullBondsView;

package/dist/views/FullBondsView/index.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { SDKPropsDTO } from '../../state/useSDKConfig';
+declare const FullBondsViewWithProviders: React.FC<SDKPropsDTO>;
+export default FullBondsViewWithProviders;

package/dist/views/GooSale/GooSale.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+export declare enum BondsViewOptions {
+    BONDSMARKET = "Bonds Market",
+    YOURBONDS = "Your Bonds"
+}
+declare const GooSale: () => React.JSX.Element;
+export default GooSale;