llms.txt
@mysten/sui v2.0 and a new dApp Kit are here! Check out the migration guide
Mysten Labs SDKs

Kiosk SDK

TypeScript SDK for interacting with Sui Kiosk onchain commerce.

Kiosk SDK is a tool to interact with Sui and Mysten Kiosk. You can use it to query kiosk related data, build transactions to interact, and extend Kiosk to support custom rules.

Installation

npm i @mysten/kiosk

About

The Kiosk SDK exports a client extension that integrates with Sui clients. Add it to your client using $extend(kiosk()) to access kiosk functionality through client.kiosk.

The Kiosk SDK requires SuiJsonRpcClient or SuiGraphQLClient. It does not work with SuiGrpcClient because it uses event queries that are not available in gRPC.

On this page