@mysten/sui 1.26.1 → 1.27.0

package/dist/cjs/client/client.js

@@ -33,7 +33,7 @@ const SUI_CLIENT_BRAND = Symbol.for("@mysten/SuiClient");
 function isSuiClient(client) {
   return typeof client === "object" && client !== null && client[SUI_CLIENT_BRAND] === true;
 }
-class SuiClient extends import_client.Experimental_SuiClient {
+class SuiClient extends import_client.Experimental_BaseClient {
   /**
    * Establish a connection to a Sui RPC endpoint
    *
@@ -42,15 +42,17 @@ class SuiClient extends import_client.Experimental_SuiClient {
   constructor(options) {
     super({ network: options.network ?? "unknown" });
     this.core = new import_jsonRPC.JSONRpcTransport(this);
+    this.jsonRpc = this;
     this.transport = options.transport ?? new import_http_transport.SuiHTTPTransport({ url: options.url });
   }
   get [SUI_CLIENT_BRAND]() {
     return true;
   }
-  async getRpcApiVersion() {
+  async getRpcApiVersion({ signal } = {}) {
     const resp = await this.transport.request({
       method: "rpc.discover",
-      params: []
+      params: [],
+      signal
     });
     return resp.info.version;
   }
@@ -63,7 +65,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
     }
     return await this.transport.request({
       method: "suix_getCoins",
-      params: [input.owner, input.coinType, input.cursor, input.limit]
+      params: [input.owner, input.coinType, input.cursor, input.limit],
+      signal: input.signal
     });
   }
   /**
@@ -75,7 +78,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
     }
     return await this.transport.request({
       method: "suix_getAllCoins",
-      params: [input.owner, input.cursor, input.limit]
+      params: [input.owner, input.cursor, input.limit],
+      signal: input.signal
     });
   }
   /**
@@ -87,7 +91,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
     }
     return await this.transport.request({
       method: "suix_getBalance",
-      params: [input.owner, input.coinType]
+      params: [input.owner, input.coinType],
+      signal: input.signal
     });
   }
   /**
@@ -97,7 +102,11 @@ class SuiClient extends import_client.Experimental_SuiClient {
     if (!input.owner || !(0, import_sui_types.isValidSuiAddress)((0, import_sui_types.normalizeSuiAddress)(input.owner))) {
       throw new Error("Invalid Sui address");
     }
-    return await this.transport.request({ method: "suix_getAllBalances", params: [input.owner] });
+    return await this.transport.request({
+      method: "suix_getAllBalances",
+      params: [input.owner],
+      signal: input.signal
+    });
   }
   /**
    * Fetch CoinMetadata for a given coin type
@@ -105,7 +114,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
   async getCoinMetadata(input) {
     return await this.transport.request({
       method: "suix_getCoinMetadata",
-      params: [input.coinType]
+      params: [input.coinType],
+      signal: input.signal
     });
   }
   /**
@@ -114,7 +124,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
   async getTotalSupply(input) {
     return await this.transport.request({
       method: "suix_getTotalSupply",
-      params: [input.coinType]
+      params: [input.coinType],
+      signal: input.signal
     });
   }
   /**
@@ -122,8 +133,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
    * @param method the method to be invoked
    * @param args the arguments to be passed to the RPC request
    */
-  async call(method, params) {
-    return await this.transport.request({ method, params });
+  async call(method, params, { signal } = {}) {
+    return await this.transport.request({ method, params, signal });
   }
   /**
    * Get Move function argument types like read, write and full access
@@ -131,7 +142,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
   async getMoveFunctionArgTypes(input) {
     return await this.transport.request({
       method: "sui_getMoveFunctionArgTypes",
-      params: [input.package, input.module, input.function]
+      params: [input.package, input.module, input.function],
+      signal: input.signal
     });
   }
   /**
@@ -141,7 +153,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
   async getNormalizedMoveModulesByPackage(input) {
     return await this.transport.request({
       method: "sui_getNormalizedMoveModulesByPackage",
-      params: [input.package]
+      params: [input.package],
+      signal: input.signal
     });
   }
   /**
@@ -150,7 +163,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
   async getNormalizedMoveModule(input) {
     return await this.transport.request({
       method: "sui_getNormalizedMoveModule",
-      params: [input.package, input.module]
+      params: [input.package, input.module],
+      signal: input.signal
     });
   }
   /**
@@ -159,7 +173,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
   async getNormalizedMoveFunction(input) {
     return await this.transport.request({
       method: "sui_getNormalizedMoveFunction",
-      params: [input.package, input.module, input.function]
+      params: [input.package, input.module, input.function],
+      signal: input.signal
     });
   }
   /**
@@ -168,7 +183,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
   async getNormalizedMoveStruct(input) {
     return await this.transport.request({
       method: "sui_getNormalizedMoveStruct",
-      params: [input.package, input.module, input.struct]
+      params: [input.package, input.module, input.struct],
+      signal: input.signal
     });
   }
   /**
@@ -188,7 +204,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
         },
         input.cursor,
         input.limit
-      ]
+      ],
+      signal: input.signal
     });
   }
   /**
@@ -200,13 +217,15 @@ class SuiClient extends import_client.Experimental_SuiClient {
     }
     return await this.transport.request({
       method: "sui_getObject",
-      params: [input.id, input.options]
+      params: [input.id, input.options],
+      signal: input.signal
     });
   }
   async tryGetPastObject(input) {
     return await this.transport.request({
       method: "sui_tryGetPastObject",
-      params: [input.id, input.version, input.options]
+      params: [input.id, input.version, input.options],
+      signal: input.signal
     });
   }
   /**
@@ -224,7 +243,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
     }
     return await this.transport.request({
       method: "sui_multiGetObjects",
-      params: [input.ids, input.options]
+      params: [input.ids, input.options],
+      signal: input.signal
     });
   }
   /**
@@ -241,7 +261,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
         input.cursor,
         input.limit,
         (input.order || "descending") === "descending"
-      ]
+      ],
+      signal: input.signal
     });
   }
   async getTransactionBlock(input) {
@@ -250,7 +271,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
     }
     return await this.transport.request({
       method: "sui_getTransactionBlock",
-      params: [input.digest, input.options]
+      params: [input.digest, input.options],
+      signal: input.signal
     });
   }
   async multiGetTransactionBlocks(input) {
@@ -265,14 +287,16 @@ class SuiClient extends import_client.Experimental_SuiClient {
     }
     return await this.transport.request({
       method: "sui_multiGetTransactionBlocks",
-      params: [input.digests, input.options]
+      params: [input.digests, input.options],
+      signal: input.signal
     });
   }
   async executeTransactionBlock({
     transactionBlock,
     signature,
     options,
-    requestType
+    requestType,
+    signal
   }) {
     const result = await this.transport.request({
       method: "sui_executeTransactionBlock",
@@ -280,7 +304,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
         typeof transactionBlock === "string" ? transactionBlock : (0, import_bcs.toBase64)(transactionBlock),
         Array.isArray(signature) ? signature : [signature],
         options
-      ]
+      ],
+      signal
     });
     if (requestType === "WaitForLocalExecution") {
       try {
@@ -314,20 +339,22 @@ class SuiClient extends import_client.Experimental_SuiClient {
   /**
    * Get total number of transactions
    */
-  async getTotalTransactionBlocks() {
+  async getTotalTransactionBlocks({ signal } = {}) {
     const resp = await this.transport.request({
       method: "sui_getTotalTransactionBlocks",
-      params: []
+      params: [],
+      signal
     });
     return BigInt(resp);
   }
   /**
    * Getting the reference gas price for the network
    */
-  async getReferenceGasPrice() {
+  async getReferenceGasPrice({ signal } = {}) {
     const resp = await this.transport.request({
       method: "suix_getReferenceGasPrice",
-      params: []
+      params: [],
+      signal
     });
     return BigInt(resp);
   }
@@ -338,7 +365,11 @@ class SuiClient extends import_client.Experimental_SuiClient {
     if (!input.owner || !(0, import_sui_types.isValidSuiAddress)((0, import_sui_types.normalizeSuiAddress)(input.owner))) {
       throw new Error("Invalid Sui address");
     }
-    return await this.transport.request({ method: "suix_getStakes", params: [input.owner] });
+    return await this.transport.request({
+      method: "suix_getStakes",
+      params: [input.owner],
+      signal: input.signal
+    });
   }
   /**
    * Return the delegated stakes queried by id.
@@ -351,14 +382,21 @@ class SuiClient extends import_client.Experimental_SuiClient {
     });
     return await this.transport.request({
       method: "suix_getStakesByIds",
-      params: [input.stakedSuiIds]
+      params: [input.stakedSuiIds],
+      signal: input.signal
     });
   }
   /**
    * Return the latest system state content.
    */
-  async getLatestSuiSystemState() {
-    return await this.transport.request({ method: "suix_getLatestSuiSystemState", params: [] });
+  async getLatestSuiSystemState({
+    signal
+  } = {}) {
+    return await this.transport.request({
+      method: "suix_getLatestSuiSystemState",
+      params: [],
+      signal
+    });
   }
   /**
    * Get events for a given query criteria
@@ -371,7 +409,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
         input.cursor,
         input.limit,
         (input.order || "descending") === "descending"
-      ]
+      ],
+      signal: input.signal
     });
   }
   /**
@@ -384,7 +423,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
       method: "suix_subscribeEvent",
       unsubscribe: "suix_unsubscribeEvent",
       params: [input.filter],
-      onMessage: input.onMessage
+      onMessage: input.onMessage,
+      signal: input.signal
     });
   }
   /**
@@ -395,7 +435,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
       method: "suix_subscribeTransaction",
       unsubscribe: "suix_unsubscribeTransaction",
       params: [input.filter],
-      onMessage: input.onMessage
+      onMessage: input.onMessage,
+      signal: input.signal
     });
   }
   /**
@@ -420,9 +461,11 @@ class SuiClient extends import_client.Experimental_SuiClient {
     } else {
       throw new Error("Unknown transaction block format.");
     }
+    input.signal?.throwIfAborted();
     return await this.transport.request({
       method: "sui_devInspectTransactionBlock",
-      params: [input.sender, devInspectTxBytes, input.gasPrice?.toString(), input.epoch]
+      params: [input.sender, devInspectTxBytes, input.gasPrice?.toString(), input.epoch],
+      signal: input.signal
     });
   }
   /**
@@ -445,7 +488,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
     }
     return await this.transport.request({
       method: "suix_getDynamicFields",
-      params: [input.parentId, input.cursor, input.limit]
+      params: [input.parentId, input.cursor, input.limit],
+      signal: input.signal
     });
   }
   /**
@@ -454,16 +498,20 @@ class SuiClient extends import_client.Experimental_SuiClient {
   async getDynamicFieldObject(input) {
     return await this.transport.request({
       method: "suix_getDynamicFieldObject",
-      params: [input.parentId, input.name]
+      params: [input.parentId, input.name],
+      signal: input.signal
     });
   }
   /**
    * Get the sequence number of the latest checkpoint that has been executed
    */
-  async getLatestCheckpointSequenceNumber() {
+  async getLatestCheckpointSequenceNumber({
+    signal
+  } = {}) {
     const resp = await this.transport.request({
       method: "sui_getLatestCheckpointSequenceNumber",
-      params: []
+      params: [],
+      signal
     });
     return String(resp);
   }
@@ -471,7 +519,11 @@ class SuiClient extends import_client.Experimental_SuiClient {
    * Returns information about a given checkpoint
    */
   async getCheckpoint(input) {
-    return await this.transport.request({ method: "sui_getCheckpoint", params: [input.id] });
+    return await this.transport.request({
+      method: "sui_getCheckpoint",
+      params: [input.id],
+      signal: input.signal
+    });
   }
   /**
    * Returns historical checkpoints paginated
@@ -479,7 +531,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
   async getCheckpoints(input) {
     return await this.transport.request({
       method: "sui_getCheckpoints",
-      params: [input.cursor, input?.limit, input.descendingOrder]
+      params: [input.cursor, input?.limit, input.descendingOrder],
+      signal: input.signal
     });
   }
   /**
@@ -488,25 +541,36 @@ class SuiClient extends import_client.Experimental_SuiClient {
   async getCommitteeInfo(input) {
     return await this.transport.request({
       method: "suix_getCommitteeInfo",
-      params: [input?.epoch]
+      params: [input?.epoch],
+      signal: input?.signal
     });
   }
-  async getNetworkMetrics() {
-    return await this.transport.request({ method: "suix_getNetworkMetrics", params: [] });
+  async getNetworkMetrics({ signal } = {}) {
+    return await this.transport.request({
+      method: "suix_getNetworkMetrics",
+      params: [],
+      signal
+    });
   }
-  async getAddressMetrics() {
-    return await this.transport.request({ method: "suix_getLatestAddressMetrics", params: [] });
+  async getAddressMetrics({ signal } = {}) {
+    return await this.transport.request({
+      method: "suix_getLatestAddressMetrics",
+      params: [],
+      signal
+    });
   }
   async getEpochMetrics(input) {
     return await this.transport.request({
       method: "suix_getEpochMetrics",
-      params: [input?.cursor, input?.limit, input?.descendingOrder]
+      params: [input?.cursor, input?.limit, input?.descendingOrder],
+      signal: input?.signal
     });
   }
   async getAllEpochAddressMetrics(input) {
     return await this.transport.request({
       method: "suix_getAllEpochAddressMetrics",
-      params: [input?.descendingOrder]
+      params: [input?.descendingOrder],
+      signal: input?.signal
     });
   }
   /**
@@ -515,37 +579,51 @@ class SuiClient extends import_client.Experimental_SuiClient {
   async getEpochs(input) {
     return await this.transport.request({
       method: "suix_getEpochs",
-      params: [input?.cursor, input?.limit, input?.descendingOrder]
+      params: [input?.cursor, input?.limit, input?.descendingOrder],
+      signal: input?.signal
     });
   }
   /**
    * Returns list of top move calls by usage
    */
-  async getMoveCallMetrics() {
-    return await this.transport.request({ method: "suix_getMoveCallMetrics", params: [] });
+  async getMoveCallMetrics({ signal } = {}) {
+    return await this.transport.request({
+      method: "suix_getMoveCallMetrics",
+      params: [],
+      signal
+    });
   }
   /**
    * Return the committee information for the asked epoch
    */
-  async getCurrentEpoch() {
-    return await this.transport.request({ method: "suix_getCurrentEpoch", params: [] });
+  async getCurrentEpoch({ signal } = {}) {
+    return await this.transport.request({
+      method: "suix_getCurrentEpoch",
+      params: [],
+      signal
+    });
   }
   /**
    * Return the Validators APYs
    */
-  async getValidatorsApy() {
-    return await this.transport.request({ method: "suix_getValidatorsApy", params: [] });
+  async getValidatorsApy({ signal } = {}) {
+    return await this.transport.request({
+      method: "suix_getValidatorsApy",
+      params: [],
+      signal
+    });
   }
   // TODO: Migrate this to `sui_getChainIdentifier` once it is widely available.
-  async getChainIdentifier() {
-    const checkpoint = await this.getCheckpoint({ id: "0" });
+  async getChainIdentifier({ signal } = {}) {
+    const checkpoint = await this.getCheckpoint({ id: "0", signal });
     const bytes = (0, import_bcs.fromBase58)(checkpoint.digest);
     return (0, import_bcs.toHex)(bytes.slice(0, 4));
   }
   async resolveNameServiceAddress(input) {
     return await this.transport.request({
       method: "suix_resolveNameServiceAddress",
-      params: [input.name]
+      params: [input.name],
+      signal: input.signal
     });
   }
   async resolveNameServiceNames({
@@ -554,7 +632,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
   }) {
     const { nextCursor, hasNextPage, data } = await this.transport.request({
       method: "suix_resolveNameServiceNames",
-      params: [input.address, input.cursor, input.limit]
+      params: [input.address, input.cursor, input.limit],
+      signal: input.signal
     });
     return {
       hasNextPage,
@@ -565,7 +644,8 @@ class SuiClient extends import_client.Experimental_SuiClient {
   async getProtocolConfig(input) {
     return await this.transport.request({
       method: "sui_getProtocolConfig",
-      params: [input?.version]
+      params: [input?.version],
+      signal: input?.signal
     });
   }
   /**