@ape.swap/bonds-sdk 1.0.0 → 1.0.2

package/dist/cjs/types/config/constants/queryKeys.d.ts

@@ -0,0 +1,18 @@
+export declare const QUERY_KEYS: {
+    INDUSTRY_STATS: string;
+    HISTORICAL_INDUSTRY_STATS: string;
+    LHD_PROFILES: string;
+    LHD_PROFILE: string;
+    LHD_PASSWORD_VERIFIED: string;
+    HOMEPAGE_STATS: string;
+    LIVE_AND_UPCOMING: string;
+    TVL_STATS: string;
+    TOKEN_HISTORIC: string;
+    BONDS_LANDING: string;
+    BOND_POST_REFERENCE: string;
+    BOND_RECOMMENDATIONS: string;
+    TOKEN_PRICES: string;
+    TIERS: string;
+    BOND_STATS: string;
+    HOT_BONDS: string;
+};

package/dist/cjs/types/config/constants/routing.d.ts

@@ -0,0 +1,31 @@
+import { Currency, Token } from '@ape.swap/sdk-core';
+type ChainTokenList = {
+    readonly [chainId: number]: Token[];
+};
+type ChainCurrencyList = {
+    readonly [chainId: number]: Currency[];
+};
+export declare const BASES_TO_CHECK_TRADES_AGAINST: ChainTokenList;
+export declare const ADDITIONAL_BASES: {
+    [chainId: number]: {
+        [tokenAddress: string]: Token[];
+    };
+};
+/**
+ * Some tokens can only be swapped via certain pairs, so we override the list of bases that are considered for these
+ * tokens.
+ */
+export declare const CUSTOM_BASES: {
+    [chainId: number]: {
+        [tokenAddress: string]: Token[];
+    };
+};
+/**
+ * Shows up in the currency select for swap and add liquidity
+ */
+export declare const COMMON_BASES: ChainCurrencyList;
+export declare const BASES_TO_TRACK_LIQUIDITY_FOR: ChainTokenList;
+export declare const PINNED_PAIRS: {
+    readonly [chainId: number]: [Token, Token][];
+};
+export {};

package/dist/cjs/types/config/constants/tokens.d.ts

@@ -0,0 +1,29 @@
+import { NativeCurrency, Token } from '@ape.swap/sdk-core';
+export declare const NATIVE_CHAIN_ID = "NATIVE";
+export declare const DEFAULT_ERC20_DECIMALS = 18;
+export declare const USDC_MAINNET: Token;
+export declare const USDC_POLYGON: Token;
+export declare const DAI_POLYGON: Token;
+export declare const USDT_POLYGON: Token;
+export declare const WBTC_POLYGON: Token;
+export declare const AMPL: Token;
+export declare const DAI: Token;
+export declare const USDT: Token;
+export declare const WBTC: Token;
+export declare const FEI: Token;
+export declare const TRIBE: Token;
+export declare const FRAX: Token;
+export declare const FXS: Token;
+export declare const renBTC: Token;
+export declare const ETH2X_FLI: Token;
+export declare const sETH2: Token;
+export declare const rETH2: Token;
+export declare const SWISE: Token;
+export declare const WETH_POLYGON: Token;
+export declare const BANANA: {
+    [chainId: number]: Token;
+};
+export declare const WRAPPED_NATIVE_CURRENCY: {
+    [chainId: number]: Token | undefined;
+};
+export declare function nativeOnChain(chainId: number): NativeCurrency | Token;

package/dist/cjs/types/config/constants/tutorials.d.ts

@@ -0,0 +1,7 @@
+import { SupportedChainId } from '@ape.swap/sdk-core';
+export declare const getMetamaskLinks: (chainId: SupportedChainId) => "https://docs.bnbchain.org/docs/wallet/metamask/" | "https://wiki.polygon.technology/docs/tools/wallets/metamask/config-polygon-on-metamask/" | "https://metamask.io/faqs/" | "https://decentralizedcreator.com/add-telos-evm-network-to-metamask/" | "https://academy.binance.com/en/articles/how-to-add-arbitrum-to-metamask";
+export declare const ROUTE_NAMES: Record<string, string>;
+export declare const FARMS: Record<string, string>;
+export declare const apebond = "https://docs.ape.bond/apebond/";
+export declare const APEBOND_DOC_LINKS: Record<string, string>;
+export declare const HELP_LINK: string;

package/dist/cjs/types/config/localization/languages.d.ts

@@ -0,0 +1,11 @@
+import { Language } from '../../contexts/Localization/types';
+export declare const EN: Language;
+export declare const ESES: Language;
+export declare const JA: Language;
+export declare const PTBR: Language;
+export declare const RU: Language;
+export declare const TR: Language;
+export declare const ZHCN: Language;
+export declare const ZHTW: Language;
+export declare const languages: Record<string, Language>;
+export declare const languageList: Language[];

package/dist/cjs/types/contexts/GlobalStyles.d.ts

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

package/dist/cjs/types/contexts/Localization/Provider.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { ContextApi } from './types';
+export declare const languageMap: Map<string, Record<string, string>>;
+export declare const LanguageContext: React.Context<ContextApi | undefined>;
+export declare const LanguageProvider: ({ children }: {
+    children: React.ReactNode;
+}) => React.JSX.Element;

package/dist/cjs/types/contexts/Localization/helpers.d.ts

@@ -0,0 +1,3 @@
+export declare const LS_KEY = "apeswap_language";
+export declare const fetchLocale: (locale: string) => Promise<any>;
+export declare const getLanguageCodeFromLS: () => any;

package/dist/cjs/types/contexts/Localization/index.d.ts

@@ -0,0 +1,3 @@
+export * from './Provider';
+export { default as useTranslation } from './useTranslation';
+export type { TranslateFunction } from './types';

package/dist/cjs/types/contexts/Localization/types.d.ts

@@ -0,0 +1,21 @@
+import translations from '../../config/localization/translations.json';
+export interface Language {
+    code: string;
+    language: string;
+    locale: string;
+}
+export type ContextData = {
+    [key: string]: string | number;
+};
+export interface ProviderState {
+    isFetching: boolean;
+    currentLanguage: Language;
+}
+export interface ContextApi extends ProviderState {
+    setLanguage: (language: Language) => void;
+    t: TranslateFunction;
+}
+type MaybeObject = Record<never, never>;
+export type TranslationKey = keyof typeof translations | (string & MaybeObject);
+export type TranslateFunction = (key: TranslationKey, data?: ContextData) => string;
+export {};

package/dist/cjs/types/contexts/Localization/useTranslation.d.ts

@@ -0,0 +1,2 @@
+declare const useTranslation: () => import("./types").ContextApi;
+export default useTranslation;

package/dist/cjs/types/contexts/MatchBreakpoints.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+type State = {
+    [key: string]: boolean;
+};
+export type BreakpointChecks = {
+    isMobile: boolean;
+    isTablet: boolean;
+    isDesktop: boolean;
+} & State;
+export declare const MatchBreakpointsContext: React.Context<BreakpointChecks>;
+export declare const getBreakpointChecks: (state: State) => BreakpointChecks;
+export declare const MatchBreakpointsProvider: ({ children }: {
+    children: React.ReactNode;
+}) => React.JSX.Element;
+export {};

package/dist/cjs/types/contexts/ModalContext.d.ts

@@ -0,0 +1,14 @@
+import React from 'react';
+interface ModalsContext {
+    nodeId: string[];
+    modalNode: React.ReactNode[];
+    setModalNode: React.Dispatch<React.SetStateAction<React.ReactNode[]>>;
+    onPresent: (node: React.ReactNode, newNodeId: string, clearModalStack: boolean) => void;
+    handleClose: () => void;
+    setCloseOnOverlayClick: React.Dispatch<React.SetStateAction<boolean>>;
+}
+export declare const Context: React.Context<ModalsContext>;
+declare const ModalProvider: ({ children }: {
+    children: React.ReactNode;
+}) => React.JSX.Element;
+export default ModalProvider;

package/dist/cjs/types/contexts/RefreshContext.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+declare const RefreshContext: React.Context<{
+    slow: number;
+    fast: number;
+    veryFast: number;
+}>;
+declare const RefreshContextProvider: React.FC<{
+    children: React.ReactNode;
+}>;
+export { RefreshContext, RefreshContextProvider };

package/dist/cjs/types/utils/connection/activate.d.ts

@@ -0,0 +1,3 @@
+import { Connection } from './types';
+declare const useActivate: () => (connection: Connection) => Promise<void>;
+export default useActivate;

package/dist/cjs/types/utils/connection/index.d.ts

@@ -0,0 +1,9 @@
+import { WalletConnect as WalletConnectV2 } from '@web3-react/walletconnect-v2';
+import { Connection } from './types';
+export declare const networkConnection: Connection;
+export declare const injectedConnection: Connection;
+export declare const gnosisSafeConnection: Connection;
+export declare const web3WalletConnectV2: WalletConnectV2, web3WalletConnectHooksV2: import("@web3-react/core").Web3ReactHooks;
+export declare const walletConnectConnection: Connection;
+export declare const coinbaseWalletConnection: Connection;
+export declare const listOfConnections: Connection[];

package/dist/cjs/types/utils/connection/types.d.ts

@@ -0,0 +1,14 @@
+import { Connector } from '@web3-react/types';
+import { Web3ReactHooks } from '@web3-react/core';
+export declare enum ConnectionType {
+    INJECTED = "INJECTED",
+    COINBASE_WALLET = "COINBASE_WALLET",
+    WALLET_CONNECT = "WALLET_CONNECT",
+    NETWORK = "NETWORK",
+    GNOSIS_SAFE = "GNOSIS_SAFE"
+}
+export interface Connection {
+    connector: Connector;
+    hooks: Web3ReactHooks;
+    type: ConnectionType;
+}

package/dist/cjs/types/utils/connection/utils.d.ts

@@ -0,0 +1,8 @@
+import { Connector } from '@web3-react/types';
+import { Connection, ConnectionType } from './types';
+/**
+ * @param connection Connection to get the type
+ * @returns The string name of the connection
+ */
+export declare const getConnectionName: (connection: Connection) => string;
+export declare function getConnection(c: Connector | ConnectionType): Connection;

package/dist/cjs/types/utils/formatNumbers.d.ts

@@ -0,0 +1,36 @@
+import { Currency, CurrencyAmount, Price } from '@ape.swap/sdk-core';
+export declare const currencyAmountToPreciseFloat: (currencyAmount: CurrencyAmount<Currency> | undefined) => number | undefined;
+export declare const priceToPreciseFloat: (price: Price<Currency, Currency> | undefined) => number | undefined;
+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/cjs/types/utils/getBalanceNumber.d.ts

@@ -0,0 +1,4 @@
+import BigNumber from 'bignumber.js';
+export declare const getBalanceNumber: (balance: BigNumber, decimals?: number) => number;
+export declare const getFullDisplayBalance: (balance: BigNumber, decimals?: number) => string;
+export declare const getBNWithDecimals: (balance: BigNumber | string | undefined, decimals?: number) => undefined | BigNumber;

package/dist/cjs/types/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/cjs/types/utils/index.d.ts

@@ -0,0 +1,16 @@
+import { Contract } from '@ethersproject/contracts';
+import type { JsonRpcProvider } from '@ethersproject/providers';
+import { ChainId } from '../config/constants/chains';
+export declare function isAddress(value: any): string | false;
+export declare function getContract(address: string, ABI: any, provider: JsonRpcProvider, account?: string): Contract;
+export declare function isSupportedChain(chainId: number | null | undefined): chainId is ChainId;
+export declare function getEtherscanLink(data: string | number, type: 'transaction' | 'token' | 'address' | 'block' | 'countdown', chainId: ChainId): string;
+/**
+ * Prompt the user to add a custom token to metamask
+ * @param tokenAddress
+ * @param tokenSymbol
+ * @param tokenDecimals
+ * @param tokenImage
+ * @returns {boolean} true if the token has been added, false otherwise
+ */
+export declare const registerToken: (tokenAddress: string, tokenSymbol: string | undefined, tokenDecimals: number, tokenImage: string | undefined) => Promise<void | null>;

package/dist/cjs/types/utils/isZero.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Returns true if the string value is zero in hex
+ * @param hexNumberString
+ */
+export default function isZero(hexNumberString: string): boolean;

package/dist/cjs/types/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/cjs/types/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/cjs/types/utils/safeNamehash.d.ts

@@ -0,0 +1 @@
+export declare function safeNamehash(name?: string): string | undefined;

package/dist/cjs/types/utils/supportedChainId.d.ts

@@ -0,0 +1,6 @@
+import { SupportedChainId } from '@ape.swap/sdk-core';
+/**
+ * Returns the input chain ID if chain is supported. If not, return undefined
+ * @param chainId a chain ID, which will be returned if it is a supported chain ID
+ */
+export declare function supportedChainId(chainId: number | undefined): SupportedChainId | undefined;

package/dist/cjs/types/utils/switchChain.d.ts

@@ -0,0 +1,3 @@
+import { Connector } from '@web3-react/types';
+import { ChainId } from '@ape.swap/apeswap-lists';
+export declare const switchChain: (connector: Connector, chainId: ChainId) => Promise<void>;

package/dist/cjs/types/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/cjs/types/views/Bonds/Bonds.d.ts

@@ -0,0 +1,2 @@
+declare const Bonds: () => import("theme-ui/jsx-runtime").JSX.Element;
+export default Bonds;

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

@@ -0,0 +1 @@
+export { default } from './Bonds';

package/dist/cjs/types/views/Bonds/styles.d.ts

@@ -0,0 +1,4 @@
+import { ThemeUIStyleObject } from 'theme-ui';
+export declare function getColumnDiscountStyle(discount: number): ThemeUIStyleObject;
+export declare const styles: Record<'tableContainer' | 'headerContainer' | 'bondrowContainer' | 'columnToken' | 'columnDiscount' | 'columnArr' | 'columnTerm' | 'columnTokensRemaining' | 'hotBond', ThemeUIStyleObject>;
+export default styles;

package/dist/cjs/types/views/Bonds/type.d.ts

@@ -0,0 +1,66 @@
+import { BillArtCollection, BillVersion, ChainId, Token } from "@ape.swap/apeswap-lists";
+export interface BondsDataResponse {
+    index: number;
+    cmcId?: number;
+    label: string;
+    chainId: ChainId;
+    type: string;
+    principalToken: string;
+    principalTokenName: string;
+    principalTokenDecimals: number;
+    payoutToken: string;
+    payoutTokenName: string;
+    payoutTokenDecimals: number;
+    discount: number;
+    billAddress: string;
+    billNftAddress: string;
+    initTime: number;
+    soldOut: boolean;
+    inactive: boolean;
+    trueBillPrice: string;
+    maxTotalPayout: string;
+    totalPayoutGiven: string;
+    maxPayout: string;
+    tokensRemaining: string;
+    showcaseToken: string;
+    showcaseTokenName: string;
+    vestingTerm: number;
+    principalTokenPrice: string;
+    payoutTokenPrice: string;
+    priceUsd: string;
+    tags?: string[];
+    arr: string;
+}
+export interface BillsConfig {
+    index: number;
+    cmcId?: number;
+    chainId: ChainId;
+    contractAddress: Partial<Record<ChainId, string>>;
+    billVersion: BillVersion;
+    billType: 'liquidity' | 'reserve' | 'launch' | 'migration' | 'cex';
+    token: Token;
+    quoteToken: Token;
+    lpToken: Token;
+    earnToken: Token;
+    billNnftAddress: Partial<Record<ChainId, string>>;
+    inactive?: boolean;
+    projectLink?: string;
+    twitter?: string;
+    initTime?: Partial<Record<ChainId, number>>;
+    initPrice?: Partial<Record<ChainId, number>>;
+    audit?: string;
+    soldOut?: boolean;
+    billArt?: {
+        collection: BillArtCollection;
+    };
+    showcaseToken?: Token;
+    bondPartner?: string;
+    shortDescription?: string;
+    fullDescription?: string;
+    featuredURLS?: string[];
+    partnersURLS?: string[];
+    tags?: string[];
+    vestingTerm?: number;
+    multiplier?: number;
+    onlyPartner?: boolean;
+}

package/dist/cjs/types/views/index.d.ts

@@ -1 +1 @@
-export { default as ClaimLifi } from './ClaimLifi';
+export { default as Bonds } from './Bonds';