@ape.swap/bonds-sdk 1.0.1 → 1.0.2-seedify

package/dist/scss/YourBondsModal.scss

@@ -0,0 +1,314 @@
+.yourbondsmodal-backdrop {
+    position: fixed;
+    top: 0;
+    left: 0;
+    width: 100%;
+    height: 100%;
+    background-color: rgba(66, 66, 66, 0.5);
+    display: flex;
+    justify-content: center;
+    align-items: center;
+    z-index: 1000;
+    overflow: auto;
+    padding: 50px;
+}
+
+.yourbondsmodal-content {
+    display: flex;
+    flex-direction: column;
+    border-radius: 10px;
+    background-color: var(--theme-ui-colors-white2);
+    padding: 10px;
+    border-radius: 10px;
+    z-index: 1001;
+    max-width: 1200px;
+    min-width: 1000px;
+    height: auto;
+    max-height: 60vh;
+    min-height: 400px;
+    overflow: auto;
+}
+
+.yourbondsmodal-spinner {
+    display: flex;
+    justify-content: center;
+    align-items: center;
+    height: 100vh;
+    width: 100vw;
+}
+
+.yourbondsmodal-header {
+    display: flex;
+    justify-content: flex-end;
+    align-items: center;
+    padding: 5px;
+
+    .svg-close {
+        height: 12px;
+        width: 12px;
+        cursor: pointer;
+    }
+}
+
+.yourbondsmodal.table-container {
+    width: 100%;
+    display: flex;
+    flex-direction: row; 
+    padding-left: 10px;
+    padding-right: 10px;
+    padding-bottom: 10px;
+}
+
+.yourbondsmodal.bondimage {
+    width: 60%;
+    height: 100%;
+    display: flex;
+    flex-direction: column; 
+    padding-left: 10px;
+    padding-right: 10px;
+    padding-bottom: 10px;
+}
+
+.yourbondsmodal.yourbondinfo {
+    width: 40%;
+    height: 100%;
+    display: flex;
+    flex-direction: column; 
+    padding-left: 10px;
+    padding-right: 10px;
+    padding-bottom: 10px;
+}
+
+.yourbondinfo.title-container {
+    font-weight: bold;
+    font-size: 1.5rem;
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+    padding-top: 5px;
+    padding-bottom: 5px;
+}
+
+.title-container.bondicon {
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+}
+
+.icon-container {
+    position: relative;
+    display: inline-block;
+}
+
+.icon-container svg {
+    position: absolute;
+    top: -8px;
+    right: -5px;
+    z-index: 1; 
+}
+
+.icon-container img {
+    display: block; 
+}
+
+.icon-container-small {
+    position: relative;
+    display: inline-block;
+}
+
+.icon-container-small svg {
+    position: absolute;
+    top: -5px;
+    right: -4px;
+    z-index: 1; 
+}
+
+.icon-container-small img {
+    display: block; 
+}
+   
+
+.title-container.tokenname {
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+    padding-left: 10px;
+}
+
+.title-container.tokentags {
+    display: flex;
+    align-items: center;
+    padding-left: 10px;
+}
+
+.yourbondinfo.blocks-container {
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+    width: 100%;
+    height: 100%;
+    justify-content: space-around;
+    margin-bottom: 10px;
+    margin-top: 5px;
+}
+
+.yourbondinfo-block.header {
+    color: white;
+    align-items: center;
+    width: 50%;
+    font-size: 12px; 
+    font-weight: 400; 
+    opacity: 0.6; 
+    line-height: 14px;
+}
+
+.yourbondinfo-block.header-title {
+    align-items: center;
+}
+
+.yourbondinfo-block.header-tooltip {
+    align-items: center;
+}
+
+.block-header.icon {
+    padding-left: 5px;
+    align-items: flex-start;
+    cursor: pointer;
+}
+
+.yourbondinfo-block.info {
+    flex-direction: row;
+    align-items: center;
+    justify-content: flex-end;
+    width: 50%;
+    display: flex;
+    background: var(--theme-ui-colors-white3);
+    border-radius: 10px;
+    padding-top: 10px;
+    padding-bottom: 10px;
+}
+
+.block-info.icon {
+    align-items: center;
+}
+
+.block-info.text {
+    padding-left: 10px;
+}
+
+.attributes-container {
+    flex-direction: column;
+    width: 100%;
+    padding-bottom: 10px;
+    align-items: center;
+
+    .attributes-header {
+        justify-content: space-between;
+        height: 24px;
+        background-color: var(--theme-ui-colors-white3); 
+        padding-left: 15px;
+        padding-right: 15px;
+        width: 100%;
+    }
+}
+
+.yourbondinfo-block.row-vested {
+    flex-direction: row;
+    height: 50px;
+    width: 100%;
+    margin-bottom: 10px;
+    padding-left: 10px;
+    padding-right: 10px;
+    align-items: center;
+    justify-content: space-between;
+    background: var(--theme-ui-colors-white3);
+    border-radius: 10px;
+    padding-top: 10px;
+    padding-bottom: 10px;
+}
+
+.yourbondinfo-block.row-pending {
+    flex-direction: row;
+    height: 50px;
+    width: 100%;
+    margin-bottom: 10px;
+    padding-left: 10px;
+    padding-right: 10px;
+    align-items: center;
+    justify-content: space-between;
+    background: var(--theme-ui-colors-white3);
+    border-radius: 10px;
+    padding-top: 10px;
+    padding-bottom: 10px;
+}
+
+.yourbondinfo-block.row-claimable {
+    flex-direction: row;
+    height: 50px;
+    width: 100%;
+    margin-bottom: 10px;
+    padding-left: 10px;
+    padding-right: 10px;
+    align-items: center;
+    justify-content: space-between;
+    background: var(--theme-ui-colors-white3);
+    border-radius: 10px;
+    padding-top: 10px;
+    padding-bottom: 10px;
+}
+
+.yourbondinfo.button-container {
+    width: 100%;
+    padding-top: 10px;
+    display: flex;
+    flex-direction: row;
+    justify-content: space-between;
+}
+
+.button-container.claim {
+    justify-content: center;
+    align-items: center;
+    cursor: pointer;    
+
+    .switch-button {
+        width: 300px;
+    }
+
+    .claim-button {
+        width: 300px;
+    }
+}
+
+.button-container.transfer {
+    justify-content: center;
+    align-items: center;
+
+    .transfer-button {
+        width: 125px;
+    }
+}
+
+.toast {
+    position: fixed;
+    top: 50px;
+    right: 20px;
+    background-color: var(--theme-ui-colors-white2);
+    color: white;
+    font-size: 24px;
+    padding: 10px 20px;
+    border-radius: 5px;
+    box-shadow: 0 0 10px rgba(0, 0, 0, 0.1);
+    z-index: 9999;
+    animation: fadein 0.5s, fadeout 0.5s 4.5s;
+    cursor: pointer;
+}
+
+@keyframes fadein {
+    from { top: 0; opacity: 0; }
+    to { top: 50px; opacity: 1; }
+}
+
+@keyframes fadeout {
+    from { top: 50px; opacity: 1; }
+    to { top: 0; opacity: 0; }
+}

package/dist/scss/index.scss

@@ -0,0 +1,12 @@
+@use 'AccordionText';
+@use 'BondMenu';
+@use 'BondModal';
+@use 'BondRow';
+@use 'BondRowHeader';
+@use 'BondRowsByChain';
+@use 'BondRowsWithTitle';
+@use 'Bonds';
+@use 'ProgressBar';
+@use 'TokenInfoName';
+@use 'YourBonds';
+@use 'YourBondsModal';

package/dist/state/allowance/useAllowance.d.ts

@@ -0,0 +1,15 @@
+import { UseQueryResult } from '@tanstack/react-query';
+import { ChainId, Token } from '@ape.swap/apeswap-lists';
+/**
+ * useAllowance hook: fetches the amount approved by the user for a given token
+ * useApproval hook: returns the approval state (not approved, pending or approved) and a function to approve on chain
+ * getTokenAllowance function fetches the allowance on chain
+ */
+export declare enum ApprovalState {
+    NOT_APPROVED = "NOT_APPROVED",
+    PENDING = "PENDING",
+    APPROVED = "APPROVED"
+}
+export default function useAllowance(currency: 'NATIVE' | Token | null, spender: string | null, account: string | null, chainId: ChainId | null): UseQueryResult<number>;
+export declare const getTokenAllowance: (currency: "NATIVE" | Token | null, spender: string | null, account: string | null, chainId: ChainId | null) => Promise<number | null>;
+export declare const useApproval: (amount: string, currency: "NATIVE" | Token | null, spender: string | null, account: string | null, chainId: ChainId | null) => [ApprovalState, () => Promise<string | null | undefined>];

package/dist/state/balance/useCurrencyBalance.d.ts

@@ -0,0 +1,4 @@
+import { UseQueryResult } from '@tanstack/react-query';
+import { ChainId, Token } from '@ape.swap/apeswap-lists';
+export default function useCurrencyBalance(currency: 'NATIVE' | Token | null, account: string | null, chainId: ChainId | null): UseQueryResult<string | undefined>;
+export declare const getTokenBalance: (currency: "NATIVE" | Token | null, account: string | null, chainId: ChainId | null) => Promise<string | null>;

package/dist/state/bonds/useBondNFTData.d.ts

@@ -0,0 +1,5 @@
+import { UseQueryResult } from '@tanstack/react-query';
+import { ChainId } from '@ape.swap/apeswap-lists';
+import { UserBillNftData } from '../../types/yourbonds';
+export default function useBondNFTData(id?: string, billNftAddress?: string, chainId?: ChainId): UseQueryResult<UserBillNftData>;
+export declare const getBondNFTData: (id: string, billNftAddress: string, chainId: ChainId) => Promise<UserBillNftData | undefined>;

package/dist/state/bonds/useBondsData.d.ts

@@ -0,0 +1,4 @@
+import { UseQueryResult } from '@tanstack/react-query';
+import { BondsData } from '../../types/bonds';
+export default function useBondsData(): UseQueryResult<BondsData[]>;
+export declare const getBondsData: () => Promise<BondsData[]>;

package/dist/state/bonds/useBondsList.d.ts

@@ -0,0 +1,4 @@
+import { UseQueryResult } from '@tanstack/react-query';
+import { BillsConfig } from '@ape.swap/apeswap-lists';
+export default function useBondsList(): UseQueryResult<BillsConfig[]>;
+export declare const getBondsList: () => Promise<BillsConfig[][]>;

package/dist/state/bonds/useHotBonds.d.ts

@@ -0,0 +1,3 @@
+import { UseQueryResult } from '@tanstack/react-query';
+export default function useHotBonds(): UseQueryResult<string[]>;
+export declare const getHotBonds: () => Promise<string[]>;

package/dist/state/bonds/useUserBonds.d.ts

@@ -0,0 +1,5 @@
+import { UseQueryResult } from '@tanstack/react-query';
+import { BillsConfig } from '@ape.swap/apeswap-lists';
+import { UserBill } from '../../types/yourbonds';
+export default function useUserBonds(): UseQueryResult<UserBill[]>;
+export declare const getUserBonds: (account: string, bondList: BillsConfig[]) => Promise<UserBill[]>;

package/dist/state/price/useCurrencyPrice.d.ts

@@ -0,0 +1,3 @@
+import { ChainId } from '@ape.swap/apeswap-lists';
+import { Token } from '@ape.swap/apeswap-lists';
+export default function useCurrencyPrice(currency: 'NATIVE' | Token | null, chainId: ChainId | null): import("../tokenPrices/useTokenPrices").TokenPrices | undefined;

package/dist/state/slippage/useSlippage.d.ts

@@ -0,0 +1 @@
+export declare const useSlippage: () => [number, (newValue: number) => void];

package/dist/state/tokenPrices/useTokenPrices.d.ts

@@ -0,0 +1,29 @@
+import { UseQueryResult } from '@tanstack/react-query';
+import { ChainId, Token } from '@ape.swap/apeswap-lists';
+export interface TokenPrices {
+    symbol: string | undefined;
+    address: string | undefined;
+    price: number | undefined;
+    decimals: number | undefined;
+    chainId: ChainId | undefined;
+}
+export default function useTokenPrices(): UseQueryResult<TokenPrices[]>;
+export declare const getTokenPrices: () => Promise<TokenPrices[]>;
+export declare const getBatchTokenPriceWithDexscreener: (params: {
+    chainId: ChainId;
+    tokens: {
+        address: string;
+        decimals: number;
+        lpToken: boolean;
+        symbol: string;
+        totalSupply?: number;
+    }[];
+}) => Promise<TokenPrices[]>;
+export declare const getDexScreenerChainName: (chainId: ChainId) => string | undefined;
+type TokenRecord = {
+    [k: string]: Token;
+};
+export declare function getTokenPricesV2FromPriceGetter(tokensToCall: TokenRecord, chain: ChainId, lpTokens?: boolean): Promise<any>;
+export declare function getPriceGetterCallData(tokensToCall: TokenRecord, // replace 'any' with the actual type
+supportedChainId: ChainId, lpTokens: boolean): (string | number | undefined)[][];
+export {};

package/dist/state/zap/getChainParam.d.ts

@@ -0,0 +1,12 @@
+import { ChainId, Protocols } from '@ape.swap/apeswap-lists';
+declare enum NetworkNames {
+    ETHEREUM = "eth",
+    BNB = "bnb",
+    POLYGON = "pol",
+    ARBITRUM = "arb",
+    LINEA = "lna",
+    BASE = "bas"
+}
+export declare const getChainParam: (chain?: ChainId) => NetworkNames | null;
+export declare const getLpType: (protocol?: Protocols) => "ichi" | "solidly" | "univ2" | null;
+export {};

package/dist/state/zap/useSoulZapBondQuote.d.ts

@@ -0,0 +1,4 @@
+import { Token } from '@ape.swap/apeswap-lists';
+import { BondsData } from '../../types/bonds';
+declare const useSoulZapBondQuote: (typedValue: string, inputCurrency: "NATIVE" | Token | undefined, bond: BondsData | undefined, account?: string) => [loading: boolean, response: any, estimateOutput: string];
+export default useSoulZapBondQuote;

package/dist/state/zap/useSoulZapTokenQuote.d.ts

@@ -0,0 +1,3 @@
+import { ChainId, Token } from '@ape.swap/apeswap-lists';
+declare const useSoulZapTokenQuote: (typedValue: string, inputCurrency: "NATIVE" | Token | undefined, outputToken: Token | undefined, chainId: ChainId, account?: string) => [loading: boolean, response: any, estimateOutput: string];
+export default useSoulZapTokenQuote;

package/dist/{cjs/types/theme → theme}/colors.d.ts

@@ -1,4 +1,4 @@
-declare const abondColors: {
+declare const colors: {
     white1: string;
     white2: string;
     white3: string;
@@ -7,6 +7,7 @@ declare const abondColors: {
     brandPrimary140: string;
     navBar: string;
     primaryButton: string;
+    primaryShade: string;
     secondary: string;
     footer: string;
     success: string;
@@ -85,4 +86,4 @@ declare const abondColors: {
     bg2: string;
     progressBar: string;
 };
-export default abondColors;
+export default colors;

package/dist/types/bonds.d.ts

@@ -0,0 +1,30 @@
+import { ChainId, Token } from '@ape.swap/apeswap-lists';
+export interface BondsData {
+    index: number;
+    cmcId?: number;
+    chainId: ChainId;
+    type: string;
+    discount: number;
+    billAddress: string;
+    billNftAddress: string;
+    soldOut: boolean;
+    inactive: boolean;
+    trueBillPrice: string;
+    maxTotalPayout: string;
+    totalPayoutGiven: string;
+    maxPayout: string;
+    tokensRemaining: string;
+    showcaseTokenName: string;
+    vestingTerm: number;
+    principalTokenPrice: string;
+    payoutTokenPrice: string;
+    tags?: string[];
+    shortDescription?: string;
+    fullDescription?: string;
+    twitter?: string;
+    projectLink?: string;
+    audit?: string;
+    billVersion?: string;
+    earnToken: Token;
+    lpToken: Token;
+}

package/dist/types/yourbonds.d.ts

@@ -0,0 +1,78 @@
+import { BondsData } from './bonds';
+import { ChainId } from '@ape.swap/apeswap-lists';
+export interface UserOwnedBillsData {
+    index: number;
+    userOwnedBills: UserBill[];
+}
+export interface UserBill {
+    address: string;
+    id: string;
+    vesting: string;
+    payout: string;
+    totalPayout?: string;
+    truePricePaid: string;
+    lastBlockTimestamp: string;
+    pendingRewards: string;
+    billNftAddress: string;
+    bond: BondsData;
+}
+export interface UserBillNftData {
+    id: number;
+    tokenId: number;
+    attributes: {
+        trait_type: string;
+        value: string;
+    }[];
+    chainId: ChainId;
+    contractAddress: string;
+    description: string;
+    image: string;
+    name: string;
+    data: {
+        billContract: string;
+        billNftAddress: string;
+        billNftId: number;
+        blockNumber: number;
+        bondArtCollection: string;
+        bondPartner: string;
+        bondVersion: string;
+        chainId: ChainId;
+        createTransactionHash: string;
+        createdAddressOwner: string;
+        createdAt: number;
+        deposit: number;
+        dollarValue: number;
+        expires: number;
+        pairName: string;
+        payout: number;
+        payoutToken: string;
+        payoutTokenData: {
+            address: string;
+            name: string;
+            symbol: string;
+            decimals: {
+                [chainId: number]: number;
+            };
+        };
+        payoutTokenPrice: string;
+        principalToken: string;
+        token0: {
+            address: string;
+            symbol: string;
+            name: string;
+            decimals: {
+                [chainId: number]: number;
+            };
+        };
+        token1: {
+            address: string;
+            symbol: string;
+            name: string;
+            decimals: {
+                [chainId: number]: number;
+            };
+        };
+        type: string;
+        vestingPeriodSeconds: number;
+    };
+}

package/dist/utils/convertToTokenValue.d.ts

@@ -0,0 +1,4 @@
+import { ethers } from 'ethers';
+export declare function adjustDecimals(numStr: string): string;
+declare const convertToTokenValue: (numberString: string, decimals: number) => ethers.BigNumber;
+export default convertToTokenValue;

package/dist/utils/displayHelpers.d.ts

@@ -0,0 +1,13 @@
+import { UserBill } from '../types/yourbonds';
+import { BondsData } from '../types/bonds';
+export declare const claimable: (userBill: UserBill) => number;
+export declare const earnTokenPrice: (bond: BondsData) => string;
+export declare const totalPending: (userBill: UserBill) => number;
+export declare const vestingTimeRemaining: (userBill: UserBill) => {
+    years: number;
+    months: number;
+    days: number;
+    hours: number;
+    minutes: number;
+    seconds: number;
+};

package/dist/utils/formatNumber.d.ts

@@ -0,0 +1,2 @@
+export declare const formatNumber: (number: number, minPrecision?: number, maxPrecision?: number) => string;
+export declare const formatNumberSI: (number: number, digits?: number) => string;

package/dist/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/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/utils/getNativeTicker.d.ts

@@ -0,0 +1,3 @@
+import { ChainId, Token } from '@ape.swap/apeswap-lists';
+export declare const getNativeTicker: (chain?: ChainId) => string | undefined;
+export declare const getTokenSymbol: (token: Token) => string;

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,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/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;