TS SDK 1.0 (#16735)

## Description Describe the changes or additions included in this PR. ## Test Plan How did you test the new or updated feature? --- If your changes are not user-facing and do not break anything, you can skip the following section. Otherwise, please briefly describe what has changed under the Release Notes section. ### Type of Change (Check all that apply) - [ ] protocol change - [ ] user-visible impact - [ ] breaking change for a client SDKs - [ ] breaking change for FNs (FN binary must upgrade) - [ ] breaking change for validators or node operators (must upgrade binaries) - [ ] breaking change for on-chain data layout - [ ] necessitate either a data wipe or data migration ### Release notes
MystenLabs · May 29, 2024 · a92b03d · a92b03d
1 parent a1ce332
commit a92b03d
Show file tree

Hide file tree

Showing 559 changed files with 15,531 additions and 17,470 deletions.
diff --git a/.changeset/bright-wombats-try.md b/.changeset/bright-wombats-try.md
@@ -1,5 +1,5 @@
 ---
-'@mysten/sui.js': patch
+'@mysten/sui': patch
 ---
 
 Add support for more JSON RPC error codes
diff --git a/.changeset/witty-llamas-smile.md b/.changeset/witty-llamas-smile.md
@@ -0,0 +1,18 @@
+---
+'@mysten/sui': major
+'@mysten/bcs': major
+'@mysten/ledgerjs-hw-app-sui': minor
+'@mysten/graphql-transport': minor
+'@mysten/wallet-standard': minor
+'@mysten/suins-toolkit': minor
+'@mysten/create-dapp': minor
+'@mysten/dapp-kit': minor
+'@mysten/deepbook': minor
+'@mysten/zklogin': minor
+'@mysten/zksend': minor
+'@mysten/enoki': minor
+'@mysten/kiosk': minor
+---
+
+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.
diff --git a/.github/actions/ts-e2e/action.yml b/.github/actions/ts-e2e/action.yml
@@ -64,5 +64,5 @@ runs:
       shell: bash
 
     - name: Run TS SDK e2e tests
-      run: pnpm dlx concurrently --kill-others --success command-1 "$E2E_RUN_LOCAL_NET_CMD" 'pnpm --filter @mysten/sui.js --filter @mysten/graphql-transport test:e2e'
+      run: pnpm dlx concurrently --kill-others --success command-1 "$E2E_RUN_LOCAL_NET_CMD" 'pnpm --filter @mysten/sui --filter @mysten/graphql-transport test:e2e'
       shell: bash
diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml
@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     outputs:
       isWallet: ${{ (steps.turbo.outputs.packages && contains(fromJson(steps.turbo.outputs.packages), 'sui-wallet')) }}
-      isTypescriptSDK: ${{ (steps.turbo.outputs.packages && contains(fromJson(steps.turbo.outputs.packages), '@mysten/sui.js')) }}
+      isTypescriptSDK: ${{ (steps.turbo.outputs.packages && contains(fromJson(steps.turbo.outputs.packages), '@mysten/sui')) }}
       isGraphQlTransport: ${{ (steps.turbo.outputs.packages && contains(fromJson(steps.turbo.outputs.packages), '@mysten/graphql-transport')) }}
       isRust: ${{ steps.diff.outputs.isRust }}
     steps:
@@ -66,7 +66,7 @@ jobs:
 
       - name: Run TS SDK e2e tests
         if: ${{ needs.diff.outputs.isTypescriptSDK == 'true' || needs.diff.outputs.isRust == 'true'}}
-        run: pnpm dlx concurrently --kill-others --success command-1 "$E2E_RUN_LOCAL_NET_CMD" 'pnpm --filter @mysten/sui.js test:e2e'
+        run: pnpm dlx concurrently --kill-others --success command-1 "$E2E_RUN_LOCAL_NET_CMD" 'pnpm --filter @mysten/sui test:e2e'
 
       - name: Run RPC/GrpahQL comaptability e2e tests
         if: ${{ needs.diff.outputs.isGraphQlTransport == 'true' || needs.diff.outputs.isRust == 'true'}}

diff --git a/apps/core/package.json b/apps/core/package.json
@@ -28,7 +28,7 @@
 		"@hookform/resolvers": "^3.1.1",
 		"@mysten/dapp-kit": "workspace:*",
 		"@mysten/kiosk": "workspace:*",
-		"@mysten/sui.js": "workspace:*",
+		"@mysten/sui": "workspace:*",
 		"@sentry/react": "^7.59.2",
 		"@tanstack/react-query": "^5.0.0",
 		"bignumber.js": "^9.1.1",
@@ -48,6 +48,6 @@
 		"tailwindcss": "^3.3.3",
 		"typescript": "^5.3.3",
 		"vite": "^4.4.4",
-		"vitest": "^0.33.0"
+		"vitest": "^1.6.0"
 	}
 }
diff --git a/apps/core/src/api/SentryHttpTransport.ts b/apps/core/src/api/SentryHttpTransport.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { SuiHTTPTransport } from '@mysten/sui.js/client';
+import { SuiHTTPTransport } from '@mysten/sui/client';
 import * as Sentry from '@sentry/react';
 
 const IGNORED_METHODS = ['suix_resolveNameServiceNames', 'suix_resolveNameServiceAddresses'];

diff --git a/apps/core/src/hooks/useFormatCoin.ts b/apps/core/src/hooks/useFormatCoin.ts
@@ -2,8 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { useSuiClient } from '@mysten/dapp-kit';
-import { CoinMetadata } from '@mysten/sui.js/client';
-import { SUI_TYPE_ARG } from '@mysten/sui.js/utils';
+import { CoinMetadata } from '@mysten/sui/client';
+import { SUI_TYPE_ARG } from '@mysten/sui/utils';
 import { useQuery, type UseQueryResult } from '@tanstack/react-query';
 import BigNumber from 'bignumber.js';
 import { useMemo } from 'react';

diff --git a/apps/core/src/hooks/useGetCoins.ts b/apps/core/src/hooks/useGetCoins.ts
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { useSuiClient } from '@mysten/dapp-kit';
-import { PaginatedCoins } from '@mysten/sui.js/client';
+import { PaginatedCoins } from '@mysten/sui/client';
 import { useInfiniteQuery } from '@tanstack/react-query';
 
 const MAX_COINS_PER_REQUEST = 10;

diff --git a/apps/core/src/hooks/useGetDelegatedStake.tsx b/apps/core/src/hooks/useGetDelegatedStake.tsx
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { useSuiClient } from '@mysten/dapp-kit';
-import type { DelegatedStake } from '@mysten/sui.js/client';
+import type { DelegatedStake } from '@mysten/sui/client';
 import { useQuery, type UseQueryOptions } from '@tanstack/react-query';
 
 type UseGetDelegatedStakesOptions = {

diff --git a/apps/core/src/hooks/useGetDynamicFields.ts b/apps/core/src/hooks/useGetDynamicFields.ts
@@ -2,8 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { useSuiClient } from '@mysten/dapp-kit';
-import { DynamicFieldPage } from '@mysten/sui.js/client';
-import { normalizeSuiAddress } from '@mysten/sui.js/utils';
+import { DynamicFieldPage } from '@mysten/sui/client';
+import { normalizeSuiAddress } from '@mysten/sui/utils';
 import { useInfiniteQuery } from '@tanstack/react-query';
 
 const MAX_PAGE_SIZE = 10;

diff --git a/apps/core/src/hooks/useGetKioskContents.ts b/apps/core/src/hooks/useGetKioskContents.ts
@@ -3,7 +3,7 @@
 
 import { useSuiClientContext } from '@mysten/dapp-kit';
 import { KIOSK_ITEM, KioskClient, KioskItem, KioskOwnerCap } from '@mysten/kiosk';
-import { SuiClient } from '@mysten/sui.js/client';
+import { SuiClient } from '@mysten/sui/client';
 import { useQuery } from '@tanstack/react-query';
 
 import { getKioskIdFromOwnerCap, ORIGINBYTE_KIOSK_OWNER_TOKEN } from '../utils/kiosk';

diff --git a/apps/core/src/hooks/useGetObject.ts b/apps/core/src/hooks/useGetObject.ts
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { useSuiClient } from '@mysten/dapp-kit';
-import { normalizeSuiAddress } from '@mysten/sui.js/utils';
+import { normalizeSuiAddress } from '@mysten/sui/utils';
 import { useQuery } from '@tanstack/react-query';
 
 const defaultOptions = {

diff --git a/apps/core/src/hooks/useGetOwnedObjects.ts b/apps/core/src/hooks/useGetOwnedObjects.ts
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { useSuiClient } from '@mysten/dapp-kit';
-import { PaginatedObjectsResponse, type SuiObjectDataFilter } from '@mysten/sui.js/client';
+import { PaginatedObjectsResponse, type SuiObjectDataFilter } from '@mysten/sui/client';
 import { useInfiniteQuery } from '@tanstack/react-query';
 
 const MAX_OBJECTS_PER_REQ = 6;

diff --git a/apps/core/src/hooks/useGetTransferAmount.ts b/apps/core/src/hooks/useGetTransferAmount.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
-import { SuiTransactionBlockResponse } from '@mysten/sui.js/client';
-import { SUI_TYPE_ARG } from '@mysten/sui.js/utils';
+import { SuiTransactionBlockResponse } from '@mysten/sui/client';
+import { SUI_TYPE_ARG } from '@mysten/sui/utils';
 import { useMemo } from 'react';
 
 import { getTotalGasUsed } from '../utils/transaction';

diff --git a/apps/core/src/hooks/useGetValidatorsEvents.ts b/apps/core/src/hooks/useGetValidatorsEvents.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 import { useSuiClient } from '@mysten/dapp-kit';
-import { SuiEvent, type EventId } from '@mysten/sui.js/client';
+import { SuiEvent, type EventId } from '@mysten/sui/client';
 import { useQuery } from '@tanstack/react-query';
 
 type GetValidatorsEvent = {

diff --git a/apps/core/src/hooks/useMultiGetObjects.ts b/apps/core/src/hooks/useMultiGetObjects.ts
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { useSuiClient } from '@mysten/dapp-kit';
-import { SuiObjectDataOptions, SuiObjectResponse } from '@mysten/sui.js/client';
+import { SuiObjectDataOptions, SuiObjectResponse } from '@mysten/sui/client';
 import { useQuery, UseQueryOptions } from '@tanstack/react-query';
 
 import { chunkArray } from '../utils/chunkArray';

diff --git a/apps/core/src/hooks/useTransactionSummary.ts b/apps/core/src/hooks/useTransactionSummary.ts
@@ -3,7 +3,7 @@
 import {
 	DryRunTransactionBlockResponse,
 	type SuiTransactionBlockResponse,
-} from '@mysten/sui.js/client';
+} from '@mysten/sui/client';
 import { useMemo } from 'react';
 
 import { getBalanceChangeSummary } from '../utils/transaction/getBalanceChangeSummary';

diff --git a/apps/core/src/utils/getRefGasPrice.ts b/apps/core/src/utils/getRefGasPrice.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { SuiValidatorSummary } from '@mysten/sui.js/client';
+import { SuiValidatorSummary } from '@mysten/sui/client';
 
 import { calculateStakeShare } from './calculateStakeShare';
 

diff --git a/apps/core/src/utils/hasDisplayData.ts b/apps/core/src/utils/hasDisplayData.ts
@@ -1,6 +1,6 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { SuiObjectResponse } from '@mysten/sui.js/client';
+import { SuiObjectResponse } from '@mysten/sui/client';
 
 export const hasDisplayData = (obj: SuiObjectResponse) => !!obj.data?.display?.data;
diff --git a/apps/core/src/utils/kiosk.ts b/apps/core/src/utils/kiosk.ts
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { KIOSK_OWNER_CAP, Network, PERSONAL_KIOSK_RULE_ADDRESS } from '@mysten/kiosk';
-import { SuiObjectData, SuiObjectResponse } from '@mysten/sui.js/client';
+import { SuiObjectData, SuiObjectResponse } from '@mysten/sui/client';
 
 export const ORIGINBYTE_KIOSK_MODULE =
 	'0x95a441d389b07437d00dd07e0b6f05f513d7659b13fd7c5d3923c7d9d847199b::ob_kiosk';

diff --git a/apps/core/src/utils/transaction/getBalanceChangeSummary.ts b/apps/core/src/utils/transaction/getBalanceChangeSummary.ts
@@ -4,8 +4,8 @@ import {
 	type DryRunTransactionBlockResponse,
 	type ObjectOwner,
 	type SuiTransactionBlockResponse,
-} from '@mysten/sui.js/client';
-import { normalizeSuiObjectId, parseStructTag } from '@mysten/sui.js/utils';
+} from '@mysten/sui/client';
+import { normalizeSuiObjectId, parseStructTag } from '@mysten/sui/utils';
 
 export type BalanceChange = {
 	coinType: string;

diff --git a/apps/core/src/utils/transaction/getGasSummary.ts b/apps/core/src/utils/transaction/getGasSummary.ts
@@ -6,7 +6,7 @@ import {
 	SuiGasData,
 	SuiTransactionBlockResponse,
 	TransactionEffects,
-} from '@mysten/sui.js/client';
+} from '@mysten/sui/client';
 
 type Optional<T> = {
 	[K in keyof T]?: T[K];

diff --git a/apps/core/src/utils/transaction/getLabel.ts b/apps/core/src/utils/transaction/getLabel.ts
@@ -1,6 +1,6 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
-import { SuiTransactionBlockResponse } from '@mysten/sui.js/client';
+import { SuiTransactionBlockResponse } from '@mysten/sui/client';
 
 // todo: add more logic for deriving transaction label
 export const getLabel = (transaction: SuiTransactionBlockResponse, currentAddress?: string) => {

diff --git a/apps/core/src/utils/transaction/getObjectChangeSummary.ts b/apps/core/src/utils/transaction/getObjectChangeSummary.ts
@@ -9,7 +9,7 @@ import {
 	SuiObjectChangePublished,
 	SuiObjectChangeTransferred,
 	SuiObjectChangeWrapped,
-} from '@mysten/sui.js/client';
+} from '@mysten/sui/client';
 
 import { groupByOwner } from './groupByOwner';
 import { SuiObjectChangeTypes } from './types';

diff --git a/apps/core/src/utils/transaction/getObjectDisplayLookup.ts b/apps/core/src/utils/transaction/getObjectDisplayLookup.ts
@@ -1,6 +1,6 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
-import { DisplayFieldsResponse, SuiObjectResponse } from '@mysten/sui.js/client';
+import { DisplayFieldsResponse, SuiObjectResponse } from '@mysten/sui/client';
 
 import { hasDisplayData } from '../hasDisplayData';
 

diff --git a/apps/core/src/utils/transaction/getOwnerType.ts b/apps/core/src/utils/transaction/getOwnerType.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import type { SuiObjectChange } from '@mysten/sui.js/client';
+import type { SuiObjectChange } from '@mysten/sui/client';
 
 export const getOwnerType = (change: SuiObjectChange) => {
 	if (!('owner' in change)) return '';

diff --git a/apps/wallet/configs/ts/tsconfig.common.json b/apps/wallet/configs/ts/tsconfig.common.json
@@ -43,8 +43,8 @@
 			"_values/*": ["./src/ui/styles/values/*"],
 			"_utils": ["./src/ui/styles/utils"],
 			"_utils/*": ["./src/ui/styles/utils/*"],
-			"@mysten/sui.js/*": ["../../sdk/typescript/src/*"],
-			"@mysten/sui.js": ["../../sdk/typescript/src/"],
+			"@mysten/sui/*": ["../../sdk/typescript/src/*"],
+			"@mysten/sui": ["../../sdk/typescript/src/"],
 			"@mysten/kiosk": ["../../sdk/kiosk/src/index.ts"],
 			"@mysten/bcs": ["../../sdk/bcs/src/"],
 			"@mysten/dapp-kit": ["../../sdk/dapp-kit/src/"],

diff --git a/apps/wallet/configs/webpack/webpack.config.common.ts b/apps/wallet/configs/webpack/webpack.config.common.ts
@@ -110,7 +110,7 @@ const commonConfig: () => Promise<Configuration> = async () => {
 		},
 		resolve: {
 			extensions: ['.ts', '.tsx', '.js'],
-			// Fix .js imports from @mysten/sui.js since we are importing it from source
+			// Fix .js imports from @mysten/sui since we are importing it from source
 			extensionAlias: {
 				'.js': ['.js', '.ts', '.tsx', '.jsx'],
 				'.mjs': ['.mjs', '.mts'],

diff --git a/apps/wallet/package.json b/apps/wallet/package.json
@@ -77,7 +77,7 @@
 		"dotenv-webpack": "^8.0.0",
 		"eslint-webpack-plugin": "^4.0.1",
 		"git-rev-sync": "^3.0.2",
-		"happy-dom": "^10.5.1",
+		"happy-dom": "^14.11.0",
 		"html-webpack-plugin": "^5.5.3",
 		"mini-css-extract-plugin": "^2.7.6",
 		"onchange": "^7.1.0",
@@ -95,7 +95,7 @@
 		"typescript": "^5.3.3",
 		"vite": "^4.4.4",
 		"vite-tsconfig-paths": "^4.2.0",
-		"vitest": "^0.33.0",
+		"vitest": "^1.6.0",
 		"web-ext": "^7.6.2",
 		"webpack": "^5.79.0",
 		"webpack-cli": "^5.0.1",
@@ -120,7 +120,7 @@
 		"@mysten/icons": "workspace:*",
 		"@mysten/kiosk": "workspace:*",
 		"@mysten/ledgerjs-hw-app-sui": "workspace:*",
-		"@mysten/sui.js": "workspace:*",
+		"@mysten/sui": "workspace:*",
 		"@mysten/wallet-standard": "workspace:*",
 		"@mysten/zklogin": "workspace:*",
 		"@noble/hashes": "^1.3.1",

diff --git a/apps/wallet/src/background/Transactions.ts b/apps/wallet/src/background/Transactions.ts
@@ -10,7 +10,7 @@ import { type SignMessageRequest } from '_payloads/transactions/SignMessage';
 import type { TransactionRequestResponse } from '_payloads/transactions/ui/TransactionRequestResponse';
 import type { ContentScriptConnection } from '_src/background/connections/ContentScriptConnection';
 import { type SignedTransaction } from '_src/ui/app/WalletSigner';
-import { type SuiTransactionBlockResponse } from '@mysten/sui.js/client';
+import { type SuiTransactionBlockResponse } from '@mysten/sui/client';
 import { type SuiSignMessageOutput } from '@mysten/wallet-standard';
 import { filter, lastValueFrom, map, race, Subject, take } from 'rxjs';
 import { v4 as uuidV4 } from 'uuid';

diff --git a/apps/wallet/src/background/account-sources/MnemonicAccountSource.ts b/apps/wallet/src/background/account-sources/MnemonicAccountSource.ts
@@ -9,8 +9,8 @@ import {
 	validateEntropy,
 } from '_shared/utils/bip39';
 import { decrypt, encrypt } from '_src/shared/cryptography/keystore';
-import { mnemonicToSeedHex } from '@mysten/sui.js/cryptography';
-import { Ed25519Keypair } from '@mysten/sui.js/keypairs/ed25519';
+import { mnemonicToSeedHex } from '@mysten/sui/cryptography';
+import { Ed25519Keypair } from '@mysten/sui/keypairs/ed25519';
 import { sha256 } from '@noble/hashes/sha256';
 import { bytesToHex } from '@noble/hashes/utils';
 import Dexie from 'dexie';

diff --git a/apps/wallet/src/background/accounts/Account.ts b/apps/wallet/src/background/accounts/Account.ts
@@ -2,11 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { type Serializable } from '_src/shared/cryptography/keystore';
-import {
-	toSerializedSignature,
-	type Keypair,
-	type SerializedSignature,
-} from '@mysten/sui.js/cryptography';
+import { toSerializedSignature, type Keypair } from '@mysten/sui/cryptography';
 import { blake2b } from '@noble/hashes/blake2b';
 
 import { setupAutoLockAlarm } from '../auto-lock-accounts';
@@ -71,10 +67,10 @@ export abstract class Account<
 		return data as T;
 	}
 
-	protected generateSignature(data: Uint8Array, keyPair: Keypair) {
+	protected async generateSignature(data: Uint8Array, keyPair: Keypair) {
 		const digest = blake2b(data, { dkLen: 32 });
 		const pubkey = keyPair.getPublicKey();
-		const signature = keyPair.signData(digest);
+		const signature = await keyPair.sign(digest);
 		const signatureScheme = keyPair.getKeyScheme();
 		return toSerializedSignature({
 			signature,
@@ -176,7 +172,7 @@ export function isPasswordUnLockable(account: unknown): account is PasswordUnloc
 
 export interface SigningAccount {
 	readonly canSign: true;
-	signData(data: Uint8Array): Promise<SerializedSignature>;
+	signData(data: Uint8Array): Promise<string>;
 }
 
 export function isSigningAccount(account: any): account is SigningAccount {

diff --git a/apps/wallet/src/background/accounts/MnemonicAccount.ts b/apps/wallet/src/background/accounts/MnemonicAccount.ts
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { fromExportedKeypair } from '_src/shared/utils/from-exported-keypair';
-import { type Keypair } from '@mysten/sui.js/cryptography';
+import { type Keypair } from '@mysten/sui/cryptography';
 
 import { MnemonicAccountSource } from '../account-sources/MnemonicAccountSource';
 import {

diff --git a/apps/wallet/src/background/accounts/index.ts b/apps/wallet/src/background/accounts/index.ts
@@ -7,7 +7,7 @@ import {
 	type MethodPayload,
 } from '_src/shared/messaging/messages/payloads/MethodPayload';
 import { type WalletStatusChange } from '_src/shared/messaging/messages/payloads/wallet-status-change';
-import { fromB64 } from '@mysten/sui.js/utils';
+import { fromB64 } from '@mysten/sui/utils';
 import Dexie from 'dexie';
 
 import { getAccountSourceByID } from '../account-sources';