@mysten/kiosk 0.0.0-experimental-20230525143947

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# @mysten/kiosk
+
+## 0.0.0-experimental-20230525143947
+
+### Major Changes
+
+- 4ea96d909a: Kiosk SDK for managing, querying and interacting with Kiosk and TransferPolicy objects
+
+### Patch Changes
+
+- Updated dependencies [4ea96d909a]
+- Updated dependencies [470c27af50]
+- Updated dependencies [03828224c9]
+- Updated dependencies [671faefe3c]
+- Updated dependencies [9ce7e051b4]
+- Updated dependencies [9ce7e051b4]
+- Updated dependencies [bb50698551]
+  - @mysten/sui.js@0.0.0-experimental-20230525143947

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,119 @@
+# Kiosk SDK
+
+> **This package is still in active development. Use at your own risk**.
+> Currently, the only supported environment is **Sui Testnet**.
+
+
+This Kiosk SDK library provides different utilities to interact/create/manage a [Kiosk](https://github.com/MystenLabs/sui/tree/main/kiosk).
+
+## Installation
+
+To install, add `@mysten/kiosk` package to your project
+
+```
+npm i @mysten/kiosk
+```
+
+You can also use your preferred package manager, such as yarn or pnpm.
+
+## Examples
+
+Here are some indicative examples on how to use the kiosk SDK.
+
+<details>
+<summary>Getting the listings & items by the kiosk's id</summary>
+
+```typescript
+import { fetchKiosk } from '@mysten/kiosk';
+import { Connection, JsonRpcProvider } from '@mysten/sui.js';
+
+const provider = new JsonRpcProvider(
+  new Connection({ fullnode: 'https://fullnode.testnet.sui.io:443' }),
+);
+
+const getKiosk = async () => {
+  const kioskAddress = `0xSomeKioskAddress`;
+
+  const {
+    data: res,
+    nextCursor,
+    hasNextPage,
+  } = await fetchKiosk(provider, kioskAddress, { limit: 100 }); // could also add `cursor` for pagination
+
+  console.log(res); // { listings: [], items: [],  itemIds: [],  listingIds: [] }
+  console.log(nextCursor); // null
+  console.log(hasNextPage); // false
+};
+```
+
+</details>
+
+<details>
+<summary>Create a kiosk, share it and get transfer the `kioskOwnerCap` to the wallet's address</summary>
+
+```typescript
+import { createKioskAndShare } from '@mysten/kiosk';
+import { TransactionBlock } from '@mysten/sui.js';
+
+const createKiosk = async () => {
+  const accountAddress = '0xSomeSuiAddress';
+
+  const tx = new TransactionBlock();
+  const kiosk_cap = createKioskAndShare(tx);
+
+  tx.transferObjects([kiosk_cap], tx.pure(accountAddress, 'address'));
+
+  // ... continue to sign and execute the transaction
+  // ...
+};
+```
+
+</details>
+
+<details>
+<summary>Place an item and list it for sale in the kiosk</summary>
+
+```typescript
+import { placeAndList } from '@mysten/kiosk';
+import { TransactionBlock } from '@mysten/sui.js';
+
+const placeAndListToKiosk = async () => {
+  const kiosk = 'SomeKioskId';
+  const kioskCap = 'KioskCapObjectId';
+  const itemType = '0xItemAddr::some:ItemType';
+  const item = 'SomeItemId';
+  const price = '100000';
+
+  const tx = new TransactionBlock();
+
+  placeAndList(tx, itemType, kiosk, kioskCap, item, price);
+
+  // ... continue to sign and execute the transaction
+  // ...
+};
+```
+
+</details>
+
+<details>
+<summary>Withdraw profits from your kiosk</summary>
+
+```typescript
+import { withdrawFromKiosk } from '@mysten/kiosk';
+import { TransactionBlock } from '@mysten/sui.js';
+
+const withdraw = async () => {
+  const kiosk = 'SomeKioskId';
+  const kioskCap = 'KioskCapObjectId';
+  const amount = '100000';
+
+  const tx = new TransactionBlock();
+
+  withdrawFromKiosk(tx, kiosk, kioskCap, amount);
+
+  // ... continue to sign and execute the transaction
+  // ...
+};
+```
+
+</details>

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@mysten/kiosk",
+  "author": "Mysten Labs <build@mystenlabs.com>",
+  "description": "Sui Kiosk library",
+  "version": "0.0.0-experimental-20230525143947",
+  "license": "Apache-2.0",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "src",
+    "CHANGELOG.md"
+  ],
+  "engines": {
+    "node": ">=16"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "source": "./src/index.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@mysten/sui.js": "0.0.0-experimental-20230525143947"
+  },
+  "devDependencies": {
+    "eslint": "^8.38.0",
+    "prettier": "^2.8.7",
+    "tsup": "^6.7.0",
+    "typescript": "^5.0.4"
+  },
+  "prettier": {
+    "printWidth": 80,
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "all"
+  },
+  "scripts": {
+    "build": "pnpm build:types && pnpm build:tsup",
+    "build:tsup": "tsup ./src/index.ts --format esm,cjs --sourcemap",
+    "build:types": "tsc --build",
+    "test": "echo \"Error: no test specified\"",
+    "lint": "eslint --max-warnings=0 ./src/**/**",
+    "prettier:fix": "prettier --write .",
+    "pre-commit": "pnpm prettier:fix && pnpm lint && pnpm build"
+  }
+}

package/src/bcs.ts

@@ -0,0 +1,69 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import { ObjectOwner, bcs } from '@mysten/sui.js';
+
+/**
+ * The Kiosk object fields (for BCS queries).
+ */
+export type Kiosk = {
+  id: string;
+  profits: string;
+  owner: string;
+  itemCount: number;
+  allowExtensions: boolean;
+};
+
+// Register the `Kiosk` struct for faster queries.
+bcs.registerStructType('0x2::kiosk::Kiosk', {
+  id: 'address',
+  profits: 'u64',
+  owner: 'address',
+  itemCount: 'u32',
+  allowExtensions: 'bool',
+});
+
+/**
+ * PurchaseCap object fields (for BCS queries).
+ */
+export type PurchaseCap = {
+  id: string;
+  kioskId: string;
+  itemId: string;
+  minPrice: string;
+};
+
+// Register the `PurchaseCap` for faster queries.
+bcs.registerStructType('0x2::kiosk::PurchaseCap', {
+  id: 'address',
+  kioskId: 'address',
+  itemId: 'address',
+  minPrice: 'u64',
+});
+
+/** Event emitted when a TransferPolicy is created. */
+export type TransferPolicyCreated = {
+  id: string;
+};
+
+// Register the `TransferPolicyCreated` event data.
+bcs.registerStructType('0x2::transfer_policy::TransferPolicyCreated', {
+  id: 'address',
+});
+
+/** The `TransferPolicy` object */
+export type TransferPolicy = {
+  id: string;
+  type: string;
+  balance: string;
+  rules: string[];
+  owner: ObjectOwner;
+};
+
+bcs.registerStructType('0x2::transfer_policy::TransferPolicy', {
+  id: 'address',
+  balance: 'u64',
+  rules: ['vector', 'string'],
+});
+
+export { bcs };

package/src/index.ts

@@ -0,0 +1,9 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+export * from './tx/kiosk';
+export * from './tx/transfer-policy';
+export * from './query/kiosk';
+export * from './bcs';
+export * from './utils';
+export * from './query/transfer-policy';

package/src/query/kiosk.ts

@@ -0,0 +1,126 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+  JsonRpcProvider,
+  PaginationArguments,
+  SuiAddress,
+  SuiObjectDataOptions,
+  SuiObjectResponse,
+  getObjectFields,
+} from '@mysten/sui.js';
+import { extractKioskData, getKioskObject, getObjects } from '../utils';
+import { Kiosk } from '../bcs';
+
+/**
+ * A dynamic field `Listing { ID, isExclusive }` attached to the Kiosk.
+ * Holds a `u64` value - the price of the item.
+ */
+export type KioskListing = {
+  /** The ID of the Item */
+  itemId: string;
+  /**
+   * Whether or not there's a `PurchaseCap` issued. `true` means that
+   * the listing is controlled by some logic and can't be purchased directly.
+   *
+   * TODO: consider renaming the field for better indication.
+   */
+  isExclusive: boolean;
+  /** The ID of the listing */
+  listingId: string;
+  price?: string;
+};
+
+/**
+ * A dynamic field `Item { ID }` attached to the Kiosk.
+ * Holds an Item `T`. The type of the item is known upfront.
+ */
+export type KioskItem = {
+  /** The ID of the Item */
+  itemId: string;
+  /** The type of the Item */
+  itemType: string;
+};
+
+/**
+ * Aggregated data from the Kiosk.
+ */
+export type KioskData = {
+  items: KioskItem[] | SuiObjectResponse[];
+  listings: KioskListing[];
+  itemIds: string[];
+  listingIds: string[];
+  kiosk?: Kiosk;
+};
+
+export type PagedKioskData = {
+  data: KioskData;
+  nextCursor: string | null;
+  hasNextPage: boolean;
+};
+
+export type FetchKioskOptions = {
+  includeKioskFields?: boolean;
+  includeItems?: boolean;
+  itemOptions?: SuiObjectDataOptions;
+  withListingPrices?: boolean;
+  listingOptions?: SuiObjectDataOptions;
+};
+
+/**
+ *
+ */
+export async function fetchKiosk(
+  provider: JsonRpcProvider,
+  kioskId: SuiAddress,
+  pagination: PaginationArguments<string>,
+  {
+    includeKioskFields = false,
+    includeItems = false,
+    withListingPrices = false,
+    itemOptions = { showDisplay: true, showType: true },
+  }: FetchKioskOptions,
+): Promise<PagedKioskData> {
+  const { data, nextCursor, hasNextPage } = await provider.getDynamicFields({
+    parentId: kioskId,
+    ...pagination,
+  });
+
+  // extracted kiosk data.
+  const kioskData = extractKioskData(data);
+
+  // split the fetching in two queries as we are most likely passing different options for each kind.
+  // For items, we usually seek the Display.
+  // For listings we usually seek the DF value (price) / exclusivity.
+  const [kiosk, itemObjects, listingObjects] = await Promise.all([
+    includeKioskFields
+      ? getKioskObject(provider, kioskId)
+      : Promise.resolve(undefined),
+    includeItems
+      ? getObjects(provider, kioskData.itemIds, itemOptions)
+      : Promise.resolve([]),
+    withListingPrices
+      ? getObjects(provider, kioskData.listingIds, {
+          showBcs: true,
+          showContent: true,
+        })
+      : Promise.resolve([]),
+  ]);
+
+  if (includeKioskFields) kioskData.kiosk = kiosk;
+  if (includeItems) kioskData.items = itemObjects;
+  if (withListingPrices)
+    kioskData.listings.map((l, i) => {
+      const fields = getObjectFields(listingObjects[i]);
+      // l.price = bcs.de('u64', listingObjects[i].data?.bcs.bcsBytes, 'base64');
+      // TODO: Figure out a way to do this with BCS to avoid querying content.
+      l.price = fields?.value;
+      return l;
+    });
+
+  return {
+    data: kioskData,
+    nextCursor,
+    hasNextPage,
+  };
+}

package/src/query/transfer-policy.ts

@@ -0,0 +1,61 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import { JsonRpcProvider } from '@mysten/sui.js';
+import { TransferPolicy, bcs } from '../bcs';
+
+/** Name of the event emitted when a TransferPolicy for T is created. */
+export const TRANSFER_POLICY_CREATED_EVENT = `0x2::transfer_policy::TransferPolicyCreated`;
+
+/**
+ * Searches the `TransferPolicy`-s for the given type. The seach is performed via
+ * the `TransferPolicyCreated` event. The policy can either be owned or shared,
+ * and the caller needs to filter the results accordingly (ie single owner can not
+ * be accessed by anyone but the owner).
+ *
+ * @param provider
+ * @param type
+ */
+export async function queryTransferPolicy(
+  provider: JsonRpcProvider,
+  type: string,
+): Promise<TransferPolicy[]> {
+  // console.log('event type: %s', `${TRANSFER_POLICY_CREATED_EVENT}<${type}>`);
+  const { data } = await provider.queryEvents({
+    query: {
+      MoveEventType: `${TRANSFER_POLICY_CREATED_EVENT}<${type}>`,
+    },
+  });
+
+  const search = data.map((event) => event.parsedJson as { id: string });
+  const policies = await provider.multiGetObjects({
+    ids: search.map((policy) => policy.id),
+    options: { showBcs: true, showOwner: true },
+  });
+
+  return policies
+    .filter((policy) => !!policy && 'data' in policy)
+    .map(({ data: policy }) => {
+      // should never happen; policies are objects and fetched via an event.
+      // policies are filtered for null and undefined above.
+      if (!policy || !policy.bcs || !('bcsBytes' in policy.bcs)) {
+        throw new Error(
+          `Invalid policy: ${policy?.objectId}, expected object, got package`,
+        );
+      }
+
+      let parsed = bcs.de(
+        '0x2::transfer_policy::TransferPolicy',
+        policy.bcs.bcsBytes,
+        'base64',
+      );
+
+      return {
+        id: policy?.objectId,
+        type: `0x2::transfer_policy::TransferPolicy<${type}>`,
+        owner: policy?.owner!,
+        rules: parsed.rules,
+        balance: parsed.balance,
+      } as TransferPolicy;
+    });
+}

package/src/tx/kiosk.ts

@@ -0,0 +1,389 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+  SuiAddress,
+  TransactionArgument,
+  TransactionBlock,
+} from '@mysten/sui.js';
+
+import { ObjectArgument, getTypeWithoutPackageAddress, objArg } from '../utils';
+import { KioskListing } from '../query/kiosk';
+import { TransferPolicy } from '../bcs';
+import { confirmRequest, resolveRoyaltyRule } from './transfer-policy';
+
+/** The Kiosk module. */
+export const KIOSK_MODULE = '0x2::kiosk';
+
+/** The Kiosk type. */
+export const KIOSK_TYPE = `${KIOSK_MODULE}::Kiosk`;
+
+/** The Kiosk Owner Cap Type */
+export const KIOSK_OWNER_CAP = `${KIOSK_MODULE}::KioskOwnerCap`;
+
+/**
+ * Create a new shared Kiosk and returns the [kiosk, kioskOwnerCap] tuple.
+ */
+export function createKiosk(
+  tx: TransactionBlock,
+): [TransactionArgument, TransactionArgument] {
+  let [kiosk, kioskOwnerCap] = tx.moveCall({
+    target: `${KIOSK_MODULE}::new`,
+  });
+
+  return [kiosk, kioskOwnerCap];
+}
+
+/**
+ * Calls the `kiosk::new()` function and shares the kiosk.
+ * Returns the `kioskOwnerCap` object.
+ */
+export function createKioskAndShare(tx: TransactionBlock): TransactionArgument {
+  let [kiosk, kioskOwnerCap] = tx.moveCall({
+    target: `${KIOSK_MODULE}::new`,
+  });
+
+  tx.moveCall({
+    target: `0x2::transfer::public_share_object`,
+    typeArguments: [KIOSK_TYPE],
+    arguments: [kiosk],
+  });
+
+  return kioskOwnerCap;
+}
+
+/**
+ * Call the `kiosk::place<T>(Kiosk, KioskOwnerCap, Item)` function.
+ * Place an item to the Kiosk.
+ */
+export function place(
+  tx: TransactionBlock,
+  itemType: string,
+  kiosk: ObjectArgument,
+  kioskCap: ObjectArgument,
+  item: ObjectArgument,
+): void {
+  tx.moveCall({
+    target: `${KIOSK_MODULE}::place`,
+    typeArguments: [itemType],
+    arguments: [objArg(tx, kiosk), objArg(tx, kioskCap), objArg(tx, item)],
+  });
+}
+
+/**
+ * Call the `kiosk::lock<T>(Kiosk, KioskOwnerCap, TransferPolicy, Item)`
+ * function. Lock an item in the Kiosk.
+ *
+ * Unlike `place` this function requires a `TransferPolicy` to exist
+ * and be passed in. This is done to make sure the item does not get
+ * locked without an option to take it out.
+ */
+export function lock(
+  tx: TransactionBlock,
+  itemType: string,
+  kiosk: ObjectArgument,
+  kioskCap: ObjectArgument,
+  policy: ObjectArgument,
+  item: ObjectArgument,
+): void {
+  tx.moveCall({
+    target: `${KIOSK_MODULE}::lock`,
+    typeArguments: [itemType],
+    arguments: [
+      objArg(tx, kiosk),
+      objArg(tx, kioskCap),
+      objArg(tx, policy),
+      objArg(tx, item),
+    ],
+  });
+}
+
+/**
+ * Call the `kiosk::take<T>(Kiosk, KioskOwnerCap, ID)` function.
+ * Take an item from the Kiosk.
+ */
+export function take(
+  tx: TransactionBlock,
+  itemType: string,
+  kiosk: ObjectArgument,
+  kioskCap: ObjectArgument,
+  itemId: SuiAddress,
+): TransactionArgument {
+  let [item] = tx.moveCall({
+    target: `${KIOSK_MODULE}::take`,
+    typeArguments: [itemType],
+    arguments: [
+      objArg(tx, kiosk),
+      objArg(tx, kioskCap),
+      tx.pure(itemId, 'address'),
+    ],
+  });
+
+  return item;
+}
+
+/**
+ * Call the `kiosk::list<T>(Kiosk, KioskOwnerCap, ID, u64)` function.
+ * List an item for sale.
+ */
+export function list(
+  tx: TransactionBlock,
+  itemType: string,
+  kiosk: ObjectArgument,
+  kioskCap: ObjectArgument,
+  itemId: SuiAddress,
+  price: string | bigint,
+): void {
+  tx.moveCall({
+    target: `${KIOSK_MODULE}::list`,
+    typeArguments: [itemType],
+    arguments: [
+      objArg(tx, kiosk),
+      objArg(tx, kioskCap),
+      tx.pure(itemId, 'address'),
+      tx.pure(price, 'u64'),
+    ],
+  });
+}
+
+/**
+ * Call the `kiosk::list<T>(Kiosk, KioskOwnerCap, ID, u64)` function.
+ * List an item for sale.
+ */
+export function delist(
+  tx: TransactionBlock,
+  itemType: string,
+  kiosk: ObjectArgument,
+  kioskCap: ObjectArgument,
+  itemId: SuiAddress,
+): void {
+  tx.moveCall({
+    target: `${KIOSK_MODULE}::delist`,
+    typeArguments: [itemType],
+    arguments: [
+      objArg(tx, kiosk),
+      objArg(tx, kioskCap),
+      tx.pure(itemId, 'address'),
+    ],
+  });
+}
+
+/**
+ * Call the `kiosk::place_and_list<T>(Kiosk, KioskOwnerCap, Item, u64)` function.
+ * Place an item to the Kiosk and list it for sale.
+ */
+export function placeAndList(
+  tx: TransactionBlock,
+  itemType: string,
+  kiosk: ObjectArgument,
+  kioskCap: ObjectArgument,
+  item: ObjectArgument,
+  price: string | bigint,
+): void {
+  tx.moveCall({
+    target: `${KIOSK_MODULE}::place_and_list`,
+    typeArguments: [itemType],
+    arguments: [
+      objArg(tx, kiosk),
+      objArg(tx, kioskCap),
+      objArg(tx, item),
+      tx.pure(price, 'u64'),
+    ],
+  });
+}
+
+/**
+ * Call the `kiosk::purchase<T>(Kiosk, ID, Coin<SUI>)` function and receive an Item and
+ * a TransferRequest which needs to be dealt with (via a matching TransferPolicy).
+ */
+export function purchase(
+  tx: TransactionBlock,
+  itemType: string,
+  kiosk: ObjectArgument,
+  itemId: SuiAddress,
+  payment: ObjectArgument,
+): [TransactionArgument, TransactionArgument] {
+  let [item, transferRequest] = tx.moveCall({
+    target: `${KIOSK_MODULE}::purchase`,
+    typeArguments: [itemType],
+    arguments: [
+      objArg(tx, kiosk),
+      tx.pure(itemId, 'address'),
+      objArg(tx, payment),
+    ],
+  });
+
+  return [item, transferRequest];
+}
+
+/**
+ * Call the `kiosk::withdraw(Kiosk, KioskOwnerCap, Option<u64>)` function and receive a Coin<SUI>.
+ * If the amount is null, then the entire balance will be withdrawn.
+ */
+export function withdrawFromKiosk(
+  tx: TransactionBlock,
+  kiosk: ObjectArgument,
+  kioskCap: ObjectArgument,
+  amount: string | bigint | null,
+): TransactionArgument {
+  let amountArg =
+    amount !== null
+      ? tx.pure(amount, 'Option<u64>')
+      : tx.pure({ None: true }, 'Option<u64>');
+
+  let [coin] = tx.moveCall({
+    target: `${KIOSK_MODULE}::withdraw`,
+    arguments: [objArg(tx, kiosk), objArg(tx, kioskCap), amountArg],
+  });
+
+  return coin;
+}
+
+/**
+ * Call the `kiosk::borrow<T>(Kiosk, KioskOwnerCap, ID): &T` function.
+ * Immutably borrow an item from the Kiosk.
+ */
+export function borrow(
+  tx: TransactionBlock,
+  itemType: string,
+  kiosk: ObjectArgument,
+  kioskCap: ObjectArgument,
+  itemId: SuiAddress,
+): TransactionArgument {
+  let [item] = tx.moveCall({
+    target: `${KIOSK_MODULE}::borrow`,
+    typeArguments: [itemType],
+    arguments: [
+      objArg(tx, kiosk),
+      objArg(tx, kioskCap),
+      tx.pure(itemId, 'address'),
+    ],
+  });
+
+  return item;
+}
+
+/**
+ * Call the `kiosk::borrow_mut<T>(Kiosk, KioskOwnerCap, ID): &mut T` function.
+ * Mutably borrow an item from the Kiosk.
+ */
+export function borrowMut(
+  tx: TransactionBlock,
+  itemType: string,
+  kiosk: ObjectArgument,
+  kioskCap: ObjectArgument,
+  itemId: SuiAddress,
+): TransactionArgument {
+  let [item] = tx.moveCall({
+    target: `${KIOSK_MODULE}::borrow_mut`,
+    typeArguments: [itemType],
+    arguments: [
+      objArg(tx, kiosk),
+      objArg(tx, kioskCap),
+      tx.pure(itemId, 'address'),
+    ],
+  });
+
+  return item;
+}
+
+/**
+ * Call the `kiosk::borrow_value<T>(Kiosk, KioskOwnerCap, ID): T` function.
+ * Immutably borrow an item from the Kiosk and return it in the end.
+ *
+ * Requires calling `returnValue` to return the item.
+ */
+export function borrowValue(
+  tx: TransactionBlock,
+  itemType: string,
+  kiosk: ObjectArgument,
+  kioskCap: ObjectArgument,
+  itemId: SuiAddress,
+): [TransactionArgument, TransactionArgument] {
+  let [item, promise] = tx.moveCall({
+    target: `${KIOSK_MODULE}::borrow_val`,
+    typeArguments: [itemType],
+    arguments: [
+      objArg(tx, kiosk),
+      objArg(tx, kioskCap),
+      tx.pure(itemId, 'address'),
+    ],
+  });
+
+  return [item, promise];
+}
+
+/**
+ * Call the `kiosk::return_value<T>(Kiosk, Item, Borrow)` function.
+ * Return an item to the Kiosk after it was `borrowValue`-d.
+ */
+export function returnValue(
+  tx: TransactionBlock,
+  itemType: string,
+  kiosk: ObjectArgument,
+  item: TransactionArgument,
+  promise: TransactionArgument,
+): void {
+  tx.moveCall({
+    target: `${KIOSK_MODULE}::return_val`,
+    typeArguments: [itemType],
+    arguments: [objArg(tx, kiosk), item, promise],
+  });
+}
+
+/**
+ * Completes the full purchase flow that includes:
+ * 1. Purchasing the item.
+ * 2. Resolving all the transfer policies (if any).
+ * 3. Returns the PurchasedItem OR places the item in the user's kiosk (if there's a kiosk lock policy).
+ */
+export function purchaseAndResolvePolicies(
+  tx: TransactionBlock,
+  itemType: string,
+  listing: KioskListing,
+  kioskId: string,
+  itemId: string,
+  policy: TransferPolicy,
+): TransactionArgument | null {
+  // if we don't pass the listing or the listing doens't have a price, return.
+  if (!listing || listing?.price === undefined) return null;
+
+  // Split the coin for the amount of the listing.
+  const coin = tx.splitCoins(tx.gas, [tx.pure(listing.price)]);
+
+  // initialize the purchase `kiosk::purchase`
+  const [purchasedItem, transferRequest] = purchase(
+    tx,
+    itemType,
+    kioskId,
+    itemId,
+    coin,
+  );
+
+  // Start resolving rules.
+  // For now, we only support royalty rule.
+  // Will need some tweaking to make it function properly with the other
+  // ruleset.
+  for (let rule of policy.rules) {
+    const ruleWithoutAddr = getTypeWithoutPackageAddress(rule);
+
+    switch (ruleWithoutAddr) {
+      case 'royalty_rule::Rule':
+        resolveRoyaltyRule(
+          tx,
+          itemType,
+          listing.price,
+          policy.id,
+          transferRequest,
+        );
+        break;
+      default:
+        break;
+    }
+  }
+
+  // confirm the Transfer Policy request.
+  confirmRequest(tx, itemType, policy.id, transferRequest);
+
+  return purchasedItem;
+}

package/src/tx/transfer-policy.ts

@@ -0,0 +1,127 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import { TransactionArgument, TransactionBlock } from '@mysten/sui.js';
+import { ObjectArgument, objArg } from '../utils';
+
+/** The Transfer Policy module. */
+export const TRANSFER_POLICY_MODULE = '0x2::transfer_policy';
+
+/** The Transer Policy Rules package address */
+// TODO: Figure out how we serve this for both testnet & mainnet (different package)
+export const TRANSFER_POLICY_RULES_PACKAGE_ADDRESS =
+  'bd8fc1947cf119350184107a3087e2dc27efefa0dd82e25a1f699069fe81a585';
+
+/**
+ * Call the `transfer_policy::new` function to create a new transfer policy.
+ * Returns `transferPolicyCap`
+ */
+export function createTransferPolicy(
+  tx: TransactionBlock,
+  itemType: string,
+  publisher: ObjectArgument,
+): TransactionArgument {
+  let [transferPolicy, transferPolicyCap] = tx.moveCall({
+    target: `${TRANSFER_POLICY_MODULE}::new`,
+    typeArguments: [itemType],
+    arguments: [objArg(tx, publisher)],
+  });
+
+  tx.moveCall({
+    target: `0x2::transfer::public_share_object`,
+    typeArguments: [itemType],
+    arguments: [transferPolicy],
+  });
+
+  return transferPolicyCap;
+}
+
+/**
+ * Call the `transfer_policy::withdraw` function to withdraw profits from a transfer policy.
+ */
+export function withdrawFromPolicy(
+  tx: TransactionBlock,
+  itemType: string,
+  policy: ObjectArgument,
+  policyCap: ObjectArgument,
+  amount: string | bigint | null,
+): TransactionArgument {
+  let amountArg =
+    amount !== null
+      ? tx.pure(amount, 'Option<u64>')
+      : tx.pure({ None: true }, 'Option<u64>');
+
+  let [profits] = tx.moveCall({
+    target: `${TRANSFER_POLICY_MODULE}::withdraw`,
+    typeArguments: [itemType],
+    arguments: [objArg(tx, policy), objArg(tx, policyCap), amountArg],
+  });
+
+  return profits;
+}
+
+/**
+ * Call the `transfer_policy::confirm_request` function to unblock the
+ * transaction.
+ */
+export function confirmRequest(
+  tx: TransactionBlock,
+  itemType: string,
+  policy: ObjectArgument,
+  request: TransactionArgument,
+): void {
+  tx.moveCall({
+    target: `${TRANSFER_POLICY_MODULE}::confirm_request`,
+    typeArguments: [itemType],
+    arguments: [objArg(tx, policy), request],
+  });
+}
+
+/**
+ * Calls the `transfer_policy::remove_rule` function to remove a Rule from the transfer policy's ruleset.
+ */
+export function removeTransferPolicyRule(
+  tx: TransactionBlock,
+  itemType: string,
+  ruleType: string,
+  configType: string,
+  policy: ObjectArgument,
+  policyCap: TransactionArgument,
+): void {
+  tx.moveCall({
+    target: `${TRANSFER_POLICY_MODULE}::remove_rule`,
+    typeArguments: [itemType, ruleType, configType],
+    arguments: [objArg(tx, policy), policyCap],
+  });
+}
+
+/**
+ * Calculates the amount to be paid for the royalty rule to be resolved,
+ * splits the coin to pass the exact amount,
+ * then calls the `royalty_rule::pay` function to resolve the royalty rule.
+ */
+export function resolveRoyaltyRule(
+  tx: TransactionBlock,
+  itemType: string,
+  price: string,
+  policyId: string,
+  transferRequest: TransactionArgument,
+) {
+  const policyObj = objArg(tx, policyId);
+  // calculates the amount
+  const [amount] = tx.moveCall({
+    target: `${TRANSFER_POLICY_RULES_PACKAGE_ADDRESS}::royalty_rule::fee_amount`,
+    typeArguments: [itemType],
+    arguments: [policyObj, objArg(tx, price)],
+  });
+
+  // splits the coin.
+  const feeCoin = tx.splitCoins(tx.gas, [amount]);
+
+  // pays the policy
+  tx.moveCall({
+    target: `${TRANSFER_POLICY_RULES_PACKAGE_ADDRESS}::royalty_rule::pay`,
+    typeArguments: [itemType],
+    arguments: [policyObj, transferRequest, feeCoin],
+  });
+}

package/src/utils.ts

@@ -0,0 +1,117 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+  JsonRpcProvider,
+  SharedObjectRef,
+  SuiObjectDataOptions,
+  SuiObjectRef,
+  TransactionArgument,
+  TransactionBlock,
+} from '@mysten/sui.js';
+import { KioskData } from './query/kiosk';
+import { DynamicFieldInfo } from '@mysten/sui.js/dist/types/dynamic_fields';
+import { bcs, Kiosk } from './bcs';
+
+/**
+ * A valid argument for any of the Kiosk functions.
+ */
+export type ObjectArgument =
+  | string
+  | TransactionArgument
+  | SharedObjectRef
+  | SuiObjectRef;
+
+/**
+ * Convert any valid input into a TransactionArgument.
+ *
+ * @param tx The transaction to use for creating the argument.
+ * @param arg The argument to convert.
+ * @returns The converted TransactionArgument.
+ */
+export function objArg(
+  tx: TransactionBlock,
+  arg: string | SharedObjectRef | SuiObjectRef | TransactionArgument,
+): TransactionArgument {
+  if (typeof arg === 'string') {
+    return tx.object(arg);
+  }
+
+  if ('digest' in arg && 'version' in arg && 'objectId' in arg) {
+    return tx.objectRef(arg);
+  }
+
+  if ('objectId' in arg && 'initialSharedVersion' in arg && 'mutable' in arg) {
+    return tx.sharedObjectRef(arg);
+  }
+
+  if ('kind' in arg) {
+    return arg;
+  }
+
+  throw new Error('Invalid argument type');
+}
+
+export async function getKioskObject(
+  provider: JsonRpcProvider,
+  id: string,
+): Promise<Kiosk> {
+  const queryRes = await provider.getObject({ id, options: { showBcs: true } });
+
+  if (!queryRes || queryRes.error || !queryRes.data) {
+    throw new Error(`Kiosk ${id} not found; ${queryRes.error}`);
+  }
+
+  if (!queryRes.data.bcs || !('bcsBytes' in queryRes.data.bcs)) {
+    throw new Error(`Invalid kiosk query: ${id}, expected object, got package`);
+  }
+
+  return bcs.de('0x2::kiosk::Kiosk', queryRes.data.bcs!.bcsBytes, 'base64');
+}
+
+// helper to extract kiosk data from dynamic fields.
+export function extractKioskData(data: DynamicFieldInfo[]): KioskData {
+  return data.reduce<KioskData>(
+    (acc: KioskData, val: DynamicFieldInfo) => {
+      const type = getTypeWithoutPackageAddress(val.name.type);
+
+      switch (type) {
+        case 'kiosk::Item':
+          acc.itemIds.push(val.objectId);
+          acc.items.push({
+            itemId: val.objectId,
+            itemType: val.objectType,
+          });
+          break;
+        case 'kiosk::Listing':
+          acc.listingIds.push(val.objectId);
+          acc.listings.push({
+            itemId: val.name.value.id,
+            listingId: val.objectId,
+            isExclusive: val.name.value.is_exclusive,
+          });
+          break;
+      }
+      return acc;
+    },
+    { listings: [], items: [], itemIds: [], listingIds: [] },
+  );
+}
+
+// simple multiGetObjects wrapper to simplify cases on functions.
+export function getObjects(
+  provider: JsonRpcProvider,
+  ids: string[],
+  options: SuiObjectDataOptions,
+) {
+  if (ids.length === 0) {
+    return Promise.resolve([]);
+  }
+
+  return provider.multiGetObjects({ ids, options });
+}
+
+// e.g. 0x2::kiosk::Item -> kiosk::Item
+export const getTypeWithoutPackageAddress = (type: string) => {
+  return type.split('::').slice(-2).join('::');
+};