Enoki

https://docs.enoki.mystenlabs.com
Admin
Enoki is a Web3 gateway for building applications on Sui, offering non-custodial account management...
Tokens:11,689
Snippets:104
Trust Score:9.8
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Enoki TypeScript SDK

Source: https://docs.enoki.mystenlabs.com/ts-sdk

Add the `@mysten/enoki` package to your project using npm. This is the initial step to integrate Enoki into your dApp.

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

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

### Custom Login Buttons with useConnectWallet

Source: https://docs.enoki.mystenlabs.com/ts-sdk/sign-in

Create custom login buttons using useConnectWallet and useWallets hooks. This example shows how to connect with Google or Facebook using Enoki wallets.

```typescript
import { useConnectWallet, useCurrentAccount, useWallets } from '@mysten/dapp-kit';
import { isEnokiWallet, EnokiWallet, AuthProvider } from '@mysten/enoki';
import { type EnokiWallet } from '@mysten/enoki';

function YourLoginComponent() {
	const currentAccount = useCurrentAccount();
	const { connect } = useConnectWallet();

	const wallets = useWallets().filter(isEnokiWallet);
	const walletsByProvider = wallets.reduce(
		(map, wallet) => map.set(wallet.provider, wallet),
		new Map<AuthProvider, EnokiWallet>(),
	);

	const googleWallet = walletsByProvider.get('google');
	const facebookWallet = walletsByProvider.get('facebook');

	if (currentAccount) {
		return <div>Current address: {currentAccount.address}</div>;
	}

	return (
		<>
			{googleWallet ? (
				<button
					onClick={() => {
						connect({ wallet: googleWallet });
					}}
				>
					Sign in with Google
				</button>
			) : null}
			{facebookWallet ? (
				<button
					onClick={() => {
						connect({ wallet: facebookWallet });
					}}
				>
					Sign in with Facebook
				</button>
			) : null}
		</>
	);
}
```

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

### Build Transaction for Sponsorship

Source: https://docs.enoki.mystenlabs.com/ts-sdk/examples

Construct a transaction, add necessary commands, and serialize it to bytes. This example sets the owner of a kiosk and transfers the kioskOwnerCap to a recipient.

```typescript
const tx = new Transaction();
tx.moveCall({
	target: '0x2::kiosk::set_owner_custom',
	arguments: [tx.object(kioskId), tx.object(user.kioskOwnerCapId), tx.pure(recipient)],
});
tx.transferObjects([tx.object(user.kioskOwnerCapId)], recipient);

const txBytes = await tx.build({
	client: suiClient,
	onlyTransactionKind: true,
});
```

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

### Get a list of subnames for an address

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Get a list of subnames for an address.

```APIDOC
## Get a list of subnames for an address

### Description
Get a list of subnames for an address.

### Method
GET

### Endpoint
/v1/subnames

### Parameters
#### Query Parameters
- **network** (string) - Optional - The network subnames are registered on. Default: "mainnet". Values: "testnet" | "mainnet"
- **domain** (string) - Optional - The domain name the subname is on.
- **address** (string) - Optional - The address to resolve subnames for
#### Header Parameters
- **Authorization** (string) - Required - Bearer <token>

### Response
#### Success Response (200)
- **data** (object)
  - **subnames** (array)
    - **name** (string)
    - **status** (string)
    - **createdAt** (string)

### Response Example
```json
{
  "data": {
    "subnames": [
      {
        "name": "string",
        "status": "PENDING",
        "createdAt": "2025-08-06T14:30:00.000Z"
      }
    ]
  }
}
```
```

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

### Sign and Execute Transaction with Enoki SDK

Source: https://docs.enoki.mystenlabs.com/ts-sdk/transactions

This example demonstrates how to use the `useSignAndExecuteTransaction` hook from dapp-kit to sign and execute a Sui transaction. Ensure the `SuiClientProvider` wraps your app and Enoki wallets are registered via the wallet standard for this hook to function correctly with Enoki.

```typescript
import { Transaction } from '@mysten/sui/transactions';
import { useSignAndExecuteTransaction } from '@mysten/dapp-kit';

function Demo() {
	const { mutateAsync: signAndExecuteTransaction } = useSignAndExecuteTransaction();

	auto async function handleButtonClick() {
		const transaction = new Transaction();
		// Add some commands to the transaction...

		// Executes the transaction using the currently connected wallet
		const { digest } = await signAndExecuteTransaction({
			transaction,
		});
	}

	return <button onClick={handleButtonClick}>Sign and execute transaction</button>;
}
```

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

### Backend Sponsored Transaction Workflow

Source: https://docs.enoki.mystenlabs.com/ts-sdk/examples

Sponsor, execute, and sign transactions entirely from the backend without needing to transfer transaction bytes to the client. This example demonstrates building the transaction, sponsoring it, signing it with an admin key, and executing it.

```typescript
const tx = new Transaction();
tx.moveCall({
	target: '0x2::kiosk::set_owner_custom',
	arguments: [tx.object(kioskId), tx.object(kioskOwnerCapId), tx.pure(address)],
});
tx.transferObjects([tx.object(kioskOwnerCapId)], address);

const txBytes = await tx.build({
	client: suiClient,
	onlyTransactionKind: true,
});
const sponsored = await enokiClient.createSponsoredTransaction({
	network: ENOKI_CLIENT_NETWORK,
	ransactionKindBytes: toB64(txBytes),
	sender: getAddress(process.env.ADMIN_SECRET_KEY!),
	allowedMoveCallTargets: [
		'0x0000000000000000000000000000000000000000000000000000000000000002::kiosk::set_owner_custom',
	],
	allowedAddresses: [address],
});
const signer = getSigner(process.env.ADMIN_SECRET_KEY!);
const { signature } = await signer.signTransaction(fromB64(sponsored.bytes));
await enokiClient.executeSponsoredTransaction({
	digest: sponsored.digest,
	signature,
});
```

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

### Create zkLogin ZKP

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

This cURL example demonstrates how to create a zero-knowledge proof for submitting transactions. The zklogin-jwt header and request body parameters are essential.

```curl
curl -X POST "https://api.enoki.mystenlabs.com/v1/zklogin/zkp" \
  -H "zklogin-jwt: string" \
  -H "Authorization: Bearer " \
  -H "Content-Type: application/json" \
  -d '{
    "ephemeralPublicKey": "string",
    "maxEpoch": 0,
    "randomness": "string"
  }'
```

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

### Get app metadata

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Returns the public metadata (configured in the Enoki Developer Portal) of the app associated with the API key.

```APIDOC
## Get app metadata

### Description
Returns the public metadata (configured in the Enoki Developer Portal) of the app associated with the API key.

### Method
GET

### Endpoint
/v1/app

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - Bearer <token>

### Response
#### Success Response (200)
- **data** (object)
  - **allowedOrigins** (array of strings)
  - **authenticationProviders** (array of objects)
    - **providerType** (string)
    - **clientId** (string)
  - **domains** (array of objects)
    - **nftId** (string)
    - **name** (string)
    - **network** (string)

### Response Example
```json
{
  "data": {
    "allowedOrigins": [
      "https://example.com"
    ],
    "authenticationProviders": [
      {
        "providerType": "google",
        "clientId": "..."
      }
    ],
    "domains": [
      {
        "nftId": "string",
        "name": "string",
        "network": "testnet"
      }
    ]
  }
}
```
```

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

### Submit Sponsored Transaction for Execution

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

This cURL example shows how to submit a previously created sponsored transaction for execution. The digest is provided in the path, and the user's signature is in the request body.

```curl
curl -X POST "https://api.enoki.mystenlabs.com/v1/transaction-blocks/sponsor/string" \
  -H "Authorization: Bearer " \
  -H "Content-Type: application/json" \
  -d '{
    "signature": "string"
  }'
```

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

### Get Address for zkLogin User

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Retrieves the address and salt for a given zkLogin JWT. Ensure the JWT is valid.

```cURL
curl -X GET "https://api.enoki.mystenlabs.com/v1/zklogin" \
  -H "zklogin-jwt: string" \
  -H "Authorization: Bearer "
```

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

### Get Addresses for zkLogin User

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Retrieves all associated addresses for a zkLogin JWT. The JWT must be valid.

```cURL
curl -X GET "https://api.enoki.mystenlabs.com/v1/zklogin/addresses" \
  -H "zklogin-jwt: string" \
  -H "Authorization: Bearer "
```

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

### Get App Metadata

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Fetches the public metadata for the application linked to the API key. This includes allowed origins and authentication providers.

```cURL
curl -X GET "https://api.enoki.mystenlabs.com/v1/app" \
  -H "Authorization: Bearer "
```

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

### Create a subname

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Initiates the creation of a subname. The subname request is added to a processing queue and will be created asynchronously, typically within a few seconds. Note: A successful response from this API does not guarantee that the subname has been created yet. To check the status of the subname, use the `get` subname API or resolve the name directly on Sui.

```APIDOC
## Create a subname

### Description
Initiates the creation of a subname. The subname request is added to a processing queue and will be created asynchronously, typically within a few seconds. Note: A successful response from this API does not guarantee that the subname has been created yet. To check the status of the subname, use the `get` subname API or resolve the name directly on Sui.

### Method
POST

### Endpoint
/v1/subnames

### Parameters
#### Header Parameters
- **zklogin-jwt** (string) - Optional - The JWT of the user signed in with zkLogin.
- **Authorization** (string) - Required - Bearer <token>
#### Request Body
- **domain** (string) - Required - The domain name to create the subname under.
- **network** (string) - Optional - The network the domain and subname are registered on. Default: "mainnet". Values: "testnet" | "mainnet"
- **subname** (string) - Required - The subname to create.
- **targetAddress** (string) - Optional - The address the new subname will resolve to

### Response
#### Success Response (202)
- **data** (object)
  - **name** (string)
  - **status** (string)
  - **createdAt** (string)

### Response Example
```json
{
  "data": {
    "name": "string",
    "status": "PENDING",
    "createdAt": "2025-08-06T14:30:00.000Z"
  }
}
```
```

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

### Get addresses for zkLogin user

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Returns the addresses for a given JWT. If the JWT is not valid, the API will return an error code.

```APIDOC
## Get addresses for zkLogin user

### Description
Returns the addresses for a given JWT. If the JWT is not valid, the API will return an error code.

### Method
GET

### Endpoint
/v1/zklogin/addresses

### Parameters
#### Header Parameters
- **zklogin-jwt** (string) - Required - The JWT of the user signed in with zkLogin.
- **Authorization** (string) - Required - Bearer <token>

### Response
#### Success Response (200)
- **data** (object)
  - **addresses** (array)
    - **clientId** (string)
    - **salt** (string)
    - **address** (string)
    - **publicKey** (string)
    - **legacy** (boolean)

### Response Example
```json
{
  "data": {
    "addresses": [
      {
        "clientId": "string",
        "salt": "string",
        "address": "string",
        "publicKey": "string",
        "legacy": true
      }
    ]
  }
}
```
```

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

### Get address for zkLogin user

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Returns the address and salt value for the given JWT. If the JWT is not valid, the API will return an error code.

```APIDOC
## Get address for zkLogin user

### Description
Returns the address and salt value for the given JWT. If the JWT is not valid, the API will return an error code.

### Method
GET

### Endpoint
/v1/zklogin

### Parameters
#### Header Parameters
- **zklogin-jwt** (string) - Required - The JWT of the user signed in with zkLogin.
- **Authorization** (string) - Required - Bearer <token>

### Response
#### Success Response (200)
- **data** (object)
  - **salt** (string)
  - **address** (string)
  - **publicKey** (string)

### Response Example
```json
{
  "data": {
    "salt": "string",
    "address": "string",
    "publicKey": "string"
  }
}
```
```

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

### Get Subnames for an Address

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Retrieves a list of subnames registered for a specific address on a given network. Query parameters for network, domain, and address are optional.

```cURL
curl -X GET "https://api.enoki.mystenlabs.com/v1/subnames?network=testnet&domain=string&address=string" \
  -H "Authorization: Bearer "
```

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

### Delete a subname

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Initiates the deletion of a subname. The subname request is added to a processing queue and will be deleted asynchronously, typically within a few seconds. Note: A successful response from this API does not guarantee that the subname has been deleted yet. To check the status of the subname, use the `get` subname API or resolve the name directly on Sui.

```APIDOC
## Delete a subname

### Description
Initiates the deletion of a subname. The subname request is added to a processing queue and will be deleted asynchronously, typically within a few seconds. Note: A successful response from this API does not guarantee that the subname has been deleted yet. To check the status of the subname, use the `get` subname API or resolve the name directly on Sui.

### Method
DELETE

### Endpoint
/v1/subnames

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - Bearer <token>

### Request Body
(No request body details provided in the source)
```

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

### Initialize Enoki Client

Source: https://docs.enoki.mystenlabs.com/ts-sdk/examples

Create an Enoki client instance in your backend service using a private API key. Keep your secret key in an environment variable and avoid exposing it publicly.

```typescript
import { EnokiClient } from '@mysten/enoki';

export const enokiClient = new EnokiClient({
	apiKey: process.env.ENOKI_SECRET_KEY!,
});
```

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

### createZkLoginNonce

Source: https://docs.enoki.mystenlabs.com/ts-sdk/advanced/client

Creates a nonce for ZkLogin.

```APIDOC
## createZkLoginNonce

### Description
Creates a nonce for ZkLogin.

### Method
(Method not specified in source)

### Endpoint
(Endpoint not specified in source)

### Parameters
(No parameters specified in source)

### Request Example
(No request example specified in source)

### Response
#### Success Response
(Response details not specified in source)

#### Response Example
(No response example specified in source)
```

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

### Initialize Enoki Wallets with TypeScript SDK

Source: https://docs.enoki.mystenlabs.com/ts-sdk/register

Use `registerEnokiWallets` to add Enoki wallets for configured auth providers. These wallets implement standard Sui wallet features. Note that Enoki wallets are network-bound and may require re-registration for network changes.

```typescript
import { registerEnokiWallets } from '@mysten/enoki';

const suiClient = new SuiClient({ url: getFullnodeUrl('testnet') });

registerEnokiWallets({
	client: suiClient,
	network: 'testnet',
	apiKey: 'YOUR_PUBLIC_ENOKI_API_KEY',
	providers: {
		google: {
			clientId: 'YOUR_GOOGLE_CLIENT_ID',
		},
		facebook: {
			clientId: 'YOUR_FACEBOOK_CLIENT_ID',
		},
		twitch: {
			clientId: 'YOUR_TWITCH_CLIENT_ID',
		},
	});

```

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

### Sign in with ConnectButton

Source: https://docs.enoki.mystenlabs.com/ts-sdk/sign-in

Use the ConnectButton component for a standard sign-in experience with Enoki Wallets. Ensure Enoki wallets are registered via registerEnokiWallets.

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

export function YourApp() {
	return <ConnectButton />;
}
```

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

### React Integration for Enoki Wallets

Source: https://docs.enoki.mystenlabs.com/ts-sdk/register

Integrate Enoki wallets into a React application by setting up dapp-kit providers and creating a component to register Enoki wallets using `registerEnokiWallets`. This component should be rendered before the wallet provider.

```typescript
import {
	createNetworkConfig,
	SuiClientProvider,
	useSuiClientContext,
	WalletProvider,
} from '@mysten/dapp-kit';
import { isEnokiNetwork, registerEnokiWallets } from '@mysten/enoki';
import { getFullnodeUrl } from '@mysten/sui/client';
import { useEffect } from 'react';

const { networkConfig } = createNetworkConfig({
	testnet: { url: getFullnodeUrl('testnet') },
	mainnet: { url: getFullnodeUrl('mainnet') },
});

function App() {
	return (
		<SuiClientProvider networks={networkConfig} defaultNetwork="testnet">
			<RegisterEnokiWallets />
			<WalletProvider autoConnect>
				<YourApp />
			</WalletProvider>
		</SuiClientProvider>
	);
}

function RegisterEnokiWallets() {
	const { client, network } = useSuiClientContext();

	useEffect(() => {
		if (!isEnokiNetwork(network)) return;

		const { unregister } = registerEnokiWallets({
			apiKey: 'YOUR_PUBLIC_ENOKI_API_KEY',
			providers: {
				// Provide the client IDs for each of the auth providers you want to use:
				google: {
					clientId: 'YOUR_GOOGLE_CLIENT_ID',
				},
				facebook: {
					clientId: 'YOUR_FACEBOOK_CLIENT_ID',
				},
				twitch: {
					clientId: 'YOUR_TWITCH_CLIENT_ID',
				},
			},
			client,
			network,
		});

		return unregister;
	}, [client, network]);

	return null;
}

```

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

### Construct TransactionBlockKindBytes

Source: https://docs.enoki.mystenlabs.com/ts-sdk/sponsored-transactions

Use the Enoki TypeScript SDK to build transaction block kind bytes for sponsorship. This is the first step before passing the bytes to your backend service.

```typescript
const client = useSuiClient();
const txb = new Transaction();

// ... add some transactions...

const transactionBlockKindBytes = await txb.build({ client, onlyTransactionKind: true });
```

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

### Register Enoki Connect Wallets in Other dApps

Source: https://docs.enoki.mystenlabs.com/enoki-connect

Integrate Enoki Connect into your dApp to allow users to access their zkLogin accounts from a source dApp. Ensure the `publicAppSlugs` array contains the correct public app slug of the source dApp.

```typescript
// in an entry file of your dApp eg. main.ts
import { registerEnokiConnectWallets } from '@mysten/enoki-connect';

registerEnokiConnectWallets({
	publicAppSlugs: ['Replace_With_Source_Public_App_Slug'],
	dappName: 'Other DApp name',
});
```

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

### createZkLoginZkp

Source: https://docs.enoki.mystenlabs.com/ts-sdk/advanced/client

Creates a Zero-Knowledge Proof (ZKP) for ZkLogin.

```APIDOC
## createZkLoginZkp

### Description
Creates a Zero-Knowledge Proof (ZKP) for ZkLogin.

### Method
(Method not specified in source)

### Endpoint
(Endpoint not specified in source)

### Parameters
(No parameters specified in source)

### Request Example
(No request example specified in source)

### Response
#### Success Response
(Response details not specified in source)

#### Response Example
(No response example specified in source)
```

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

### getZkLogin

Source: https://docs.enoki.mystenlabs.com/ts-sdk/advanced/client

Initiates or retrieves information for a ZkLogin session.

```APIDOC
## getZkLogin

### Description
Initiates or retrieves information for a ZkLogin session.

### Method
(Method not specified in source)

### Endpoint
(Endpoint not specified in source)

### Parameters
(No parameters specified in source)

### Request Example
(No request example specified in source)

### Response
#### Success Response
(Response details not specified in source)

#### Response Example
(No response example specified in source)
```

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

### Create zkLogin ZKP

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Creates a zero-knowledge proof, which is used to submit transactions to Sui.

```APIDOC
## Create zkLogin ZKP

### Description
Creates a zero-knowledge proof, which is used to submit transactions to Sui.

### Method
POST

### Endpoint
/v1/zklogin/zkp

### Authorization
apiKey
AuthorizationBearer <token>
In: header

### Header Parameters
- **zklogin-jwt** (string) - Required - The JWT of the user signed in with zkLogin.

### Request Body
application/json
- **network** (string) - Optional - The Sui network you wish to use. Defaults to `mainnet`. Value in `"testnet" | "mainnet" | "devnet"`
- **ephemeralPublicKey** (string) - Required - The ephemeral public key created during the zkLogin process, encoded as a base64 string.
- **maxEpoch** (integer) - Required - The `maxEpoch` created during the zkLogin process. Range `0 <= value`
- **randomness** (string) - Required - The `randomness` created during the zkLogin process.

### Response Body
### application/json
#### Success Response (200)
{
  "data": {
    "proofPoints": null,
    "issBase64Details": null,
    "headerBase64": null,
    "addressSeed": "string"
  }
}
```

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

### Create Sponsored Transaction

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Use this cURL command to create a sponsored transaction. Include the zklogin-jwt header if available, otherwise provide the sender address.

```curl
curl -X POST "https://api.enoki.mystenlabs.com/v1/transaction-blocks/sponsor" \
  -H "zklogin-jwt: string" \
  -H "Authorization: Bearer " \
  -H "Content-Type: application/json" \
  -d '{
    "transactionBlockKindBytes": "string"
  }'
```

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

### Generate zkLogin Nonce

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Use this cURL command to generate a nonce for the zkLogin OAuth flow. Ensure the Authorization header is correctly set.

```curl
curl -X POST "https://api.enoki.mystenlabs.com/v1/zklogin/nonce" \
  -H "Authorization: Bearer " \
  -H "Content-Type: application/json" \
  -d '{
    "ephemeralPublicKey": "string"
  }'
```

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

### Sponsor Transaction with Enoki

Source: https://docs.enoki.mystenlabs.com/ts-sdk/examples

Call the Enoki client to sponsor a transaction. Specify the network, transaction kind bytes, sender, and optionally allowed move call targets and addresses. The response contains the transaction bytes and digest.

```typescript
const resp = await enokiClient.createSponsoredTransaction({
	network: ENOKI_CLIENT_NETWORK,
	ransactionKindBytes: toB64(txBytes),
	sender: address,
	allowedMoveCallTargets: ['0x2::kiosk::set_owner_custom'],
	allowedAddresses: [recipient],
});
```

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

### Create zkLogin nonce

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Generates a nonce used in the zkLogin OAuth flow. This API is optional; a nonce can also be constructed client-side.

```APIDOC
## Create zkLogin nonce

### Description
Generates a nonce used in the zkLogin OAuth flow. Using this API is not required, you can also construct a nonce client-side if desired.

### Method
POST

### Endpoint
/v1/zklogin/nonce

### Authorization
apiKey
AuthorizationBearer <token>
In: header

### Request Body
application/json
- **network** (string) - Optional - The Sui network you wish to use. Defaults to `mainnet`. Value in `"testnet" | "mainnet" | "devnet"`
- **ephemeralPublicKey** (string) - Required - The ephemeral public key created during the zkLogin process, encoded as a base64 string.
- **additionalEpochs** (number) - Optional - The amount of epochs that you would like to have the nonce be valid for. Default `2`. Range `0 <= value <= 30`

### Response Body
### application/json
#### Success Response (200)
{
  "data": {
    "nonce": "string",
    "randomness": "string",
    "epoch": 0,
    "maxEpoch": 0,
    "estimatedExpiration": 0
  }
}
```

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

### getAuthProviders

Source: https://docs.enoki.mystenlabs.com/ts-sdk/advanced/client

Retrieves the available authentication providers.

```APIDOC
## getAuthProviders

### Description
Retrieves the available authentication providers.

### Method
(Method not specified in source)

### Endpoint
(Endpoint not specified in source)

### Parameters
(No parameters specified in source)

### Request Example
(No request example specified in source)

### Response
#### Success Response
(Response details not specified in source)

#### Response Example
(No response example specified in source)
```

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

### Create Subname with Private API Key

Source: https://docs.enoki.mystenlabs.com/subnames

Use a private API key to create a subname, specifying the target Sui address. This is suitable for backend operations.

```javascript
const response = await fetch('https://api.enoki.mystenlabs.com/v1/subnames', {
	method: 'POST',
	headers: {
		Authorization: `Bearer ${privateApiKey}`,
		'Content-Type': 'application/json',
	},
	body: JSON.stringify({
		domain: 'yourapp.sui',
		network: 'mainnet',
		subname: 'alice',
		targetAddress: '0x1234567890abcdef...',
	}),
});
```

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

### Submits a sponsored transaction for execution

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Submits a transaction created from `/transaction-blocks/sponsor` for execution.

```APIDOC
## Submits a sponsored transaction for execution

### Description
Submits a transaction created from `/transaction-blocks/sponsor` for execution.

### Method
POST

### Endpoint
/v1/transaction-blocks/sponsor/{digest}

### Authorization
apiKey
AuthorizationBearer <token>
In: header

### Path Parameters
- **digest** (string) - Required - The digest of the previously-created sponsored transaction block to execute.

### Request Body
application/json
- **signature** (string) - Required - User signature of the transaction.

### Response Body
### application/json
#### Success Response (200)
{
  "data": {
    "digest": "string"
  }
}
```

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

### Create Subname with Public API Key

Source: https://docs.enoki.mystenlabs.com/subnames

Use a public API key and the user's zkLogin JWT to create a subname associated with their address. Each user can only have one subname per domain.

```javascript
const response = await fetch('https://api.enoki.mystenlabs.com/v1/subnames', {
	method: 'POST',
	headers: {
		Authorization: `Bearer ${publicApiKey}`,
		'zklogin-jwt': userJwt,
		'Content-Type': 'application/json',
	},
	body: JSON.stringify({
		domain: 'yourapp.sui',
		network: 'mainnet',
		subname: 'alice',
	}),
});

const data = await response.json();
// { name: 'alice@yourapp.sui', status: 'PENDING', createdAt: '2025-08-06T14:30:00.000Z' }
```

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

### Create a Subname

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Initiates the asynchronous creation of a subname. A successful response indicates the request is queued, not that the subname is immediately created. The zkLogin JWT is optional.

```cURL
curl -X POST "https://api.enoki.mystenlabs.com/v1/subnames" \
  -H "zklogin-jwt: string" \
  -H "Authorization: Bearer " \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "string",
    "subname": "string"
  }'
```

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

### Authorization Header Format

Source: https://docs.enoki.mystenlabs.com/http-api

Use this format to construct the Authorization header when calling the Enoki API from a backend service. Public keys can be used for frontend calls or publicly available code.

```http
Authorization: Bearer <YOUR_ENOKI_API_KEY>
```

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

### Query Subnames

Source: https://docs.enoki.mystenlabs.com/subnames

Retrieves a list of subnames associated with a given Sui address.

```APIDOC
## GET /v1/subnames

### Description
Retrieves subnames associated with a specific Sui address on a given network and domain.

### Method
GET

### Endpoint
`/v1/subnames`

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.

#### Query Parameters
- **network** (string) - Required - The Sui network (`mainnet` or `testnet`).
- **address** (string) - Required - The Sui address to query subnames for.
- **domain** (string) - Required - The SuiNS domain to filter by (e.g., `yourapp.sui`).

### Request Example
```
https://api.enoki.mystenlabs.com/v1/subnames?network=mainnet&address=0x1234567890abcdef...&domain=yourapp.sui
```

### Response
#### Success Response (200 OK)
- **subnames** (array) - An array of subname objects.
  - **name** (string) - The full name of the subname (e.g., `alice@yourapp.sui`).
  - **status** (string) - The status of the subname (e.g., `ACTIVE`).
  - **createdAt** (string) - The timestamp when the subname was created.

#### Response Example
```json
{
  "subnames": [
    {
      "name": "alice@yourapp.sui",
      "status": "ACTIVE",
      "createdAt": "2025-08-06T14:30:00.000Z"
    }
  ]
}
```
```

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

### Create sponsored transaction

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Creates a sponsored transaction.

```APIDOC
## Create sponsored transaction

### Description
Creates sponsored transaction

### Method
POST

### Endpoint
/v1/transaction-blocks/sponsor

### Authorization
apiKey
AuthorizationBearer <token>
In: header

### Header Parameters
- **zklogin-jwt** (string) - Optional - The JWT of the user signed in with zkLogin.

### Request Body
application/json
- **network** (string) - Optional - The Sui network you wish to use. Defaults to `mainnet`. Value in `"testnet" | "mainnet" | "devnet"`
- **transactionBlockKindBytes** (string) - Required - Bytes of the transaction with the `onlyTransactionKind` flag set to true.
- **sender** (string) - Optional - The address sending the transaction. Include this parameter if not including the `zklogin-jwt` header. This option is only supported when calling the API from a backend service using a private key.
- **allowedAddresses** (array<string>) - Optional - List of Sui addresses that can be present in the transaction. These addresses are combined with the list configured in the Enoki Developer Portal. Transactions attempting to refer to or transfer assets outside of these addresses are rejected.
- **allowedMoveCallTargets** (array<string>) - Optional - List of permitted Move targets the sponsored user's transactions can call.

### Response Body
### application/json
#### Success Response (200)
{
  "data": {
    "digest": "string",
    "bytes": "string"
  }
}
```

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

### Execute Sponsored Transaction

Source: https://docs.enoki.mystenlabs.com/ts-sdk/examples

Execute a sponsored transaction using its digest and the user's signature. This is typically called after the signature has been collected from the user.

```typescript
const resp = await enokiClient.executeSponsoredTransaction({
	digest,
	signature,
});
```

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

### Create Subname

Source: https://docs.enoki.mystenlabs.com/subnames

Creates a new identity subname for a user. This can be done using a public API key with zkLogin for user-facing applications or a private API key for backend operations.

```APIDOC
## POST /v1/subnames

### Description
Creates a new identity subname for a user on the Sui blockchain.

### Method
POST

### Endpoint
`/v1/subnames`

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.
- **zklogin-jwt** (string) - Optional (Required when using public API key) - The user's zkLogin JWT.
- **Content-Type** (string) - Required - `application/json`

#### Request Body
- **domain** (string) - Required - The SuiNS domain to create the subname under (e.g., `yourapp.sui`).
- **network** (string) - Required - The Sui network (`mainnet` or `testnet`).
- **subname** (string) - Required - The desired subname (e.g., `alice`).
- **targetAddress** (string) - Optional (Required when using private API key) - The Sui address the subname should resolve to.

### Request Example (Public API Key with zkLogin)
```json
{
  "domain": "yourapp.sui",
  "network": "mainnet",
  "subname": "alice"
}
```

### Request Example (Private API Key)
```json
{
  "domain": "yourapp.sui",
  "network": "mainnet",
  "subname": "alice",
  "targetAddress": "0x1234567890abcdef..."
}
```

### Response
#### Success Response (200 OK)
- **name** (string) - The full name of the created subname (e.g., `alice@yourapp.sui`).
- **status** (string) - The status of the subname creation (e.g., `PENDING`, `ACTIVE`).
- **createdAt** (string) - The timestamp when the subname was created.

#### Response Example
```json
{
  "name": "alice@yourapp.sui",
  "status": "PENDING",
  "createdAt": "2025-08-06T14:30:00.000Z"
}
```
```

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

### Query Subnames by Address

Source: https://docs.enoki.mystenlabs.com/subnames

Retrieve subnames associated with a specific Sui address and domain. Requires an API key for authorization.

```javascript
const response = await fetch(
	'https://api.enoki.mystenlabs.com/v1/subnames?' +
		new URLSearchParams({
			network: 'mainnet',
			address: '0x1234567890abcdef...',
			domain: 'yourapp.sui',
		}),
	{
		headers: {
			Authorization: `Bearer ${apiKey}`,
		},
	}
);

const data = await response.json();
// {
//   subnames: [
//     { name: 'alice@yourapp.sui', status: 'ACTIVE', createdAt: '2025-08-06T14:30:00.000Z' }
//   ]
// }
```

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

### Hide Enoki Wallets from ConnectButton Modal

Source: https://docs.enoki.mystenlabs.com/ts-sdk/sign-in

Filter Enoki wallets from the ConnectButton modal using the walletFilter prop. This is useful when supporting both Enoki and normal wallets with custom login buttons.

```typescript
import { ConnectButton } from '@mysten/dapp-kit';
import { isEnokiWallet } from '@mysten/enoki';

export function YourApp() {
	return <ConnectButton walletFilter={(wallet) => !isEnokiWallet(wallet)} />;
}
```

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

### Sign Sponsored Transaction (Client-Side)

Source: https://docs.enoki.mystenlabs.com/ts-sdk/examples

Collect the user's signature for a sponsored transaction on the client side. This uses the `useSignTransaction` hook from `@mysten/dapp-kit` to sign the transaction bytes obtained from the backend.

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

export default function Example() {
   const { mutateAsync: signTransaction } = useSignTransaction();

   const getSignature = async () => {
      // use bytes returned from your backend after sponsoring the transaction
      const { signature } = await signTransaction({ transaction: bytes });
      if (!signature) {
         throw new Error('Error signing transaction block');
      }
      ...
   }
}
```

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

### DELETE /v1/subnames

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Deletes a subname associated with a domain. Requires domain and subname as input. Optionally accepts network and target address.

```APIDOC
## DELETE /v1/subnames

### Description
Deletes a subname associated with a domain. Requires domain and subname as input. Optionally accepts network and target address.

### Method
DELETE

### Endpoint
/v1/subnames

### Parameters
#### Request Body
- **domain** (string) - Required - The domain name the subname is on.
- **subname** (string) - Required - The subname to delete.
- **network** (string) - Optional - The network the domain and subname are registered on. Default: "mainnet". Value in "testnet" | "mainnet".
- **targetAddress** (string) - Optional - The address the new subname will resolve to.

### Request Example
```json
{
  "domain": "string",
  "subname": "string"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains information about the deleted subname.
  - **name** (string) - The name of the subname.
  - **status** (string) - The status of the subname operation (e.g., PENDING).
  - **createdAt** (string) - The timestamp when the subname was created.

#### Response Example
```json
{
  "data": {
    "name": "string",
    "status": "PENDING",
    "createdAt": "2025-08-06T14:30:00.000Z"
  }
}
```
```

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

### Request ID Header Format

Source: https://docs.enoki.mystenlabs.com/http-api

Include this header in your requests to facilitate debugging. The value should be a globally unique identifier, typically a UUID, generated by the client.

```http
Request-Id: <UUID>
```

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

### Delete a Subname

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Initiates the asynchronous deletion of a subname. A successful response indicates the request is queued, not that the subname is immediately deleted.

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

### Subname Deletion Pending Response

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

This JSON object represents a successful response when a subname deletion request is initiated. The status will be 'PENDING' until the deletion is fully processed.

```json
{
  "data": {
    "name": "string",
    "status": "PENDING",
    "createdAt": "2025-08-06T14:30:00.000Z"
  }
}
```

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

### Delete Subname with Private API Key

Source: https://docs.enoki.mystenlabs.com/subnames

Remove a subname using a private API key. This operation is restricted to private keys for security.

```javascript
const response = await fetch('https://api.enoki.mystenlabs.com/v1/subnames', {
	method: 'DELETE',
	headers: {
		Authorization: `Bearer ${privateApiKey}`,
		'Content-Type': 'application/json',
	},
	body: JSON.stringify({
		domain: 'yourapp.sui',
		network: 'mainnet',
		subname: 'alice',
	}),
});
```

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

### Delete Subname cURL Request

Source: https://docs.enoki.mystenlabs.com/http-api/openapi

Use this cURL command to send a DELETE request to the /v1/subnames endpoint to delete a subname. Ensure you replace 'string' placeholders with actual values and provide a valid Bearer token.

```curl
curl -X DELETE "https://api.enoki.mystenlabs.com/v1/subnames" \
  -H "Authorization: Bearer " \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "string",
    "subname": "string"
  }'
```

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

### Delete Subname

Source: https://docs.enoki.mystenlabs.com/subnames

Removes an identity subname. This operation requires a private API key for security.

```APIDOC
## DELETE /v1/subnames

### Description
Removes an existing identity subname. This action can only be performed using a private API key.

### Method
DELETE

### Endpoint
`/v1/subnames`

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token for authentication (must be a private API key).
- **Content-Type** (string) - Required - `application/json`

#### Request Body
- **domain** (string) - Required - The SuiNS domain of the subname to delete (e.g., `yourapp.sui`).
- **network** (string) - Required - The Sui network (`mainnet` or `testnet`).
- **subname** (string) - Required - The subname to delete (e.g., `alice`).

### Request Example
```json
{
  "domain": "yourapp.sui",
  "network": "mainnet",
  "subname": "alice"
}
```

### Response
(No specific response body is detailed for successful deletion in the source, typically an empty 200 OK or a confirmation message would be returned.)
```
Tokens:
Raw