@scallop-io/sui-kit 0.37.0 → 0.38.0

package/dist/index.d.ts

@@ -2,5 +2,4 @@ export { TransactionBlock, SUI_CLOCK_OBJECT_ID, SUI_SYSTEM_STATE_OBJECT_ID, } fr
 export { SuiKit } from './suiKit';
 export { SuiAccountManager } from './libs/suiAccountManager';
 export { SuiTxBlock } from './libs/suiTxBuilder';
-export { SuiRpcProvider } from './libs/suiRpcProvider';
 export type * from './types';

package/dist/index.js

@@ -24,7 +24,6 @@ __export(src_exports, {
   SUI_SYSTEM_STATE_OBJECT_ID: () => import_sui10.SUI_SYSTEM_STATE_OBJECT_ID,
   SuiAccountManager: () => SuiAccountManager,
   SuiKit: () => SuiKit,
-  SuiRpcProvider: () => SuiRpcProvider,
   SuiTxBlock: () => SuiTxBlock,
   TransactionBlock: () => import_sui10.TransactionBlock
 });
@@ -150,153 +149,11 @@ var SuiAccountManager = class {
   }
 };
 
-// src/libs/suiRpcProvider/index.ts
-var import_sui6 = require("@mysten/sui.js");
-
-// src/libs/suiRpcProvider/faucet.ts
-var import_sui4 = require("@mysten/sui.js");
-var import_ts_retry_promise = require("ts-retry-promise");
-var requestFaucet = async (address, provider) => {
-  console.log("\nRequesting SUI from faucet for address: ", address);
-  const headers = {
-    authority: "faucet.testnet.sui.io",
-    method: "POST",
-    path: "/gas",
-    scheme: "https",
-    accept: "*/*",
-    "accept-encoding": "gzip, deflate, br",
-    "accept-language": "zh-CN,zh;q=0.9,en;q=0.8,ja;q=0.7",
-    "content-length": "105",
-    "content-type": "application/json",
-    origin: "chrome-extension://opcgpfmipidbgpenhmajoajpbobppdil",
-    cookie: '_ga=GA1.1.2092533979.1664032306; sui_io_cookie={"level":["necessary","analytics"],"revision":0,"data":null,"rfc_cookie":false}; _ga_YKP53WJMB0=GS1.1.1680531285.31.0.1680531334.11.0.0; _ga_0GW4F97GFL=GS1.1.1680826187.125.0.1680826187.60.0.0; __cf_bm=6rPjXUwuzUPy4yDlZuXgDj0v7xLPpUd5z0CFGCoN_YI-1680867579-0-AZMhU7/mKUUbUlOa27LmfW6eIFkBkXsPKqYgWjpjWpj2XzDckgUsRu/pxSRGfvXCspn3w7Df+uO1MR/b+XikJU0=; _cfuvid=zjwCXMmu19KBIVo_L9Qbq4TqFXJpophG3.EvFTxqdf4-1680867579342-0-604800000',
-    "sec-ch-ua": '"Google Chrome";v="111", "Not(A:Brand";v="8", "Chromium";v="111"',
-    "sec-ch-ua-mobile": "?0",
-    "sec-ch-ua-platform": "macOS",
-    "sec-fetch-dest": "empty",
-    "sec-fetch-mode": "cors",
-    "sec-fetch-site": "none",
-    "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36"
-  };
-  const resp = await (0, import_ts_retry_promise.retry)(
-    () => provider.requestSuiFromFaucet(address, headers),
-    {
-      backoff: "EXPONENTIAL",
-      // overall timeout in 60 seconds
-      timeout: 1e3 * 60,
-      // skip retry if we hit the rate-limit error
-      retryIf: (error) => !(error instanceof import_sui4.FaucetRateLimitError),
-      logger: (msg) => console.warn(`Retry requesting faucet: ${msg}`)
-    }
-  );
-  (0, import_sui4.assert)(resp, import_sui4.FaucetResponse, "Request faucet failed\n");
-  console.log("Request faucet success\n");
-};
-
-// src/libs/suiRpcProvider/defaultChainConfigs.ts
-var import_sui5 = require("@mysten/sui.js");
-var getDefaultNetworkParams = (networkType = "devnet") => {
-  switch (networkType) {
-    case "localnet":
-      return import_sui5.localnetConnection;
-    case "devnet":
-      return import_sui5.devnetConnection;
-    case "testnet":
-      return import_sui5.testnetConnection;
-    case "mainnet":
-      return import_sui5.mainnetConnection;
-    default:
-      return import_sui5.devnetConnection;
-  }
-};
-
-// src/libs/suiRpcProvider/index.ts
-var SuiRpcProvider = class {
-  /**
-   *
-   * @param networkType, 'testnet' | 'mainnet' | 'devnet' | 'localnet', default is 'devnet'
-   * @param fullnodeUrl, the fullnode url, default is the preconfig fullnode url for the given network type
-   * @param faucetUrl, the faucet url, default is the preconfig faucet url for the given network type
-   */
-  constructor({
-    fullnodeUrl,
-    faucetUrl,
-    networkType
-  } = {}) {
-    const defaultNetworkParams = getDefaultNetworkParams(
-      networkType || "devnet"
-    );
-    this.fullnodeUrl = fullnodeUrl || defaultNetworkParams.fullnode;
-    this.faucetUrl = faucetUrl || defaultNetworkParams.faucet;
-    const connection = new import_sui6.Connection({
-      fullnode: this.fullnodeUrl,
-      faucet: this.faucetUrl
-    });
-    this.provider = new import_sui6.JsonRpcProvider(connection);
-  }
-  /**
-   * Request some SUI from faucet
-   * @Returns {Promise<boolean>}, true if the request is successful, false otherwise.
-   */
-  async requestFaucet(addr) {
-    return requestFaucet(addr, this.provider);
-  }
-  async getBalance(addr, coinType) {
-    return this.provider.getBalance({ owner: addr, coinType });
-  }
-  async getObjects(ids) {
-    const options = { showContent: true, showDisplay: true, showType: true };
-    const objects = await this.provider.multiGetObjects({ ids, options });
-    const parsedObjects = objects.map((object) => {
-      const objectId = (0, import_sui6.getObjectId)(object);
-      const objectType = (0, import_sui6.getObjectType)(object);
-      const objectVersion = (0, import_sui6.getObjectVersion)(object);
-      const objectFields = (0, import_sui6.getObjectFields)(object);
-      const objectDisplay = (0, import_sui6.getObjectDisplay)(object);
-      return {
-        objectId,
-        objectType,
-        objectVersion,
-        objectFields,
-        objectDisplay
-      };
-    });
-    return parsedObjects;
-  }
-  /**
-   * @description Select coins that add up to the given amount.
-   * @param addr the address of the owner
-   * @param amount the amount that is needed for the coin
-   * @param coinType the coin type, default is '0x2::SUI::SUI'
-   */
-  async selectCoins(addr, amount, coinType = "0x2::SUI::SUI") {
-    const coins = await this.provider.getCoins({ owner: addr, coinType });
-    const selectedCoins = [];
-    let totalAmount = 0;
-    coins.data.sort((a, b) => parseInt(b.balance) - parseInt(a.balance));
-    for (const coinData of coins.data) {
-      selectedCoins.push({
-        objectId: coinData.coinObjectId,
-        digest: coinData.digest,
-        version: coinData.version
-      });
-      totalAmount = totalAmount + parseInt(coinData.balance);
-      if (totalAmount >= amount) {
-        break;
-      }
-    }
-    if (!selectedCoins.length) {
-      throw new Error("No valid coins found for the transaction.");
-    }
-    return selectedCoins;
-  }
-};
-
 // src/libs/suiTxBuilder/index.ts
-var import_sui8 = require("@mysten/sui.js");
+var import_sui5 = require("@mysten/sui.js");
 
 // src/libs/suiTxBuilder/util.ts
-var import_sui7 = require("@mysten/sui.js");
+var import_sui4 = require("@mysten/sui.js");
 var getDefaultSuiInputType = (value) => {
   if (typeof value === "string" && value.startsWith("0x")) {
     return "object";
@@ -314,7 +171,7 @@ function makeVecParam(txBlock, args, type) {
   const defaultSuiType = getDefaultSuiInputType(args[0]);
   if (type === "object" || !type && defaultSuiType === "object") {
     const objects = args.map(
-      (arg) => typeof arg === "string" ? txBlock.object((0, import_sui7.normalizeSuiObjectId)(arg)) : arg
+      (arg) => typeof arg === "string" ? txBlock.object((0, import_sui4.normalizeSuiObjectId)(arg)) : arg
     );
     return txBlock.makeMoveVec({ objects });
   } else {
@@ -330,7 +187,7 @@ function isMoveVecArg(arg) {
 function convertArgs(txBlock, args) {
   return args.map((arg) => {
     if (typeof arg === "string" && arg.startsWith("0x")) {
-      return txBlock.object((0, import_sui7.normalizeSuiObjectId)(arg));
+      return txBlock.object((0, import_sui4.normalizeSuiObjectId)(arg));
     } else if (isMoveVecArg(arg)) {
       const vecType = arg.vecType || void 0;
       return vecType ? makeVecParam(txBlock, arg.value, vecType) : makeVecParam(txBlock, arg);
@@ -345,7 +202,7 @@ function convertArgs(txBlock, args) {
 // src/libs/suiTxBuilder/index.ts
 var SuiTxBlock = class {
   constructor(transaction) {
-    this.txBlock = new import_sui8.TransactionBlock(transaction);
+    this.txBlock = new import_sui5.TransactionBlock(transaction);
   }
   //======== override methods of TransactionBlock ============
   address(value) {
@@ -527,7 +384,7 @@ var SuiTxBlock = class {
     tx.moveCall({
       target: "0x3::sui_system::request_add_stake",
       arguments: [
-        tx.object(import_sui8.SUI_SYSTEM_STATE_OBJECT_ID),
+        tx.object(import_sui5.SUI_SYSTEM_STATE_OBJECT_ID),
         stakeCoin,
         tx.pure(validatorAddr)
       ]
@@ -536,6 +393,224 @@ var SuiTxBlock = class {
   }
 };
 
+// src/libs/suiInteractor/suiInteractor.ts
+var import_sui7 = require("@mysten/sui.js");
+
+// src/libs/suiModel/suiOwnedObject.ts
+var import_sui6 = require("@mysten/sui.js");
+var SuiOwnedObject = class {
+  constructor(param) {
+    this.objectId = param.objectId;
+    this.version = param.version;
+    this.digest = param.digest;
+  }
+  /**
+   * Check if the object is fully initialized.
+   * So that when it's used as an input, it won't be necessary to fetch from fullnode again.
+   * Which can save time when sending transactions.
+   */
+  isFullObject() {
+    return !!this.version && !!this.digest;
+  }
+  asCallArg() {
+    if (!this.version || !this.digest) {
+      return this.objectId;
+    }
+    return {
+      Object: {
+        ImmOrOwned: {
+          objectId: this.objectId,
+          version: this.version,
+          digest: this.digest
+        }
+      }
+    };
+  }
+  /**
+   * Update object version & digest based on the transaction response.
+   * @param txResponse
+   */
+  updateFromTxResponse(txResponse) {
+    const changes = (0, import_sui6.getObjectChanges)(txResponse);
+    if (!changes) {
+      throw new Error("Bad transaction response!");
+    }
+    for (const change of changes) {
+      if (change.type === "mutated" && change.objectId === this.objectId) {
+        this.digest = change.digest;
+        this.version = change.version;
+        return;
+      }
+    }
+    throw new Error("Could not find object in transaction response!");
+  }
+};
+
+// src/libs/suiModel/suiSharedObject.ts
+var SuiSharedObject = class {
+  constructor(param) {
+    this.objectId = param.objectId;
+    this.initialSharedVersion = param.initialSharedVersion;
+  }
+  asCallArg(mutable = false) {
+    if (!this.initialSharedVersion) {
+      return this.objectId;
+    }
+    return {
+      Object: {
+        Shared: {
+          objectId: this.objectId,
+          initialSharedVersion: this.initialSharedVersion,
+          mutable
+        }
+      }
+    };
+  }
+};
+
+// src/libs/suiInteractor/suiInteractor.ts
+var SuiInteractor = class {
+  constructor(fullNodeUrls) {
+    if (fullNodeUrls.length === 0)
+      throw new Error("fullNodeUrls must not be empty");
+    this.providers = fullNodeUrls.map((url) => new import_sui7.JsonRpcProvider(new import_sui7.Connection({ fullnode: url })));
+    this.currentProvider = this.providers[0];
+  }
+  switchToNextProvider() {
+    const currentProviderIdx = this.providers.indexOf(this.currentProvider);
+    this.currentProvider = this.providers[(currentProviderIdx + 1) % this.providers.length];
+  }
+  async sendTx(transactionBlock, signature) {
+    const txResOptions = {
+      showEvents: true,
+      showEffects: true,
+      showObjectChanges: true,
+      showBalanceChanges: true
+    };
+    const currentProviderIdx = this.providers.indexOf(this.currentProvider);
+    const providers = [
+      ...this.providers.slice(currentProviderIdx, this.providers.length),
+      ...this.providers.slice(0, currentProviderIdx)
+    ];
+    for (const provider of providers) {
+      try {
+        const res = await this.currentProvider.executeTransactionBlock({
+          transactionBlock,
+          signature,
+          options: txResOptions
+        });
+        this.currentProvider = provider;
+        return res;
+      } catch (err) {
+        console.warn(`Failed to send transaction with fullnode ${provider.connection.fullnode}: ${err}`);
+      }
+    }
+    throw new Error("Failed to send transaction with all fullnodes");
+  }
+  async getObjects(ids) {
+    const options = { showContent: true, showDisplay: true, showType: true, showOwner: true };
+    const currentProviderIdx = this.providers.indexOf(this.currentProvider);
+    const providers = [
+      ...this.providers.slice(currentProviderIdx, this.providers.length),
+      ...this.providers.slice(0, currentProviderIdx)
+    ];
+    for (const provider of providers) {
+      try {
+        const objects = await this.currentProvider.multiGetObjects({ ids, options });
+        this.currentProvider = provider;
+        const parsedObjects = objects.map((object) => {
+          const objectId = (0, import_sui7.getObjectId)(object);
+          const objectType = (0, import_sui7.getObjectType)(object);
+          const objectVersion = (0, import_sui7.getObjectVersion)(object);
+          const objectDigest = object.data ? object.data.digest : void 0;
+          const initialSharedVersion = (0, import_sui7.getSharedObjectInitialVersion)(object);
+          const objectFields = (0, import_sui7.getObjectFields)(object);
+          const objectDisplay = (0, import_sui7.getObjectDisplay)(object);
+          return {
+            objectId,
+            objectType,
+            objectVersion,
+            objectDigest,
+            objectFields,
+            objectDisplay,
+            initialSharedVersion
+          };
+        });
+        return parsedObjects;
+      } catch (err) {
+        console.warn(`Failed to get objects with fullnode ${provider.connection.fullnode}: ${err}`);
+      }
+    }
+    throw new Error("Failed to get objects with all fullnodes");
+  }
+  async getObject(id) {
+    const objects = await this.getObjects([id]);
+    return objects[0];
+  }
+  /**
+   * @description Update objects in a batch
+   * @param suiObjects
+   */
+  async updateObjects(suiObjects) {
+    const objectIds = suiObjects.map((obj) => obj.objectId);
+    const objects = await this.getObjects(objectIds);
+    for (const object of objects) {
+      const suiObject = suiObjects.find((obj) => obj.objectId === object.objectId);
+      if (suiObject instanceof SuiSharedObject) {
+        suiObject.initialSharedVersion = object.initialSharedVersion;
+      } else if (suiObject instanceof SuiOwnedObject) {
+        suiObject.version = object.objectVersion;
+        suiObject.digest = object.objectDigest;
+      }
+    }
+  }
+  /**
+   * @description Select coins that add up to the given amount.
+   * @param addr the address of the owner
+   * @param amount the amount that is needed for the coin
+   * @param coinType the coin type, default is '0x2::SUI::SUI'
+   */
+  async selectCoins(addr, amount, coinType = "0x2::SUI::SUI") {
+    const coins = await this.currentProvider.getCoins({ owner: addr, coinType });
+    const selectedCoins = [];
+    let totalAmount = 0;
+    coins.data.sort((a, b) => parseInt(b.balance) - parseInt(a.balance));
+    for (const coinData of coins.data) {
+      selectedCoins.push({
+        objectId: coinData.coinObjectId,
+        digest: coinData.digest,
+        version: coinData.version
+      });
+      totalAmount = totalAmount + parseInt(coinData.balance);
+      if (totalAmount >= amount) {
+        break;
+      }
+    }
+    if (!selectedCoins.length) {
+      throw new Error("No valid coins found for the transaction.");
+    }
+    return selectedCoins;
+  }
+};
+
+// src/libs/suiInteractor/defaultConfig.ts
+var import_sui8 = require("@mysten/sui.js");
+var defaultGasBudget = 10 ** 8;
+var getDefaultConnection = (networkType = "devnet") => {
+  switch (networkType) {
+    case "localnet":
+      return import_sui8.localnetConnection;
+    case "devnet":
+      return import_sui8.devnetConnection;
+    case "testnet":
+      return import_sui8.testnetConnection;
+    case "mainnet":
+      return import_sui8.mainnetConnection;
+    default:
+      return import_sui8.devnetConnection;
+  }
+};
+
 // src/suiKit.ts
 var SuiKit = class {
   /**
@@ -548,21 +623,16 @@ var SuiKit = class {
    * @param secretKey, base64 or hex string, when mnemonics is provided, secretKey will be ignored
    * @param networkType, 'testnet' | 'mainnet' | 'devnet' | 'localnet', default is 'devnet'
    * @param fullnodeUrl, the fullnode url, default is the preconfig fullnode url for the given network type
-   * @param faucetUrl, the faucet url, default is the preconfig faucet url for the given network type
    */
   constructor({
     mnemonics,
     secretKey,
     networkType,
-    fullnodeUrl,
-    faucetUrl
+    fullnodeUrls
   } = {}) {
     this.accountManager = new SuiAccountManager({ mnemonics, secretKey });
-    this.rpcProvider = new SuiRpcProvider({
-      fullnodeUrl,
-      faucetUrl,
-      networkType
-    });
+    fullnodeUrls = fullnodeUrls || [getDefaultConnection(networkType).fullnode];
+    this.suiInteractor = new SuiInteractor(fullnodeUrls);
   }
   /**
    * if derivePathParams is not provided or mnemonics is empty, it will return the currentSigner.
@@ -572,7 +642,7 @@ var SuiKit = class {
    */
   getSigner(derivePathParams) {
     const keyPair = this.accountManager.getKeyPair(derivePathParams);
-    return new import_sui9.RawSigner(keyPair, this.rpcProvider.provider);
+    return new import_sui9.RawSigner(keyPair, this.suiInteractor.currentProvider);
   }
   /**
    * @description Switch the current account with the given derivePathParams
@@ -592,22 +662,21 @@ var SuiKit = class {
     return this.accountManager.currentAddress;
   }
   provider() {
-    return this.rpcProvider.provider;
-  }
-  /**
-   * Request some SUI from faucet
-   * @Returns {Promise<boolean>}, true if the request is successful, false otherwise.
-   */
-  async requestFaucet(derivePathParams) {
-    const addr = this.accountManager.getAddress(derivePathParams);
-    return this.rpcProvider.requestFaucet(addr);
+    return this.suiInteractor.currentProvider;
   }
   async getBalance(coinType, derivePathParams) {
     const owner = this.accountManager.getAddress(derivePathParams);
-    return this.rpcProvider.getBalance(owner, coinType);
+    return this.suiInteractor.currentProvider.getBalance({ owner, coinType });
   }
   async getObjects(objectIds) {
-    return this.rpcProvider.getObjects(objectIds);
+    return this.suiInteractor.getObjects(objectIds);
+  }
+  /**
+   * @description Update objects in a batch
+   * @param suiObjects
+   */
+  async updateObjects(suiObjects) {
+    return this.suiInteractor.updateObjects(suiObjects);
   }
   async signTxn(tx, derivePathParams) {
     tx = tx instanceof SuiTxBlock ? tx.txBlock : tx;
@@ -615,16 +684,8 @@ var SuiKit = class {
     return signer.signTransactionBlock({ transactionBlock: tx });
   }
   async signAndSendTxn(tx, derivePathParams) {
-    tx = tx instanceof SuiTxBlock ? tx.txBlock : tx;
-    const signer = this.getSigner(derivePathParams);
-    return signer.signAndExecuteTransactionBlock({
-      transactionBlock: tx,
-      options: {
-        showEffects: true,
-        showEvents: true,
-        showObjectChanges: true
-      }
-    });
+    const { transactionBlockBytes, signature } = await this.signTxn(tx, derivePathParams);
+    return this.suiInteractor.sendTx(transactionBlockBytes, signature);
   }
   /**
    * Transfer the given amount of SUI to the recipient
@@ -659,7 +720,7 @@ var SuiKit = class {
     const tx = new SuiTxBlock();
     const owner = this.accountManager.getAddress(derivePathParams);
     const totalAmount = amounts.reduce((a, b) => a + b, 0);
-    const coins = await this.rpcProvider.selectCoins(
+    const coins = await this.suiInteractor.selectCoins(
       owner,
       totalAmount,
       coinType
@@ -704,7 +765,7 @@ var SuiKit = class {
    */
   async selectCoinsWithAmount(amount, coinType, owner) {
     owner = owner || this.accountManager.currentAddress;
-    const coins = await this.rpcProvider.selectCoins(owner, amount, coinType);
+    const coins = await this.suiInteractor.selectCoins(owner, amount, coinType);
     return coins.map((c) => c.objectId);
   }
   /**
@@ -727,7 +788,7 @@ var SuiKit = class {
    */
   async inspectTxn(tx, derivePathParams) {
     tx = tx instanceof SuiTxBlock ? tx.txBlock : tx;
-    return this.rpcProvider.provider.devInspectTransactionBlock({
+    return this.suiInteractor.currentProvider.devInspectTransactionBlock({
       transactionBlock: tx,
       sender: this.getAddress(derivePathParams)
     });
@@ -739,7 +800,6 @@ var SuiKit = class {
   SUI_SYSTEM_STATE_OBJECT_ID,
   SuiAccountManager,
   SuiKit,
-  SuiRpcProvider,
   SuiTxBlock,
   TransactionBlock
 });