@ape.swap/bonds-sdk 4.0.0-test.2 → 4.0.0-test.20

package/README.md

@@ -6,8 +6,8 @@ The `@ape.swap/bonds-sdk` package provides an embeddable set of tools and UI com
 
 ## Key Features
 
-- Fully customizable bond views powered by the following components: `<FullBondsView />`, `<Bonds/>` & `<YourBonds />`.
-- Multi-chain support for a ever-growing array of Blockchains that currently include BNB Chain, Ethereum, Base, Polygon, Arbitrum, Lightlink, Linea, Graphlinq, IOTA and Crossfi.
+- Fully customizable bond views powered by the following components: `<FullBondsView />`, `<Bonds/>`, `<YourBonds /> & <SingleBond />`.
+- Multi-chain support for a ever-growing array of EVM and Non EVM Blockchains.
 - Prebuilt styles and layouts optimized for embedding.
 - Compatibility with the most popular web3 development library: Wagmi.
 - Plug-and-play configuration to fit various project requirements.
@@ -28,6 +28,15 @@ yarn add @ape.swap/bonds-sdk
 
 ---
 
+## Required Dependencies
+
+The following are some key dependencies you must have for the SDK to work properly:
+
+- **React**: Required to build the UI. Ensure your project uses React v18 or later.
+- **Wagmi**: Used for handling wallet connections and blockchain interactions.
+
+---
+
 ## Basic Usage
 
 Here's an example of how to integrate the `@ape.swap/bonds-sdk` package into your project:
@@ -54,7 +63,7 @@ const MyBondsComponent = () => {
         ChainId.IOTA,
         ChainId.CROSSFI,
         ]}
-      useRainbowKit={true}
+      connector={'rainbowkit'}
       useHotBonds={true}
       theme={{
         "radii": "10px",
@@ -83,19 +92,20 @@ export default MyBondsComponent
 
 The core of the SDK lies in its config object params, passed as a prop to its components. Below is a breakdown of key options:
 
-| Property        | Type                | Description                                                                                                                                                    |
-|-----------------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `referenceId`   | `string`            | A unique identifier for the bonds, shall be provided by ApeBond team.                                                                                          |
-| `chains`        | `Array`             | An array of supported chain IDs (e.g., `56`, `1`, `137`, etc). It also determines the order of the chains on the bond list.                                    |
-| `useRainbowKit` | `boolean`           | Whether to enable RainbowKit for wallet connections. Might be replaced for an enum in the near future.                                                         |
-| `useHotBonds`   | `boolean`           | Whether to show the "hot bonds" component.                                                                                                                     |
-| `theme`         | `Object (optional)` | This is how you can customize the styles of the SDK. Override styles like colors, typography, and layout settings to match your project's branding.            |      
-| `tokenSymbol`   | `string[]`          | This parameter is specific to the `<SingleBond />` component. It defines the token(s) to display in the UI. Currently, only a single token (one element in the array) is supported.|      
+| Property      | Type                       | Description                                                                                                                                                                         |
+|---------------|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `referenceId` | `string`                   | A unique identifier for the bonds, shall be provided by ApeBond team.                                                                                                               |
+| `chains`      | `Array`                    | An array of supported chain IDs (e.g., `56`, `1`, `137`, etc). It also determines the order of the chains on the bond list.                                                         |
+| `connector`   | `'rainbowkit' or 'appkit'` | Determines your preferred wallet-connector. If your connector is not listed here get in contact with the dev team to request the integration.                                       | 
+| `useHotBonds` | `boolean`                  | Whether to show the "hot bonds" component.                                                                                                                                          |
+| `theme`       | `Object (optional)`        | This is how you can customize the styles of the SDK. Override styles like colors, typography, and layout settings to match your project's branding.                                 |      
+| `tokenSymbol` | `string[]`                 | This parameter is specific to the `<SingleBond />` component. It defines the token(s) to display in the UI. Currently, only a single token (one element in the array) is supported. |      
 
 ### Chain Support
 
 The SDK currently supports the following chains:
 
+EVM:
 - Binance Smart Chain (BSC)
 - Ethereum (MAINNET)
 - Polygon (MATIC)
@@ -106,6 +116,14 @@ The SDK currently supports the following chains:
 - Graphlinq
 - IOTA
 - CrossFi
+- Unichain
+- Berachain
+- Sonic
+- Katana
+- Monad Testnet
+
+Non-EVM:
+- SOLANA
 
 The list get updated constantly, so make sure to use latest version of the SDK.
 
@@ -131,16 +149,7 @@ Once you are happy with the styles, make sure to copy the output styles object a
 
 To use a custom font in the theme, include the `customFont` property with the name of your desired font family. Please note that you will need to manually download the font and embed it in your project using a `<script>` or `<link>` tag in your HTML file.
 
-Bear in mind, that the components of the SDK will use the width and height provided by the parent component.
-
----
-
-## Dependencies
-
-The following are some key dependencies you must have for the SDK to work properly:
-
-- **React**: Required to build the UI. Ensure your project uses React v18 or later.
-- **Wagmi**: Used for handling wallet connections and blockchain interactions.
+Bear in mind, that the components of the SDK will use the width and height provided by the parent component, therefore, we recommend wrapping ApeBond SDK components with a div with the desired size.
 
 ---
 

package/dist/components/ConnectButton/AppKitButton.d.ts

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

package/dist/components/Tooltip/Tooltip.d.ts

@@ -8,6 +8,7 @@ export interface TooltipProps {
     audit?: string;
     chain: number;
     isSoldOut?: boolean;
+    billType?: string;
 }
 declare const BondInfoTooltip: React.FunctionComponent<TooltipProps>;
 export default BondInfoTooltip;

package/dist/components/uikit-sdk/Svg/tokens/KATANA.d.ts

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

package/dist/components/uikit-sdk/Svg/tokens/UNICHAIN.d.ts

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

package/dist/components/uikit-sdk/Svg/tokens/index.d.ts

@@ -26,3 +26,5 @@ export { default as MONAD } from './MONAD';
 export { default as SONIC } from './SONIC';
 export { default as BERA } from './BERA';
 export { default as SOLANA } from './SOL';
+export { default as KATANA } from './KATANA';
+export { default as UNICHAIN } from './UNICHAIN';

package/dist/components/uikit-sdk/Svg/types.d.ts

@@ -57,6 +57,8 @@ export declare enum icons {
     SONIC = "sonic",
     BERA = "bera",
     SOL = "sol",
+    KATANA = "katana",
+    UNICHAIN = "unichain",
     DISCORD = "discord",
     REDDIT = "reddit",
     MEDIUM = "medium",

package/dist/config/constants/networks.d.ts

@@ -1,2 +1,4 @@
 import { ChainId } from '@ape.swap/apeswap-lists';
 export declare const PUBLIC_RPC_URLS: Partial<Record<ChainId, string[]>>;
+export declare const HELIUS_SOL_RPC = "https://mainnet.helius-rpc.com/?api-key=d80b11e0-692f-4da0-91d6-830799c8c385";
+export declare const getRPC: (chain: ChainId) => string;

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

@@ -23,6 +23,7 @@ export declare const QUERY_KEYS: {
     USER_BONDS: string;
     BOND_NFT_DATA: string;
     TOKEN_PRICES: string;
+    SOL_PRICES: string;
     HOT_BONDS: string;
     HOT_BONDS_CONTRACTS: string;
     CURRENCY_BALANCE: string;