@scallop-io/sui-scallop-sdk 2.0.0-alpha.4 → 2.0.0-alpha.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -337,6 +337,7 @@ declare class ScallopConstants {
337
337
  private _coinTypes;
338
338
  private _sCoinTypes;
339
339
  private _coinTypeToCoinNameMap;
340
+ private _supportedBorrowIncentiveRewards;
340
341
  constructor(params: ScallopConstantsParams, instance?: ScallopConstantsInstanceParams);
341
342
  get isAddressInitialized(): boolean;
342
343
  get isInitialized(): boolean;
@@ -345,16 +346,61 @@ declare class ScallopConstants {
345
346
  get whitelist(): Whitelist;
346
347
  parseToOldMarketCoin(coinType: string): string;
347
348
  get protocolObjectId(): string;
349
+ /**
350
+ * @description
351
+ * Return maps of coin names to coin decimals.
352
+ */
348
353
  get coinDecimals(): Record<string, number | undefined>;
354
+ /**
355
+ * @description
356
+ * Return maps of coin names to coin types.
357
+ */
349
358
  get coinTypes(): Record<string, string | undefined>;
350
- get wormholeCoinTypeToCoinName(): Record<string, string | undefined>;
359
+ /**
360
+ * @description
361
+ * Return maps of coin types to its coin name
362
+ */
351
363
  get coinTypeToCoinNameMap(): Record<string, string | undefined>;
364
+ /**
365
+ * @description
366
+ * Return maps of wormhole coin types to its coin name.
367
+ */
368
+ get wormholeCoinTypeToCoinName(): Record<string, string | undefined>;
369
+ /**
370
+ * @description
371
+ * Return maps of coin name to its old market coin type (...::reserve::MarketCoin<coinType>)
372
+ */
352
373
  get coinNameToOldMarketCoinTypeMap(): Record<string, string | undefined>;
374
+ /**
375
+ * @description
376
+ * Return maps of sCoin raw name from its type to its sCoin name. (e.g. 'scallop_sui' -> 'ssui')
377
+ */
353
378
  get sCoinRawNameToScoinNameMap(): Record<string, string | undefined>;
379
+ /**
380
+ * @description
381
+ * Return maps of scoin type to its sCoin name
382
+ */
354
383
  get sCoinTypeToSCoinNameMap(): Record<string, string | undefined>;
384
+ /**
385
+ * @description
386
+ * Return maps of volo coin type to its coin name
387
+ */
355
388
  get voloCoinTypeToCoinNameMap(): Record<string, string | undefined>;
389
+ /**
390
+ * @description
391
+ * Return maps of sui bridge coin type to its coin name
392
+ */
356
393
  get suiBridgeCoinTypeToCoinNameMap(): Record<string, string | undefined>;
394
+ /**
395
+ * @description
396
+ * Return maps of sCoin coin name to its coin type
397
+ */
357
398
  get sCoinTypes(): Record<string, string | undefined>;
399
+ /**
400
+ * @description
401
+ * Return set of supported coin types for borrow incentive rewards
402
+ * (all supported pools + sCoins + custom coins from `whitelist.borrowIncentiveRewards`)
403
+ */
358
404
  get supportedBorrowIncentiveRewards(): Set<string>;
359
405
  private isEmptyObject;
360
406
  private readApi;
@@ -2967,7 +3013,6 @@ type ScallopIndexerParams = ScallopCacheParams & {
2967
3013
  type ScallopAddressParams = ScallopCacheParams & {
2968
3014
  addressApiUrl?: string;
2969
3015
  addressId: string;
2970
- whitelistId: string;
2971
3016
  auth?: string;
2972
3017
  network?: NetworkType;
2973
3018
  forceAddressesInterface?: Partial<Record<NetworkType, AddressesInterface>>;
package/dist/index.d.ts CHANGED
@@ -337,6 +337,7 @@ declare class ScallopConstants {
337
337
  private _coinTypes;
338
338
  private _sCoinTypes;
339
339
  private _coinTypeToCoinNameMap;
340
+ private _supportedBorrowIncentiveRewards;
340
341
  constructor(params: ScallopConstantsParams, instance?: ScallopConstantsInstanceParams);
341
342
  get isAddressInitialized(): boolean;
342
343
  get isInitialized(): boolean;
@@ -345,16 +346,61 @@ declare class ScallopConstants {
345
346
  get whitelist(): Whitelist;
346
347
  parseToOldMarketCoin(coinType: string): string;
347
348
  get protocolObjectId(): string;
349
+ /**
350
+ * @description
351
+ * Return maps of coin names to coin decimals.
352
+ */
348
353
  get coinDecimals(): Record<string, number | undefined>;
354
+ /**
355
+ * @description
356
+ * Return maps of coin names to coin types.
357
+ */
349
358
  get coinTypes(): Record<string, string | undefined>;
350
- get wormholeCoinTypeToCoinName(): Record<string, string | undefined>;
359
+ /**
360
+ * @description
361
+ * Return maps of coin types to its coin name
362
+ */
351
363
  get coinTypeToCoinNameMap(): Record<string, string | undefined>;
364
+ /**
365
+ * @description
366
+ * Return maps of wormhole coin types to its coin name.
367
+ */
368
+ get wormholeCoinTypeToCoinName(): Record<string, string | undefined>;
369
+ /**
370
+ * @description
371
+ * Return maps of coin name to its old market coin type (...::reserve::MarketCoin<coinType>)
372
+ */
352
373
  get coinNameToOldMarketCoinTypeMap(): Record<string, string | undefined>;
374
+ /**
375
+ * @description
376
+ * Return maps of sCoin raw name from its type to its sCoin name. (e.g. 'scallop_sui' -> 'ssui')
377
+ */
353
378
  get sCoinRawNameToScoinNameMap(): Record<string, string | undefined>;
379
+ /**
380
+ * @description
381
+ * Return maps of scoin type to its sCoin name
382
+ */
354
383
  get sCoinTypeToSCoinNameMap(): Record<string, string | undefined>;
384
+ /**
385
+ * @description
386
+ * Return maps of volo coin type to its coin name
387
+ */
355
388
  get voloCoinTypeToCoinNameMap(): Record<string, string | undefined>;
389
+ /**
390
+ * @description
391
+ * Return maps of sui bridge coin type to its coin name
392
+ */
356
393
  get suiBridgeCoinTypeToCoinNameMap(): Record<string, string | undefined>;
394
+ /**
395
+ * @description
396
+ * Return maps of sCoin coin name to its coin type
397
+ */
357
398
  get sCoinTypes(): Record<string, string | undefined>;
399
+ /**
400
+ * @description
401
+ * Return set of supported coin types for borrow incentive rewards
402
+ * (all supported pools + sCoins + custom coins from `whitelist.borrowIncentiveRewards`)
403
+ */
358
404
  get supportedBorrowIncentiveRewards(): Set<string>;
359
405
  private isEmptyObject;
360
406
  private readApi;
@@ -2967,7 +3013,6 @@ type ScallopIndexerParams = ScallopCacheParams & {
2967
3013
  type ScallopAddressParams = ScallopCacheParams & {
2968
3014
  addressApiUrl?: string;
2969
3015
  addressId: string;
2970
- whitelistId: string;
2971
3016
  auth?: string;
2972
3017
  network?: NetworkType;
2973
3018
  forceAddressesInterface?: Partial<Record<NetworkType, AddressesInterface>>;