@mysten/sui 1.27.0 → 1.28.0

package/package.json

@@ -3,7 +3,7 @@
   "author": "Mysten Labs <build@mystenlabs.com>",
   "description": "Sui TypeScript API(Work in Progress)",
   "homepage": "https://sdk.mystenlabs.com",
-  "version": "1.27.0",
+  "version": "1.28.0",
   "license": "Apache-2.0",
   "sideEffects": false,
   "files": [
@@ -145,7 +145,8 @@
     "graphql": "^16.9.0",
     "poseidon-lite": "^0.2.0",
     "valibot": "^0.36.0",
-    "@mysten/bcs": "1.6.0"
+    "@mysten/bcs": "1.6.0",
+    "@mysten/utils": "0.0.0"
   },
   "scripts": {
     "clean": "rm -rf tsconfig.tsbuildinfo ./dist",

package/src/experimental/client.ts

@@ -2,14 +2,13 @@
 // SPDX-License-Identifier: Apache-2.0
 /* eslint-disable @typescript-eslint/ban-types */
 
+import type { Simplify, UnionToIntersection } from '@mysten/utils';
 import { ClientCache } from './cache.js';
 import type { Experimental_CoreClient } from './core.js';
 import type {
 	ClientWithExtensions,
 	Experimental_SuiClientTypes,
-	Simplify,
 	SuiClientRegistration,
-	UnionToIntersection,
 } from './types.js';
 
 export abstract class Experimental_BaseClient {
@@ -38,26 +37,21 @@ export abstract class Experimental_BaseClient {
 			),
 		) as ClientWithExtensions<
 			Simplify<
-				Omit<
+				UnionToIntersection<
 					{
-						[K in keyof this]: this[K];
-					},
-					keyof Experimental_BaseClient
-				> &
-					UnionToIntersection<
-						{
-							[K in keyof Registrations]: Registrations[K] extends SuiClientRegistration<
-								this,
-								infer Name extends string,
-								infer Extension
-							>
-								? {
-										[K2 in Name]: Extension;
-									}
-								: never;
-						}[number]
-					>
-			>
+						[K in keyof Registrations]: Registrations[K] extends SuiClientRegistration<
+							this,
+							infer Name extends string,
+							infer Extension
+						>
+							? {
+									[K2 in Name]: Extension;
+								}
+							: never;
+					}[number]
+				>
+			>,
+			this
 		>;
 	}
 }

package/src/experimental/types.ts

@@ -26,17 +26,10 @@ export interface SelfRegisteringClientExtension<
 	};
 }
 
-export type Simplify<T> = {
-	[K in keyof T]: T[K];
-} & {};
-
-export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (
-	k: infer I,
-) => void
-	? I
-	: never;
-
-export type ClientWithExtensions<T> = Experimental_BaseClient & T;
+export type ClientWithExtensions<
+	T,
+	Base extends Experimental_BaseClient = Experimental_BaseClient,
+> = Base & T;
 
 export namespace Experimental_SuiClientTypes {
 	export type Network = 'mainnet' | 'testnet' | 'devnet' | 'localnet' | (string & {});

package/src/faucet/faucet.ts

@@ -29,6 +29,17 @@ type BatchStatusFaucetResponse = {
 	error?: string | null;
 };
 
+type FaucetResponseV2 = {
+	status: 'Success' | FaucetFailure;
+	coin_sent: FaucetCoinInfo | null;
+};
+
+type FaucetFailure = {
+	Failure: {
+		internal: string;
+	};
+};
+
 type FaucetRequest = {
 	host: string;
 	path: string;
@@ -37,7 +48,7 @@ type FaucetRequest = {
 	method: 'GET' | 'POST';
 };
 
-async function faucetRequest({ host, path, body, headers, method }: FaucetRequest) {
+async function faucetRequest<T>({ host, path, body, headers, method }: FaucetRequest): Promise<T> {
 	const endpoint = new URL(path, host).toString();
 	const res = await fetch(endpoint, {
 		method,
@@ -56,10 +67,7 @@ async function faucetRequest({ host, path, body, headers, method }: FaucetReques
 
 	try {
 		const parsed = await res.json();
-		if (parsed.error) {
-			throw new Error(`Faucet returns error: ${parsed.error}`);
-		}
-		return parsed;
+		return parsed as T;
 	} catch (e) {
 		throw new Error(
 			`Encountered error when parsing response from faucet, error: ${e}, status ${res.status}, response ${res}`,
@@ -67,12 +75,15 @@ async function faucetRequest({ host, path, body, headers, method }: FaucetReques
 	}
 }
 
+/**
+ * @deprecated("Use requestSuiFromFaucetV2 instead")
+ */
 export async function requestSuiFromFaucetV0(input: {
 	host: string;
 	recipient: string;
 	headers?: HeadersInit;
 }): Promise<FaucetResponse> {
-	return faucetRequest({
+	const response = await faucetRequest<FaucetResponse>({
 		host: input.host,
 		path: '/gas',
 		body: {
@@ -83,14 +94,23 @@ export async function requestSuiFromFaucetV0(input: {
 		headers: input.headers,
 		method: 'POST',
 	});
+
+	if (response.error) {
+		throw new Error(`Faucet request failed: ${response.error}`);
+	}
+
+	return response;
 }
 
+/**
+ * @deprecated("Use requestSuiFromFaucetV2 instead")
+ */
 export async function requestSuiFromFaucetV1(input: {
 	host: string;
 	recipient: string;
 	headers?: HeadersInit;
 }): Promise<BatchFaucetResponse> {
-	return faucetRequest({
+	const response = await faucetRequest<BatchFaucetResponse>({
 		host: input.host,
 		path: '/v1/gas',
 		body: {
@@ -101,19 +121,58 @@ export async function requestSuiFromFaucetV1(input: {
 		headers: input.headers,
 		method: 'POST',
 	});
+
+	if (response.error) {
+		throw new Error(`Faucet request failed: ${response.error}`);
+	}
+
+	return response;
+}
+
+export async function requestSuiFromFaucetV2(input: {
+	host: string;
+	recipient: string;
+	headers?: HeadersInit;
+}) {
+	const response = await faucetRequest<FaucetResponseV2>({
+		host: input.host,
+		path: '/v2/gas',
+		body: {
+			FixedAmountRequest: {
+				recipient: input.recipient,
+			},
+		},
+		headers: input.headers,
+		method: 'POST',
+	});
+
+	if (response.status !== 'Success') {
+		throw new Error(`Faucet request failed: ${response.status.Failure.internal}`);
+	}
+
+	return response;
 }
 
+/**
+ * @deprecated("Use requestSuiFromFaucetV2 which returns directly a success or failure status")
+ */
 export async function getFaucetRequestStatus(input: {
 	host: string;
 	taskId: string;
 	headers?: HeadersInit;
-}): Promise<BatchStatusFaucetResponse> {
-	return faucetRequest({
+}) {
+	const response = await faucetRequest<BatchStatusFaucetResponse>({
 		host: input.host,
 		path: `/v1/status/${input.taskId}`,
 		headers: input.headers,
 		method: 'GET',
 	});
+
+	if (response.error) {
+		throw new Error(`Faucet request failed: ${response.error}`);
+	}
+
+	return response;
 }
 
 export function getFaucetHost(network: 'testnet' | 'devnet' | 'localnet') {

package/src/faucet/index.ts

@@ -4,6 +4,7 @@
 export {
 	requestSuiFromFaucetV0,
 	requestSuiFromFaucetV1,
+	requestSuiFromFaucetV2,
 	getFaucetRequestStatus,
 	getFaucetHost,
 	FaucetRateLimitError,

package/src/transactions/data/internal.ts

@@ -25,17 +25,16 @@ import {
 } from 'valibot';
 
 import { isValidSuiAddress, normalizeSuiAddress } from '../../utils/sui-types.js';
-
-type Merge<T> = T extends object ? { [K in keyof T]: T[K] } : never;
+import type { Simplify } from '@mysten/utils';
 
 type EnumSchema<T extends Record<string, GenericSchema<any>>> = GenericSchema<
 	EnumInputShape<
-		Merge<{
+		Simplify<{
 			[K in keyof T]: InferInput<T[K]>;
 		}>
 	>,
 	EnumOutputShape<
-		Merge<{
+		Simplify<{
 			[K in keyof T]: InferOutput<T[K]>;
 		}>
 	>

package/src/transactions/data/v2.ts

@@ -22,15 +22,14 @@ import {
 } from 'valibot';
 
 import { BCSBytes, JsonU64, ObjectID, ObjectRef, SuiAddress } from './internal.js';
-
-type Merge<T> = T extends object ? { [K in keyof T]: T[K] } : never;
+import type { Simplify } from '@mysten/utils';
 
 function enumUnion<T extends Record<string, GenericSchema<any>>>(options: T) {
 	return union(
 		Object.entries(options).map(([key, value]) => object({ [key]: value })),
 	) as GenericSchema<
 		EnumInputShape<
-			Merge<{
+			Simplify<{
 				[K in keyof T]: InferInput<T[K]>;
 			}>
 		>

package/src/transactions/executor/parallel.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { toBase64 } from '@mysten/bcs';
-
+import { promiseWithResolvers } from '@mysten/utils';
 import { bcs } from '../../bcs/index.js';
 import type { SuiObjectRef } from '../../bcs/types.js';
 import type {
@@ -456,15 +456,3 @@ export class ParallelTransactionExecutor {
 		await this.#client.waitForTransaction({ digest: result.digest });
 	}
 }
-
-function promiseWithResolvers<T>() {
-	let resolve: (value: T) => void;
-	let reject: (reason: any) => void;
-
-	const promise = new Promise<T>((_resolve, _reject) => {
-		resolve = _resolve;
-		reject = _reject;
-	});
-
-	return { promise, resolve: resolve!, reject: reject! };
-}

package/src/transactions/intents/CoinWithBalance.ts

@@ -12,7 +12,7 @@ import type { Argument } from '../data/internal.js';
 import { Inputs } from '../Inputs.js';
 import type { BuildTransactionOptions } from '../json-rpc-resolver.js';
 import { getClient } from '../json-rpc-resolver.js';
-import type { Transaction } from '../Transaction.js';
+import type { Transaction, TransactionResult } from '../Transaction.js';
 import type { TransactionDataBuilder } from '../TransactionData.js';
 
 const COIN_WITH_BALANCE = 'CoinWithBalance';
@@ -26,12 +26,18 @@ export function coinWithBalance({
 	balance: bigint | number;
 	type?: string;
 	useGasCoin?: boolean;
-}) {
+}): (tx: Transaction) => TransactionResult {
+	let coinResult: TransactionResult | null = null;
+
 	return (tx: Transaction) => {
+		if (coinResult) {
+			return coinResult;
+		}
+
 		tx.addIntentResolver(COIN_WITH_BALANCE, resolveCoinBalance);
 		const coinType = type === 'gas' ? type : normalizeStructTag(type);
 
-		return tx.add(
+		coinResult = tx.add<TransactionResult>(
 			Commands.Intent({
 				name: COIN_WITH_BALANCE,
 				inputs: {},
@@ -41,6 +47,8 @@ export function coinWithBalance({
 				} satisfies InferInput<typeof CoinWithBalanceData>,
 			}),
 		);
+
+		return coinResult;
 	};
 }
 

package/src/transactions/json-rpc-resolver.ts

@@ -12,6 +12,7 @@ import type { Argument, CallArg, Command, OpenMoveTypeSignature } from './data/i
 import { Inputs } from './Inputs.js';
 import { getPureBcsSchema, isTxContext, normalizedTypeToMoveTypeSignature } from './serializer.js';
 import type { TransactionDataBuilder } from './TransactionData.js';
+import { chunk } from '@mysten/utils';
 
 // The maximum objects that can be fetched at once using multiGetObjects.
 const MAX_OBJECTS_PER_FETCH = 50;
@@ -479,9 +480,3 @@ export function getClient(options: BuildTransactionOptions): SuiClient {
 
 	return options.client;
 }
-
-function chunk<T>(arr: T[], size: number): T[][] {
-	return Array.from({ length: Math.ceil(arr.length / size) }, (_, i) =>
-		arr.slice(i * size, i * size + size),
-	);
-}

package/src/version.ts

@@ -3,5 +3,5 @@
 
 // This file is generated by genversion.mjs. Do not edit it directly.
 
-export const PACKAGE_VERSION = '1.27.0';
-export const TARGETED_RPC_VERSION = '1.47.0';
+export const PACKAGE_VERSION = '1.28.0';
+export const TARGETED_RPC_VERSION = '1.48.0';