@mysten/sui 1.2.1 → 1.3.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @mysten/sui.js
 
+## 1.3.0
+
+### Minor Changes
+
+- 086b2bc: Add waitForLastTransaction methods to all executor classes
+- cdedf69: Add Argument helpers for constructing transaction arguments without a Transaction
+  instance
+- beed646: Add tx.pure.vector and tx.pure.option methods
+
+### Patch Changes
+
+- 7fc464a: Remove unique symbols from types to improve compatability between version
+- 0fb0628: Mark subscription methods as deprecated.
+- 0f27a97: Update dependencies
+- Updated dependencies [7fc464a]
+- Updated dependencies [0f27a97]
+  - @mysten/bcs@1.0.3
+
 ## 1.2.1
 
 ### Patch Changes
@@ -12,7 +30,8 @@
 
 ### Minor Changes
 
-- fef99d377f: Update parallel executor class to handle gasPrice and budgeting to remove extra rpc calls during execution"
+- fef99d377f: Update parallel executor class to handle gasPrice and budgeting to remove extra rpc
+  calls during execution"
 
 ## 1.1.2
 
@@ -70,8 +89,10 @@
 
 ### Major Changes
 
-- a92b03de42: The Typescript SDK has been renamed to `@mysten/sui` and includes many new features and breaking changes.
-  See the [full migration guide](https://sdk.mystenlabs.com/typescript/migrations/sui-1.0) for details on how to upgrade.
+- a92b03de42: The Typescript SDK has been renamed to `@mysten/sui` and includes many new features
+  and breaking changes. See the
+  [full migration guide](https://sdk.mystenlabs.com/typescript/migrations/sui-1.0) for details on
+  how to upgrade.
 
 ### Patch Changes
 
@@ -105,7 +126,8 @@
 
 ### Minor Changes
 
-- 929db4976a: Add normalizeSuiNSName and isValidSuiNSName utils, and add a format option to SuiClient.resolveNameServiceNames
+- 929db4976a: Add normalizeSuiNSName and isValidSuiNSName utils, and add a format option to
+  SuiClient.resolveNameServiceNames
 
 ## 0.51.2
 
@@ -137,7 +159,8 @@
 
 ### Minor Changes
 
-- a34f1cb67d: Use Bech32 instead of Hex for private key export, supports both Hex and Bech32 for importing
+- a34f1cb67d: Use Bech32 instead of Hex for private key export, supports both Hex and Bech32 for
+  importing
 
 ### Patch Changes
 
@@ -191,9 +214,14 @@
 
 ### Minor Changes
 
-- 0259aec82: Removed dependency on @open-rpc/client-js and replaced it with standard fetch and WebSocket based APIs
+- 0259aec82: Removed dependency on @open-rpc/client-js and replaced it with standard fetch and
+  WebSocket based APIs
 
-  If you are using the `subscribeEvent` or `subscribeTransaction` in environments that do not support the `WebSocket` api natively (This will be true for most versions of Node.js) you will need to provide a WebSocket implementation when creating your SuiClient. You can either use a global polyfill for the WebSocket class, or pass a compatible WebSocket implementation into SuiHTTPTransport (eg, using the `ws` package)
+  If you are using the `subscribeEvent` or `subscribeTransaction` in environments that do not
+  support the `WebSocket` api natively (This will be true for most versions of Node.js) you will
+  need to provide a WebSocket implementation when creating your SuiClient. You can either use a
+  global polyfill for the WebSocket class, or pass a compatible WebSocket implementation into
+  SuiHTTPTransport (eg, using the `ws` package)
 
   ```typescript
   import { getFullnodeUrl, SuiClient, SuiHTTPTransport } from '@mysten/sui.js/client';
@@ -219,7 +247,8 @@
 
 ### Patch Changes
 
-- 652bcdd92: Remove some multisig methods that had previously been deprecated and are no longer exported
+- 652bcdd92: Remove some multisig methods that had previously been deprecated and are no longer
+  exported
 
 ## 0.46.0
 
@@ -230,7 +259,8 @@
 ### Patch Changes
 
 - 28c2c3330: Use the same issuer string in address derivation for the two google's iss values
-- 43444c58f: Extend the `TransactionBlock#object()` API to accept the `TransactionResult` type as well, so that it can be used flexibly in SDKs.
+- 43444c58f: Extend the `TransactionBlock#object()` API to accept the `TransactionResult` type as
+  well, so that it can be used flexibly in SDKs.
 - 8d1e74e52: Fix setting gasPrice for devInspectTransactionBlock
 - 3718a230b: Adds `txb.pure.id()` to pass ID pure values more intuitively
 
@@ -274,7 +304,8 @@
 
 ### Patch Changes
 
-- faa13ded9: Ensure that TransactionBlocks can be copied via structuredClone to workaround bug in sui wallet
+- faa13ded9: Ensure that TransactionBlocks can be copied via structuredClone to workaround bug in
+  sui wallet
 - c5684bb52: rename zk to zkLogin
 
 ## 0.43.0
@@ -288,7 +319,8 @@
   - txb.transferObjects now accepts `address` as JavaScript string
   - All single objects, or lists of objects, now also accepts object IDs as JavaScript strings
   - txb.pure accepts `SerializedBcs` (eg `txb.pure(bcs.U64.serialize(123))`)
-  - Added pure helpers (`txb.pure.address()`, `txb.bool()`, and `txb.pure.u{8-256}()`) to simplify serialization of pure values
+  - Added pure helpers (`txb.pure.address()`, `txb.bool()`, and `txb.pure.u{8-256}()`) to simplify
+    serialization of pure values
   - Deprecated using `txb.pure` with raw JavaScript values, or an explicit type argument.
 
 - 1bc430161: Updated BCS defintions to use new BCS schema builder
@@ -330,7 +362,8 @@
 
 ### Minor Changes
 
-- ba8e3b857: Rename TransactionBlock generated type in @mysten/sui.js/client to SuiTransactionBlock to avoid conflicting names in exports
+- ba8e3b857: Rename TransactionBlock generated type in @mysten/sui.js/client to SuiTransactionBlock
+  to avoid conflicting names in exports
 
 ### Patch Changes
 
@@ -344,13 +377,15 @@
 
 ### Patch Changes
 
-- 8281e3d25: Add new `sign` method to the TransactionBlock class, so that implementing transaction signing is easier.
+- 8281e3d25: Add new `sign` method to the TransactionBlock class, so that implementing transaction
+  signing is easier.
 
 ## 0.39.0
 
 ### Minor Changes
 
-- 47ea5ec7c: Update keypair signature methods to return bytes as a base64 encoded string for better compatability
+- 47ea5ec7c: Update keypair signature methods to return bytes as a base64 encoded string for better
+  compatability
 
 ## 0.38.0
 
@@ -361,8 +396,8 @@
 - 0f06d593a: Added a MultiSigPublicKey class for verifying multisig signatures
 - 09f4ed3fc: update signMessage to correctly wrap PersonalMessages before signing
 - 6d41059c7: Deprecate imports from the root path which can be imported from a modular export
-- cc6441f46: The Sui TS SDK has been broken up into a set of modular exports, and all exports from the root of
-  the package have been deprecated. The following export paths have been added:
+- cc6441f46: The Sui TS SDK has been broken up into a set of modular exports, and all exports from
+  the root of the package have been deprecated. The following export paths have been added:
 
   - `@mysten/sui.js/client` - A client for interacting with Sui RPC nodes.
   - `@mysten/sui.js/bcs` - A BCS builder with pre-defined types for Sui.
@@ -377,23 +412,23 @@
   As part of this refactor we are deprecating a number of existing APIs:
 
   - `JsonRPCProvider` - This Provider pattern is being replaced by a new `SuiClient`
-  - `SignerWithProver` and `RawSigner` - The Concept of Signers is being removed from the SDK. Signing
-    in verifying has been moved to the KeyPair classes, and the `signAndExecuteTransactionBlock`
-    method has been moved to the new `SuiClient`.
+  - `SignerWithProver` and `RawSigner` - The Concept of Signers is being removed from the SDK.
+    Signing in verifying has been moved to the KeyPair classes, and the
+    `signAndExecuteTransactionBlock` method has been moved to the new `SuiClient`.
   - The `superstruct` type definitions for types used by JsonRPCProvider are being replaced with
     generated types exported from `@mysten/sui.js/client`. The new type definitions are pure
     typescript types and can't be used for runtime validation. By generating these as types, it will
     be easier to keep them in sync with the RPC definitions and avoid discrepancies between the type
     definitions in the SDK and the data returned by RPC methods.
   - A large number of "getters" are being deprecated. These getters were intended to reduce friction
-    caused by rapid iteration in the RPC layer leading up to the mainnet launch. Now that mainnet has
-    been launched the RPC API should be more stable, and many of these helpers can be replaced by
-    simply accessing the nested properties in the returned data directly.
-
-  The current release should be mostly backwards compatible, and all existing exports will continue to
-  be available in this release (with deprecation warnings). With the large number of deprecations
-  there may be functionality that should be moved into the new modular version of the SDK. If you find
-  there are features that were deprecated without a suitable replacement, we have created a
+    caused by rapid iteration in the RPC layer leading up to the mainnet launch. Now that mainnet
+    has been launched the RPC API should be more stable, and many of these helpers can be replaced
+    by simply accessing the nested properties in the returned data directly.
+
+  The current release should be mostly backwards compatible, and all existing exports will continue
+  to be available in this release (with deprecation warnings). With the large number of deprecations
+  there may be functionality that should be moved into the new modular version of the SDK. If you
+  find there are features that were deprecated without a suitable replacement, we have created a
   [Github Discussion thread](https://github.com/MystenLabs/sui/discussions/13150) to track those
   use-cases.
 
@@ -450,8 +485,8 @@
 
   #### Migrating faucet requests
 
-  The ability to request Sui from a faucet was not added to `SuiClient`, instead you will need to use
-  a method `@mysten/sui.js/faucet` to make these requests
+  The ability to request Sui from a faucet was not added to `SuiClient`, instead you will need to
+  use a method `@mysten/sui.js/faucet` to make these requests
 
   ```diff
   - import { JsonRpcProvider, devnetConnection } from '@mysten/sui.js';
@@ -467,12 +502,15 @@
   +});
   ```
 
-- 001148443: Introduce new `@mysten/sui.js/faucet` export, which should be used for all faucet interactions. This deprecates the previous `requestSuiFromFaucet` APIs that existed on the `JsonRpcProvider` and `Signer` classes.
+- 001148443: Introduce new `@mysten/sui.js/faucet` export, which should be used for all faucet
+  interactions. This deprecates the previous `requestSuiFromFaucet` APIs that existed on the
+  `JsonRpcProvider` and `Signer` classes.
 
 ### Patch Changes
 
 - ad46f9f2f: add getAllEpochAddressMetrics method to rpc-provider
-- 34242be56: Add new `isTransactionBlock` method, and deprecate the previous `TransactionBlock.is` method
+- 34242be56: Add new `isTransactionBlock` method, and deprecate the previous `TransactionBlock.is`
+  method
 - 4e2a150a1: websocket client memory leak fix in reconnect logics
 - 83d0fb734: Deprecate type aliases for strings.
 
@@ -504,8 +542,13 @@
 ### Minor Changes
 
 - 3ea9adb71a: Add multisig support
-- 1cfb1c9da3: The `TransactionBlock` builder now uses the protocol config from the chain when constructing and validating transactions, instead of using hard-coded limits. If you wish to perform signing offline (without a provider), you can either define a `protocolConfig` option when building a transaction, or explicitly set `limits`, which will be used instead of the protocol config.
-- fb3bb9118a: Remove logging of RPCValidation errors when typescript types do not match RPC response types
+- 1cfb1c9da3: The `TransactionBlock` builder now uses the protocol config from the chain when
+  constructing and validating transactions, instead of using hard-coded limits. If you wish to
+  perform signing offline (without a provider), you can either define a `protocolConfig` option when
+  building a transaction, or explicitly set `limits`, which will be used instead of the protocol
+  config.
+- fb3bb9118a: Remove logging of RPCValidation errors when typescript types do not match RPC response
+  types
 
 ### Patch Changes
 
@@ -526,13 +569,16 @@
 
 - 470c27af50: Added network address metrics
 - 671faefe3c: Add `getChainIdentifier` method
-- 9ce7e051b4: Update internal client to use `@open-rpc/client-js` instead of `jayson` and `rpc-websockets`. This results in a more consistent experience and better error messaging.
+- 9ce7e051b4: Update internal client to use `@open-rpc/client-js` instead of `jayson` and
+  `rpc-websockets`. This results in a more consistent experience and better error messaging.
 
 ### Patch Changes
 
 - 4ea96d909a: the event BCS data is a base64 string
 - bcbb178c44: Fixes BCS definition so it matches the RPC one
-- 03828224c9: Previously, effects had an unwrapped_then_deleted field on ts-sdk. This is an issue since jsonrpc returns the field as unwrappedThenDeleted. Update the transaction type definition to use camelcase.
+- 03828224c9: Previously, effects had an unwrapped_then_deleted field on ts-sdk. This is an issue
+  since jsonrpc returns the field as unwrappedThenDeleted. Update the transaction type definition to
+  use camelcase.
 - 9ce7e051b4: Add `subscribeTransaction` method.
 - bb50698551: Fixes BCS type definition in the type layout
 
@@ -573,13 +619,17 @@
 
 ### Patch Changes
 
-- 4ae3cbea3: Response for `getCoinMetadata` is now nullable, in the event that no metadata can be found.
+- 4ae3cbea3: Response for `getCoinMetadata` is now nullable, in the event that no metadata can be
+  found.
 - d2755a496: Fix dependency on msw
 - f612dac98: Change the default gas budgeting to take storage rebates into account.
 - c219e7470: Changed the response type of `getRpcApiVersion` to string.
-- 59ae0e7d6: Removed `skipDataValidation` option, this is now not configurable and is the default behavior.
-- c219e7470: Fix type of `limit` on `getCheckpoints` and `getEpochs` API so that is correctly a number.
-- 4e463c691: Add `waitForTransactionBlock` API to wait for a transaction to be available over the API.
+- 59ae0e7d6: Removed `skipDataValidation` option, this is now not configurable and is the default
+  behavior.
+- c219e7470: Fix type of `limit` on `getCheckpoints` and `getEpochs` API so that is correctly a
+  number.
+- 4e463c691: Add `waitForTransactionBlock` API to wait for a transaction to be available over the
+  API.
 - b4f0bfc76: Fix type definitions for package exports.
 - Updated dependencies [b4f0bfc76]
   - @mysten/bcs@0.7.1
@@ -594,7 +644,9 @@
 
 ### Minor Changes
 
-- 9b42d0ada: This release replaces all uint64 and uint128 numbers with BigInt in all JSON RPC responses to preserve precision. This is a Major Breaking Change - you must update your TS-SDK to latest version
+- 9b42d0ada: This release replaces all uint64 and uint128 numbers with BigInt in all JSON RPC
+  responses to preserve precision. This is a Major Breaking Change - you must update your TS-SDK to
+  latest version
 
 ## 0.31.0
 
@@ -613,59 +665,105 @@
 
 ### Minor Changes
 
-- 956ec28eb: Change `signMessage` to return message bytes. Add support for sui:signMessage in the wallet standard
+- 956ec28eb: Change `signMessage` to return message bytes. Add support for sui:signMessage in the
+  wallet standard
 - 4adfbff73: Use Blake2b instead of sha3_256 for address generation
-- 4c4573ebe: Removed DevInspectResultsType and now DevInspectResults has a property results of ExecutionResultType and a property error
+- 4c4573ebe: Removed DevInspectResultsType and now DevInspectResults has a property results of
+  ExecutionResultType and a property error
 - acc2edb31: Update schema for `SuiSystemState` and `DelegatedStake`
-- 941b03af1: Change functions in transactions.ts of ts-sdk such that: `getTotalGasUsed` and `getTotalGasUsedUpperBound` of ts-sdk return a `bigint`,fields of `gasCostSummary` are defined as `string`, `epochId` is defined as `string`. In `sui-json-rpc` the corresponding types are defined as `BigInt`. Introduce `SuiEpochId` type to `sui-json-rpc` types that is a `BigInt`.
-- a6690ac7d: Changed the default behavior of `publish` to publish an upgreadeable-by-sender package instead of immutable.
+- 941b03af1: Change functions in transactions.ts of ts-sdk such that: `getTotalGasUsed` and
+  `getTotalGasUsedUpperBound` of ts-sdk return a `bigint`,fields of `gasCostSummary` are defined as
+  `string`, `epochId` is defined as `string`. In `sui-json-rpc` the corresponding types are defined
+  as `BigInt`. Introduce `SuiEpochId` type to `sui-json-rpc` types that is a `BigInt`.
+- a6690ac7d: Changed the default behavior of `publish` to publish an upgreadeable-by-sender package
+  instead of immutable.
 - a211dc03a: Change object digest from Base64 encoded to Base58 encoded for rpc version >= 0.28.0
-- 4c1e331b8: Gas budget is now optional, and will automatically be computed by executing a dry-run when not provided.
-- 19b567f21: Unified self- and delegated staking flows. Removed fields from `Validator` (`stake_amount`, `pending_stake`, and `pending_withdraw`) and renamed `delegation_staking_pool` to `staking_pool`. Additionally removed the `validator_stake` and `delegated_stake` fields in the `ValidatorSet` type and replaced them with a `total_stake` field.
-- 7659e2e91: Introduce new `Transaction` builder class, and deprecate all existing methods of sending transactions. The new builder class is designed to take full advantage of Programmable Transactions. Any transaction using the previous `SignableTransaction` interface will be converted to a `Transaction` class when possible, but this interface will be fully removed soon.
+- 4c1e331b8: Gas budget is now optional, and will automatically be computed by executing a dry-run
+  when not provided.
+- 19b567f21: Unified self- and delegated staking flows. Removed fields from `Validator`
+  (`stake_amount`, `pending_stake`, and `pending_withdraw`) and renamed `delegation_staking_pool` to
+  `staking_pool`. Additionally removed the `validator_stake` and `delegated_stake` fields in the
+  `ValidatorSet` type and replaced them with a `total_stake` field.
+- 7659e2e91: Introduce new `Transaction` builder class, and deprecate all existing methods of
+  sending transactions. The new builder class is designed to take full advantage of Programmable
+  Transactions. Any transaction using the previous `SignableTransaction` interface will be converted
+  to a `Transaction` class when possible, but this interface will be fully removed soon.
 - 0d3cb44d9: Change all snake_case field in ts-sdk normalized.ts to camelCase.
-- 36c264ebb: Remove `generateTransactionDigest`. Use one of the following instead: `signer.getTransactionDigest`, `Transaction.getDigest()` or `TransactionDataBuilder.getDigestFromBytes()` instead.
-- 891abf5ed: Remove support for RPC Batch Request in favor of multiGetTransactions and multiGetObjects
+- 36c264ebb: Remove `generateTransactionDigest`. Use one of the following instead:
+  `signer.getTransactionDigest`, `Transaction.getDigest()` or
+  `TransactionDataBuilder.getDigestFromBytes()` instead.
+- 891abf5ed: Remove support for RPC Batch Request in favor of multiGetTransactions and
+  multiGetObjects
 - 2e0ef59fa: Added VALIDATORS_EVENTS_QUERY
-- 33cb357e1: Change functions in json-rpc-provider.ts of ts-sdk such that: `getTotalTransactionBlocks`, `getReferenceGasPrice` return a `bigint`, `getLatestCheckpointSequenceNumber` returns a `string`, `gasPrice` of `devInspectTransactionBlock` is defined as a `string`, checkpoint sequence number of `getCheckpoint` is defined as a `string`, `cursor` of `getCheckpoints` is defined as a `string`. Introduce `SuiCheckpointSequenceNumber` type in sui-json-rpc-types that is a `BigInt` to use instead of `CheckpointSequenceNumber` of sui-types.
+- 33cb357e1: Change functions in json-rpc-provider.ts of ts-sdk such that:
+  `getTotalTransactionBlocks`, `getReferenceGasPrice` return a `bigint`,
+  `getLatestCheckpointSequenceNumber` returns a `string`, `gasPrice` of `devInspectTransactionBlock`
+  is defined as a `string`, checkpoint sequence number of `getCheckpoint` is defined as a `string`,
+  `cursor` of `getCheckpoints` is defined as a `string`. Introduce `SuiCheckpointSequenceNumber`
+  type in sui-json-rpc-types that is a `BigInt` to use instead of `CheckpointSequenceNumber` of
+  sui-types.
 - 6bd88570c: Rework all coin APIs to take objects as arguments instead of positional arguments.
-- f1e42f792: Consolidate get_object and get_raw_object into a single get_object endpoint which now takes an additional config parameter with type `SuiObjectDataOptions` and has a new return type `SuiObjectResponse`. By default, only object_id, version, and digest are fetched.
+- f1e42f792: Consolidate get_object and get_raw_object into a single get_object endpoint which now
+  takes an additional config parameter with type `SuiObjectDataOptions` and has a new return type
+  `SuiObjectResponse`. By default, only object_id, version, and digest are fetched.
 - 272389c20: Support for new versioned TransactionData format
 - 3de8de361: Remove `getSuiSystemState` method. Use `getLatestSuiSystemState` method instead.
-- be3c4f51e: Add `display` field in `SuiObjectResponse` for frontend rendering. See more details in https://forums.sui.io/t/nft-object-display-proposal/4872
-- dbe73d5a4: Update `executeTransaction` and `signAndExecuteTransaction` to take in an additional parameter `SuiTransactionBlockResponseOptions` which is used to specify which fields to include in `SuiTransactionBlockResponse` (e.g., transaction, effects, events, etc). By default, only the transaction digest will be included.
-- c82e4b454: Introduce BigInt struct to sui-json-rpc-types to serialize and deserialize amounts to/from string. Change ts-sdk to serialize amounts of PaySui and Pay as string.
-- 7a2eaf4a3: Changing the SuiObjectResponse struct to use data/error fields instead of details/status
-- 2ef2bb59e: Deprecate getTransactionDigestsInRange. This method will be removed before April 2023, please use `getTransactions` instead
+- be3c4f51e: Add `display` field in `SuiObjectResponse` for frontend rendering. See more details in
+  https://forums.sui.io/t/nft-object-display-proposal/4872
+- dbe73d5a4: Update `executeTransaction` and `signAndExecuteTransaction` to take in an additional
+  parameter `SuiTransactionBlockResponseOptions` which is used to specify which fields to include in
+  `SuiTransactionBlockResponse` (e.g., transaction, effects, events, etc). By default, only the
+  transaction digest will be included.
+- c82e4b454: Introduce BigInt struct to sui-json-rpc-types to serialize and deserialize amounts
+  to/from string. Change ts-sdk to serialize amounts of PaySui and Pay as string.
+- 7a2eaf4a3: Changing the SuiObjectResponse struct to use data/error fields instead of
+  details/status
+- 2ef2bb59e: Deprecate getTransactionDigestsInRange. This method will be removed before April 2023,
+  please use `getTransactions` instead
 - 9b29bef37: Pass blake2b hash to signer API
 - 8700809b5: Add a new `getCheckpoints` endpoint that returns a paginated list of checkpoints.
 - 5c3b00cde: Add object id to staking pool and pool id to staked sui.
-- 01272ab7d: Remove deprecated `getCheckpointContents`, `getCheckpointContentsByDigest`, `getCheckpointSummary` and `getCheckpointSummaryByDigest` methods.
+- 01272ab7d: Remove deprecated `getCheckpointContents`, `getCheckpointContentsByDigest`,
+  `getCheckpointSummary` and `getCheckpointSummaryByDigest` methods.
 - 9822357d6: Add getStakesByIds to get DelegatedStake queried by id
-- 3d9a04648: Adds `deactivation_epoch` to staking pool object, and adds `inactive_pools` to the validator set object.
+- 3d9a04648: Adds `deactivation_epoch` to staking pool object, and adds `inactive_pools` to the
+  validator set object.
 - da72e73a9: Change the address of Move package for staking and validator related Move modules.
 - a0955c479: Switch from 20 to 32-byte address. Match Secp256k1.deriveKeypair with Ed25519.
 - 0c9047698: Remove all gas selection APIs from the json rpc provider.
-- d5ef1b6e5: Added dependencies to publish command, dependencies now also returned from the sui move CLI with the `--dump-bytecode-as-base64` flag
-- 0a7b42a6d: This changes almost all occurences of "delegate", "delegation" (and various capitalizations/forms) to their equivalent "stake"-based name. Function names, function argument names, RPC endpoints, Move functions, and object fields have been updated with this new naming convention.
+- d5ef1b6e5: Added dependencies to publish command, dependencies now also returned from the sui move
+  CLI with the `--dump-bytecode-as-base64` flag
+- 0a7b42a6d: This changes almost all occurences of "delegate", "delegation" (and various
+  capitalizations/forms) to their equivalent "stake"-based name. Function names, function argument
+  names, RPC endpoints, Move functions, and object fields have been updated with this new naming
+  convention.
 - 3de8de361: Remove `getValidators` API. Use `getLatestSuiSystemState` instead.
 - dd348cf03: Refactor `getTransactions` to `queryTransactions`
 - 57c17e02a: Removed `JsonRpcProviderWithCache`, use `JsonRpcProvider` instead.
-- 65f1372dd: Rename `provider.getTransactionWithEffects` to `provider.getTransaction`. The new method takes in an additional parameter `SuiTransactionBlockResponseOptions` to configure which fields to fetch(transaction, effects, events, etc). By default, only the transaction digest will be returned.
+- 65f1372dd: Rename `provider.getTransactionWithEffects` to `provider.getTransaction`. The new
+  method takes in an additional parameter `SuiTransactionBlockResponseOptions` to configure which
+  fields to fetch(transaction, effects, events, etc). By default, only the transaction digest will
+  be returned.
 - a09239308: [testing only] an intent scope can be passed in to verifyMessage
-- fe335e6ba: Removed usage of `cross-fetch` in the TypeScript SDK. If you are running in an environment that does not have `fetch` defined, you will need to polyfill it.
+- fe335e6ba: Removed usage of `cross-fetch` in the TypeScript SDK. If you are running in an
+  environment that does not have `fetch` defined, you will need to polyfill it.
 - 5dc25faad: Remove getTransactionDigestsInRange from the SDK
 - 64234baaf: added combined `getCheckpoint` endpoint for retrieving information about a checkpoint
 - d3170ba41: All JSON-RPC APIs now accept objects instead of positional arugments.
-- a6ffb8088: Removed events from transaction effects, TransactionEvents will now be provided in the TransactionResponse, along side TransactionEffects.
-- 3304eb83b: Refactor Rust SuiTransactionBlockKind to be internally tagged for Json serialization with tag="type" and SuiEvent to be adjacently tagged with tag="type" and content="content"
+- a6ffb8088: Removed events from transaction effects, TransactionEvents will now be provided in the
+  TransactionResponse, along side TransactionEffects.
+- 3304eb83b: Refactor Rust SuiTransactionBlockKind to be internally tagged for Json serialization
+  with tag="type" and SuiEvent to be adjacently tagged with tag="type" and content="content"
 - 4189171ef: Adds support for validator candidate.
 - 77bdf907f: When parsing u64, u128, and u256 values with bcs, they are now string encoded.
 - a74df16ec: Minor change to the system transaction format
-- 0f7aa6507: Switching the response type of the getOwnedObjects api to a paginatedObjects response, and also moving filtering to FN
+- 0f7aa6507: Switching the response type of the getOwnedObjects api to a paginatedObjects response,
+  and also moving filtering to FN
 - 9b60bf700: Change all snake_case fields in checkpoint.ts and faucet.ts to camelCase
-- 64fb649eb: Remove old `SuiExecuteTransactionResponse` interface, and `CertifiedTransaction` interface in favor of the new unified `SuiTransactionBlockResponse` interfaces.
-- a6b0c4e5f: Changed the getOwnerObjectsForAddress api to getOwnedObjects, and added options/ pagination to the parameters
+- 64fb649eb: Remove old `SuiExecuteTransactionResponse` interface, and `CertifiedTransaction`
+  interface in favor of the new unified `SuiTransactionBlockResponse` interfaces.
+- a6b0c4e5f: Changed the getOwnerObjectsForAddress api to getOwnedObjects, and added options/
+  pagination to the parameters
 
 ### Patch Changes
 
@@ -688,7 +786,8 @@
 
 ### Patch Changes
 
-- 31bfcae6a: Make arguments field optional for MoveCall to match Rust definition. This fixes a bug where the Explorer page does not load for transactions with no argument.
+- 31bfcae6a: Make arguments field optional for MoveCall to match Rust definition. This fixes a bug
+  where the Explorer page does not load for transactions with no argument.
 
 ## 0.29.0
 
@@ -696,7 +795,8 @@
 
 - f2e713bd0: Add TransactionExpiration to TransactionData
 - 4baf554f1: Make fromSecretKey take the 32 bytes privkey
-- aa650aa3b: Introduce new `Connection` class, which is used to define the endpoints that are used when interacting with the network.
+- aa650aa3b: Introduce new `Connection` class, which is used to define the endpoints that are used
+  when interacting with the network.
 - 6ff0c785f: Use DynamicFieldName struct instead of string for dynamic field's name
 
 ### Patch Changes
@@ -711,9 +811,15 @@
 
 ### Minor Changes
 
-- a67cc044b: Transaction signatures are now serialized into a single string, and all APIs that previously took the public key, signature, and scheme now just take the single serialized signature string. To help make parsing this easier, there are new `toSerializedSignature` and `toParsedSignaturePubkeyPair` methods exposed as well.
-- a67cc044b: The RawSigner now provides a `signTransaction` function, which can be used to sign a transaction without submitting it to the network.
-- a67cc044b: The RawSigner now provides a `signMessage` function that can be used to sign personal messages. The SDK also now exports a `verifyMessage` function that can be used to easily verify a message signed with `signMessage`.
+- a67cc044b: Transaction signatures are now serialized into a single string, and all APIs that
+  previously took the public key, signature, and scheme now just take the single serialized
+  signature string. To help make parsing this easier, there are new `toSerializedSignature` and
+  `toParsedSignaturePubkeyPair` methods exposed as well.
+- a67cc044b: The RawSigner now provides a `signTransaction` function, which can be used to sign a
+  transaction without submitting it to the network.
+- a67cc044b: The RawSigner now provides a `signMessage` function that can be used to sign personal
+  messages. The SDK also now exports a `verifyMessage` function that can be used to easily verify a
+  message signed with `signMessage`.
 
 ### Patch Changes
 
@@ -725,7 +831,8 @@
 
 ### Minor Changes
 
-- 473005d8f: Add protocol_version to CheckpointSummary and SuiSystemObject. Consolidate end-of-epoch information in CheckpointSummary.
+- 473005d8f: Add protocol_version to CheckpointSummary and SuiSystemObject. Consolidate end-of-epoch
+  information in CheckpointSummary.
 - 59641dc29: Support for deserializing new ConsensusCommitPrologue system transaction
 - 629804d26: Remove usage of `Base64DataBuffer`, and use `Uint8Array` instead.
 - f51c85e85: remove get_objects_owned_by_object and replace it with get_dynamic_fields
@@ -761,7 +868,8 @@
 
 ### Minor Changes
 
-- 7b4bf43bc: Support for interacting with Devnet v0.24+ where Move Calls refer to their packages by ObjectID only (not ObjectRef).
+- 7b4bf43bc: Support for interacting with Devnet v0.24+ where Move Calls refer to their packages by
+  ObjectID only (not ObjectRef).
 
 ### Patch Changes
 
@@ -778,7 +886,8 @@
 ### Patch Changes
 
 - 01458ffd5: Fix websocket default port for DevNet
-- a274ecfc7: Make previousTransaction optional for CoinStruct to support v0.22 network where it doesn't exist
+- a274ecfc7: Make previousTransaction optional for CoinStruct to support v0.22 network where it
+  doesn't exist
 - 89091ddab: change estimator logic to use upper bound
 - 71bee7563: fix creating websocket url
 
@@ -814,16 +923,22 @@
 ### Minor Changes
 
 - 4fb12ac6d: - removes `transfer` function from framework Coin
-  - renames `newTransferTx` function from framework Coin to `newPayTransaction`. Also it's now a public method and without the need of signer so a dapp can use it
+  - renames `newTransferTx` function from framework Coin to `newPayTransaction`. Also it's now a
+    public method and without the need of signer so a dapp can use it
   - fixes edge cases with pay txs
 - bb14ffdc5: Remove ImmediateReturn and WaitForTxCert from ExecuteTransactionRequestType
-- d2015f815: Rebuilt type-narrowing utilties (e.g. `isSuiObject`) on top of Superstruct, which should make them more reliable.
-  The type-narrowing functions are no longer exported, instead a Superstruct schema is exported, in addition to an `is` and `assert` function, both of which can be used to replace the previous narrowing functions. For example, `isSuiObject(data)` becomes `is(data, SuiObject)`.
-- 7d0f25b61: Add devInspectTransaction, which is similar to dryRunTransaction, but lets you call any Move function(including non-entry function) with arbitrary values.
+- d2015f815: Rebuilt type-narrowing utilties (e.g. `isSuiObject`) on top of Superstruct, which
+  should make them more reliable. The type-narrowing functions are no longer exported, instead a
+  Superstruct schema is exported, in addition to an `is` and `assert` function, both of which can be
+  used to replace the previous narrowing functions. For example, `isSuiObject(data)` becomes
+  `is(data, SuiObject)`.
+- 7d0f25b61: Add devInspectTransaction, which is similar to dryRunTransaction, but lets you call any
+  Move function(including non-entry function) with arbitrary values.
 
 ### Patch Changes
 
-- 9fbe2714b: Add devInspectMoveCall, which is similar to devInspectTransaction, but lets you call any Move function without a gas object and budget
+- 9fbe2714b: Add devInspectMoveCall, which is similar to devInspectTransaction, but lets you call
+  any Move function without a gas object and budget
 
 ## 0.20.0
 
@@ -874,7 +989,8 @@
 
 - a9602e533: Remove deprecated events API
 - db22728c1: \* adds dryRunTransaction support
-  - adds getGasCostEstimation to the signer-with-provider that estimates the gas cost for a transaction
+  - adds getGasCostEstimation to the signer-with-provider that estimates the gas cost for a
+    transaction
 - 3b510d0fc: adds coin transfer method to framework that uses pay and paySui
 
 ## 0.16.0
@@ -917,7 +1033,8 @@
 - b4a8ee9bf: Support passing a vector of objects in LocalTxnBuilder
 - ef3571dc8: Fix gas selection bug for a vector of objects
 - cccfe9315: Add deserialization util method to LocalTxnDataSerializer
-- 2dc594ef7: Introduce getCoinDenominationInfo, which returns denomination info of a coin, now only supporting SUI coin.
+- 2dc594ef7: Introduce getCoinDenominationInfo, which returns denomination info of a coin, now only
+  supporting SUI coin.
 - 4f0c611ff: Protocol change to add 'initial shared version' to shared object references.
 
 ## 0.13.0
@@ -934,10 +1051,13 @@
 ### Minor Changes
 
 - e0b173b9e: Standardize Ed25519KeyPair key derivation with SLIP10
-- 059ede517: Flip the default value of `skipDataValidation` to true in order to mitigate the impact of breaking changes on applications. When there's a mismatch between the TypeScript definitions and RPC response, the SDK now log a console warning instead of throwing an error.
+- 059ede517: Flip the default value of `skipDataValidation` to true in order to mitigate the impact
+  of breaking changes on applications. When there's a mismatch between the TypeScript definitions
+  and RPC response, the SDK now log a console warning instead of throwing an error.
 - 03e6b552b: Add util function to get coin balances
 - 4575c0a02: Fix type definition of SuiMoveNormalizedType
-- ccf7f148d: Added generic signAndExecuteTransaction method to the SDK, which can be used with any supported type of transaction.
+- ccf7f148d: Added generic signAndExecuteTransaction method to the SDK, which can be used with any
+  supported type of transaction.
 
 ### Patch Changes
 

package/README.md

@@ -478,47 +478,3 @@ const events = client.queryEvents({
 	limit: 2,
 });
 ```
-
-Subscribe to all events created by transactions sent by account
-`0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231`
-
-```typescript
-import { getFullnodeUrl, SuiClient } from '@mysten/sui/client';
-
-const client = new SuiClient({
-	url: getFullnodeUrl('testnet'),
-});
-// calls RPC method 'suix_subscribeEvent' with params:
-// [ { Sender: '0xbff6ccc8707aa517b4f1b95750a2a8c666012df3' } ]
-const unsubscribe = await client.subscribeEvent({
-	filter: {
-		Sender: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
-	},
-	onMessage(event) {
-		// handle subscription notification message here. This function is called once per subscription message.
-	},
-});
-
-// later, to unsubscribe:
-await unsubscribe();
-```
-
-Subscribe to all events created by a package's `nft` module
-
-```typescript
-import { getFullnodeUrl, SuiClient } from '@mysten/sui/client';
-
-const client = new SuiClient({
-	url: getFullnodeUrl('testnet'),
-});
-const somePackage = '0x...';
-const devnetNftFilter = {
-	MoveModule: { package: somePackage, module: 'nft' },
-};
-const devNftSub = await client.subscribeEvent({
-	filter: devnetNftFilter,
-	onMessage(event) {
-		// handle subscription notification message here
-	},
-});
-```

package/dist/cjs/bcs/bcs.d.ts

@@ -1455,7 +1455,7 @@ export declare function IntentMessage<T extends BcsType<any>>(T: T): BcsType<{
             $kind: "Sui";
         };
     };
-    value: T extends BcsType<infer U_2, any> ? U_2 : never;
+    value: T extends BcsType<infer U, any> ? U : never;
 }, {
     intent: {
         scope: import("@mysten/bcs").EnumInputShape<{
@@ -1471,7 +1471,7 @@ export declare function IntentMessage<T extends BcsType<any>>(T: T): BcsType<{
             Sui: boolean | object | null;
         };
     };
-    value: T extends BcsType<any, infer U_3> ? U_3 : never;
+    value: T extends BcsType<any, infer U_1> ? U_1 : never;
 }>;
 export declare const CompressedSignature: BcsType<import("@mysten/bcs").EnumOutputShapeWithKeys<{
     ED25519: number[];