@haneullabs/kiosk 0.1.0 → 1.1.3

package/README.md

@@ -3,6 +3,6 @@
 This Kiosk SDK library provides different utilities to interact/create/manage a
 [Kiosk](https://github.com/GeunhwaJeong/haneul/tree/main/kiosk).
 
-[You can read the documentation and see examples by clicking here.](https://sdk.haneullabs.com/kiosk)
+[You can read the documentation and see examples by clicking here.](https://sdk.haneul-labs.com/kiosk)
 
-[If you are migrating from `0.6.x`, you can follow these instructions](https://sdk.haneullabs.com/kiosk/from-v1)
+[If you are migrating from `0.6.x`, you can follow these instructions](https://sdk.haneul-labs.com/kiosk/from-v1)

package/dist/client/kiosk-client.d.mts

@@ -0,0 +1,126 @@
+import { BaseRulePackageIds, TransferPolicyRule } from "../constants.mjs";
+import { FetchKioskOptions, KioskData, KioskExtension, OwnedKiosks } from "../types/kiosk.mjs";
+import { TransferPolicy, TransferPolicyCap } from "../types/transfer-policy.mjs";
+import { KioskClientOptions, KioskCompatibleClient } from "../types/index.mjs";
+import { PaginationArguments } from "@haneullabs/haneul/jsonRpc";
+import { HaneulClientTypes } from "@haneullabs/haneul/client";
+
+//#region src/client/kiosk-client.d.ts
+type KioskExtensionOptions<Name extends string = 'kiosk'> = {
+  name?: Name;
+  packageIds?: BaseRulePackageIds;
+};
+/**
+ * Creates a kiosk client extension that can be used with `client.$extend()`.
+ *
+ * @example
+ * ```ts
+ * import { HaneulJsonRpcClient } from '@haneullabs/haneul/jsonRpc';
+ * import { kiosk } from '@haneullabs/kiosk';
+ *
+ * const client = new HaneulJsonRpcClient({
+ *   url: getJsonRpcFullnodeUrl('mainnet'),
+ *   network: 'mainnet',
+ * }).$extend(kiosk());
+ *
+ * const ownedKiosks = await client.kiosk.getOwnedKiosks({ address: '0x...' });
+ * ```
+ */
+declare function kiosk<const Name extends string = 'kiosk'>({
+  name,
+  packageIds
+}?: KioskExtensionOptions<Name>): {
+  name: Name;
+  register: (client: KioskCompatibleClient) => KioskClient;
+};
+/**
+ * A Client that allows you to interact with kiosk.
+ * Offers utilities to query kiosk, craft transactions to edit your own kiosk,
+ * purchase, manage transfer policies, create new kiosks etc.
+ * If you pass packageIds, all functionality will be managed using these packages.
+ */
+declare class KioskClient {
+  client: KioskCompatibleClient;
+  network: HaneulClientTypes.Network;
+  rules: TransferPolicyRule[];
+  packageIds?: BaseRulePackageIds;
+  constructor(options: KioskClientOptions);
+  /**
+   * Get an addresses's owned kiosks.
+   * @param address The address for which we want to retrieve the kiosks.
+   * @param pagination Optional pagination arguments.
+   * @returns An Object containing all the `kioskOwnerCap` objects as well as the kioskIds.
+   */
+  getOwnedKiosks({
+    address,
+    pagination
+  }: {
+    address: string;
+    pagination?: PaginationArguments<string>;
+  }): Promise<OwnedKiosks>;
+  /**
+   * Fetches the kiosk contents.
+   * @param id The ID of the kiosk to fetch.
+   * @param options Optional to control the fetch behavior.
+   * @returns
+   */
+  getKiosk({
+    id,
+    options
+  }: {
+    id: string;
+    options?: FetchKioskOptions;
+  }): Promise<KioskData>;
+  /**
+   * Fetch the extension data (if any) for a kiosk, by type
+   * @param kioskId The ID of the kiosk to lookup
+   * @param extensionType The Type of the extension (can be used from by using the type returned by `getKiosk()`)
+   */
+  getKioskExtension({
+    kioskId,
+    type
+  }: {
+    kioskId: string;
+    type: string;
+  }): Promise<KioskExtension | null>;
+  /**
+   * Query the Transfer Policy(ies) for type `T`.
+   * @param type The Type we're querying for (E.g `0xMyAddress::hero::Hero`)
+   */
+  getTransferPolicies({
+    type
+  }: {
+    type: string;
+  }): Promise<TransferPolicy[]>;
+  /**
+   * Query all the owned transfer policies for an address.
+   * Returns `TransferPolicyCap` which uncludes `policyId, policyCapId, type`.
+   * @param address The address we're searching the owned transfer policies for.
+   */
+  getOwnedTransferPolicies({
+    address
+  }: {
+    address: string;
+  }): Promise<TransferPolicyCap[] | undefined>;
+  /**
+   * Query the Transfer Policy Cap for type `T`, owned by `address`
+   * @param type The Type `T` for the object
+   * @param address The address that owns the cap.
+   */
+  getOwnedTransferPoliciesByType({
+    type,
+    address
+  }: {
+    type: string;
+    address: string;
+  }): Promise<TransferPolicyCap[]>;
+  addRuleResolver(rule: TransferPolicyRule): void;
+  /**
+   * A convenient helper to get the packageIds for our supported ruleset,
+   * based on `kioskClient` configuration.
+   */
+  getRulePackageId(rule: 'kioskLockRulePackageId' | 'royaltyRulePackageId' | 'personalKioskRulePackageId' | 'floorPriceRulePackageId'): string | undefined;
+}
+//#endregion
+export { KioskClient, KioskExtensionOptions, kiosk };
+//# sourceMappingURL=kiosk-client.d.mts.map

package/dist/client/kiosk-client.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kiosk-client.d.mts","names":[],"sources":["../../src/client/kiosk-client.ts"],"mappings":";;;;;;;;KA6BY,qBAAA;EACX,IAAA,GAAO,IAAA;EACP,UAAA,GAAa,kBAAA;AAAA;AAFd;;;;;;;;;;;AAqBA;;;;;AArBA,iBAqBgB,KAAA,qCAAA,CAAA;EACf,IAAA;EACA;AAAA,IACE,qBAAA,CAAsB,IAAA;;qBAGJ,qBAAA,KAAqB,WAAA;AAAA;;;;;;;cAgB7B,WAAA;EACZ,MAAA,EAAQ,qBAAA;EACR,OAAA,EAAS,iBAAA,CAAkB,OAAA;EAC3B,KAAA,EAAO,kBAAA;EACP,UAAA,GAAa,kBAAA;cAED,OAAA,EAAS,kBAAA;;;;;;;EAmBf,cAAA,CAAA;IACL,OAAA;IACA;EAAA;IAEA,OAAA;IACA,UAAA,GAAa,mBAAA;EAAA,IACV,OAAA,CAAQ,WAAA;EA7BH;;;;;;EA+CH,QAAA,CAAA;IAAW,EAAA;IAAI;EAAA;IAAa,EAAA;IAAY,OAAA,GAAU,iBAAA;EAAA,IAAsB,OAAA,CAAQ,SAAA;EAAjE;;;;;EASf,iBAAA,CAAA;IAAoB,OAAA;IAAS;EAAA;IAAU,OAAA;IAAiB,IAAA;EAAA,IAAc,OAAA,CAArC,cAAA;EAQP;;;;EAA1B,mBAAA,CAAA;IAAsB;EAAA;IAAU,IAAA;EAAA,IAAc,OAAA,CAApB,cAAA;EAkBoB;;;;;EAT9C,wBAAA,CAAA;IAA2B;EAAA;IAAa,OAAA;EAAA,IAAiB,OAAA,CAAvB,iBAAA;EAzE/B;;;;;EAkFH,8BAAA,CAAA;IAAiC,IAAA;IAAM;EAAA;IAAa,IAAA;IAAc,OAAA;EAAA,IAAiB,OAAA,CAArC,iBAAA;EAOpD,eAAA,CAAgB,IAAA,EAAM,kBAAA;EAjErB;;;;EA2ED,gBAAA,CACC,IAAA;AAAA"}

package/dist/client/kiosk-client.mjs

@@ -0,0 +1,124 @@
+import { FLOOR_PRICE_RULE_ADDRESS, KIOSK_LOCK_RULE_ADDRESS, PERSONAL_KIOSK_RULE_ADDRESS, ROYALTY_RULE_ADDRESS, getBaseRules, rules } from "../constants.mjs";
+import { fetchKiosk, fetchKioskExtension, getOwnedKiosks } from "../query/kiosk.mjs";
+import { queryOwnedTransferPolicies, queryTransferPolicy, queryTransferPolicyCapsByType } from "../query/transfer-policy.mjs";
+
+//#region src/client/kiosk-client.ts
+/**
+* Creates a kiosk client extension that can be used with `client.$extend()`.
+*
+* @example
+* ```ts
+* import { HaneulJsonRpcClient } from '@haneullabs/haneul/jsonRpc';
+* import { kiosk } from '@haneullabs/kiosk';
+*
+* const client = new HaneulJsonRpcClient({
+*   url: getJsonRpcFullnodeUrl('mainnet'),
+*   network: 'mainnet',
+* }).$extend(kiosk());
+*
+* const ownedKiosks = await client.kiosk.getOwnedKiosks({ address: '0x...' });
+* ```
+*/
+function kiosk({ name = "kiosk", packageIds } = {}) {
+	return {
+		name,
+		register: (client) => {
+			return new KioskClient({
+				client,
+				network: client.network,
+				packageIds
+			});
+		}
+	};
+}
+/**
+* A Client that allows you to interact with kiosk.
+* Offers utilities to query kiosk, craft transactions to edit your own kiosk,
+* purchase, manage transfer policies, create new kiosks etc.
+* If you pass packageIds, all functionality will be managed using these packages.
+*/
+var KioskClient = class {
+	constructor(options) {
+		this.client = options.client;
+		this.network = options.network;
+		this.rules = rules;
+		this.packageIds = options.packageIds;
+		if (options.packageIds) this.rules.push(...getBaseRules(options.packageIds));
+	}
+	/**
+	* Get an addresses's owned kiosks.
+	* @param address The address for which we want to retrieve the kiosks.
+	* @param pagination Optional pagination arguments.
+	* @returns An Object containing all the `kioskOwnerCap` objects as well as the kioskIds.
+	*/
+	async getOwnedKiosks({ address, pagination }) {
+		const personalPackageId = this.packageIds?.personalKioskRulePackageId || PERSONAL_KIOSK_RULE_ADDRESS[this.network];
+		return getOwnedKiosks(this.client, address, {
+			pagination,
+			personalKioskType: personalPackageId ? `${personalPackageId}::personal_kiosk::PersonalKioskCap` : ""
+		});
+	}
+	/**
+	* Fetches the kiosk contents.
+	* @param id The ID of the kiosk to fetch.
+	* @param options Optional to control the fetch behavior.
+	* @returns
+	*/
+	async getKiosk({ id, options }) {
+		return (await fetchKiosk(this.client, id, {}, options || {})).data;
+	}
+	/**
+	* Fetch the extension data (if any) for a kiosk, by type
+	* @param kioskId The ID of the kiosk to lookup
+	* @param extensionType The Type of the extension (can be used from by using the type returned by `getKiosk()`)
+	*/
+	async getKioskExtension({ kioskId, type }) {
+		return fetchKioskExtension(this.client, kioskId, type);
+	}
+	/**
+	* Query the Transfer Policy(ies) for type `T`.
+	* @param type The Type we're querying for (E.g `0xMyAddress::hero::Hero`)
+	*/
+	async getTransferPolicies({ type }) {
+		return queryTransferPolicy(this.client, type);
+	}
+	/**
+	* Query all the owned transfer policies for an address.
+	* Returns `TransferPolicyCap` which uncludes `policyId, policyCapId, type`.
+	* @param address The address we're searching the owned transfer policies for.
+	*/
+	async getOwnedTransferPolicies({ address }) {
+		return queryOwnedTransferPolicies(this.client, address);
+	}
+	/**
+	* Query the Transfer Policy Cap for type `T`, owned by `address`
+	* @param type The Type `T` for the object
+	* @param address The address that owns the cap.
+	*/
+	async getOwnedTransferPoliciesByType({ type, address }) {
+		return queryTransferPolicyCapsByType(this.client, address, type);
+	}
+	addRuleResolver(rule) {
+		if (this.rules.find((x) => x.rule === rule.rule)) throw new Error(`Rule ${rule.rule} resolver already exists.`);
+		this.rules.push(rule);
+	}
+	/**
+	* A convenient helper to get the packageIds for our supported ruleset,
+	* based on `kioskClient` configuration.
+	*/
+	getRulePackageId(rule) {
+		const rules$1 = this.packageIds || {};
+		const network = this.network;
+		if (!rules$1[rule] && network !== "mainnet" && network !== "testnet") throw new Error(`Missing packageId for rule ${rule}`);
+		switch (rule) {
+			case "kioskLockRulePackageId": return rules$1[rule] || KIOSK_LOCK_RULE_ADDRESS[network];
+			case "royaltyRulePackageId": return rules$1[rule] || ROYALTY_RULE_ADDRESS[network];
+			case "personalKioskRulePackageId": return rules$1[rule] || PERSONAL_KIOSK_RULE_ADDRESS[network];
+			case "floorPriceRulePackageId": return rules$1[rule] || FLOOR_PRICE_RULE_ADDRESS[network];
+		}
+	}
+};
+
+//#endregion
+export { KioskClient, kiosk };
+//# sourceMappingURL=kiosk-client.mjs.map

package/dist/client/kiosk-client.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"kiosk-client.mjs","names":["rules"],"sources":["../../src/client/kiosk-client.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { PaginationArguments } from '@haneullabs/haneul/jsonRpc';\nimport type { HaneulClientTypes } from '@haneullabs/haneul/client';\n\nimport {\n\tFLOOR_PRICE_RULE_ADDRESS,\n\tgetBaseRules,\n\tKIOSK_LOCK_RULE_ADDRESS,\n\tPERSONAL_KIOSK_RULE_ADDRESS,\n\tROYALTY_RULE_ADDRESS,\n\trules,\n} from '../constants.js';\nimport type { BaseRulePackageIds, TransferPolicyRule } from '../constants.js';\nimport { fetchKiosk, fetchKioskExtension, getOwnedKiosks } from '../query/kiosk.js';\nimport {\n\tqueryOwnedTransferPolicies,\n\tqueryTransferPolicy,\n\tqueryTransferPolicyCapsByType,\n} from '../query/transfer-policy.js';\nimport type {\n\tFetchKioskOptions,\n\tKioskClientOptions,\n\tKioskCompatibleClient,\n\tKioskData,\n\tOwnedKiosks,\n} from '../types/index.js';\n\nexport type KioskExtensionOptions<Name extends string = 'kiosk'> = {\n\tname?: Name;\n\tpackageIds?: BaseRulePackageIds;\n};\n\n/**\n * Creates a kiosk client extension that can be used with `client.$extend()`.\n *\n * @example\n * ```ts\n * import { HaneulJsonRpcClient } from '@haneullabs/haneul/jsonRpc';\n * import { kiosk } from '@haneullabs/kiosk';\n *\n * const client = new HaneulJsonRpcClient({\n *   url: getJsonRpcFullnodeUrl('mainnet'),\n *   network: 'mainnet',\n * }).$extend(kiosk());\n *\n * const ownedKiosks = await client.kiosk.getOwnedKiosks({ address: '0x...' });\n * ```\n */\nexport function kiosk<const Name extends string = 'kiosk'>({\n\tname = 'kiosk' as Name,\n\tpackageIds,\n}: KioskExtensionOptions<Name> = {}) {\n\treturn {\n\t\tname,\n\t\tregister: (client: KioskCompatibleClient) => {\n\t\t\treturn new KioskClient({\n\t\t\t\tclient,\n\t\t\t\tnetwork: client.network,\n\t\t\t\tpackageIds,\n\t\t\t});\n\t\t},\n\t};\n}\n\n/**\n * A Client that allows you to interact with kiosk.\n * Offers utilities to query kiosk, craft transactions to edit your own kiosk,\n * purchase, manage transfer policies, create new kiosks etc.\n * If you pass packageIds, all functionality will be managed using these packages.\n */\nexport class KioskClient {\n\tclient: KioskCompatibleClient;\n\tnetwork: HaneulClientTypes.Network;\n\trules: TransferPolicyRule[];\n\tpackageIds?: BaseRulePackageIds;\n\n\tconstructor(options: KioskClientOptions) {\n\t\tthis.client = options.client;\n\t\tthis.network = options.network;\n\t\tthis.rules = rules; // add all the default rules.\n\t\tthis.packageIds = options.packageIds;\n\n\t\t// Add the custom Package Ids too on the rule list.\n\t\t// Only adds the rules that are passed in the packageId object.\n\t\tif (options.packageIds) this.rules.push(...getBaseRules(options.packageIds));\n\t}\n\n\t/// Querying\n\n\t/**\n\t * Get an addresses's owned kiosks.\n\t * @param address The address for which we want to retrieve the kiosks.\n\t * @param pagination Optional pagination arguments.\n\t * @returns An Object containing all the `kioskOwnerCap` objects as well as the kioskIds.\n\t */\n\tasync getOwnedKiosks({\n\t\taddress,\n\t\tpagination,\n\t}: {\n\t\taddress: string;\n\t\tpagination?: PaginationArguments<string>;\n\t}): Promise<OwnedKiosks> {\n\t\tconst personalPackageId =\n\t\t\tthis.packageIds?.personalKioskRulePackageId || PERSONAL_KIOSK_RULE_ADDRESS[this.network];\n\n\t\treturn getOwnedKiosks(this.client, address, {\n\t\t\tpagination,\n\t\t\tpersonalKioskType: personalPackageId\n\t\t\t\t? `${personalPackageId}::personal_kiosk::PersonalKioskCap`\n\t\t\t\t: '',\n\t\t});\n\t}\n\n\t/**\n\t * Fetches the kiosk contents.\n\t * @param id The ID of the kiosk to fetch.\n\t * @param options Optional to control the fetch behavior.\n\t * @returns\n\t */\n\tasync getKiosk({ id, options }: { id: string; options?: FetchKioskOptions }): Promise<KioskData> {\n\t\treturn (await fetchKiosk(this.client, id, {}, options || {})).data;\n\t}\n\n\t/**\n\t * Fetch the extension data (if any) for a kiosk, by type\n\t * @param kioskId The ID of the kiosk to lookup\n\t * @param extensionType The Type of the extension (can be used from by using the type returned by `getKiosk()`)\n\t */\n\tasync getKioskExtension({ kioskId, type }: { kioskId: string; type: string }) {\n\t\treturn fetchKioskExtension(this.client, kioskId, type);\n\t}\n\n\t/**\n\t * Query the Transfer Policy(ies) for type `T`.\n\t * @param type The Type we're querying for (E.g `0xMyAddress::hero::Hero`)\n\t */\n\tasync getTransferPolicies({ type }: { type: string }) {\n\t\treturn queryTransferPolicy(this.client, type);\n\t}\n\n\t/**\n\t * Query all the owned transfer policies for an address.\n\t * Returns `TransferPolicyCap` which uncludes `policyId, policyCapId, type`.\n\t * @param address The address we're searching the owned transfer policies for.\n\t */\n\tasync getOwnedTransferPolicies({ address }: { address: string }) {\n\t\treturn queryOwnedTransferPolicies(this.client, address);\n\t}\n\n\t/**\n\t * Query the Transfer Policy Cap for type `T`, owned by `address`\n\t * @param type The Type `T` for the object\n\t * @param address The address that owns the cap.\n\t */\n\tasync getOwnedTransferPoliciesByType({ type, address }: { type: string; address: string }) {\n\t\treturn queryTransferPolicyCapsByType(this.client, address, type);\n\t}\n\n\t// Someone would just have to create a `kiosk-client.ts` file in their project, initialize a KioskClient\n\t// and call the `addRuleResolver` function. Each rule has a `resolve` function.\n\t// The resolve function is automatically called on `purchaseAndResolve` function call.\n\taddRuleResolver(rule: TransferPolicyRule) {\n\t\tif (this.rules.find((x) => x.rule === rule.rule))\n\t\t\tthrow new Error(`Rule ${rule.rule} resolver already exists.`);\n\t\tthis.rules.push(rule);\n\t}\n\n\t/**\n\t * A convenient helper to get the packageIds for our supported ruleset,\n\t * based on `kioskClient` configuration.\n\t */\n\tgetRulePackageId(\n\t\trule:\n\t\t\t| 'kioskLockRulePackageId'\n\t\t\t| 'royaltyRulePackageId'\n\t\t\t| 'personalKioskRulePackageId'\n\t\t\t| 'floorPriceRulePackageId',\n\t) {\n\t\tconst rules = this.packageIds || {};\n\t\tconst network = this.network;\n\n\t\t/// Check existence of rule based on network and throw an error if it's not found.\n\t\t/// We always have a fallback for testnet or mainnet.\n\t\tif (!rules[rule] && network !== 'mainnet' && network !== 'testnet') {\n\t\t\tthrow new Error(`Missing packageId for rule ${rule}`);\n\t\t}\n\n\t\tswitch (rule) {\n\t\t\tcase 'kioskLockRulePackageId':\n\t\t\t\treturn rules[rule] || KIOSK_LOCK_RULE_ADDRESS[network];\n\t\t\tcase 'royaltyRulePackageId':\n\t\t\t\treturn rules[rule] || ROYALTY_RULE_ADDRESS[network];\n\t\t\tcase 'personalKioskRulePackageId':\n\t\t\t\treturn rules[rule] || PERSONAL_KIOSK_RULE_ADDRESS[network];\n\t\t\tcase 'floorPriceRulePackageId':\n\t\t\t\treturn rules[rule] || FLOOR_PRICE_RULE_ADDRESS[network];\n\t\t}\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAkDA,SAAgB,MAA2C,EAC1D,OAAO,SACP,eACgC,EAAE,EAAE;AACpC,QAAO;EACN;EACA,WAAW,WAAkC;AAC5C,UAAO,IAAI,YAAY;IACtB;IACA,SAAS,OAAO;IAChB;IACA,CAAC;;EAEH;;;;;;;;AASF,IAAa,cAAb,MAAyB;CAMxB,YAAY,SAA6B;AACxC,OAAK,SAAS,QAAQ;AACtB,OAAK,UAAU,QAAQ;AACvB,OAAK,QAAQ;AACb,OAAK,aAAa,QAAQ;AAI1B,MAAI,QAAQ,WAAY,MAAK,MAAM,KAAK,GAAG,aAAa,QAAQ,WAAW,CAAC;;;;;;;;CAW7E,MAAM,eAAe,EACpB,SACA,cAIwB;EACxB,MAAM,oBACL,KAAK,YAAY,8BAA8B,4BAA4B,KAAK;AAEjF,SAAO,eAAe,KAAK,QAAQ,SAAS;GAC3C;GACA,mBAAmB,oBAChB,GAAG,kBAAkB,sCACrB;GACH,CAAC;;;;;;;;CASH,MAAM,SAAS,EAAE,IAAI,WAA4E;AAChG,UAAQ,MAAM,WAAW,KAAK,QAAQ,IAAI,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE;;;;;;;CAQ/D,MAAM,kBAAkB,EAAE,SAAS,QAA2C;AAC7E,SAAO,oBAAoB,KAAK,QAAQ,SAAS,KAAK;;;;;;CAOvD,MAAM,oBAAoB,EAAE,QAA0B;AACrD,SAAO,oBAAoB,KAAK,QAAQ,KAAK;;;;;;;CAQ9C,MAAM,yBAAyB,EAAE,WAAgC;AAChE,SAAO,2BAA2B,KAAK,QAAQ,QAAQ;;;;;;;CAQxD,MAAM,+BAA+B,EAAE,MAAM,WAA8C;AAC1F,SAAO,8BAA8B,KAAK,QAAQ,SAAS,KAAK;;CAMjE,gBAAgB,MAA0B;AACzC,MAAI,KAAK,MAAM,MAAM,MAAM,EAAE,SAAS,KAAK,KAAK,CAC/C,OAAM,IAAI,MAAM,QAAQ,KAAK,KAAK,2BAA2B;AAC9D,OAAK,MAAM,KAAK,KAAK;;;;;;CAOtB,iBACC,MAKC;EACD,MAAMA,UAAQ,KAAK,cAAc,EAAE;EACnC,MAAM,UAAU,KAAK;AAIrB,MAAI,CAACA,QAAM,SAAS,YAAY,aAAa,YAAY,UACxD,OAAM,IAAI,MAAM,8BAA8B,OAAO;AAGtD,UAAQ,MAAR;GACC,KAAK,yBACJ,QAAOA,QAAM,SAAS,wBAAwB;GAC/C,KAAK,uBACJ,QAAOA,QAAM,SAAS,qBAAqB;GAC5C,KAAK,6BACJ,QAAOA,QAAM,SAAS,4BAA4B;GACnD,KAAK,0BACJ,QAAOA,QAAM,SAAS,yBAAyB"}

package/dist/client/kiosk-transaction.d.mts

@@ -0,0 +1,235 @@
+import { ItemId, ItemReference, ItemValue, KioskOwnerCap, Price, PurchaseOptions } from "../types/kiosk.mjs";
+import { KioskClient } from "./kiosk-client.mjs";
+import { ObjectArgument } from "../types/index.mjs";
+import { Transaction, TransactionArgument, TransactionObjectArgument } from "@haneullabs/haneul/transactions";
+
+//#region src/client/kiosk-transaction.d.ts
+type KioskTransactionParams = {
+  /** The Transaction for this run */transaction: Transaction;
+  /**
+   * You can create a new KioskClient by calling `new KioskClient()`
+   */
+  kioskClient: KioskClient;
+  /**
+   * You can optionally pass in the `cap` as returned
+   * from `kioskClient.getOwnedKiosks` when initializing the client
+   * Otherwise, you can set it by calling `kioskTransaction.setCap()`
+   */
+  cap?: KioskOwnerCap;
+};
+/**
+ * A helper for building transactions that involve kiosk.
+ */
+declare class KioskTransaction {
+  #private;
+  transaction: Transaction;
+  kioskClient: KioskClient;
+  kiosk?: TransactionObjectArgument;
+  kioskCap?: TransactionObjectArgument;
+  constructor({
+    transaction,
+    kioskClient,
+    cap
+  }: KioskTransactionParams);
+  /**
+   * Creates a kiosk and saves `kiosk` and `kioskOwnerCap` in state.
+   * Helpful if we want to chain some actions before sharing + transferring the cap to the specified address.
+   * @param borrow If true, the `kioskOwnerCap` is borrowed from the `PersonalKioskCap` to be used in next transactions.
+   */
+  create(): this;
+  /**
+   * Creates a personal kiosk & shares it.
+   * The `PersonalKioskCap` is transferred to the signer.
+   * @param borrow If true, the `kioskOwnerCap` is borrowed from the `PersonalKioskCap` to be used in next transactions.
+   */
+  createPersonal(borrow?: boolean): this;
+  /**
+   * Converts a kiosk to a Personal (Soulbound) Kiosk.
+   * Requires initialization by either calling `ktxb.create()` or `ktxb.setCap()`.
+   */
+  convertToPersonal(borrow?: boolean): this;
+  /**
+   * Single function way to create a kiosk, share it and transfer the cap to the specified address.
+   */
+  createAndShare(address: string): this;
+  /**
+   * Shares the kiosk.
+   */
+  share(): this;
+  /**
+   * Should be called only after `create` is called.
+   * It shares the kiosk & transfers the cap to the specified address.
+   */
+  shareAndTransferCap(address: string): this;
+  /**
+   * A function to borrow an item from a kiosk & execute any function with it.
+   * Example: You could borrow a Fren out of a kiosk, attach an accessory (or mix), and return it.
+   */
+  borrowTx({
+    itemType,
+    itemId
+  }: ItemId, callback: (item: TransactionArgument) => void): this;
+  /**
+   * Borrows an item from the kiosk.
+   * This will fail if the item is listed for sale.
+   *
+   * Requires calling `return`.
+   */
+  borrow({
+    itemType,
+    itemId
+  }: ItemId): [TransactionArgument, TransactionArgument];
+  /**
+   * Returns the item back to the kiosk.
+   * Accepts the parameters returned from the `borrow` function.
+   */
+  return({
+    itemType,
+    item,
+    promise
+  }: ItemValue & {
+    promise: TransactionArgument;
+  }): this;
+  /**
+   * A function to withdraw from kiosk
+   * @param address Where to transfer the coin.
+   * @param amount The amount we aim to withdraw.
+   */
+  withdraw(address: string, amount?: string | bigint | number): this;
+  /**
+   * A function to place an item in the kiosk.
+   * @param itemType The type `T` of the item
+   * @param item The ID or Transaction Argument of the item
+   */
+  place({
+    itemType,
+    item
+  }: ItemReference): this;
+  /**
+   * A function to place an item in the kiosk and list it for sale in one transaction.
+   * @param itemType The type `T` of the item
+   * @param item The ID or Transaction Argument of the item
+   * @param price The price in GEUNHWA
+   */
+  placeAndList({
+    itemType,
+    item,
+    price
+  }: ItemReference & Price): this;
+  /**
+   * A function to list an item in the kiosk.
+   * @param itemType The type `T` of the item
+   * @param itemId The ID of the item
+   * @param price The price in GEUNHWA
+   */
+  list({
+    itemType,
+    itemId,
+    price
+  }: ItemId & {
+    price: string | bigint;
+  }): this;
+  /**
+   * A function to delist an item from the kiosk.
+   * @param itemType The type `T` of the item
+   * @param itemId The ID of the item
+   */
+  delist({
+    itemType,
+    itemId
+  }: ItemId): this;
+  /**
+   * A function to take an item from the kiosk. The transaction won't succeed if the item is listed or locked.
+    * @param itemType The type `T` of the item
+   * @param itemId The ID of the item
+   */
+  take({
+    itemType,
+    itemId
+  }: ItemId): TransactionObjectArgument;
+  /**
+   * Transfer a non-locked/non-listed item to an address.
+   *
+   * @param itemType The type `T` of the item
+   * @param itemId The ID of the item
+   * @param address The destination address
+   */
+  transfer({
+    itemType,
+    itemId,
+    address
+  }: ItemId & {
+    address: string;
+  }): this;
+  /**
+   * A function to take lock an item in the kiosk.
+    * @param itemType The type `T` of the item
+   * @param item The ID or Transaction Argument of the item
+   * @param itemId The ID of the item - Deprecated: Use `item` instead.
+   * @param policy The Policy ID or Transaction Argument for item T
+   */
+  lock({
+    itemType,
+    item,
+    itemId,
+    policy
+  }: ItemReference & {
+    policy: ObjectArgument;
+    itemId?: string;
+  }): this;
+  /**
+   * Purchase an item from a seller's kiosk.
+   * Returns [item, transferRequest]
+   * Can be called like: `const [item, transferRequest] = kioskTx.purchase({...})`
+   * @param itemType The type `T` of the item
+   * @param itemId The ID of the item
+   * @param price The price in GEUNHWA
+   * @param sellerKiosk The kiosk which is selling the item. Can be an id or an object argument.
+   */
+  purchase({
+    itemType,
+    itemId,
+    price,
+    sellerKiosk
+  }: ItemId & Price & {
+    sellerKiosk: ObjectArgument;
+  }): [TransactionObjectArgument, TransactionObjectArgument];
+  /**
+   * A function to purchase and resolve a transfer policy.
+   * If the transfer policy has the `lock` rule, the item is locked in the kiosk.
+   * Otherwise, the item is placed in the kiosk.
+   * @param itemType The type of the item
+   * @param itemId The id of the item
+   * @param price The price of the specified item
+   * @param sellerKiosk The kiosk which is selling the item. Can be an id or an object argument.
+   * @param extraArgs Used to pass arguments for custom rule resolvers.
+   */
+  purchaseAndResolve({
+    itemType,
+    itemId,
+    price,
+    sellerKiosk,
+    extraArgs
+  }: ItemId & Price & {
+    sellerKiosk: ObjectArgument;
+  } & PurchaseOptions): Promise<this>;
+  /**
+   * A function to setup the client using an existing `ownerCap`,
+   * as return from the `kioskClient.getOwnedKiosks` function.
+   * @param cap `KioskOwnerCap` object as returned from `getOwnedKiosks` SDK call.
+   */
+  setCap(cap: KioskOwnerCap): this | undefined;
+  /**
+   *	A function that ends up the kiosk building tx & returns the `kioskOwnerCap` back to the
+   *  `PersonalKioskCap`, in case we are operating on a personal kiosk.
+   * 	It will also share the `kiosk` if it's not shared, and finalize the transfer of the personal cap if it's pending.
+   */
+  finalize(): void;
+  setKioskCap(cap: TransactionObjectArgument): this;
+  setKiosk(kiosk: TransactionObjectArgument): this;
+  getKiosk(): TransactionObjectArgument;
+  getKioskCap(): TransactionObjectArgument;
+}
+//#endregion
+export { KioskTransaction, KioskTransactionParams };
+//# sourceMappingURL=kiosk-transaction.d.mts.map

package/dist/client/kiosk-transaction.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kiosk-transaction.d.mts","names":[],"sources":["../../src/client/kiosk-transaction.ts"],"mappings":";;;;;;KAyBY,sBAAA;qCAEX,WAAA,EAAa,WAAA;EAFF;;;EAOX,WAAA,EAAa,WAAA;EAAA;;;;;EAMb,GAAA,GAAM,aAAA;AAAA;;;;cAMM,gBAAA;EAAA;EACZ,WAAA,EAAa,WAAA;EACb,WAAA,EAAa,WAAA;EACb,KAAA,GAAQ,yBAAA;EACR,QAAA,GAAW,yBAAA;;IAYG,WAAA;IAAa,WAAA;IAAa;EAAA,GAAO,sBAAA;EAbvC;;;;;EAyBR,MAAA,CAAA;EA0FW;;;;;EAzEX,cAAA,CAAe,MAAA;EA6Fc;;;;EApF7B,iBAAA,CAAkB,MAAA;EAoGO;;;EA1EzB,cAAA,CAAe,OAAA;EA2GG;;;EAjGlB,KAAA,CAAA;EAmH+B;;;;EApG/B,mBAAA,CAAoB,OAAA;EAuHK;;;;EA1GzB,QAAA,CAAA;IAAW,QAAA;IAAU;EAAA,GAAU,MAAA,EAAQ,QAAA,GAAW,IAAA,EAAM,mBAAA;EA4IjD;;;;;;EAxHP,MAAA,CAAA;IAAS,QAAA;IAAU;EAAA,GAAU,MAAA,IAAU,mBAAA,EAAqB,mBAAA;EA0IpB;;;;EA1HxC,MAAA,CAAA;IAAS,QAAA;IAAU,IAAA;IAAM;EAAA,GAAW,SAAA;IAAc,OAAA,EAAS,mBAAA;EAAA;EAyK1D;;;;;EAzJD,QAAA,CAAS,OAAA,UAAiB,MAAA;EA6JS;;;;;EA5InC,KAAA,CAAA;IAAQ,QAAA;IAAU;EAAA,GAAQ,aAAA;EA2KzB;;;;;;EAzJD,YAAA,CAAA;IAAe,QAAA;IAAU,IAAA;IAAM;EAAA,GAAS,aAAA,GAAgB,KAAA;EA4N5C;;;;;;EAzMZ,IAAA,CAAA;IAAO,QAAA;IAAU,MAAA;IAAQ;EAAA,GAAS,MAAA;IAAW,KAAA;EAAA;EA/NhC;;;;;EAgPb,MAAA,CAAA;IAAS,QAAA;IAAU;EAAA,GAAU,MAAA;EA7OlB;;;;;EA8PX,IAAA,CAAA;IAAO,QAAA;IAAU;EAAA,GAAU,MAAA,GAAS,yBAAA;EAlPI;;;;;;;EAoQxC,QAAA,CAAA;IAAW,QAAA;IAAU,MAAA;IAAQ;EAAA,GAAW,MAAA;IAAW,OAAA;EAAA;EA3KnD;;;;;;;EA0LA,IAAA,CAAA;IACC,QAAA;IACA,IAAA;IACA,MAAA;IACA;EAAA,GACE,aAAA;IAAkB,MAAA,EAAQ,cAAA;IAAgB,MAAA;EAAA;EA9JpC;;;;;;;;;EAwLT,QAAA,CAAA;IACC,QAAA;IACA,MAAA;IACA,KAAA;IACA;EAAA,GACE,MAAA,GAAS,KAAA;IAAU,WAAA,EAAa,cAAA;EAAA,KAClC,yBAAA,EACA,yBAAA;EA/KiD;;;;;;;;;;EAwM5C,kBAAA,CAAA;IACL,QAAA;IACA,MAAA;IACA,KAAA;IACA,WAAA;IACA;EAAA,GACE,MAAA,GAAS,KAAA;IAAU,WAAA,EAAa,cAAA;EAAA,IAAmB,eAAA,GAAe,OAAA;EA3JtD;;;;;EA4Nf,MAAA,CAAO,GAAA,EAAK,aAAA;EA5N4C;;;;;EA4OxD,QAAA,CAAA;EAgDA,WAAA,CAAY,GAAA,EAAK,yBAAA;EAMjB,QAAA,CAAS,KAAA,EAAO,yBAAA;EAUhB,QAAA,CAAA,GAAQ,yBAAA;EASR,WAAA,CAAA,GAAW,yBAAA;AAAA"}