Sui TypeScript SDK

https://sdk.mystenlabs.com/
Admin
The Sui TypeScript SDK is a modular library of tools for interacting with the Sui blockchain,...
Tokens:1,081,803
Snippets:7,824
Trust Score:9.8
Update:1 day ago
Show doc for...
Tokens:
Raw
### Install dependencies and start dev server

Source: https://sdk.mystenlabs.com/dapp-kit/getting-started/create-dapp

Install dependencies with pnpm install and start the development server with pnpm dev.

```bash
pnpm install
pnpm dev
```

--------------------------------

### Complete example

Source: https://sdk.mystenlabs.com/sui/migrations/sui-2.0/zksend

A full example showing how to create a client with the zkSend extension, create a link builder, add claimable Mist, create the send transaction, get the link URL, and later load an existing link to access its assets.

```typescript
import { zksend } from '@mysten/zksend';
import { SuiGrpcClient } from '@mysten/sui/grpc';

// Create client with zkSend extension
const client = new SuiGrpcClient({
	baseUrl: 'https://fullnode.testnet.sui.io:443',
	network: 'testnet',
}).$extend(zksend());

// Create a new link
const linkBuilder = client.zksend.linkBuilder({
	sender: myAddress,
});

// Add assets to the link
linkBuilder.addClaimableMist(1_000_000_000n); // 1 SUI

// Create the transaction and get the claim URL
const tx = await linkBuilder.createSendTransaction();
const linkUrl = linkBuilder.getLink();

// Later, load an existing link
const existingLink = await client.zksend.loadLinkFromUrl(linkUrl);
const assets = existingLink.assets;
```

--------------------------------

### Setup: Install dependencies and build with pnpm

Source: https://sdk.mystenlabs.com/typedoc/index.html

Run at the root or in an individual package directory. Use `pnpm turbo build` to ensure task dependencies run first. Dependency install scripts are disabled by default; use `pnpm approve-builds` to approve new ones.

```shell
pnpm install
pnpm turbo build
Copy
```

--------------------------------

### Quick start with SuiGraphQLClient

Source: https://sdk.mystenlabs.com/sui/clients

Creates a SuiGraphQLClient for mainnet. The same code as the gRPC example, differing only in the client constructor.

```typescript
import { SuiGraphQLClient } from '@mysten/sui/graphql';

const client = new SuiGraphQLClient({
	network: 'mainnet',
	url: 'https://graphql.mainnet.sui.io/graphql',
});
```

--------------------------------

### Quickstart: Define schema, serialize and deserialize with @mysten/bcs

Source: https://sdk.mystenlabs.com/bcs

Shows how to define a custom UID type using a fixed array and transform, define a Coin struct, serialize and deserialize BCS bytes, and serialize an option. The example logs the hex output of the serialized option.

```typescript
import { bcs, fromHex, toHex } from '@mysten/bcs';

// define UID as a 32-byte array, then add a transform to/from hex strings
const UID = bcs.fixedArray(32, bcs.u8()).transform({
	input: (id: string) => fromHex(id),
	output: (id) => toHex(Uint8Array.from(id)),
});

const Coin = bcs.struct('Coin', {
	id: UID,
	value: bcs.u64(),
});

// deserialization: BCS bytes into Coin
const bcsBytes = Coin.serialize({
	id: '0000000000000000000000000000000000000000000000000000000000000001',
	value: 1000000n,
}).toBytes();

const coin = Coin.parse(bcsBytes);

// serialization: Object into bytes - an Option with <T = Coin>
const hex = bcs.option(Coin).serialize(coin).toHex();

console.log(hex);
```

--------------------------------

### Install for Vanilla JavaScript and other frameworks

Source: https://sdk.mystenlabs.com/dapp-kit

Install the framework-agnostic core package and the Sui SDK using npm. This command is for vanilla JavaScript and other frameworks.

```bash
npm i @mysten/dapp-kit-core @mysten/sui
```

--------------------------------

### SuiGrpcClient Usage Example

Source: https://sdk.mystenlabs.com/sui/migrations/sui-2.0/json-rpc-migration

Example of using the SuiGrpcClient to get the latest checkpoint and its details via the ledger service.

```APIDOC
## SuiGrpcClient

### Description
Creates a gRPC client for interacting with Sui fullnode services. This example demonstrates retrieving the latest checkpoint sequence number and checkpoint details.

### Constructor
`new SuiGrpcClient({ baseUrl, network })`

### Parameters
- **baseUrl** (string) - Required - The base URL of the Sui fullnode gRPC endpoint.
- **network** (string) - Required - The network name (e.g., 'mainnet').

### Methods
#### ledgerService.getServiceInfo
- **Description**: Retrieves service information, including the latest checkpoint height.
- **Parameters**: `{}` (empty request)
- **Returns**: `{ response: { checkpointHeight: number } }`

#### ledgerService.getCheckpoint
- **Description**: Retrieves a checkpoint by its sequence number.
- **Parameters**:
  - `checkpointId` (object) - Required - Contains `oneofKind` (string) and `sequenceNumber` (number).
  - `readMask` (object) - Required - Contains `paths` (array of strings) specifying which fields to return.
- **Returns**: `{ response: { checkpoint: { sequenceNumber: number, digest: string, summary: { timestamp: string } } } }`

### Request Example
```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';

const client = new SuiGrpcClient({
	baseUrl: 'https://fullnode.mainnet.sui.io:443',
	network: 'mainnet',
});

const { response: info } = await client.ledgerService.getServiceInfo({});
const latestCheckpoint = info.checkpointHeight;

if (latestCheckpoint == null) {
	throw new Error('The server did not return a checkpoint height');
}

const { response } = await client.ledgerService.getCheckpoint({
	checkpointId: { oneofKind: 'sequenceNumber', sequenceNumber: latestCheckpoint },
	readMask: { paths: ['sequence_number', 'digest', 'summary.timestamp'] },
});

console.log(response.checkpoint?.sequenceNumber, response.checkpoint?.summary?.timestamp);
```

### Response Example
```json
{
  "checkpoint": {
    "sequenceNumber": 12345,
    "digest": "...",
    "summary": {
      "timestamp": "2023-01-01T00:00:00Z"
    }
  }
}
```
```

--------------------------------

### Quick theme setup with CSS custom properties

Source: https://sdk.mystenlabs.com/sui/migrations/sui-2.0/dapp-kit

Example of customizing dApp kit components using CSS custom properties. Set these variables in your global stylesheet to override the default theme.

```css
:root {
	--primary: #4f46e5;
	--primary-foreground: #ffffff;
	--background: #ffffff;
	--foreground: #0f172a;
	--border: #e2e8f0;
	--radius: 0.5rem;
}
```

--------------------------------

### Install dependencies and build the SDK

Source: https://sdk.mystenlabs.com/typedoc/modules/_mysten_sui.html

Commands to install dependencies and build the TypeScript SDK. Run `pnpm install` first, then either `pnpm run build` (if in the `sdk/sui` project) or `pnpm sdk build` (if in the root of the `sui` repo).

```bash
# Install all dependencies
$ pnpm install

# Run `build` for the TypeScript SDK if you're in the `sdk/sui` project
$ pnpm run build

# Run `sdk build` for the TypeScript SDK if you're in the root of `sui` repo
$ pnpm sdk build

```

--------------------------------

### Install the Web Crypto Signer package

Source: https://sdk.mystenlabs.com/sui/cryptography/signers/webcrypto

Install the @mysten/webcrypto-signer package using npm.

```bash
npm i @mysten/webcrypto-signer
```

--------------------------------

### Install @mysten/payment-kit and @mysten/sui

Source: https://sdk.mystenlabs.com/typedoc/modules/_mysten_payment-kit.html

Install the Payment Kit SDK and the Sui TypeScript SDK via npm. This is the required first step before using the SDK.

```bash
npm install --save @mysten/payment-kit @mysten/sui

```

--------------------------------

### Install new dApp Kit packages

Source: https://sdk.mystenlabs.com/sui/migrations/sui-2.0/dapp-kit

Remove the legacy @mysten/dapp-kit package and install the new @mysten/dapp-kit-react, @mysten/dapp-kit-core, and @mysten/sui packages.

```bash
npm uninstall @mysten/dapp-kit
npm i @mysten/dapp-kit-react @mysten/dapp-kit-core @mysten/sui
```

--------------------------------

### Install @mysten/enoki

Source: https://sdk.mystenlabs.com/typedoc/modules/_mysten_enoki.html

Install the @mysten/enoki package using npm.

```bash
npm install @mysten/enoki
```

--------------------------------

### Install dApp Kit packages with npm

Source: https://sdk.mystenlabs.com/dapp-kit/getting-started/next-js

Install the required packages for dApp Kit in a Next.js project. Use this command in your terminal.

```bash
npm i @mysten/dapp-kit-react @mysten/sui
```

--------------------------------

### Install dApp Kit packages with npm

Source: https://sdk.mystenlabs.com/dapp-kit/getting-started/vue

Install the required packages for dApp Kit in a Vue application using npm.

```bash
npm i @mysten/dapp-kit-core @mysten/sui @nanostores/vue
```

--------------------------------

### Install @mysten/ledger-signer and @mysten/ledgerjs-hw-app-sui

Source: https://sdk.mystenlabs.com/sui/cryptography/signers/ledger

Install the required packages for using the Ledger signer. You also need a Ledger transport for your environment, such as @ledgerhq/hw-transport-node-hid in Node.js or @ledgerhq/hw-transport-webhid in the browser.

```bash
npm i @mysten/ledger-signer @mysten/ledgerjs-hw-app-sui
```

--------------------------------

### Onchain package configuration example

Source: https://sdk.mystenlabs.com/codegen

Example of an onchain package configuration object. It uses a package ID, a custom package name, and a network to fetch the package from.

```typescript
{
  package: '0xabf837e98c26087cba0883c0a7a28326b1fa3c5e1e2c5abdb486f9e8f594c837',
  packageName: 'pyth',
  network: 'testnet',
}
```

--------------------------------

### Local package configuration example

Source: https://sdk.mystenlabs.com/codegen

Example of a local package configuration object for the packages array. It specifies a package identifier and a path to the Move package directory.

```typescript
{
  package: '@local-pkg/my-package',
  path: './move/my-package',
}
```

--------------------------------

### Complete theme example with CSS custom properties

Source: https://sdk.mystenlabs.com/dapp-kit/theming

A complete theme example matching a custom design system. It defines colors, typography, and layout variables using HSL values and a font stack.

```CSS
:root {
	/* Colors */
	--background: hsl(0 0% 100%);
	--foreground: hsl(222.2 84% 4.9%);
	--primary: hsl(221.2 83.2% 53.3%);
	--primary-foreground: hsl(210 40% 98%);
	--secondary: hsl(210 40% 96.1%);
	--secondary-foreground: hsl(222.2 47.4% 11.2%);
	--accent: hsl(210 40% 96.1%);
	--accent-foreground: hsl(222.2 47.4% 11.2%);
	--muted: hsl(210 40% 96.1%);
	--muted-foreground: hsl(215.4 16.3% 46.9%);
	--border: hsl(214.3 31.8% 91.4%);
	--popover: hsl(0 0% 100%);
	--popover-foreground: hsl(222.2 84% 4.9%);
	--ring: hsl(221.2 83.2% 53.3%);

	/* Typography */
	--font-sans:
		system-ui, -apple-system, 'Segoe UI', 'Roboto', 'Ubuntu', 'Cantarell', 'Noto Sans', sans-serif;
	--font-weight-medium: 500;
	--font-weight-semibold: 600;

	/* Layout */
	--radius: 0.5rem;
}
```

--------------------------------

### Run setup.ts

Source: https://sdk.mystenlabs.com/sui

Executes the setup script to generate a keypair and request SUI.

```bash
node setup.ts
```

--------------------------------

### getRegistryIdFromName example

Source: https://sdk.mystenlabs.com/typedoc/classes/_mysten_payment-kit.PaymentKitClient.html

Gets the registry object id from a registry name. Returns the derived registry id.

```typescript
const registryId = await client.getRegistryIdFromName("my-registry");
```

--------------------------------

### useCurrentClient usage example

Source: https://sdk.mystenlabs.com/dapp-kit/react/hooks/use-current-client

Import useCurrentClient from '@mysten/dapp-kit-react' and call it inside a component to get the current client. The example shows querying the balance for an owner address and logging it. Must be used within a DAppKitProvider descendant.

```typescript
import { useCurrentClient } from '@mysten/dapp-kit-react';

export function MyComponent() {
	const client = useCurrentClient();

	const handleQuery = async () => {
		const balance = await client.getBalance({
			owner: '0x...',
		});
		console.log(balance);
	};

	return <button onClick={handleQuery}>Check Balance</button>;
}
```

--------------------------------

### connectWallet example with state subscription

Source: https://sdk.mystenlabs.com/dapp-kit/actions/connect-wallet

Demonstrates connecting to the first available wallet and subscribing to connection state. Logs the connected account address when connected, or the connection object otherwise. Handles connection errors with try/catch.

```typescript
const wallets = dAppKit.stores.$wallets.get();

const unsubscribe = dAppKit.stores.$connection.subscribe((connection) => {
	if (connection.isConnected) {
		console.log(`Connected account address: ${connection.account.address}`);
	} else {
		console.log({ connection });
	}
});

if (wallets.length > 0) {
	try {
		const { accounts } = await dAppKit.connectWallet({
			wallet: wallets[0],
		});
		console.log('Available accounts:', accounts);
	} catch (error) {
		console.error('Connection failed:', error);
	}
}
```

--------------------------------

### Withdraw from address balance to Balance<T>

Source: https://sdk.mystenlabs.com/sui/transactions/coins-and-balances

Redeems a withdrawal to get a Balance<T> directly using balance::redeem_funds. The example withdraws 1 SUI.

```typescript
const [balance] = tx.moveCall({
	target: '0x2::balance::redeem_funds',
	typeArguments: ['0x2::sui::SUI'],
	arguments: [tx.withdrawal({ amount: 1_000_000_000 })],
});
```

--------------------------------

### Example usage of connection store

Source: https://sdk.mystenlabs.com/dapp-kit/state

Shows how to use the $connection store to check if connected and access wallet and account details.

```javascript
const connection = dAppKit.stores.$connection.get();

if (connection.isConnected && connection.wallet && connection.account) {
	console.log('Address:', connection.account.address);
	console.log('Wallet:', connection.wallet.name);
	console.log('Available accounts:', connection.wallet.accounts);
}
```

--------------------------------

### useWalletConnection usage example

Source: https://sdk.mystenlabs.com/dapp-kit/react/hooks/use-wallet-connection

Import useWalletConnection from '@mysten/dapp-kit-react' and use it to get the connection object. The example checks the connection status and renders different UI based on whether the wallet is disconnected, connecting, or connected. When connected, it displays the wallet name and account address.

```tsx
import { useWalletConnection } from '@mysten/dapp-kit-react';

export function MyComponent() {
	const connection = useWalletConnection();

	if (connection.status === 'disconnected') {
		return <div>Please connect your wallet</div>;
	}

	if (connection.status === 'connecting') {
		return <div>Connecting...</div>;
	}

	// status === 'connected'
	return (
		<div>
			<p>Connected to: {connection.wallet.name}</p>
			<p>Address: {connection.account.address}</p>
		</div>
	);
}
```

--------------------------------

### Get Owned Objects with SuiGrpcClient

Source: https://sdk.mystenlabs.com/typedoc/modules/_mysten_sui.html

Fetches objects owned by a specific address using the SuiGrpcClient. The client is configured for the testnet network. The example uses the owner address '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231'.

```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';

const client = new SuiGrpcClient({
	network: 'testnet',
	baseUrl: 'https://fullnode.testnet.sui.io:443',
});

const objects = await client.getOwnedObjects({
	owner: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
});
```

--------------------------------

### Withdraw from address balance to Coin<T>

Source: https://sdk.mystenlabs.com/sui/transactions/coins-and-balances

Creates a withdrawal input and redeems it to get a Coin<T> using coin::redeem_funds. The example withdraws 1 SUI and transfers the coin to a recipient.

```typescript
const tx = new Transaction();

const [coin] = tx.moveCall({
	target: '0x2::coin::redeem_funds',
	typeArguments: ['0x2::sui::SUI'],
	arguments: [tx.withdrawal({ amount: 1_000_000_000 })],
});

tx.transferObjects([coin], '0xRecipientAddress');
```

--------------------------------

### Create dApp with both template and name flags

Source: https://sdk.mystenlabs.com/dapp-kit/getting-started/create-dapp

Use this command to create a new dApp with the react-client-dapp template and the name my-app, skipping both prompts.

```bash
npm create @mysten/dapp -- -t react-client-dapp -n my-app
```

--------------------------------

### constructor

Source: https://sdk.mystenlabs.com/typedoc/classes/_mysten_enoki.EnokiPublicKey.html

Creates a new EnokiPublicKey instance.

```APIDOC
## EnokiPublicKey.constructor

### Description
Constructs a new EnokiPublicKey instance.

### Method
constructor

### Parameters
- **value** (unknown) - Required - The value to construct the public key from.

### Returns
- **EnokiPublicKey** - A new instance of EnokiPublicKey.

```

--------------------------------

### useWallets usage example

Source: https://sdk.mystenlabs.com/dapp-kit/react/hooks/use-wallets

Import useWallets from '@mysten/dapp-kit-react' and call it inside a component to get the list of wallets. Each wallet has a name and icon property. Must be used within a DAppKitProvider descendant.

```tsx
import { useWallets } from '@mysten/dapp-kit-react';

export function MyComponent() {
	const wallets = useWallets();

	return (
		<div>
			{wallets.map((wallet) => (
				<div key={wallet.name}>
					<img src={wallet.icon} alt={wallet.name} />
					<span>{wallet.name}</span>
				</div>
			))}
		</div>
	);
}
```

--------------------------------

### useCurrentNetwork usage example

Source: https://sdk.mystenlabs.com/dapp-kit/react/hooks/use-current-network

Import useCurrentNetwork from '@mysten/dapp-kit-react' and call it inside a component to get the current network. The hook must be used within a DAppKitProvider descendant, otherwise an error is thrown.

```tsx
import { useCurrentNetwork } from '@mysten/dapp-kit-react';

export function MyComponent() {
	const network = useCurrentNetwork();

	return (
		<div>
			<p>Current network: {network}</p>
		</div>
	);
}
```

--------------------------------

### constructor

Source: https://sdk.mystenlabs.com/typedoc/classes/_mysten_enoki.EnokiPublicKey.html

Creates a new EnokiPublicKey instance.

```APIDOC
## constructor

### Description
Creates a new EnokiPublicKey instance.

### Signature
`constructor(value: string | Uint8Array, legacyAddress?: string)`

### Parameters
- **value** (string | Uint8Array) - Required - The public key value.
- **legacyAddress** (string) - Optional - A legacy address associated with the key.
```

--------------------------------

### Create a new project with npm

Source: https://sdk.mystenlabs.com/sui

Commands to initialize a new Node.js project with type module and install the @mysten/sui package.

```bash
mkdir hello-sui
cd hello-sui
npm init -y
npm pkg set type=module
npm i @mysten/sui
```

--------------------------------

### Get Move Function Signature with getMoveFunction

Source: https://sdk.mystenlabs.com/sui/clients/querying

Returns a normalized signature for a Move function. The example retrieves the 'value' function from the 'coin' module of package 0x2 and logs visibility, isEntry, parameters, and typeParameters.

```typescript
const { function: fn } = await client.getMoveFunction({
	packageId: '0x2',
	moduleName: 'coin',
	name: 'value',
});

console.log(fn.visibility, fn.isEntry);
console.log(fn.parameters);
console.log(fn.typeParameters);
```

--------------------------------

### Get Object and Multi-Get Objects with SuiGrpcClient

Source: https://sdk.mystenlabs.com/typedoc/modules/_mysten_sui.html

Fetches object details for a single object and demonstrates batch fetching multiple objects. The example shows how to use the 'options' parameter to control which fields are returned, such as 'showContent' and 'showType'.

```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';

const client = new SuiGrpcClient({
	network: 'testnet',
	baseUrl: 'https://fullnode.testnet.sui.io:443',
});

const object = await client.getObject({
	id: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
	// fetch the object content field
	options: { showContent: true },
});

// You can also fetch multiple objects in one batch request
const objects = await client.multiGetObjects({
	ids: [
		'0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
		'0x9ad3de788483877fe348aef7f6ba3e52b9cfee5f52de0694d36b16a6b50c1429',
	],
	// only fetch the object type
	options: { showType: true },
});
```

--------------------------------

### Quick start with SuiGrpcClient

Source: https://sdk.mystenlabs.com/sui/clients

Creates a SuiGrpcClient for mainnet and fetches a balance and an object. This is the default client for reading from a full node.

```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';

const client = new SuiGrpcClient({
	network: 'mainnet',
	baseUrl: 'https://fullnode.mainnet.sui.io:443',
});

const { balance } = await client.getBalance({ owner: '0x...' });

const { object } = await client.getObject({
	objectId: '0x...',
	include: { content: true },
});
```

--------------------------------

### Using SuiGrpcClient to get checkpoint info

Source: https://sdk.mystenlabs.com/sui/migrations/sui-2.0/json-rpc-migration

This example demonstrates how to use the SuiGrpcClient to retrieve the latest checkpoint sequence number and then fetch checkpoint details. It requires a Sui fullnode URL and network. The code throws an error if the server does not return a checkpoint height.

```TypeScript
import { SuiGrpcClient } from '@mysten/sui/grpc';

const client = new SuiGrpcClient({
	baseUrl: 'https://fullnode.mainnet.sui.io:443',
	network: 'mainnet',
});

const { response: info } = await client.ledgerService.getServiceInfo({});
const latestCheckpoint = info.checkpointHeight;

if (latestCheckpoint == null) {
	throw new Error('The server did not return a checkpoint height');
}

const { response } = await client.ledgerService.getCheckpoint({
	checkpointId: { oneofKind: 'sequenceNumber', sequenceNumber: latestCheckpoint },
	readMask: { paths: ['sequence_number', 'digest', 'summary.timestamp'] },
});

console.log(response.checkpoint?.sequenceNumber, response.checkpoint?.summary?.timestamp);
```

--------------------------------

### new EnokiClient(config: EnokiClientConfig): EnokiClient

Source: https://sdk.mystenlabs.com/typedoc/classes/_mysten_enoki.EnokiClient.html

Creates a new EnokiClient instance with the provided configuration.

```APIDOC
## new EnokiClient(config: EnokiClientConfig): EnokiClient

### Description
Creates a new EnokiClient instance with the provided configuration.

### Parameters
- **config** (EnokiClientConfig) - Required - Configuration for the client.

### Returns
EnokiClient
```

--------------------------------

### Install @mysten/bcs with npm

Source: https://sdk.mystenlabs.com/bcs

Install the @mysten/bcs package using npm. This is the command shown in the npm tab of the installation section.

```bash
npm i @mysten/bcs
```

--------------------------------

### static fromProof(address: string, proof: { addressSeed: string; headerBase64: string; issBase64Details: { indexMod4: number; value: string }; proofPoints: { a: Iterable<string, any, any> & { length: number }; b: Iterable<Iterable<string, any, any> & { length: number }, any, any> & { length: number }; c: Iterable<string, any, any> & { length: number } } }): ZkLoginPublicIdentifier

Source: https://sdk.mystenlabs.com/typedoc/classes/_mysten_enoki.EnokiPublicKey.html

Creates a ZkLoginPublicIdentifier from the given address and proof data.

```APIDOC
## static fromProof(address: string, proof: { addressSeed: string; headerBase64: string; issBase64Details: { indexMod4: number; value: string }; proofPoints: { a: Iterable<string, any, any> & { length: number }; b: Iterable<Iterable<string, any, any> & { length: number }, any, any> & { length: number }; c: Iterable<string, any, any> & { length: number } } }): ZkLoginPublicIdentifier

### Description
Creates a ZkLoginPublicIdentifier from the given address and proof data.

### Method
fromProof (static)

### Parameters
- **address** (string) - Required - The address associated with the proof.
- **proof** (object) - Required - The proof data.
  - **addressSeed** (string) - Required - The address seed.
  - **headerBase64** (string) - Required - The header in base64.
  - **issBase64Details** (object) - Required - The issuer base64 details.
    - **indexMod4** (number) - Required - The index modulo 4.
    - **value** (string) - Required - The value.
  - **proofPoints** (object) - Required - The proof points.
    - **a** (Iterable<string, any, any> & { length: number }) - Required - The 'a' proof point.
    - **b** (Iterable<Iterable<string, any, any> & { length: number }, any, any> & { length: number }) - Required - The 'b' proof point.
    - **c** (Iterable<string, any, any> & { length: number }) - Required - The 'c' proof point.

### Returns
ZkLoginPublicIdentifier - The created public identifier.
```

--------------------------------

### Install @mysten/gcp-kms-signer

Source: https://sdk.mystenlabs.com/sui/cryptography/signers/gcp-kms

Install the package via npm.

```bash
npm i @mysten/gcp-kms-signer
```

--------------------------------

### Vanilla usage of mysten-dapp-kit-connect-modal

Source: https://sdk.mystenlabs.com/dapp-kit/web-components/connect-modal

Shows how to set up the modal with a custom trigger button, create a dAppKit instance with SuiGrpcClient, and open the modal programmatically.

```html
<button id="custom-trigger">Open Wallet Selector</button>
<mysten-dapp-kit-connect-modal></mysten-dapp-kit-connect-modal>

<script>
	import { createDAppKit } from '@mysten/dapp-kit-core';
	import { SuiGrpcClient } from '@mysten/sui/grpc';

	const GRPC_URLS = {
	    mainnet: 'https://fullnode.mainnet.sui.io:443',
	    testnet: 'https://fullnode.testnet.sui.io:443',
	};

	const dAppKit = createDAppKit({
	    enableBurnerWallet: import.meta.env.DEV,
	    networks: ['mainnet', 'testnet'],
	    defaultNetwork: 'testnet',
	    createClient(network) {
	        return new SuiGrpcClient({ network, baseUrl: GRPC_URLS[network] });
	    },
	});

	const modal = document.querySelector('mysten-dapp-kit-connect-modal');
	modal!.instance = dAppKit;

	const trigger = document.getElementById('custom-trigger');
	trigger?.addEventListener('click', () => {
	    modal!.show();
	});
</script>
```

--------------------------------

### Create a DAppKit instance with createDAppKit

Source: https://sdk.mystenlabs.com/dapp-kit/dapp-kit-instance

Use createDAppKit from @mysten/dapp-kit-core to create an instance that manages wallet connections and network configuration. The example configures a testnet network and uses SuiGrpcClient from @mysten/sui/grpc as the client. This instance provides wallet connection management, network switching, client access, and state stores for reactive updates.

```typescript
import { createDAppKit } from '@mysten/dapp-kit-core';
import { SuiGrpcClient } from '@mysten/sui/grpc';

const GRPC_URLS = {
	testnet: 'https://fullnode.testnet.sui.io:443',
};

export const dAppKit = createDAppKit({
	networks: ['testnet'],
	createClient: (network) => new SuiGrpcClient({ network, baseUrl: GRPC_URLS[network] }),
});
```

--------------------------------

### Create a Sui dApp with npm

Source: https://sdk.mystenlabs.com/dapp-kit/getting-started/create-dapp

Run this command in your terminal to scaffold a new Sui app project. The CLI will prompt you to choose a template and project name, then create a ready-to-run project.

```bash
npm create @mysten/dapp
```

--------------------------------

### get enokiClient(): EnokiClient

Source: https://sdk.mystenlabs.com/typedoc/classes/_mysten_enoki.EnokiFlow.html

Gets the EnokiClient instance associated with this EnokiFlow.

```APIDOC
## get enokiClient(): EnokiClient

### Description
Returns the EnokiClient instance associated with this EnokiFlow.

### Returns
- **EnokiClient** - The EnokiClient instance.
```

--------------------------------

### Install @mysten/aws-kms-signer

Source: https://sdk.mystenlabs.com/sui/cryptography/signers/aws-kms

Install the package using npm. The package requires Node.js >= 22.

```bash
npm i @mysten/aws-kms-signer
```

--------------------------------

### Setup SuiGrpcClient with Payment Kit extension

Source: https://sdk.mystenlabs.com/typedoc/modules/_mysten_payment-kit.html

Create a SuiGrpcClient instance configured for testnet and extend it with the paymentKit() extension. This client is required to use the Payment Kit SDK.

```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';
import { paymentKit } from '@mysten/payment-kit';

// Create a Sui client with a Payment Kit extension
const client = new SuiGrpcClient({
	network: 'testnet',
	baseUrl: 'https://fullnode.testnet.sui.io:443',
}).$extend(paymentKit());

```

--------------------------------

### constructor

Source: https://sdk.mystenlabs.com/typedoc/classes/_mysten_enoki.EnokiKeypair.html

Creates a new EnokiKeypair instance.

```APIDOC
## constructor

### Description
Creates a new EnokiKeypair instance.

### Method
constructor

### Signature
`new EnokiKeypair(...)`

### Parameters
No parameters are documented in the source.

### Returns
A new EnokiKeypair instance.
```

--------------------------------

### Native APIs: gRPC and GraphQL examples

Source: https://sdk.mystenlabs.com/sui/clients

Use native APIs for transport-specific features not covered by the shared API. The gRPC example calls ledgerService.getServiceInfo, and the GraphQL example uses a custom query for chainIdentifier.

```typescript
// gRPC: generated service clients, read masks, and streams
const { response } = await grpcClient.ledgerService.getServiceInfo({});

// GraphQL: type-safe custom queries
const result = await graphqlClient.query({
	query: graphql(`
		query {
			chainIdentifier
		}
	`),
});
```

--------------------------------

### bcs.u256 example

Source: https://sdk.mystenlabs.com/typedoc/variables/_mysten_bcs.bcs.html

Creates a BcsType for a 256-bit unsigned integer. The example serializes the value 1 to bytes.

```typescript
bcs.u256().serialize(1).toBytes() // Uint8Array [ 1, ..., 0 ]
```

--------------------------------

### bcs.u16 example

Source: https://sdk.mystenlabs.com/typedoc/variables/_mysten_bcs.bcs.html

Creates a BcsType for a 16-bit unsigned integer. The example serializes the value 65535 to bytes.

```typescript
bcs.u16().serialize(65535).toBytes() // Uint8Array [ 255, 255 ]
```

--------------------------------

### Usage examples

Source: https://sdk.mystenlabs.com/sui/cryptography/signers/webcrypto

Derive the public key, address, sign messages, and sign transactions using the keypair.

```javascript
const publicKey = keypair.getPublicKey();
const address = publicKey.toSuiAddress();

const message = new TextEncoder().encode('hello world');
await keypair.signPersonalMessage(message);
await keypair.signTransaction(txBytes);
```

--------------------------------

### Create a dApp Kit instance

Source: https://sdk.mystenlabs.com/dapp-kit/getting-started/vue

Create a dApp Kit instance with a testnet network and a gRPC client. This is the first step in setting up dApp Kit for Vue.

```typescript
// src/dapp-kit.ts
import { createDAppKit } from '@mysten/dapp-kit-core';
import { SuiGrpcClient } from '@mysten/sui/grpc';

const GRPC_URLS = {
	testnet: 'https://fullnode.testnet.sui.io:443',
};

export const dAppKit = createDAppKit({
	networks: ['testnet'],
	createClient: (network) => new SuiGrpcClient({ network, baseUrl: GRPC_URLS[network] }),
});
```

--------------------------------

### bcs.u128 example

Source: https://sdk.mystenlabs.com/typedoc/variables/_mysten_bcs.bcs.html

Creates a BcsType for a 128-bit unsigned integer. The example serializes the value 1 to bytes.

```typescript
bcs.u128().serialize(1).toBytes() // Uint8Array [ 1, ..., 0 ]
```

--------------------------------

### Install native gRPC dependencies

Source: https://sdk.mystenlabs.com/sui/clients/grpc

Installs the required packages for using the native gRPC transport with SuiGrpcClient in server-side applications.

```bash
npm install @protobuf-ts/grpc-transport @grpc/grpc-js
```

--------------------------------

### Create a new passkey with PasskeyKeypair.getPasskeyInstance

Source: https://sdk.mystenlabs.com/sui/cryptography/signers/passkey

Initializes a new passkey wallet for the origin using the BrowserPasskeyProvider. The rpName and rpId are required, and authenticatorSelection can be set to 'cross-platform' or 'platform'. The returned keypair should be cached because the public key is only available at creation.

```typescript
const keypair = await PasskeyKeypair.getPasskeyInstance(
	new BrowserPasskeyProvider('Sui Passkey Example', {
		rpName: 'Sui Passkey Example',
		rpId: window.location.hostname,
		authenticatorSelection: {
			authenticatorAttachment: 'cross-platform', // or "platform"
		},
	} as BrowserPasswordProviderOptions),
);
```

--------------------------------

### fromProof

Source: https://sdk.mystenlabs.com/typedoc/classes/_mysten_enoki.EnokiPublicKey.html

Creates an EnokiPublicKey from a proof.

```APIDOC
## fromProof

### Description
Creates an EnokiPublicKey from a proof.

### Signature
`static fromProof(proof: string): EnokiPublicKey`

### Parameters
- **proof** (string) - Required - The proof string.

### Returns
- **EnokiPublicKey** - A new EnokiPublicKey instance.
```

--------------------------------

### constructor

Source: https://sdk.mystenlabs.com/typedoc/classes/_mysten_enoki.EnokiClient.html

Creates a new EnokiClient instance.

```APIDOC
## constructor

### Description
Creates a new EnokiClient instance.

### Method
constructor

### Signature
`new EnokiClient(config)`

### Parameters
- **config** (object) - Required - Configuration object for the client.

### Response
Returns a new EnokiClient instance.
```

--------------------------------

### fromDerivationPath

Source: https://sdk.mystenlabs.com/typedoc/classes/_mysten_signers.ledger.LedgerSigner.html

Prepares the signer by fetching and setting the public key from a Ledger device. It is recommended to initialize a LedgerSigner instance using this function.

```APIDOC
## fromDerivationPath

### Description
Prepares the signer by fetching and setting the public key from a Ledger device. It is recommended to initialize a LedgerSigner instance using this function.

### Method
fromDerivationPath (Static)

### Signature
fromDerivationPath(derivationPath: string, ledgerClient: Sui, suiClient: ClientWithCoreApi): Promise<LedgerSigner>

### Parameters
- **derivationPath** (string) - Required - The derivation path for the Ledger key.
- **ledgerClient** (Sui) - Required - The Ledger client.
- **suiClient** (ClientWithCoreApi) - Required - The Sui client.

### Returns
Promise<LedgerSigner> - A promise that resolves once a LedgerSigner instance is prepared (public key is set).
```

--------------------------------

### Uninstall and install @mysten/sui

Source: https://sdk.mystenlabs.com/sui/migrations/sui-1.0

Commands to uninstall the old package and install the new one. Use npm, pnpm, yarn, or bun.

```bash
npm uninstall @mysten/sui.js
npm install @mysten/sui
```

--------------------------------

### fromOptions

Source: https://sdk.mystenlabs.com/typedoc/classes/_mysten_signers.gcp.GcpKmsSigner.html

Creates a GcpKmsSigner from options.

```APIDOC
## fromOptions

### Description
Creates a GcpKmsSigner from options.

### Method
fromOptions

### Parameters
- **options** (object) - Required - Options for the signer.

### Returns
- **Promise<GcpKmsSigner>** - A new GcpKmsSigner instance.
```

--------------------------------

### parsePaymentTransactionUri example

Source: https://sdk.mystenlabs.com/typedoc/functions/_mysten_payment-kit.parsePaymentTransactionUri.html

Parses a payment transaction URI string into PaymentUriParams. The example shows a URI with amount, coinType, and nonce parameters.

```typescript
const params = parsePaymentTransactionUri("sui:0x...?amount=1000000&coinType=0x...&nonce=...");
```

--------------------------------

### constructor

Source: https://sdk.mystenlabs.com/typedoc/classes/_mysten_bcs.BcsType.html

Creates a new BcsType instance.

```APIDOC
## constructor

### Description
Creates a new BcsType instance.

### Signature
`constructor(options: { name: string; validate: (value: Input) => void; write: (value: Input, serializer: BcsWriter) => void; read: (reader: BcsReader) => T; serializedSize: (value: Input) => number; })`

### Parameters
- **options** (object) - Required - Configuration for the BcsType.
  - **name** (string) - Required - The name of the type.
  - **validate** (function) - Required - Validates the input value.
  - **write** (function) - Required - Serializes the value to a BcsWriter.
  - **read** (function) - Required - Deserializes from a BcsReader.
  - **serializedSize** (function) - Required - Returns the serialized size of the value.
```

--------------------------------

### bcs.tuple example

Source: https://sdk.mystenlabs.com/typedoc/variables/_mysten_bcs.bcs.html

Creates a BcsTuple type from an array of BcsType instances. The example serializes a tuple of u8, string, and bool values to bytes.

```typescript
const tuple = bcs.tuple([bcs.u8(), bcs.string(), bcs.bool()])
tuple.serialize([1, 'a', true]).toBytes() // Uint8Array [ 1, 1, 97, 1 ]
```

--------------------------------

### fromProof

Source: https://sdk.mystenlabs.com/typedoc/classes/_mysten_enoki.EnokiPublicKey.html

Creates an EnokiPublicKey from a zkLogin proof.

```APIDOC
## EnokiPublicKey.fromProof

### Description
Creates an EnokiPublicKey instance from a zkLogin proof.

### Method
fromProof (static)

### Parameters
- **proof** (unknown) - Required - The zkLogin proof.

### Returns
- **EnokiPublicKey** - A new EnokiPublicKey instance.

```

--------------------------------

### constructor

Source: https://sdk.mystenlabs.com/typedoc/classes/_mysten_deepbook-v3.index.DeepBookClient.html

Creates a new DeepBookClient instance with the provided options.

```APIDOC
## constructor

### Description
Creates a new DeepBookClient instance.

### Method
constructor

### Signature
`new DeepBookClient(__namedParameters: DeepBookClientOptions): DeepBookClient`

### Parameters
- **__namedParameters** (DeepBookClientOptions) - Required - Options for the DeepBookClient.

### Returns
DeepBookClient
```

--------------------------------

### Install @mysten/codegen as a dev dependency

Source: https://sdk.mystenlabs.com/codegen

Install the codegen package as a dev dependency using npm. The package is currently in development and might have breaking changes.

```bash
npm install -D @mysten/codegen
```

--------------------------------

### constructor

Source: https://sdk.mystenlabs.com/typedoc/classes/_mysten_deepbook-v3.index.SuiPythClient.html

Creates a new SuiPythClient instance.

```APIDOC
## constructor

### Description
Creates a new SuiPythClient instance.

### Signature
`constructor(provider: SuiClient, pythStateId: string, wormholeStateId: string)`

### Parameters
- **provider** (SuiClient) - Required - The Sui client used to interact with the network.
- **pythStateId** (string) - Required - The state ID for the Pyth contract.
- **wormholeStateId** (string) - Required - The state ID for the Wormhole contract.
```

--------------------------------

### bcs.fixedArray example

Source: https://sdk.mystenlabs.com/typedoc/variables/_mysten_bcs.bcs.html

Creates a fixed-length array BcsType and serializes an array of numbers. The example shows serializing [1, 2, 3] with bcs.u8() and outputs a Uint8Array.

```typescript
bcs.fixedArray(3, bcs.u8()).serialize([1, 2, 3]).toBytes() // Uint8Array [ 1, 2, 3 ]
```

--------------------------------

### AWS KMS Signer fromKeyId example

Source: https://sdk.mystenlabs.com/typedoc/modules/_mysten_signers.html

Creates an AWS KMS signer by directly providing the key ID and credentials. This is an example from the API documentation for fromKeyId.

```typescript
const signer = await AwsKmsSigner.fromKeyId('your-kms-key-id', {
	region: 'us-west-2',
	accessKeyId: 'your-access-key-id',
	secretAccessKey: 'your-secret-access-key',
});
```

--------------------------------

### paymentKit

Source: https://sdk.mystenlabs.com/typedoc/modules/_mysten_payment-kit.html

Initializes the payment kit client with the provided options.

```APIDOC
## paymentKit

### Description
Initializes the payment kit client with the provided options.

### Function Signature
`paymentKit(options: PaymentKitClientOptions): PaymentKitClient`

### Parameters
- **options** (PaymentKitClientOptions) - Required - The options for the payment kit client.

### Returns
- **PaymentKitClient** - The initialized payment kit client.

```
Tokens:
Raw