wowok 2.1.38 → 2.1.40

package/dist/cjs/jsonRpc/client.js

@@ -1,5 +1,3 @@
-// Copyright (c) Mysten Labs, Inc.
-// SPDX-License-Identifier: Apache-2.0
 import { fromBase58, toBase64, toHex } from "@mysten/bcs";
 import { Experimental_BaseClient } from "../experimental/client.js";
 import { isTransaction } from "../transactions/Transaction.js";
@@ -19,11 +17,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
     get [SUI_CLIENT_BRAND]() {
         return true;
     }
-    /**
-     * Establish a connection to a Sui RPC endpoint
-     *
-     * @param options configuration options for the API Client
-     */
     constructor(options) {
         super({ network: options.network ?? "unknown" });
         this.transport =
@@ -40,9 +33,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
         });
         return resp.info.version;
     }
-    /**
-     * Get all Coin<`coin_type`> objects owned by an address.
-     */
     async getCoins({ coinType, owner, cursor, limit, signal, }) {
         if (!owner || !isValidWowAddress(normalizeWowAddress(owner))) {
             throw new Error("Invalid Wow address");
@@ -53,9 +43,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: signal,
         });
     }
-    /**
-     * Get all Coin objects owned by an address.
-     */
     async getAllCoins(input) {
         if (!input.owner ||
             !isValidWowAddress(normalizeWowAddress(input.owner))) {
@@ -67,9 +54,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: input.signal,
         });
     }
-    /**
-     * Get the total coin balance for one coin type, owned by the address owner.
-     */
     async getBalance({ owner, coinType, signal, }) {
         if (!owner || !isValidWowAddress(normalizeWowAddress(owner))) {
             throw new Error("Invalid Wow address");
@@ -80,9 +64,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: signal,
         });
     }
-    /**
-     * Get the total coin balance for all coin types, owned by the address owner.
-     */
     async getAllBalances(input) {
         if (!input.owner ||
             !isValidWowAddress(normalizeWowAddress(input.owner))) {
@@ -94,9 +75,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: input.signal,
         });
     }
-    /**
-     * Fetch CoinMetadata for a given coin type
-     */
     async getCoinMetadata({ coinType, signal, }) {
         return await this.transport.request({
             method: "wx_getCoinMetadata",
@@ -104,9 +82,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: signal,
         });
     }
-    /**
-     *  Fetch total supply for a coin
-     */
     async getTotalSupply({ coinType, signal, }) {
         return await this.transport.request({
             method: "wx_getTotalSupply",
@@ -114,17 +89,9 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: signal,
         });
     }
-    /**
-     * Invoke any RPC method
-     * @param method the method to be invoked
-     * @param args the arguments to be passed to the RPC request
-     */
     async call(method, params, { signal } = {}) {
         return await this.transport.request({ method, params, signal });
     }
-    /**
-     * Get Move function argument types like read, write and full access
-     */
     async getMoveFunctionArgTypes({ package: pkg, module, function: fn, signal, }) {
         return await this.transport.request({
             method: "w_getMoveFunctionArgTypes",
@@ -132,10 +99,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: signal,
         });
     }
-    /**
-     * Get a map from module name to
-     * structured representations of Move modules
-     */
     async getNormalizedMoveModulesByPackage({ package: pkg, signal, }) {
         return await this.transport.request({
             method: "w_getNormalizedMoveModulesByPackage",
@@ -143,9 +106,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: signal,
         });
     }
-    /**
-     * Get a structured representation of Move module
-     */
     async getNormalizedMoveModule({ package: pkg, module, signal, }) {
         return await this.transport.request({
             method: "w_getNormalizedMoveModule",
@@ -153,9 +113,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: signal,
         });
     }
-    /**
-     * Get a structured representation of Move function
-     */
     async getNormalizedMoveFunction({ package: pkg, module, function: fn, signal, }) {
         return await this.transport.request({
             method: "w_getNormalizedMoveFunction",
@@ -163,12 +120,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: signal,
         });
     }
-    /**
-     * Get a structured representation of Move struct
-     */
-    /**
-     * Get the normalized Move struct from a package
-     */
     async getNormalizedMoveStruct({ package: pkg, module, struct, signal, }) {
         return await this.transport.request({
             method: "w_getNormalizedMoveStruct",
@@ -176,9 +127,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: signal,
         });
     }
-    /**
-     * Get all objects owned by an address
-     */
     async getOwnedObjects(input) {
         if (!input.owner ||
             !isValidWowAddress(normalizeWowAddress(input.owner))) {
@@ -198,9 +146,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: input.signal,
         });
     }
-    /**
-     * Get details about an object
-     */
     async getObject(input) {
         if (!input.id || !isValidWowObjectId(normalizeWowObjectId(input.id))) {
             throw new Error("Invalid object ID");
@@ -234,9 +179,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: input.signal,
         });
     }
-    /**
-     * Get transaction blocks for a given query criteria
-     */
     async queryTransactionBlocks({ filter, options, cursor, limit, order, signal, }) {
         return await this.transport.request({
             method: "wx_queryTransactionBlocks",
@@ -298,7 +240,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
                 });
             }
             catch (e) {
-                // continue regardless of outcome
             }
         }
         return result;
@@ -319,9 +260,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             ...input,
         });
     }
-    /**
-     * Get total number of transactions
-     */
     async getTotalTransactionBlocks({ signal, } = {}) {
         const resp = await this.transport.request({
             method: "w_getTotalTransactionBlocks",
@@ -330,9 +268,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
         });
         return BigInt(resp);
     }
-    /**
-     * Getting the reference gas price for the network
-     */
     async getReferenceGasPrice({ signal, } = {}) {
         const resp = await this.transport.request({
             method: "wx_getReferenceGasPrice",
@@ -341,9 +276,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
         });
         return BigInt(resp);
     }
-    /**
-     * Return the delegated stakes for an address
-     */
     async getStakes(input) {
         if (!input.owner ||
             !isValidWowAddress(normalizeWowAddress(input.owner))) {
@@ -355,9 +287,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: input.signal,
         });
     }
-    /**
-     * Return the delegated stakes queried by id.
-     */
     async getStakesByIds(input) {
         input.stakedSuiIds.forEach((id) => {
             if (!id || !isValidWowObjectId(normalizeWowObjectId(id))) {
@@ -370,9 +299,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: input.signal,
         });
     }
-    /**
-     * Return the latest system state content.
-     */
     async getLatestSuiSystemState({ signal, } = {}) {
         return await this.transport.request({
             method: "wx_getLatestSuiSystemState",
@@ -380,9 +306,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal,
         });
     }
-    /**
-     * Get events for a given query criteria
-     */
     async queryEvents({ query, cursor, limit, order, signal, }) {
         return await this.transport.request({
             method: "wx_queryEvents",
@@ -395,11 +318,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal,
         });
     }
-    /**
-     * Subscribe to get notifications whenever an event matching the filter occurs
-     *
-     * @deprecated
-     */
     async subscribeEvent(input) {
         return this.transport.subscribe({
             method: "wx_subscribeEvent",
@@ -409,9 +327,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: input.signal,
         });
     }
-    /**
-     * @deprecated
-     */
     async subscribeTransaction(input) {
         return this.transport.subscribe({
             method: "wx_subscribeTransaction",
@@ -421,11 +336,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: input.signal,
         });
     }
-    /**
-     * Runs the transaction block in dev-inspect mode. Which allows for nearly any
-     * transaction (or Move call) with any arguments. Detailed results are
-     * provided, including both the transaction effects and any return values.
-     */
     async devInspectTransactionBlock(input) {
         let devInspectTxBytes;
         if (isTransaction(input.transactionBlock)) {
@@ -456,9 +366,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: input.signal,
         });
     }
-    /**
-     * Dry run a transaction block and return the result.
-     */
     async dryRunTransactionBlock(input) {
         return await this.transport.request({
             method: "w_dryRunTransactionBlock",
@@ -469,9 +376,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             ],
         });
     }
-    /**
-     * Return the list of dynamic field objects owned by an object
-     */
     async getDynamicFields(input) {
         if (!input.parentId ||
             !isValidWowObjectId(normalizeWowObjectId(input.parentId))) {
@@ -483,9 +387,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: input.signal,
         });
     }
-    /**
-     * Return the dynamic field object information for a specified object
-     */
     async getDynamicFieldObject(input) {
         return await this.transport.request({
             method: "wx_getDynamicFieldObject",
@@ -493,9 +394,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: input.signal,
         });
     }
-    /**
-     * Get the sequence number of the latest checkpoint that has been executed
-     */
     async getLatestCheckpointSequenceNumber({ signal, } = {}) {
         const resp = await this.transport.request({
             method: "w_getLatestCheckpointSequenceNumber",
@@ -504,9 +402,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
         });
         return String(resp);
     }
-    /**
-     * Returns information about a given checkpoint
-     */
     async getCheckpoint(input) {
         return await this.transport.request({
             method: "w_getCheckpoint",
@@ -514,12 +409,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: input.signal,
         });
     }
-    /**
-     * Returns historical checkpoints paginated
-     */
-    /**
-     * Return the committee information for the asked epoch
-     */
     async getCheckpoints(input) {
         return await this.transport.request({
             method: "w_getCheckpoints",
@@ -527,9 +416,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: input.signal,
         });
     }
-    /**
-     * Return the committee information for the asked epoch
-     */
     async getCommitteeInfo(input) {
         return await this.transport.request({
             method: "wx_getCommitteeInfo",
@@ -565,9 +451,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: input?.signal,
         });
     }
-    /**
-     * Return the committee information for the asked epoch
-     */
     async getEpochs(input) {
         return await this.transport.request({
             method: "wx_getEpochs",
@@ -575,9 +458,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: input?.signal,
         });
     }
-    /**
-     * Returns list of top move calls by usage
-     */
     async getMoveCallMetrics({ signal, } = {}) {
         return await this.transport.request({
             method: "wx_getMoveCallMetrics",
@@ -585,9 +465,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal,
         });
     }
-    /**
-     * Return the committee information for the asked epoch
-     */
     async getCurrentEpoch({ signal, } = {}) {
         return await this.transport.request({
             method: "wx_getCurrentEpoch",
@@ -595,9 +472,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal,
         });
     }
-    /**
-     * Return the Validators APYs
-     */
     async getValidatorsApy({ signal, } = {}) {
         return await this.transport.request({
             method: "wx_getValidatorsApy",
@@ -605,7 +479,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal,
         });
     }
-    // TODO: Migrate this to `sui_getChainIdentifier` once it is widely available.
     async getChainIdentifier({ signal, } = {}) {
         const checkpoint = await this.getCheckpoint({ id: "0", signal });
         const bytes = fromBase58(checkpoint.digest);
@@ -618,19 +491,12 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             signal: input?.signal,
         });
     }
-    /**
-     * Wait for a transaction block result to be available over the API.
-     * This can be used in conjunction with `executeTransactionBlock` to wait for the transaction to
-     * be available via the API.
-     * This currently polls the `getTransactionBlock` API to check for the transaction.
-     */
     async waitForTransaction({ signal, timeout = 60 * 1000, pollInterval = 2 * 1000, ...input }) {
         const timeoutSignal = AbortSignal.timeout(timeout);
         const timeoutPromise = new Promise((_, reject) => {
             timeoutSignal.addEventListener("abort", () => reject(timeoutSignal.reason));
         });
         timeoutPromise.catch(() => {
-            // Swallow unhandled rejections that might be thrown after early return
         });
         while (!timeoutSignal.aborted) {
             signal?.throwIfAborted();
@@ -638,7 +504,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
                 return await this.getTransactionBlock(input);
             }
             catch {
-                // Wait for either the next poll interval, or the timeout.
                 await Promise.race([
                     new Promise((resolve) => setTimeout(resolve, pollInterval)),
                     timeoutPromise,
@@ -646,8 +511,6 @@ export class SuiJsonRpcClient extends Experimental_BaseClient {
             }
         }
         timeoutSignal.throwIfAborted();
-        // This should never happen, because the above case should always throw, but just adding it in the event that something goes horribly wrong.
         throw new Error("Unexpected error while waiting for transaction block.");
     }
 }
-//# sourceMappingURL=client.js.map

package/dist/cjs/jsonRpc/core.js

@@ -1,5 +1,3 @@
-// Copyright (c) Mysten Labs, Inc.
-// SPDX-License-Identifier: Apache-2.0
 import { fromBase64 } from "@mysten/bcs";
 import { bcs } from "../bcs/index.js";
 import { Transaction } from "../transactions/Transaction.js";
@@ -587,4 +585,3 @@ function parseVisibility(visibility) {
             return "unknown";
     }
 }
-//# sourceMappingURL=core.js.map

package/dist/cjs/jsonRpc/errors.js

@@ -1,5 +1,3 @@
-// Copyright (c) Mysten Labs, Inc.
-// SPDX-License-Identifier: Apache-2.0
 const CODE_TO_ERROR_TYPE = {
     "-32700": "ParseError",
     "-32701": "OversizedRequest",
@@ -38,4 +36,3 @@ export class SuiHTTPStatusError extends SuiHTTPTransportError {
         this.statusText = statusText;
     }
 }
-//# sourceMappingURL=errors.js.map

package/dist/cjs/jsonRpc/http-transport.d.ts

@@ -1,7 +1,4 @@
 import type { WebsocketClientOptions } from "./rpc-websocket-client.js";
-/**
- * An object defining headers to be passed to the RPC server
- */
 export type HttpHeaders = {
     [header: string]: string;
 };

package/dist/cjs/jsonRpc/http-transport.js

@@ -1,5 +1,3 @@
-// Copyright (c) Mysten Labs, Inc.
-// SPDX-License-Identifier: Apache-2.0
 import { PACKAGE_VERSION, TARGETED_RPC_VERSION } from "../version.js";
 import { JsonRpcError, SuiHTTPStatusError } from "./errors.js";
 import { WebsocketClient } from "./rpc-websocket-client.js";
@@ -70,4 +68,3 @@ export class JsonRpcHTTPTransport {
         return async () => !!(await unsubscribe());
     }
 }
-//# sourceMappingURL=http-transport.js.map

package/dist/cjs/jsonRpc/index.js

@@ -1,6 +1,3 @@
-// Copyright (c) Mysten Labs, Inc.
-// SPDX-License-Identifier: Apache-2.0
 export { JsonRpcHTTPTransport, } from "./http-transport.js";
 export { isSuiJsonRpcClient, SuiJsonRpcClient, } from "./client.js";
 export { SuiHTTPStatusError, SuiHTTPTransportError, JsonRpcError, } from "./errors.js";
-//# sourceMappingURL=index.js.map

package/dist/cjs/jsonRpc/json-rpc-resolver.js

@@ -1,14 +1,10 @@
-// Copyright (c) Mysten Labs, Inc.
-// SPDX-License-Identifier: Apache-2.0
 import { parse } from "valibot";
 import { normalizeWowAddress, normalizeWowObjectId, WOW_TYPE_ARG, } from "../utils/index.js";
 import { ObjectRefSchema } from "../transactions/data/internal.js";
 import { Inputs } from "../transactions/Inputs.js";
 import { getPureBcsSchema, isTxContext, normalizedTypeToMoveTypeSignature, } from "../transactions/serializer.js";
 import { chunk } from "@mysten/utils";
-// The maximum objects that can be fetched at once using multiGetObjects.
 const MAX_OBJECTS_PER_FETCH = 50;
-// An amount of gas (in gas units) that is added to transactions as an overhead to ensure transactions do not fail.
 const GAS_SAFE_OVERHEAD = 1000n;
 const MAX_GAS = 50_000_000_000;
 export function jsonRpcClientResolveTransactionPlugin(client) {
@@ -56,7 +52,6 @@ async function setGasBudget(transactionData, client) {
         ? gasBudget
         : baseComputationCostWithOverhead);
 }
-// The current default is just picking _all_ coins we can which may not be ideal.
 async function setGasPayment(transactionData, client) {
     if (!transactionData.gasConfig.payment) {
         const coins = await client.getCoins({
@@ -64,7 +59,6 @@ async function setGasPayment(transactionData, client) {
             coinType: WOW_TYPE_ARG,
         });
         const paymentCoins = coins.data
-            // Filter out coins that are also used as input:
             .filter((coin) => {
             const matchingInput = transactionData.inputs.find((input) => {
                 if (input.Object?.ImmOrOwnedObject) {
@@ -87,8 +81,6 @@ async function setGasPayment(transactionData, client) {
     }
 }
 async function resolveObjectReferences(transactionData, client) {
-    // Keep track of the object references that will need to be resolved at the end of the transaction.
-    // We keep the input by-reference to avoid needing to re-resolve it:
     const objectsToResolve = transactionData.inputs.filter((input) => {
         return (input.UnresolvedObject &&
             !(input.UnresolvedObject.version ||
@@ -173,12 +165,7 @@ async function normalizeInputs(transactionData, client) {
     const moveCallsToResolve = [];
     const moveFunctionsToResolve = new Set();
     commands.forEach((command) => {
-        // Special case move call:
         if (command.MoveCall) {
-            // Determine if any of the arguments require encoding.
-            // - If they don't, then this is good to go.
-            // - If they do, then we need to fetch the normalized move module.
-            // If we already know the argument types, we don't need to resolve them again
             if (command.MoveCall._argumentTypes) {
                 return;
             }
@@ -216,9 +203,6 @@ async function normalizeInputs(transactionData, client) {
             if (!parameters) {
                 return;
             }
-            // Entry functions can have a mutable reference to an instance of the TxContext
-            // struct defined in the TxContext module as the last parameter. The caller of
-            // the function does not need to pass it in as an argument.
             const hasTxContext = parameters.length > 0 &&
                 isTxContext(parameters[parameters.length - 1]);
             const params = hasTxContext
@@ -245,7 +229,6 @@ async function normalizeInputs(transactionData, client) {
             if (arg.$kind !== "Input")
                 return;
             const input = inputs[arg.Input];
-            // Skip if the input is already resolved
             if (!input.UnresolvedPure && !input.UnresolvedObject) {
                 return;
             }
@@ -311,4 +294,3 @@ function isReceivingType(type) {
         type.body.datatype.module === "transfer" &&
         type.body.datatype.type === "Receiving");
 }
-//# sourceMappingURL=json-rpc-resolver.js.map

package/dist/cjs/jsonRpc/rpc-websocket-client.d.ts

@@ -5,25 +5,10 @@ type SubscriptionRequest<T = any> = {
     onMessage: (event: T) => void;
     signal?: AbortSignal;
 };
-/**
- * Configuration options for the websocket connection
- */
 export type WebsocketClientOptions = {
-    /**
-     * Custom WebSocket class to use. Defaults to the global WebSocket class, if available.
-     */
     WebSocketConstructor?: typeof WebSocket;
-    /**
-     * Milliseconds before timing out while calling an RPC method
-     */
     callTimeout?: number;
-    /**
-     * Milliseconds between attempts to connect
-     */
     reconnectTimeout?: number;
-    /**
-     * Maximum number of times to try connecting before giving up
-     */
     maxReconnects?: number;
 };
 export declare const DEFAULT_CLIENT_OPTIONS: {

package/dist/cjs/jsonRpc/rpc-websocket-client.js

@@ -1,5 +1,3 @@
-// Copyright (c) Mysten Labs, Inc.
-// SPDX-License-Identifier: Apache-2.0
 import { JsonRpcError } from "./errors.js";
 function getWebsocketUrl(httpUrl) {
     const url = new URL(httpUrl);
@@ -7,7 +5,6 @@ function getWebsocketUrl(httpUrl) {
     return url.toString();
 }
 export const DEFAULT_CLIENT_OPTIONS = {
-    // We fudge the typing because we also check for undefined in the constructor:
     WebSocketConstructor: (typeof WebSocket !== "undefined"
         ? WebSocket
         : undefined),
@@ -156,4 +153,3 @@ class RpcSubscription {
         }
     }
 }
-//# sourceMappingURL=rpc-websocket-client.js.map

package/dist/cjs/jsonRpc/types/chain.js

@@ -1,4 +1 @@
-// Copyright (c) Mysten Labs, Inc.
-// SPDX-License-Identifier: Apache-2.0
 export {};
-//# sourceMappingURL=chain.js.map

package/dist/cjs/jsonRpc/types/changes.js

@@ -1,4 +1 @@
-// Copyright (c) Mysten Labs, Inc.
-// SPDX-License-Identifier: Apache-2.0
 export {};
-//# sourceMappingURL=changes.js.map

package/dist/cjs/jsonRpc/types/coins.js

@@ -1,4 +1 @@
-// Copyright (c) Mysten Labs, Inc.
-// SPDX-License-Identifier: Apache-2.0
 export {};
-//# sourceMappingURL=coins.js.map

package/dist/cjs/jsonRpc/types/common.js

@@ -1,4 +1 @@
-// Copyright (c) Mysten Labs, Inc.
-// SPDX-License-Identifier: Apache-2.0
 export {};
-//# sourceMappingURL=common.js.map