@mysten/sui 1.34.0 → 1.36.0

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@mysten/sui",
   "author": "Mysten Labs <build@mystenlabs.com>",
-  "description": "Sui TypeScript API(Work in Progress)",
+  "description": "Sui TypeScript API",
   "homepage": "https://sdk.mystenlabs.com",
-  "version": "1.34.0",
+  "version": "1.36.0",
   "license": "Apache-2.0",
   "sideEffects": false,
   "files": [
@@ -147,8 +147,8 @@
     "graphql": "^16.11.0",
     "poseidon-lite": "^0.2.0",
     "valibot": "^0.36.0",
-    "@mysten/bcs": "1.6.3",
-    "@mysten/utils": "0.1.0"
+    "@mysten/bcs": "1.6.4",
+    "@mysten/utils": "0.1.1"
   },
   "scripts": {
     "clean": "rm -rf tsconfig.tsbuildinfo ./dist",

package/src/bcs/bcs.ts

@@ -75,10 +75,8 @@ export const Owner = bcs.enum('Owner', {
 		initialSharedVersion: bcs.u64(),
 	}),
 	Immutable: null,
-	ConsensusV2: bcs.struct('ConsensusV2', {
-		authenticator: bcs.enum('Authenticator', {
-			SingleOwner: Address,
-		}),
+	ConsensusAddressOwner: bcs.struct('ConsensusAddressOwner', {
+		owner: Address,
 		startVersion: bcs.u64(),
 	}),
 });

package/src/client/types/generated.ts

@@ -10,11 +10,6 @@
  * /crates/sui-open-rpc/spec/openrpc.json
  */
 
-export type Authenticator =
-	/** The contained SuiAddress exclusively has all permissions: read, write, delete, transfer */
-	{
-		SingleOwner: string;
-	};
 export interface Balance {
 	coinObjectCount: number;
 	coinType: string;
@@ -680,15 +675,10 @@ export type ObjectOwner =
 				initial_shared_version: string;
 			};
 	  }
-	| 'Immutable' /**
-	 * Object is sequenced via consensus. Ownership is managed by the configured authenticator.
-	 *
-	 * Note: wondering what happened to `V1`? `Shared` above was the V1 of consensus objects.
-	 */
+	| 'Immutable' /** Object is exclusively owned by a single address and sequenced via consensus. */
 	| {
-			ConsensusV2: {
-				/** The authentication mode of the object */
-				authenticator: Authenticator;
+			ConsensusAddressOwner: {
+				owner: string;
 				/**
 				 * The version at which the object most recently became a consensus object. This serves the same
 				 * function as `initial_shared_version`, except it may change if the object's Owner type changes.
@@ -966,6 +956,7 @@ export type SuiEndOfEpochTransactionKind =
 	| 'RandomnessStateCreate'
 	| 'CoinDenyListStateCreate'
 	| 'StoreExecutionTimeObservations'
+	| 'AccumulatorRootCreate'
 	| {
 			ChangeEpoch: SuiChangeEpoch;
 	  }
@@ -998,6 +989,12 @@ export type SuiMoveAbility = 'Copy' | 'Drop' | 'Store' | 'Key';
 export interface SuiMoveAbilitySet {
 	abilities: SuiMoveAbility[];
 }
+export interface SuiMoveAbort {
+	error_code?: string | null;
+	function?: string | null;
+	line?: number | null;
+	module_id?: string | null;
+}
 export interface SuiMoveModuleId {
 	address: string;
 	name: string;
@@ -1005,6 +1002,7 @@ export interface SuiMoveModuleId {
 export interface SuiMoveNormalizedEnum {
 	abilities: SuiMoveAbilitySet;
 	typeParameters: SuiMoveStructTypeParameter[];
+	variantDeclarationOrder?: string[] | null;
 	variants: {
 		[key: string]: SuiMoveNormalizedField[];
 	};
@@ -1365,6 +1363,8 @@ export type TransactionBlockData = {
 export type TransactionEffects =
 	/** The response from processing a transaction or a certified transaction */
 	{
+		/** The abort error populated if the transaction failed with an abort code. */
+		abortError?: SuiMoveAbort | null;
 		/** ObjectRef and owner of new objects created. */
 		created?: OwnedObjectRef[];
 		/** Object Refs of objects now deleted (the old refs). */
@@ -1486,6 +1486,16 @@ export type SuiTransactionBlockKind =
 			kind: 'ConsensusCommitPrologueV4';
 			round: string;
 			sub_dag_index?: string | null;
+	  } /** A series of commands where the results of one command can be used in future commands */
+	| {
+			/** Input objects or primitive values */
+			inputs: SuiCallArg[];
+			kind: 'ProgrammableSystemTransaction';
+			/**
+			 * The transactions to be executed sequentially. A failure in any transaction will result in the
+			 * failure of the entire programmable transaction block.
+			 */
+			transactions: SuiTransaction[];
 	  };
 export interface SuiTransactionBlockResponse {
 	balanceChanges?: BalanceChange[] | null;

package/src/client/types/params.ts

@@ -10,9 +10,8 @@
  * /crates/sui-open-rpc/spec/openrpc.json
  */
 
-import type { Transaction } from '../../transactions/index.js';
 import type * as RpcTypes from './generated.js';
-
+import type { Transaction } from '../../transactions/index.js';
 /**
  * Runs the transaction 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

package/src/experimental/client.ts

@@ -13,12 +13,17 @@ import type {
 
 export abstract class Experimental_BaseClient {
 	network: Experimental_SuiClientTypes.Network;
-	cache = new ClientCache();
+	cache: ClientCache;
 	base: Experimental_BaseClient;
 
-	constructor({ network, base }: Experimental_SuiClientTypes.SuiClientOptions) {
+	constructor({
+		network,
+		base,
+		cache = base?.cache ?? new ClientCache(),
+	}: Experimental_SuiClientTypes.SuiClientOptions) {
 		this.network = network;
 		this.base = base ?? this;
+		this.cache = cache;
 	}
 
 	abstract core: Experimental_CoreClient;

package/src/experimental/core.ts

@@ -19,6 +19,11 @@ export interface Experimental_CoreClientOptions
 	mvr?: Experimental_SuiClientTypes.MvrOptions;
 }
 
+const DEFAULT_MVR_URLS: Record<string, string> = {
+	mainnet: 'https://mainnet.mvr.mystenlabs.com',
+	testnet: 'https://testnet.mvr.mystenlabs.com',
+};
+
 export abstract class Experimental_CoreClient
 	extends Experimental_BaseClient
 	implements Experimental_SuiClientTypes.TransportMethods
@@ -28,9 +33,10 @@ export abstract class Experimental_CoreClient
 
 	constructor(options: Experimental_CoreClientOptions) {
 		super(options);
+
 		this.mvr = new MvrClient({
-			cache: this.base.cache.scope('core'),
-			url: options.mvr?.url,
+			cache: this.cache.scope('core.mvr'),
+			url: options.mvr?.url ?? DEFAULT_MVR_URLS[this.network],
 			pageSize: options.mvr?.pageSize,
 			overrides: options.mvr?.overrides,
 		});
@@ -91,6 +97,10 @@ export abstract class Experimental_CoreClient
 
 	abstract resolveTransactionPlugin(): TransactionPlugin;
 
+	abstract verifyZkLoginSignature(
+		options: Experimental_SuiClientTypes.VerifyZkLoginSignatureOptions,
+	): Promise<Experimental_SuiClientTypes.ZkLoginVerifyResponse>;
+
 	async getDynamicField(
 		options: Experimental_SuiClientTypes.GetDynamicFieldOptions,
 	): Promise<Experimental_SuiClientTypes.GetDynamicFieldResponse> {

package/src/experimental/transports/graphql.ts

@@ -413,8 +413,14 @@ function mapOwner(owner: Object_Owner_FieldsFragment): Experimental_SuiClientTyp
 	switch (owner.__typename) {
 		case 'AddressOwner':
 			return { $kind: 'AddressOwner', AddressOwner: owner.owner?.asAddress?.address };
-		case 'ConsensusV2':
-			return { $kind: 'ConsensusV2', ConsensusV2: owner.authenticator!.address };
+		case 'ConsensusAddressOwner':
+			return {
+				$kind: 'ConsensusAddressOwner',
+				ConsensusAddressOwner: {
+					owner: owner.owner?.address,
+					startVersion: owner.startVersion,
+				},
+			};
 		case 'Immutable':
 			return { $kind: 'Immutable', Immutable: true };
 		case 'Parent':

package/src/experimental/transports/json-rpc-resolver.ts

@@ -170,8 +170,12 @@ async function resolveObjectReferences(transactionData: TransactionDataBuilder,
 		}
 		const owner = object.data.owner;
 		const initialSharedVersion =
-			owner && typeof owner === 'object' && 'Shared' in owner
-				? owner.Shared.initial_shared_version
+			owner && typeof owner === 'object'
+				? 'Shared' in owner
+					? owner.Shared.initial_shared_version
+					: 'ConsensusAddressOwner' in owner
+						? owner.ConsensusAddressOwner.start_version
+						: null
 				: null;
 
 		return {

package/src/experimental/transports/jsonRPC.ts

@@ -291,15 +291,12 @@ function parseOwner(owner: ObjectOwner): Experimental_SuiClientTypes.ObjectOwner
 		};
 	}
 
-	if ('ConsensusV2' in owner) {
+	if ('ConsensusAddressOwner' in owner) {
 		return {
-			$kind: 'ConsensusV2',
-			ConsensusV2: {
-				authenticator: {
-					$kind: 'SingleOwner',
-					SingleOwner: owner.ConsensusV2.authenticator.SingleOwner,
-				},
-				startVersion: owner.ConsensusV2.start_version,
+			$kind: 'ConsensusAddressOwner',
+			ConsensusAddressOwner: {
+				owner: owner.ConsensusAddressOwner.owner,
+				startVersion: owner.ConsensusAddressOwner.start_version,
 			},
 		};
 	}

package/src/experimental/types.ts

@@ -3,6 +3,7 @@
 /* eslint-disable @typescript-eslint/ban-types */
 
 import type { SerializedTransactionDataV2, TransactionPlugin } from '../transactions/index.js';
+import type { ClientCache } from './cache.js';
 import type { Experimental_BaseClient } from './client.js';
 
 export type SuiClientRegistration<
@@ -38,6 +39,7 @@ export namespace Experimental_SuiClientTypes {
 	export interface SuiClientOptions {
 		network: Network;
 		base?: Experimental_BaseClient;
+		cache?: ClientCache;
 	}
 
 	export interface MvrOptions {
@@ -265,7 +267,7 @@ export namespace Experimental_SuiClientTypes {
 	}
 
 	export interface TransportMethods {
-		verifyZkLoginSignature?: (
+		verifyZkLoginSignature: (
 			options: VerifyZkLoginSignatureOptions,
 		) => Promise<ZkLoginVerifyResponse>;
 	}
@@ -361,22 +363,20 @@ export namespace Experimental_SuiClientTypes {
 		Immutable: true;
 	}
 
-	export interface ConsensusV2 {
-		$kind: 'ConsensusV2';
-		ConsensusV2: {
-			authenticator: ConsensusV2Authenticator;
+	export interface ConsensusAddressOwner {
+		$kind: 'ConsensusAddressOwner';
+		ConsensusAddressOwner: {
+			owner: string;
 			startVersion: string;
 		};
 	}
 
-	export interface SingleOwnerAuthenticator {
-		$kind: 'SingleOwner';
-		SingleOwner: string;
-	}
-
-	export type ConsensusV2Authenticator = SingleOwnerAuthenticator;
-
-	export type ObjectOwner = AddressOwner | ParentOwner | SharedOwner | ImmutableOwner | ConsensusV2;
+	export type ObjectOwner =
+		| AddressOwner
+		| ParentOwner
+		| SharedOwner
+		| ImmutableOwner
+		| ConsensusAddressOwner;
 
 	/** Effects */
 

package/src/graphql/generated/latest/schema.graphql

@@ -174,11 +174,6 @@ enum AddressTransactionBlockRelationship {
 	AFFECTED
 }
 
-"""
-An Authenticator represents the access control rules for a ConsensusV2 object.
-"""
-union Authenticator = Address
-
 """
 System transaction for creating the on-chain state used by zkLogin.
 """
@@ -833,6 +828,14 @@ type CoinMetadata implements IMoveObject & IObject & IOwner {
 	supply: BigInt
 }
 
+"""
+Same as AddressOwner, but the object is versioned by consensus.
+"""
+type ConsensusAddressOwner {
+	startVersion: UInt53!
+	owner: Owner
+}
+
 """
 System transaction that runs at the beginning of a checkpoint, and is responsible for setting
 the current value of the clock, based on the timestamp from consensus.
@@ -857,16 +860,6 @@ type ConsensusCommitPrologueTransaction {
 	consensusCommitDigest: String
 }
 
-"""
-A ConsensusV2 object is an object that is automatically versioned by the consensus protocol
-and allows different authentication modes based on the chosen authenticator.
-(Initially, only single-owner authentication is supported.)
-"""
-type ConsensusV2 {
-	startVersion: UInt53!
-	authenticator: Authenticator
-}
-
 """
 ISO-8601 Date and Time: RFC3339 in UTC with format: YYYY-MM-DDTHH:MM:SS.mmmZ. Note that the milliseconds part is optional, and it may be omitted if its value is 0.
 """
@@ -2918,9 +2911,9 @@ enum ObjectKind {
 }
 
 """
-The object's owner type: Immutable, Shared, Parent, or Address.
+The object's owner type: Immutable, Shared, Parent, Address, or ConsensusAddress.
 """
-union ObjectOwner = Immutable | Shared | Parent | AddressOwner | ConsensusV2
+union ObjectOwner = Immutable | Shared | Parent | AddressOwner | ConsensusAddressOwner
 
 input ObjectRef {
 	"""
@@ -4299,6 +4292,10 @@ type TransactionBlockEffects {
 	"""
 	errors: String
 	"""
+	The error code of the Move abort, populated if this transaction failed with a Move abort.
+	"""
+	abortCode: BigInt
+	"""
 	Transactions whose outputs this transaction depends upon.
 	"""
 	dependencies(first: Int, after: String, last: Int, before: String): DependencyConnection!
@@ -4447,7 +4444,7 @@ type TransactionInputEdge {
 
 """
 The optional extra data a user can provide to a transaction dry run.
-`sender` defaults to `0x0`. If gasObjects` is not present, or is an empty list,
+`sender` defaults to `0x0`. If `gasObjects` is not present, or is an empty list,
 it is substituted with a mock Coin object, `gasPrice` defaults to the reference
 gas price, `gasBudget` defaults to the max gas budget and `gasSponsor` defaults
 to the sender.

package/src/graphql/generated/latest/tada-env.ts

@@ -661,16 +661,6 @@ const introspection = {
           }
         ]
       },
-      {
-        "kind": "UNION",
-        "name": "Authenticator",
-        "possibleTypes": [
-          {
-            "kind": "OBJECT",
-            "name": "Address"
-          }
-        ]
-      },
       {
         "kind": "OBJECT",
         "name": "AuthenticatorStateCreateTransaction",
@@ -2722,6 +2712,34 @@ const introspection = {
           }
         ]
       },
+      {
+        "kind": "OBJECT",
+        "name": "ConsensusAddressOwner",
+        "fields": [
+          {
+            "name": "owner",
+            "type": {
+              "kind": "OBJECT",
+              "name": "Owner"
+            },
+            "args": [],
+            "isDeprecated": false
+          },
+          {
+            "name": "startVersion",
+            "type": {
+              "kind": "NON_NULL",
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "UInt53"
+              }
+            },
+            "args": [],
+            "isDeprecated": false
+          }
+        ],
+        "interfaces": []
+      },
       {
         "kind": "OBJECT",
         "name": "ConsensusCommitPrologueTransaction",
@@ -2771,34 +2789,6 @@ const introspection = {
         ],
         "interfaces": []
       },
-      {
-        "kind": "OBJECT",
-        "name": "ConsensusV2",
-        "fields": [
-          {
-            "name": "authenticator",
-            "type": {
-              "kind": "UNION",
-              "name": "Authenticator"
-            },
-            "args": [],
-            "isDeprecated": false
-          },
-          {
-            "name": "startVersion",
-            "type": {
-              "kind": "NON_NULL",
-              "ofType": {
-                "kind": "SCALAR",
-                "name": "UInt53"
-              }
-            },
-            "args": [],
-            "isDeprecated": false
-          }
-        ],
-        "interfaces": []
-      },
       {
         "kind": "SCALAR",
         "name": "DateTime"
@@ -8847,7 +8837,7 @@ const introspection = {
           },
           {
             "kind": "OBJECT",
-            "name": "ConsensusV2"
+            "name": "ConsensusAddressOwner"
           },
           {
             "kind": "OBJECT",
@@ -13040,6 +13030,15 @@ const introspection = {
         "kind": "OBJECT",
         "name": "TransactionBlockEffects",
         "fields": [
+          {
+            "name": "abortCode",
+            "type": {
+              "kind": "SCALAR",
+              "name": "BigInt"
+            },
+            "args": [],
+            "isDeprecated": false
+          },
           {
             "name": "balanceChanges",
             "type": {