@mysten/sui 1.17.0 → 1.18.0

package/graphql/schemas/latest/package.json

@@ -0,0 +1,6 @@
+{
+	"private": true,
+	"import": "../../../dist/esm/graphql/schemas/latest/index.js",
+	"main": "../../../dist/cjs/graphql/schemas/latest/index.js",
+	"sideEffects": false
+}

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.17.0",
+  "version": "1.18.0",
   "license": "Apache-2.0",
   "sideEffects": false,
   "files": [
@@ -93,6 +93,10 @@
     "./graphql/schemas/2024.4": {
       "import": "./dist/esm/graphql/schemas/2024.4/index.js",
       "require": "./dist/cjs/graphql/schemas/2024.4/index.js"
+    },
+    "./graphql/schemas/latest": {
+      "import": "./dist/esm/graphql/schemas/latest/index.js",
+      "require": "./dist/cjs/graphql/schemas/latest/index.js"
     }
   },
   "bugs": {
@@ -137,7 +141,6 @@
     "graphql": "^16.9.0",
     "jose": "^5.6.3",
     "poseidon-lite": "^0.2.0",
-    "tweetnacl": "^1.0.3",
     "valibot": "^0.36.0",
     "@mysten/bcs": "1.2.0"
   },

package/src/client/types/generated.ts

@@ -10,6 +10,11 @@
  * /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;
@@ -164,15 +169,27 @@ export interface DryRunTransactionBlockResponse {
 	input: TransactionBlockData;
 	objectChanges: SuiObjectChange[];
 }
-export interface DynamicFieldInfo {
-	bcsName: string;
-	digest: string;
-	name: DynamicFieldName;
-	objectId: string;
-	objectType: string;
-	type: DynamicFieldType;
-	version: string;
-}
+export type DynamicFieldInfo =
+	| {
+			digest: string;
+			name: DynamicFieldName;
+			objectId: string;
+			objectType: string;
+			type: DynamicFieldType;
+			version: string;
+			bcsEncoding: 'base64';
+			bcsName: string;
+	  }
+	| {
+			digest: string;
+			name: DynamicFieldName;
+			objectId: string;
+			objectType: string;
+			type: DynamicFieldType;
+			version: string;
+			bcsEncoding: 'base58';
+			bcsName: string;
+	  };
 export interface DynamicFieldName {
 	type: string;
 	value: unknown;
@@ -200,38 +217,64 @@ export interface EndOfEpochData {
 	 */
 	nextEpochProtocolVersion: string;
 }
-export interface SuiEvent {
-	/** Base 58 encoded bcs bytes of the move event */
-	bcs: string;
-	/**
-	 * Sequential event ID, ie (transaction seq number, event seq number). 1) Serves as a unique event ID
-	 * for each fullnode 2) Also serves to sequence events for the purposes of pagination and querying. A
-	 * higher id is an event seen later by that fullnode. This ID is the "cursor" for event querying.
-	 */
-	id: EventId;
-	/** Move package where this event was emitted. */
-	packageId: string;
-	/** Parsed json value of the event */
-	parsedJson: unknown;
-	/** Sender's Sui address. */
-	sender: string;
-	/** UTC timestamp in milliseconds since epoch (1/1/1970) */
-	timestampMs?: string | null;
-	/** Move module where this event was emitted. */
-	transactionModule: string;
-	/** Move event type. */
-	type: string;
-}
+export type SuiEvent =
+	| {
+			/**
+			 * Sequential event ID, ie (transaction seq number, event seq number). 1) Serves as a unique event ID
+			 * for each fullnode 2) Also serves to sequence events for the purposes of pagination and querying. A
+			 * higher id is an event seen later by that fullnode. This ID is the "cursor" for event querying.
+			 */
+			id: EventId;
+			/** Move package where this event was emitted. */
+			packageId: string;
+			/** Parsed json value of the event */
+			parsedJson: unknown;
+			/** Sender's Sui address. */
+			sender: string;
+			/** UTC timestamp in milliseconds since epoch (1/1/1970) */
+			timestampMs?: string | null;
+			/** Move module where this event was emitted. */
+			transactionModule: string;
+			/** Move event type. */
+			type: string;
+			bcs: string;
+			bcsEncoding: 'base64';
+	  }
+	| {
+			/**
+			 * Sequential event ID, ie (transaction seq number, event seq number). 1) Serves as a unique event ID
+			 * for each fullnode 2) Also serves to sequence events for the purposes of pagination and querying. A
+			 * higher id is an event seen later by that fullnode. This ID is the "cursor" for event querying.
+			 */
+			id: EventId;
+			/** Move package where this event was emitted. */
+			packageId: string;
+			/** Parsed json value of the event */
+			parsedJson: unknown;
+			/** Sender's Sui address. */
+			sender: string;
+			/** UTC timestamp in milliseconds since epoch (1/1/1970) */
+			timestampMs?: string | null;
+			/** Move module where this event was emitted. */
+			transactionModule: string;
+			/** Move event type. */
+			type: string;
+			bcs: string;
+			bcsEncoding: 'base58';
+	  };
 export type SuiEventFilter =
-	/** Query by sender address. */
+	/** Return all events. */
+	| {
+			All: [];
+	  } /** Return events that match any of the given filters. Only supported on event subscriptions. */
+	| {
+			Any: SuiEventFilter[];
+	  } /** Query by sender address. */
 	| {
 			Sender: string;
 	  } /** Return events emitted by the given transaction. */
 	| {
 			Transaction: string;
-	  } /** Return events emitted in a specified Package. */
-	| {
-			Package: string;
 	  } /**
 	 * Return events emitted in a specified Move module. If the event is defined in Module A but emitted in
 	 * a tx with Module B, query `MoveModule` by module B returns the event. Query `MoveEventModule` by
@@ -262,12 +305,6 @@ export type SuiEventFilter =
 				/** the Move package ID */
 				package: string;
 			};
-	  }
-	| {
-			MoveEventField: {
-				path: string;
-				value: unknown;
-			};
 	  } /** Return events emitted in [start_time, end_time] interval */
 	| {
 			TimeRange: {
@@ -276,22 +313,8 @@ export type SuiEventFilter =
 				/** left endpoint of time interval, milliseconds since epoch, inclusive */
 				startTime: string;
 			};
-	  }
-	| {
-			All: SuiEventFilter[];
-	  }
-	| {
-			Any: SuiEventFilter[];
-	  }
-	| {
-			And: [SuiEventFilter, SuiEventFilter];
-	  }
-	| {
-			Or: [SuiEventFilter, SuiEventFilter];
 	  };
-/**
- * Unique ID of a Sui Event, the ID is a combination of transaction digest and event seq number.
- */
+/** Unique ID of a Sui Event, the ID is a combination of transaction digest and event seq number. */
 export interface EventId {
 	eventSeq: string;
 	txDigest: string;
@@ -648,7 +671,22 @@ export type ObjectOwner =
 				initial_shared_version: string;
 			};
 	  }
-	| 'Immutable';
+	| '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.
+	 */
+	| {
+			ConsensusV2: {
+				/** The authentication mode of the object */
+				authenticator: Authenticator;
+				/**
+				 * 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.
+				 */
+				start_version: string;
+			};
+	  };
 /**
  * `next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the
  * next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first
@@ -954,6 +992,13 @@ export interface SuiMoveModuleId {
 	address: string;
 	name: string;
 }
+export interface SuiMoveNormalizedEnum {
+	abilities: SuiMoveAbilitySet;
+	typeParameters: SuiMoveStructTypeParameter[];
+	variants: {
+		[key: string]: SuiMoveNormalizedField[];
+	};
+}
 export interface SuiMoveNormalizedField {
 	name: string;
 	type: SuiMoveNormalizedType;
@@ -967,6 +1012,9 @@ export interface SuiMoveNormalizedFunction {
 }
 export interface SuiMoveNormalizedModule {
 	address: string;
+	enums?: {
+		[key: string]: SuiMoveNormalizedEnum;
+	};
 	exposedFunctions: {
 		[key: string]: SuiMoveNormalizedFunction;
 	};
@@ -1465,7 +1513,7 @@ export interface SuiTransactionBlockResponseQuery {
 	options?: SuiTransactionBlockResponseOptions | null;
 }
 export type TransactionFilter =
-	/** Query by checkpoint. */
+	/** CURRENTLY NOT SUPPORTED. Query by checkpoint. */
 	| {
 			Checkpoint: string;
 	  } /** Query by move function. */
@@ -1481,6 +1529,9 @@ export type TransactionFilter =
 	  } /** Query by changed object, including created, mutated and unwrapped objects. */
 	| {
 			ChangedObject: string;
+	  } /** Query for transactions that touch this object. */
+	| {
+			AffectedObject: string;
 	  } /** Query by sender address. */
 	| {
 			FromAddress: string;
@@ -1493,7 +1544,7 @@ export type TransactionFilter =
 				from: string;
 				to: string;
 			};
-	  } /** Query txs that have a given address as sender or recipient. */
+	  } /** CURRENTLY NOT SUPPORTED. Query txs that have a given address as sender or recipient. */
 	| {
 			FromOrToAddress: {
 				addr: string;

package/src/client/types/params.ts

@@ -204,7 +204,11 @@ export interface GetBalanceParams {
 	 */
 	coinType?: string | null | undefined;
 }
-/** Return metadata(e.g., symbol, decimals) for a coin */
+/**
+ * Return metadata (e.g., symbol, decimals) for a coin. Note that if the coin's metadata was wrapped in
+ * the transaction that published its marker type, or the latest version of the metadata object is
+ * wrapped or deleted, it will not be found.
+ */
 export interface GetCoinMetadataParams {
 	/** type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC) */
 	coinType: string;

package/src/cryptography/publickey.ts

@@ -93,6 +93,13 @@ export abstract class PublicKey {
 		return this.verifyWithIntent(transaction, signature, 'TransactionData');
 	}
 
+	/**
+	 * Verifies that the public key is associated with the provided address
+	 */
+	verifyAddress(address: string): boolean {
+		return this.toSuiAddress() === address;
+	}
+
 	/**
 	 * Returns the bytes representation of the public key
 	 * prefixed with the signature scheme flag