@scallop-io/sui-scallop-sdk 2.2.0 → 2.2.1

package/README.md

@@ -47,17 +47,30 @@ This SDK is used to interact with [sui-lending-protocol](https://github.com/scal
   const scallopSDK = new Scallop({
       addressId: '67c44a103fe1b8c454eb9699',
       networkType: 'mainnet',
+      secretKey: [secretKey]
       ...
   });
 
-  const scallopAddress = await scallopSDK.getScallopAddress(...);
-  const scallopConstants = await scallopSDK.getScallopConstants(...);
-  const scallopQuery = await scallopSDK.createScallopQuery(...);
-  const scallopBuilder = await scallopSDK.createScallopBuilder(...);
-  const scallopUtils = await scallopSDK.createScallopUtils(...);
-  const scallopClient = await scallopSDK.createScallopClient(...);
+  const scallopAddress = await scallopSDK.getScallopAddress();
+  const scallopConstants = await scallopSDK.getScallopConstants();
+  const scallopQuery = await scallopSDK.createScallopQuery();
+  const scallopBuilder = await scallopSDK.createScallopBuilder();
+  const scallopUtils = await scallopSDK.createScallopUtils();
+  const scallopClient = await scallopSDK.createScallopClient();
   const scallopIndexer = await scallopSDK.createScallopIndexer();
 
+  // Or with single init
+  await scallopSDK.init();
+  const scallopClient = scallopSDK.client;
+  const {
+    query,
+    builder,
+    constants,
+    address,
+    indexer
+  } = scallopClient;
+  const { indexer } = query;
+
   // Or, you can choose to import the class directly to create an instance.
   import {
     ScallopAddress,
@@ -77,15 +90,15 @@ This SDK is used to interact with [sui-lending-protocol](https://github.com/scal
     addressId: '67c44a103fe1b8c454eb9699',
     ...
   );
-  const ScallopQuery = new ScallopQuery(
+  const scallopQuery = new ScallopQuery(
     addressId: '67c44a103fe1b8c454eb9699',
     ...
   );
-  const ScallopBuilder = new ScallopBuilder(
+  const scallopBuilder = new ScallopBuilder(
     addressId: '67c44a103fe1b8c454eb9699',
     ...
   );
-  const ScallopUtils = new ScallopUtils(
+  const scallopUtils = new ScallopUtils(
     addressId: '67c44a103fe1b8c454eb9699',
     ...
   );
@@ -93,13 +106,14 @@ This SDK is used to interact with [sui-lending-protocol](https://github.com/scal
     addressId: '67c44a103fe1b8c454eb9699',
     ...
   );
-  const ScallopIndexer = new ScallopIndexer();
+  const scallopIndexer = new ScallopIndexer();
+
   // Remember to initialize the instance before using it
   await scallopAddress.read();
   await scallopConstants.init();
-  await ScallopQuery.init();
-  await ScallopBuilder.init();
-  await ScallopUtils.init();
+  await scallopQuery.init();
+  await scallopBuilder.init();
+  await scallopUtils.init();
   await scallopClient.init();
   ```
 
@@ -113,7 +127,7 @@ Below we will give a brief introduction to these instances respectively, and int
 - [Use Scallop Builder](./document/builder.md)
 - [Use Scallop Utils](./document/utils.md)
 - [Use Scallop Indexer](./document/indexer.md)
-- [Use Scallop Indexer](./document/constants.md)
+- [Use Scallop Constants](./document/constants.md)
 
 For the original codes, please refer to `test` folder.
 
@@ -128,8 +142,13 @@ You need to set up the `.env` file before testing. (Reference `.env.example`)
   pnpm run test:unit test/query.spec.ts
   pnpm run test:unit test/utils.spec.ts
   pnpm run test:unit test/indexer.spec.ts
+  pnpm run test:unit test/constants.spec.ts
+  pnpm run test:unit test/rate-limiter.spec.ts
   ```
 
 ## License
 
 [APACHE-2.0](https://www.apache.org/licenses/LICENSE-2.0)
+
+
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/scallop-io/sui-scallop-sdk)

package/dist/index.d.mts

@@ -1062,6 +1062,7 @@ declare class ScallopQuery implements ScallopQueryInterface {
 type ScallopBuilderParams = {
     query?: ScallopQuery;
     usePythPullModel?: boolean;
+    sponsoredFeeds?: string[];
     useOnChainXOracleList?: boolean;
 } & ScallopQueryParams;
 /**
@@ -1079,6 +1080,7 @@ declare class ScallopBuilder implements ScallopBuilderInterface {
     readonly query: ScallopQuery;
     readonly usePythPullModel: boolean;
     readonly useOnChainXOracleList: boolean;
+    readonly sponsoredFeeds: string[];
     constructor(params: ScallopBuilderParams);
     get utils(): ScallopUtils;
     get constants(): ScallopConstants;

package/dist/index.d.ts

@@ -1062,6 +1062,7 @@ declare class ScallopQuery implements ScallopQueryInterface {
 type ScallopBuilderParams = {
     query?: ScallopQuery;
     usePythPullModel?: boolean;
+    sponsoredFeeds?: string[];
     useOnChainXOracleList?: boolean;
 } & ScallopQueryParams;
 /**
@@ -1079,6 +1080,7 @@ declare class ScallopBuilder implements ScallopBuilderInterface {
     readonly query: ScallopQuery;
     readonly usePythPullModel: boolean;
     readonly useOnChainXOracleList: boolean;
+    readonly sponsoredFeeds: string[];
     constructor(params: ScallopBuilderParams);
     get utils(): ScallopUtils;
     get constants(): ScallopConstants;