@scallop-io/sui-scallop-sdk 1.5.3 → 2.0.0-alpha.1

package/src/models/scallop.ts

@@ -4,10 +4,10 @@ import { ScallopClient } from './scallopClient';
 import { ScallopBuilder } from './scallopBuilder';
 import { ScallopQuery } from './scallopQuery';
 import { ScallopUtils } from './scallopUtils';
-import { ADDRESS_ID } from '../constants';
 import type {
   ScallopBuilderParams,
   ScallopClientParams,
+  ScallopConstantsParams,
   ScallopParams,
   ScallopQueryParams,
   ScallopUtilsParams,
@@ -15,8 +15,9 @@ import type {
 import { ScallopIndexer } from './scallopIndexer';
 import { ScallopCache } from './scallopCache';
 import { QueryClientConfig } from '@tanstack/query-core';
-import type { QueryClient } from '@tanstack/query-core';
 import { newSuiKit } from './suiKit';
+import { ScallopConstants } from './scallopConstants';
+import type { QueryClient } from '@tanstack/query-core';
 
 /**
  * @argument params - The parameters for the Scallop instance.
@@ -41,6 +42,7 @@ export class Scallop {
   public cache: ScallopCache;
 
   private address: ScallopAddress;
+  private constants: ScallopConstants;
 
   public constructor(
     params: ScallopParams,
@@ -59,14 +61,15 @@ export class Scallop {
         queryClient,
       }
     );
-    this.address = new ScallopAddress(
-      {
-        id: params?.addressId ?? ADDRESS_ID,
-        network: params?.networkType,
-        forceInterface: params?.forceAddressesInterface,
-      },
-      { cache: this.cache }
-    );
+
+    this.address = new ScallopAddress(params, {
+      cache: this.cache,
+    });
+    this.constants = new ScallopConstants(params, { address: this.address });
+  }
+
+  private async initConstants(params?: Partial<ScallopConstantsParams>) {
+    if (!this.constants.isInitialized) await this.constants.init(params);
   }
 
   /**
@@ -86,8 +89,8 @@ export class Scallop {
    *
    * @return Scallop Builder.
    */
-  public async createScallopBuilder(params?: ScallopBuilderParams) {
-    if (!this.address.getAddresses()) await this.address.read();
+  public async createScallopBuilder(params?: Partial<ScallopBuilderParams>) {
+    await this.initConstants(params);
     const builderParams = {
       ...this.params,
       ...params,
@@ -105,8 +108,8 @@ export class Scallop {
    * @param walletAddress - When user cannot provide a secret key or mnemonic, the scallop client cannot directly derive the address of the transaction the user wants to sign. This argument specifies the wallet address for signing the transaction.
    * @return Scallop Client.
    */
-  public async createScallopClient(params?: ScallopClientParams) {
-    if (!this.address.getAddresses()) await this.address.read();
+  public async createScallopClient(params?: Partial<ScallopClientParams>) {
+    await this.initConstants(params);
     const clientParams = {
       ...this.params,
       ...params,
@@ -123,12 +126,13 @@ export class Scallop {
    *
    * @return Scallop Query.
    */
-  public async createScallopQuery(params?: ScallopQueryParams) {
-    if (!this.address.getAddresses()) await this.address.read();
+  public async createScallopQuery(params?: Partial<ScallopQueryParams>) {
+    await this.initConstants(params);
     const queryParams = {
       ...this.params,
       ...params,
     };
+
     const scallopQuery = new ScallopQuery(queryParams, {
       utils: await this.createScallopUtils(queryParams),
     });
@@ -154,15 +158,15 @@ export class Scallop {
    *
    * @return Scallop Utils.
    */
-  public async createScallopUtils(params?: ScallopUtilsParams) {
-    if (!this.address.getAddresses()) await this.address.read();
+  public async createScallopUtils(params?: Partial<ScallopUtilsParams>) {
+    await this.initConstants(params);
     const scallopUtils = new ScallopUtils(
       {
         ...this.params,
         ...params,
       },
       {
-        address: this.address,
+        constants: this.constants,
         suiKit: this.suiKit,
       }
     );

package/src/models/scallopAddress.ts

@@ -406,6 +406,7 @@ const EMPTY_ADDRESSES: AddressesInterface = {
     },
   },
 };
+
 /**
  * @description
  * It provides methods for managing addresses.
@@ -417,6 +418,7 @@ const EMPTY_ADDRESSES: AddressesInterface = {
  * await scallopAddress.<address async functions>();
  * ```
  */
+
 export class ScallopAddress {
   private readonly _auth?: string;
   private readonly _requestClient: AxiosInstance;
@@ -431,7 +433,7 @@ export class ScallopAddress {
     params: ScallopAddressParams,
     instance?: ScallopAddressInstanceParams
   ) {
-    const { id, auth, network, forceInterface } = params;
+    const { addressId, auth, network, forceAddressesInterface } = params;
     this.cache = instance?.cache ?? new ScallopCache({});
 
     this._requestClient = axios.create({
@@ -443,7 +445,8 @@ export class ScallopAddress {
       timeout: 8000,
     });
     if (auth) this._auth = auth;
-    this._id = id;
+
+    this._id = addressId;
     this._network = network ?? 'mainnet';
     this._addressesMap = USE_TEST_ADDRESS
       ? new Map([['mainnet', TEST_ADDRESSES]])
@@ -451,9 +454,9 @@ export class ScallopAddress {
     if (USE_TEST_ADDRESS) this._currentAddresses = TEST_ADDRESSES;
 
     // Set the addresses from the forceInterface if it is provided.
-    if (forceInterface) {
+    if (forceAddressesInterface) {
       for (const [network, addresses] of Object.entries<AddressesInterface>(
-        forceInterface
+        forceAddressesInterface
       )) {
         if (['localnet', 'devnet', 'testnet', 'mainnet'].includes(network)) {
           if (network === this._network) this._currentAddresses = addresses;

package/src/models/scallopBuilder.ts

@@ -1,6 +1,5 @@
 import { normalizeSuiAddress } from '@mysten/sui/utils';
 import { SuiKit } from '@scallop-io/sui-kit';
-import { ADDRESS_ID } from '../constants';
 import { newScallopTxBlock } from '../builders';
 import { ScallopAddress } from './scallopAddress';
 import { ScallopQuery } from './scallopQuery';
@@ -17,14 +16,12 @@ import type {
 import type {
   ScallopBuilderParams,
   ScallopTxBlock,
-  SupportMarketCoins,
-  SupportAssetCoins,
-  SupportSCoin,
   ScallopBuilderInstanceParams,
   SelectCoinReturnType,
 } from '../types';
 import { ScallopCache } from './scallopCache';
 import { newSuiKit } from './suiKit';
+import { ScallopConstants } from './scallopConstants';
 
 /**
  * @description
@@ -43,13 +40,14 @@ export class ScallopBuilder {
 
   public suiKit: SuiKit;
   public address: ScallopAddress;
+  public constants: ScallopConstants;
   public query: ScallopQuery;
   public utils: ScallopUtils;
   public walletAddress: string;
   public cache: ScallopCache;
 
   public constructor(
-    params: ScallopBuilderParams = {},
+    params: ScallopBuilderParams,
     instance?: ScallopBuilderInstanceParams
   ) {
     this.suiKit = instance?.suiKit ?? newSuiKit(params);
@@ -59,37 +57,36 @@ export class ScallopBuilder {
       params?.walletAddress ?? this.suiKit.currentAddress()
     );
 
-    if (instance?.query) {
-      this.query = instance.query;
-      this.utils = this.query.utils;
-      this.address = this.utils.address;
-      this.cache = this.address.cache;
-    } else {
-      this.cache = new ScallopCache(this.params, {
+    this.cache =
+      instance?.query?.cache ??
+      new ScallopCache(this.params, {
         suiKit: this.suiKit,
       });
-      this.address = new ScallopAddress(
-        {
-          id: params?.addressId ?? ADDRESS_ID,
-          network: params?.networkType,
-          forceInterface: params?.forceAddressesInterface,
-        },
-        {
-          cache: this.cache,
-        }
-      );
-      this.utils = new ScallopUtils(this.params, {
+
+    this.address =
+      instance?.query?.address ??
+      new ScallopAddress(this.params, {
+        cache: this.cache,
+      });
+
+    this.constants =
+      instance?.query?.constants ??
+      new ScallopConstants(this.params, {
         address: this.address,
       });
-      this.query = new ScallopQuery(
-        {
-          walletAddress: this.walletAddress,
-        },
-        {
-          utils: this.utils,
-        }
-      );
-    }
+
+    this.utils =
+      instance?.query?.utils ??
+      new ScallopUtils(this.params, {
+        constants: this.constants,
+      });
+
+    this.query =
+      instance?.query ??
+      new ScallopQuery(this.params, {
+        utils: this.utils,
+      });
+
     this.isTestnet = params.networkType
       ? params.networkType === 'testnet'
       : false;
@@ -129,7 +126,7 @@ export class ScallopBuilder {
    * @param sender - Sender address.
    * @return Take coin and left coin.
    */
-  public async selectCoin<T extends SupportAssetCoins>(
+  public async selectCoin<T extends string>(
     txBlock: ScallopTxBlock | SuiKitTxBlock,
     assetCoinName: T,
     amount: number,
@@ -157,7 +154,7 @@ export class ScallopBuilder {
    */
   public async selectMarketCoin(
     txBlock: ScallopTxBlock | SuiKitTxBlock,
-    marketCoinName: SupportMarketCoins,
+    marketCoinName: string,
     amount: number,
     sender: string = this.walletAddress
   ) {
@@ -185,7 +182,7 @@ export class ScallopBuilder {
    */
   public async selectSCoin(
     txBlock: ScallopTxBlock | SuiKitTxBlock,
-    sCoinName: SupportSCoin,
+    sCoinName: string,
     amount: number,
     sender: string = this.walletAddress
   ) {

package/src/models/scallopCache.ts

@@ -101,7 +101,7 @@ export class ScallopCache {
     //   // if(cacheOptions.mutations)this.queryClient.setMutationDefaults(cacheOptions.mutations);
     // }
 
-    this.tokens = this.tokensPerInterval;
+    this.tokens = this.tokensPerInterval; // Initial tokens value
     this.lastRefill = Date.now();
     this.walletAddress = params.walletAddress ?? this.suiKit.currentAddress();
   }