@scallop-io/sui-scallop-sdk 0.44.7 → 0.44.9

package/dist/models/index.d.ts

@@ -4,3 +4,4 @@ export * from './scallopClient';
 export * from './scallopBuilder';
 export * from './scallopQuery';
 export * from './scallopUtils';
+export * from './scallopIndexer';

package/dist/models/scallop.d.ts

@@ -5,6 +5,7 @@ import { ScallopBuilder } from './scallopBuilder';
 import { ScallopQuery } from './scallopQuery';
 import { ScallopUtils } from './scallopUtils';
 import type { ScallopParams } from '../types/';
+import { ScallopIndexer } from './scallopIndexer';
 /**
  * @description
  * The main instance that controls interaction with the Scallop contract.
@@ -12,10 +13,11 @@ import type { ScallopParams } from '../types/';
  * @example
  * ```typescript
  * const sdk = new Scallop(<parameters>);
- * const scallopUtils= await sdk.getScallopUtils();
  * const scallopAddress = await sdk.getScallopAddress();
  * const scallopBuilder = await sdk.createScallopBuilder();
  * const scallopClient = await sdk.createScallopClient();
+ * const scallopIndexer= await sdk.createScallopIndexer();
+ * const scallopUtils= await sdk.createScallopUtils();
  * ```
  */
 export declare class Scallop {
@@ -49,6 +51,12 @@ export declare class Scallop {
      * @return Scallop Query.
      */
     createScallopQuery(): Promise<ScallopQuery>;
+    /**
+     * Create a scallop indexer instance.
+     *
+     * @return Scallop Indexer.
+     */
+    createScallopIndexer(): Promise<ScallopIndexer>;
     /**
      * Create a scallop utils instance.
      *

package/dist/models/scallopAddress.d.ts

@@ -2,7 +2,7 @@ import type { NetworkType } from '@scallop-io/sui-kit';
 import type { ScallopAddressParams, AddressesInterface, AddressStringPath } from '../types';
 /**
  * @description
- * it provides methods for managing addresses.
+ * It provides methods for managing addresses.
  *
  * @example
  * ```typescript

package/dist/models/scallopBuilder.d.ts

@@ -8,7 +8,7 @@ import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import type { ScallopInstanceParams, ScallopBuilderParams, ScallopTxBlock, SupportMarketCoins, SupportAssetCoins } from '../types';
 /**
  * @description
- * it provides methods for operating the transaction block, making it more convenient to organize transaction combinations.
+ * It provides methods for operating the transaction block, making it more convenient to organize transaction combinations.
  *
  * @example
  * ```typescript

package/dist/models/scallopIndexer.d.ts

@@ -0,0 +1,81 @@
+import type { Market, MarketPools, MarketPool, MarketCollaterals, MarketCollateral, Spools, Spool, BorrowIncentivePools, BorrowIncentivePool, SupportPoolCoins, SupportCollateralCoins, SupportStakeMarketCoins, SupportBorrowIncentiveCoins, TotalValueLocked } from '../types';
+/**
+ * @description
+ * It provides methods to obtain sdk index data from mainnet.
+ *
+ *
+ * @example
+ * ```typescript
+ * const scallopIndexer = new scallopIndexer(<parameters>);
+ * scallopIndexer.<indexer functions>();
+ * await scallopIndexer.<indexer async functions>();
+ * ```
+ */
+export declare class ScallopIndexer {
+    private _requestClient;
+    constructor();
+    /**
+     * Get market index data.
+     *
+     * @return Market data.
+     */
+    getMarket(): Promise<Pick<Market, 'pools' | 'collaterals'>>;
+    /**
+     * Get market pools index data.
+     *
+     * @return Market pools data.
+     */
+    getMarketPools(): Promise<Required<MarketPools>>;
+    /**
+     * Get market pool index data.
+     *
+     * @return Market pool data.
+     */
+    getMarketPool(poolCoinName: SupportPoolCoins): Promise<MarketPool>;
+    /**
+     * Get market collaterals index data.
+     *
+     * @return Market collaterals data.
+     */
+    getMarketCollaterals(): Promise<Required<MarketCollaterals>>;
+    /**
+     * Get market collateral index data.
+     *
+     * @return Market collateral data.
+     */
+    getMarketCollateral(collateralCoinName: SupportCollateralCoins): Promise<MarketCollateral>;
+    /**
+     * Get spools index data.
+     *
+     * @return Spools data.
+     */
+    getSpools(): Promise<Required<Spools>>;
+    /**
+     * Get spool index data.
+     *
+     * @return Spool data.
+     */
+    getSpool(marketCoinName: SupportStakeMarketCoins): Promise<Spool>;
+    /**
+     * Get borrow incentive pools index data.
+     *
+     * @return Borrow incentive pools data.
+     */
+    getBorrowIncentivePools(): Promise<Required<BorrowIncentivePools>>;
+    /**
+     * Get borrow incentive pool index data.
+     *
+     * @return Borrow incentive pool data.
+     */
+    getBorrowIncentivePool(borrowIncentiveCoinName: SupportBorrowIncentiveCoins): Promise<BorrowIncentivePool>;
+    /**
+     * Get total value locked index data.
+     *
+     * @return Total value locked.
+     */
+    getTotalValueLocked(): Promise<TotalValueLocked & {
+        totalValueChangeRatio: number;
+        borrowValueChangeRatio: number;
+        supplyValueChangeRatio: number;
+    }>;
+}

package/dist/models/scallopQuery.d.ts

@@ -2,9 +2,10 @@ import { SuiKit } from '@scallop-io/sui-kit';
 import { ScallopQueryParams, ScallopInstanceParams, SupportStakeMarketCoins, SupportAssetCoins, SupportPoolCoins, SupportCollateralCoins, SupportMarketCoins, SupportBorrowIncentiveCoins } from '../types';
 import { ScallopAddress } from './scallopAddress';
 import { ScallopUtils } from './scallopUtils';
+import { ScallopIndexer } from './scallopIndexer';
 /**
  * @description
- * it provides methods for getting on-chain data from the Scallop contract.
+ * It provides methods for getting on-chain data from the Scallop contract.
  *
  * @example
  * ```typescript
@@ -19,6 +20,7 @@ export declare class ScallopQuery {
     suiKit: SuiKit;
     address: ScallopAddress;
     utils: ScallopUtils;
+    indexer: ScallopIndexer;
     constructor(params: ScallopQueryParams, instance?: ScallopInstanceParams);
     /**
      * Request the scallop API to initialize data.
@@ -28,10 +30,10 @@ export declare class ScallopQuery {
     init(forece?: boolean): Promise<void>;
     /**
      * Query market data.
-     *
+     * @param indexer - Whether to use indexer.
      * @return Market data.
      */
-    queryMarket(): Promise<import("../types").Market>;
+    queryMarket(indexer?: boolean): Promise<import("../types").Market>;
     /**
      * Get market pools.
      *
@@ -40,9 +42,10 @@ export declare class ScallopQuery {
      * the `queryMarket` method to reduce time consumption.
      *
      * @param poolCoinNames - Specific an array of support pool coin name.
+     * @param indexer - Whether to use indexer.
      * @return Market pools data.
      */
-    getMarketPools(poolCoinNames?: SupportPoolCoins[]): Promise<{
+    getMarketPools(poolCoinNames?: SupportPoolCoins[], indexer?: boolean): Promise<{
         eth?: import("../types").MarketPool | undefined;
         btc?: import("../types").MarketPool | undefined;
         usdc?: import("../types").MarketPool | undefined;
@@ -59,9 +62,10 @@ export declare class ScallopQuery {
      * Get  market pool
      *
      * @param poolCoinName - Specific support pool coin name.
+     * @param indexer - Whether to use indexer.
      * @return Market pool data.
      */
-    getMarketPool(poolCoinName: SupportPoolCoins): Promise<import("../types").MarketPool | undefined>;
+    getMarketPool(poolCoinName: SupportPoolCoins, indexer?: boolean): Promise<import("../types").MarketPool | undefined>;
     /**
      * Get market collaterals.
      *
@@ -70,9 +74,10 @@ export declare class ScallopQuery {
      * the `queryMarket` method to reduce time consumption.
      *
      * @param collateralCoinNames - Specific an array of support collateral coin name.
+     * @param indexer - Whether to use indexer.
      * @return Market collaterals data.
      */
-    getMarketCollaterals(collateralCoinNames?: SupportCollateralCoins[]): Promise<{
+    getMarketCollaterals(collateralCoinNames?: SupportCollateralCoins[], indexer?: boolean): Promise<{
         eth?: import("../types").MarketCollateral | undefined;
         btc?: import("../types").MarketCollateral | undefined;
         usdc?: import("../types").MarketCollateral | undefined;
@@ -89,9 +94,10 @@ export declare class ScallopQuery {
      * Get market collateral
      *
      * @param collateralCoinName - Specific support collateral coin name.
+     * @param indexer - Whether to use indexer.
      * @return Market collateral data.
      */
-    getMarketCollateral(collateralCoinName: SupportCollateralCoins): Promise<import("../types").MarketCollateral | undefined>;
+    getMarketCollateral(collateralCoinName: SupportCollateralCoins, indexer?: boolean): Promise<import("../types").MarketCollateral | undefined>;
     /**
      * Get obligations data.
      *
@@ -173,9 +179,10 @@ export declare class ScallopQuery {
      * Get spools data.
      *
      * @param stakeMarketCoinNames - Specific an array of support stake market coin name.
+     * @param indexer - Whether to use indexer.
      * @return Spools data.
      */
-    getSpools(stakeMarketCoinNames?: SupportStakeMarketCoins[]): Promise<{
+    getSpools(stakeMarketCoinNames?: SupportStakeMarketCoins[], indexer?: boolean): Promise<{
         ssui?: import("../types").Spool | undefined;
         susdc?: import("../types").Spool | undefined;
         susdt?: import("../types").Spool | undefined;
@@ -184,9 +191,10 @@ export declare class ScallopQuery {
      * Get spool data.
      *
      * @param stakeMarketCoinName - Specific support stake market coin name.
+     * @param indexer - Whether to use indexer.
      * @return Spool data.
      */
-    getSpool(stakeMarketCoinName: SupportStakeMarketCoins): Promise<import("../types").Spool | undefined>;
+    getSpool(stakeMarketCoinName: SupportStakeMarketCoins, indexer?: boolean): Promise<import("../types").Spool | undefined>;
     /**
      * Get stake accounts data for all stake pools (spools).
      *
@@ -258,9 +266,10 @@ export declare class ScallopQuery {
      * Get borrow incentive pools data.
      *
      * @param coinNames - Specific an array of support borrow incentive coin name.
+     * @param indexer - Whether to use indexer.
      * @return Borrow incentive pools data.
      */
-    getBorrowIncentivePools(coinNames?: SupportBorrowIncentiveCoins[]): Promise<{
+    getBorrowIncentivePools(coinNames?: SupportBorrowIncentiveCoins[], indexer?: boolean): Promise<{
         usdc?: import("../types").BorrowIncentivePool | undefined;
         usdt?: import("../types").BorrowIncentivePool | undefined;
         sui?: import("../types").BorrowIncentivePool | undefined;
@@ -282,9 +291,10 @@ export declare class ScallopQuery {
      *
      * @param poolCoinNames - Specific an array of support pool coin name.
      * @param ownerAddress - The owner address.
+     * @param indexer - Whether to use indexer.
      * @return All lending and spool infomation.
      */
-    getLendings(poolCoinNames?: SupportPoolCoins[], ownerAddress?: string): Promise<{
+    getLendings(poolCoinNames?: SupportPoolCoins[], ownerAddress?: string, indexer?: boolean): Promise<{
         eth?: import("../types").Lending | undefined;
         btc?: import("../types").Lending | undefined;
         usdc?: import("../types").Lending | undefined;
@@ -302,9 +312,10 @@ export declare class ScallopQuery {
      *
      * @param poolCoinName - Specific support pool coin name.
      * @param ownerAddress - The owner address.
+     * @param indexer - Whether to use indexer.
      * @return Lending pool data.
      */
-    getLending(poolCoinName: SupportPoolCoins, ownerAddress?: string): Promise<import("../types").Lending>;
+    getLending(poolCoinName: SupportPoolCoins, ownerAddress?: string, indexer?: boolean): Promise<import("../types").Lending>;
     /**
      * Get user all obligation accounts information.
      *
@@ -312,9 +323,10 @@ export declare class ScallopQuery {
      * All collateral and borrowing information in all obligation accounts owned by the user.
      *
      * @param ownerAddress - The owner address.
+     * @param indexer - Whether to use indexer.
      * @return All obligation accounts information.
      */
-    getObligationAccounts(ownerAddress?: string): Promise<{
+    getObligationAccounts(ownerAddress?: string, indexer?: boolean): Promise<{
         [x: string]: import("../types").ObligationAccount | undefined;
     }>;
     /**
@@ -325,16 +337,18 @@ export declare class ScallopQuery {
      *
      * @param obligationId - The obligation id.
      * @param ownerAddress - The owner address.
+     * @param indexer - Whether to use indexer.
      * @return Borrowing and collateral information.
      */
-    getObligationAccount(obligationId: string, ownerAddress?: string): Promise<import("../types").ObligationAccount>;
+    getObligationAccount(obligationId: string, ownerAddress?: string, indexer?: boolean): Promise<import("../types").ObligationAccount>;
     /**
      * Get total value locked.
      *
+     * @param indexer - Whether to use indexer.
      * @description
      * Include total supplied value and total borrowed value.
      *
      * @return Total value locked.
      */
-    getTvl(): Promise<import("../types").TotalValueLocked>;
+    getTvl(indexer?: boolean): Promise<import("../types").TotalValueLocked>;
 }

package/dist/queries/borrowIncentiveQuery.d.ts

@@ -5,9 +5,10 @@ import type { SupportBorrowIncentiveCoins } from '../types';
  *
  * @param query - The Scallop query instance.
  * @param borrowIncentiveCoinNames - Specific an array of support borrow incentive coin name.
+ * @param indexer - Whether to use indexer.
  * @return Borrow incentive pools data.
  */
-export declare const queryBorrowIncentivePools: (query: ScallopQuery, borrowIncentiveCoinNames?: SupportBorrowIncentiveCoins[]) => Promise<{
+export declare const queryBorrowIncentivePools: (query: ScallopQuery, borrowIncentiveCoinNames?: SupportBorrowIncentiveCoins[], indexer?: boolean) => Promise<{
     usdc?: import("../types").BorrowIncentivePool | undefined;
     usdt?: import("../types").BorrowIncentivePool | undefined;
     sui?: import("../types").BorrowIncentivePool | undefined;

package/dist/queries/coreQuery.d.ts

@@ -9,10 +9,10 @@ import { Market, MarketPool, MarketCollateral, SupportAssetCoins, SupportPoolCoi
  * Use inspectTxn call to obtain the data provided in the scallop contract query module.
  *
  * @param query - The Scallop query instance.
- * @param rateType - How interest rates are calculated.
+ * @param indexer - Whether to use indexer.
  * @return Market data.
  */
-export declare const queryMarket: (query: ScallopQuery) => Promise<Market>;
+export declare const queryMarket: (query: ScallopQuery, indexer?: boolean) => Promise<Market>;
 /**
  * Get coin market pools data.
  *
@@ -22,9 +22,10 @@ export declare const queryMarket: (query: ScallopQuery) => Promise<Market>;
  *
  * @param query - The Scallop query instance.
  * @param coinNames - Specific an array of support pool coin name.
+ * @param indexer - Whether to use indexer.
  * @return Market pools data.
  */
-export declare const getMarketPools: (query: ScallopQuery, poolCoinNames?: SupportPoolCoins[]) => Promise<{
+export declare const getMarketPools: (query: ScallopQuery, poolCoinNames?: SupportPoolCoins[], indexer?: boolean) => Promise<{
     eth?: MarketPool | undefined;
     btc?: MarketPool | undefined;
     usdc?: MarketPool | undefined;
@@ -42,11 +43,12 @@ export declare const getMarketPools: (query: ScallopQuery, poolCoinNames?: Suppo
  *
  * @param query - The Scallop query instance.
  * @param poolCoinName - Specific support pool coin name.
+ * @param indexer - Whether to use indexer.
  * @param marketObject - The market object.
  * @param coinPrice - The coin price.
  * @returns Market pool data.
  */
-export declare const getMarketPool: (query: ScallopQuery, poolCoinName: SupportPoolCoins, marketObject?: SuiObjectData | null, coinPrice?: number) => Promise<MarketPool | undefined>;
+export declare const getMarketPool: (query: ScallopQuery, poolCoinName: SupportPoolCoins, indexer?: boolean, marketObject?: SuiObjectData | null, coinPrice?: number) => Promise<MarketPool | undefined>;
 /**
  * Get coin market collaterals data.
  *
@@ -56,9 +58,10 @@ export declare const getMarketPool: (query: ScallopQuery, poolCoinName: SupportP
  *
  * @param query - The Scallop query instance.
  * @param collateralCoinNames - Specific an array of support collateral coin name.
+ * @param indexer - Whether to use indexer.
  * @return Market collaterals data.
  */
-export declare const getMarketCollaterals: (query: ScallopQuery, collateralCoinNames?: SupportCollateralCoins[]) => Promise<{
+export declare const getMarketCollaterals: (query: ScallopQuery, collateralCoinNames?: SupportCollateralCoins[], indexer?: boolean) => Promise<{
     eth?: MarketCollateral | undefined;
     btc?: MarketCollateral | undefined;
     usdc?: MarketCollateral | undefined;
@@ -76,11 +79,12 @@ export declare const getMarketCollaterals: (query: ScallopQuery, collateralCoinN
  *
  * @param query - The Scallop query instance.
  * @param collateralCoinName - Specific support collateral coin name.
+ * @param indexer - Whether to use indexer.
  * @param marketObject - The market object.
  * @param coinPrice - The coin price.
  * @returns Market collateral data.
  */
-export declare const getMarketCollateral: (query: ScallopQuery, collateralCoinName: SupportCollateralCoins, marketObject?: SuiObjectData | null, coinPrice?: number) => Promise<MarketCollateral | undefined>;
+export declare const getMarketCollateral: (query: ScallopQuery, collateralCoinName: SupportCollateralCoins, indexer?: boolean, marketObject?: SuiObjectData | null, coinPrice?: number) => Promise<MarketCollateral | undefined>;
 /**
  * Query all owned obligations.
  *

package/dist/queries/portfolioQuery.d.ts

@@ -6,9 +6,10 @@ import type { Market, SupportPoolCoins, MarketPool, Spool, StakeAccount, Lending
  * @param query - The ScallopQuery instance.
  * @param poolCoinNames - Specific an array of support pool coin name.
  * @param ownerAddress - The owner address.
+ * @param indexer - Whether to use indexer.
  * @return User lending infomation for specific pools.
  */
-export declare const getLendings: (query: ScallopQuery, poolCoinNames?: SupportPoolCoins[], ownerAddress?: string) => Promise<{
+export declare const getLendings: (query: ScallopQuery, poolCoinNames?: SupportPoolCoins[], ownerAddress?: string, indexer?: boolean) => Promise<{
     eth?: Lending | undefined;
     btc?: Lending | undefined;
     usdc?: Lending | undefined;
@@ -30,6 +31,7 @@ export declare const getLendings: (query: ScallopQuery, poolCoinNames?: SupportP
  * @param query - The ScallopQuery instance.
  * @param poolCoinName - Specific support coin name.
  * @param ownerAddress - The owner address.
+ * @param indexer - Whether to use indexer.
  * @param marketPool - The market pool data.
  * @param spool - The spool data.
  * @param stakeAccounts - The stake accounts data.
@@ -37,15 +39,16 @@ export declare const getLendings: (query: ScallopQuery, poolCoinNames?: SupportP
  * @param marketCoinAmount - The market coin amount.
  * @return User lending infomation for specific pool.
  */
-export declare const getLending: (query: ScallopQuery, poolCoinName: SupportPoolCoins, ownerAddress?: string, marketPool?: MarketPool, spool?: Spool, stakeAccounts?: StakeAccount[], coinAmount?: number, marketCoinAmount?: number, coinPrice?: number) => Promise<Lending>;
+export declare const getLending: (query: ScallopQuery, poolCoinName: SupportPoolCoins, ownerAddress?: string, indexer?: boolean, marketPool?: MarketPool, spool?: Spool, stakeAccounts?: StakeAccount[], coinAmount?: number, marketCoinAmount?: number, coinPrice?: number) => Promise<Lending>;
 /**
  * Get all obligation accounts data.
  *
  * @param query - The Scallop query instance.
  * @param ownerAddress - The owner address.
+ * @param indexer - Whether to use indexer.
  * @return All obligation accounts data.
  */
-export declare const getObligationAccounts: (query: ScallopQuery, ownerAddress?: string) => Promise<{
+export declare const getObligationAccounts: (query: ScallopQuery, ownerAddress?: string, indexer?: boolean) => Promise<{
     [x: string]: ObligationAccount | undefined;
 }>;
 /**
@@ -53,13 +56,15 @@ export declare const getObligationAccounts: (query: ScallopQuery, ownerAddress?:
  *
  * @param query - The Scallop query instance.
  * @param obligationId - The obligation id.
+ * @param indexer - Whether to use indexer.
  * @return Obligation account data.
  */
-export declare const getObligationAccount: (query: ScallopQuery, obligationId: string, ownerAddress?: string, market?: Market, coinPrices?: CoinPrices, coinAmounts?: CoinAmounts) => Promise<ObligationAccount>;
+export declare const getObligationAccount: (query: ScallopQuery, obligationId: string, ownerAddress?: string, indexer?: boolean, market?: Market, coinPrices?: CoinPrices, coinAmounts?: CoinAmounts) => Promise<ObligationAccount>;
 /**
  * Get total value locked data.
  *
  * @param query - The Scallop query instance.
+ * @param indexer - Whether to use indexer.
  * @return Total value locked data.
  */
-export declare const getTotalValueLocked: (query: ScallopQuery) => Promise<TotalValueLocked>;
+export declare const getTotalValueLocked: (query: ScallopQuery, indexer?: boolean) => Promise<TotalValueLocked>;

package/dist/queries/spoolQuery.d.ts

@@ -1,13 +1,14 @@
 import type { ScallopQuery } from '../models';
-import type { MarketPool, Spool, StakePool, StakeRewardPool, StakeAccounts, SupportStakeMarketCoins } from '../types';
+import type { MarketPool, Spool, StakePool, StakeRewardPool, StakeAccounts, SupportStakeMarketCoins, CoinPrices } from '../types';
 /**
  * Get spools data.
  *
  * @param query - The Scallop query instance.
  * @param marketCoinNames - Specific an array of support stake market coin name.
+ * @param indexer - Whether to use indexer.
  * @return Spools data.
  */
-export declare const getSpools: (query: ScallopQuery, stakeMarketCoinNames?: SupportStakeMarketCoins[]) => Promise<{
+export declare const getSpools: (query: ScallopQuery, stakeMarketCoinNames?: SupportStakeMarketCoins[], indexer?: boolean) => Promise<{
     ssui?: Spool | undefined;
     susdc?: Spool | undefined;
     susdt?: Spool | undefined;
@@ -17,10 +18,12 @@ export declare const getSpools: (query: ScallopQuery, stakeMarketCoinNames?: Sup
  *
  * @param query - The Scallop query instance.
  * @param marketCoinName - Specific support stake market coin name.
+ * @param indexer - Whether to use indexer.
  * @param marketPool - The market pool data.
+ * @param coinPrices - The coin prices.
  * @return Spool data.
  */
-export declare const getSpool: (query: ScallopQuery, marketCoinName: SupportStakeMarketCoins, marketPool?: MarketPool) => Promise<Spool | undefined>;
+export declare const getSpool: (query: ScallopQuery, marketCoinName: SupportStakeMarketCoins, indexer?: boolean, marketPool?: MarketPool, coinPrices?: CoinPrices) => Promise<Spool | undefined>;
 /**
  * Get all stake accounts of the owner.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "0.44.7",
+  "version": "0.44.9",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",

package/src/constants/common.ts

@@ -1,4 +1,5 @@
 export const API_BASE_URL = 'https://sui.api.scallop.io';
+export const SDK_API_BASE_URL = 'https://sdk.api.scallop.io';
 
 export const ADDRESSES_ID = '6462a088a7ace142bb6d7e9b';
 

package/src/models/index.ts

@@ -4,3 +4,4 @@ export * from './scallopClient';
 export * from './scallopBuilder';
 export * from './scallopQuery';
 export * from './scallopUtils';
+export * from './scallopIndexer';

package/src/models/scallop.ts

@@ -6,6 +6,7 @@ import { ScallopQuery } from './scallopQuery';
 import { ScallopUtils } from './scallopUtils';
 import { ADDRESSES_ID } from '../constants';
 import type { ScallopParams } from '../types/';
+import { ScallopIndexer } from './scallopIndexer';
 
 /**
  * @description
@@ -14,10 +15,11 @@ import type { ScallopParams } from '../types/';
  * @example
  * ```typescript
  * const sdk = new Scallop(<parameters>);
- * const scallopUtils= await sdk.getScallopUtils();
  * const scallopAddress = await sdk.getScallopAddress();
  * const scallopBuilder = await sdk.createScallopBuilder();
  * const scallopClient = await sdk.createScallopClient();
+ * const scallopIndexer= await sdk.createScallopIndexer();
+ * const scallopUtils= await sdk.createScallopUtils();
  * ```
  */
 export class Scallop {
@@ -93,6 +95,17 @@ export class Scallop {
     return scallopQuery;
   }
 
+  /**
+   * Create a scallop indexer instance.
+   *
+   * @return Scallop Indexer.
+   */
+  public async createScallopIndexer() {
+    const scallopIndexer = new ScallopIndexer();
+
+    return scallopIndexer;
+  }
+
   /**
    * Create a scallop utils instance.
    *

package/src/models/scallopAddress.ts

@@ -213,7 +213,7 @@ const EMPTY_ADDRESSES: AddressesInterface = {
 
 /**
  * @description
- * it provides methods for managing addresses.
+ * It provides methods for managing addresses.
  *
  * @example
  * ```typescript

package/src/models/scallopBuilder.ts

@@ -18,7 +18,7 @@ import type {
 
 /**
  * @description
- * it provides methods for operating the transaction block, making it more convenient to organize transaction combinations.
+ * It provides methods for operating the transaction block, making it more convenient to organize transaction combinations.
  *
  * @example
  * ```typescript