@haneullabs/kiosk 1.1.2 → 1.1.3

package/docs/kiosk-client/transfer-policy-transaction/using-the-manager.md

@@ -0,0 +1,115 @@
+# Using the manager
+
+> Use the TransferPolicyTransaction manager for policy rules
+
+# How to use
+
+After following the introduction steps on how to initialize a transfer policy transaction you can
+call any of the available functions to prepare your Programmable Transaction Block (PTB).
+
+## Available functions
+
+### Withdraw profits
+
+`withdraw(address: string, amount?: string | bigint)`
+
+After setting up the manager, you can withdraw profits from the specified transfer policy.
+
+`amount` is optional. Leave empty to withdraw all profits.
+
+```typescript
+// ... tp transaction is initialized and policy is set.
+// Withdraw 10 HANEUL from the policy. Leave last parameter empty to withdraw all profits.
+tpTx.withdraw('address_to_transfer_coin', 10_000_000_000n);
+```
+
+### Add/Remove rules
+
+> You can chain the actions when you're calling them, to add multiple rules.
+
+After setting up the transaction, you can add any of the supported rules to the policy.
+
+#### Royalty rule
+
+`addRoyaltyRule(percentageBps: number | string, minAmount: number | string)`
+
+You can add the royalty rule like the following example.
+
+`percentageToBasisPoints` is a helper to convert a percentage (0.00-100%) to basis points.
+
+Use `minAmount` to set a minimum amount per transaction, so that the royalty paid is
+**MAX(percentageBps, minAmount)**. Use 0 for no minimum amount.
+
+```typescript
+// ... tp transaction is initialized and policy is set.
+tpTx.addRoyaltyRule(percentageToBasisPoints(30), 1_000_000_000);
+```
+
+You can remove the rule by calling:
+
+```typescript
+tpTx.removeRoyaltyRule();
+```
+
+#### Kiosk lock rule
+
+`addLockRule()`
+
+You can add the kiosk lock rule like the following example.
+
+```typescript
+// ... tp transaction is initialized and policy is set.
+tpTx.addLockRule();
+```
+
+You can remove the rule by calling:
+
+```typescript
+tpTx.removeLockRule();
+```
+
+#### Personal kiosk rule
+
+`addPersonalKioskRule()`
+
+You can add the kiosk lock rule like the following example.
+
+```typescript
+// ... tp transaction is initialized and policy is set.
+tpTx.addPersonalKioskRule();
+```
+
+You can remove the rule by calling:
+
+```typescript
+tpTx.removePersonalKioskRule();
+```
+
+#### Floor price rule
+
+`addFloorPriceRule(minPrice: string | bigint)`
+
+You can add the floor price rule like the following example:
+
+```typescript
+// ... tp transaction is initialized and policy is set.
+tpTx.addFloorPriceRule(10_000_000_000n); // sets 10 HANEUL as the floor price.
+```
+
+You can remove the rule by calling:
+
+```typescript
+tpTx.removeFloorPriceRule();
+```
+
+#### Updating rules
+
+If you want to update a rule, call the `remove...` function, and then call `add` again with the new
+settings.
+
+Example:
+
+```typescript
+// ... tp transaction is initialized and policy is set.
+tpTx.removeRoyaltyRule().addRoyaltyRule(percentageToBasisPoints(20), 1_000_000_000);
+```

package/docs/llms-index.md

@@ -0,0 +1,10 @@
+# Kiosk
+
+> Interact with on-chain commerce applications
+
+- [Kiosk SDK](./index.md): TypeScript SDK for interacting with Haneul Kiosk on-chain commerce
+- [Kiosk Client](./kiosk-client/introduction.md): Introduction to the KioskClient for querying and
+  managing kiosks
+- [Querying](./kiosk-client/querying.md): Query kiosk contents, items, and transfer policies
+- [Advanced Examples](./advanced-examples.md): Advanced Kiosk SDK usage patterns and examples
+- [Migrating from Kiosk SDK V1](./from-v1.md): Migrate from Kiosk SDK v1 to the current version

package/package.json

@@ -2,7 +2,7 @@
   "name": "@haneullabs/kiosk",
   "author": "Haneul Labs <build@haneul-labs.com>",
   "description": "Haneul Kiosk library",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.mjs",
@@ -18,6 +18,7 @@
   "files": [
     "CHANGELOG.md",
     "dist",
+    "docs",
     "src"
   ],
   "engines": {
@@ -31,8 +32,8 @@
     "url": "https://github.com/GeunhwaJeong/ts-sdks/issues/new"
   },
   "dependencies": {
-    "@haneullabs/utils": "^0.3.1",
-    "@haneullabs/bcs": "^2.0.2"
+    "@haneullabs/utils": "^0.3.2",
+    "@haneullabs/bcs": "^2.0.3"
   },
   "devDependencies": {
     "cross-env": "^10.1.0",
@@ -42,14 +43,15 @@
     "vite": "^7.3.1",
     "vitest": "^4.0.17",
     "wait-on": "^9.0.3",
-    "@haneullabs/haneul": "^2.4.0",
-    "@haneullabs/codegen": "^0.8.2"
+    "@haneullabs/haneul": "^2.13.0",
+    "@haneullabs/codegen": "^0.8.3"
   },
   "peerDependencies": {
-    "@haneullabs/haneul": "^2.4.0"
+    "@haneullabs/haneul": "^2.13.0"
   },
   "scripts": {
     "build": "rm -rf dist && tsc --noEmit && tsdown",
+    "build:docs": "tsx ../docs/scripts/build-docs.ts",
     "codegen": "haneul-ts-codegen generate && pnpm lint:fix",
     "test": "echo 'No unit tests for kiosk SDK'",
     "pre-commit": "pnpm prettier:fix && pnpm lint && pnpm build",

package/src/contracts/kiosk/deps/haneul/kiosk.ts

@@ -31,7 +31,7 @@
  *
  * - `locked` - Similar to `placed` except that `take` is disabled and the only way
  *   to move the asset out of the Kiosk is to `list` it or `list_with_purchase_cap`
- *   therefore performing a trade (issuing a `TransferRequest`). The check on the
+ *   therefore performing a trade (ishaneulng a `TransferRequest`). The check on the
  *   `lock` function makes sure that the `TransferPolicy` exists to not lock the
  *   item in a `Kiosk` forever.
  *

package/src/query/client-utils.ts

@@ -3,8 +3,8 @@
 
 import type { HaneulClientTypes } from '@haneullabs/haneul/client';
 import { graphql } from '@haneullabs/haneul/graphql/schema';
-import { isSuiGraphQLClient } from '@haneullabs/haneul/graphql';
-import { isSuiJsonRpcClient } from '@haneullabs/haneul/jsonRpc';
+import { isHaneulGraphQLClient } from '@haneullabs/haneul/graphql';
+import { isHaneulJsonRpcClient } from '@haneullabs/haneul/jsonRpc';
 import { normalizeStructTag } from '@haneullabs/haneul/utils';
 import { chunk, fromBase64 } from '@haneullabs/utils';
 
@@ -72,7 +72,7 @@ export async function getAllObjects(
 	const chunks = chunk(ids, DEFAULT_QUERY_LIMIT);
 	const results: ObjectWithDisplay[] = [];
 
-	if (isSuiGraphQLClient(client)) {
+	if (isHaneulGraphQLClient(client)) {
 		for (const batch of chunks) {
 			const { data } = await client.query({
 				query: FetchObjectsWithDisplayQuery,
@@ -125,7 +125,7 @@ export async function getAllObjects(
 		return results;
 	}
 
-	if (isSuiJsonRpcClient(client)) {
+	if (isHaneulJsonRpcClient(client)) {
 		for (const batch of chunks) {
 			const responses = await client.multiGetObjects({
 				ids: batch,
@@ -261,7 +261,7 @@ export async function queryEvents(
 	client: KioskCompatibleClient,
 	eventType: string,
 ): Promise<{ json: unknown }[]> {
-	if (isSuiGraphQLClient(client)) {
+	if (isHaneulGraphQLClient(client)) {
 		const query = graphql(`
 			query QueryEvents($eventType: String!) {
 				events(filter: { eventType: $eventType }, first: 50) {
@@ -286,7 +286,7 @@ export async function queryEvents(
 		);
 	}
 
-	if (isSuiJsonRpcClient(client)) {
+	if (isHaneulJsonRpcClient(client)) {
 		const events = await client.queryEvents({
 			query: { MoveEventType: eventType },
 		});

package/src/types/kiosk.ts

@@ -93,10 +93,13 @@ export type KioskDisplay = {
 	error: string | null;
 };
 
-export type ObjectWithDisplay = HaneulClientTypes.Object<{
-	content: true;
-	previousTransaction: true;
-}> & {
+export type ObjectWithDisplay = Omit<
+	HaneulClientTypes.Object<{
+		content: true;
+		previousTransaction: true;
+	}>,
+	'display'
+> & {
 	display?: KioskDisplay;
 };
 

package/src/utils.ts

@@ -104,7 +104,7 @@ export function extractKioskData(
 export function attachListingsAndPrices(
 	kioskData: KioskData,
 	listings: KioskListing[],
-	listingObjects: HaneulClientTypes.Object[],
+	listingObjects: ObjectWithDisplay[],
 ) {
 	const itemListings = listings.reduce<Record<string, KioskListing>>(
 		(acc: Record<string, KioskListing>, item, idx) => {