@iota/kiosk 0.1.1 → 0.2.0

package/src/tx/rules/attach.ts

@@ -2,12 +2,12 @@
 // Modifications Copyright (c) 2024 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
-import type { TransactionBlock } from '@iota/iota-sdk/transactions';
+import type { Transaction } from '@iota/iota-sdk/transactions';
 
 import type { ObjectArgument } from '../../types/index.js';
 
 export function attachKioskLockRuleTx(
-    tx: TransactionBlock,
+    tx: Transaction,
     type: string,
     policy: ObjectArgument,
     policyCap: ObjectArgument,
@@ -21,7 +21,7 @@ export function attachKioskLockRuleTx(
 }
 
 export function attachRoyaltyRuleTx(
-    tx: TransactionBlock,
+    tx: Transaction,
     type: string,
     policy: ObjectArgument,
     policyCap: ObjectArgument,
@@ -45,7 +45,7 @@ export function attachRoyaltyRuleTx(
 }
 
 export function attachPersonalKioskRuleTx(
-    tx: TransactionBlock,
+    tx: Transaction,
     type: string,
     policy: ObjectArgument,
     policyCap: ObjectArgument,
@@ -59,7 +59,7 @@ export function attachPersonalKioskRuleTx(
 }
 
 export function attachFloorPriceRuleTx(
-    tx: TransactionBlock,
+    tx: Transaction,
     type: string,
     policy: ObjectArgument,
     policyCap: ObjectArgument,

package/src/tx/rules/resolve.ts

@@ -9,22 +9,22 @@ import { lock } from '../kiosk.js';
  * A helper to resolve the royalty rule.
  */
 export function resolveRoyaltyRule(params: RuleResolvingParams) {
-    const { transactionBlock: txb, itemType, price, packageId, transferRequest, policyId } = params;
+    const { transaction: tx, itemType, price, packageId, transferRequest, policyId } = params;
 
-    const policyObj = txb.object(policyId);
+    const policyObj = tx.object(policyId);
 
     // calculates the amount
-    const [amount] = txb.moveCall({
+    const [amount] = tx.moveCall({
         target: `${packageId}::royalty_rule::fee_amount`,
         typeArguments: [itemType],
-        arguments: [policyObj, txb.pure.u64(price || '0')],
+        arguments: [policyObj, tx.pure.u64(price || '0')],
     });
 
     // splits the coin.
-    const feeCoin = txb.splitCoins(txb.gas, [amount]);
+    const feeCoin = tx.splitCoins(tx.gas, [amount]);
 
     // pays the policy
-    txb.moveCall({
+    tx.moveCall({
         target: `${packageId}::royalty_rule::pay`,
         typeArguments: [itemType],
         arguments: [policyObj, transferRequest, feeCoin],
@@ -33,7 +33,7 @@ export function resolveRoyaltyRule(params: RuleResolvingParams) {
 
 export function resolveKioskLockRule(params: RuleResolvingParams) {
     const {
-        transactionBlock: txb,
+        transaction: tx,
         packageId,
         itemType,
         kiosk,
@@ -45,13 +45,13 @@ export function resolveKioskLockRule(params: RuleResolvingParams) {
 
     if (!kiosk || !kioskCap) throw new Error('Missing Owned Kiosk or Owned Kiosk Cap');
 
-    lock(txb, itemType, kiosk, kioskCap, policyId, purchasedItem);
+    lock(tx, itemType, kiosk, kioskCap, policyId, purchasedItem);
 
     // proves that the item is locked in the kiosk to the TP.
-    txb.moveCall({
+    tx.moveCall({
         target: `${packageId}::kiosk_lock_rule::prove`,
         typeArguments: [itemType],
-        arguments: [transferRequest, txb.object(kiosk)],
+        arguments: [transferRequest, tx.object(kiosk)],
     });
 }
 
@@ -60,15 +60,15 @@ export function resolveKioskLockRule(params: RuleResolvingParams) {
  * @param params
  */
 export function resolvePersonalKioskRule(params: RuleResolvingParams) {
-    const { transactionBlock: txb, packageId, itemType, kiosk, transferRequest } = params;
+    const { transaction: tx, packageId, itemType, kiosk, transferRequest } = params;
 
     if (!kiosk) throw new Error('Missing owned Kiosk.');
 
     // proves that the destination kiosk is personal.
-    txb.moveCall({
+    tx.moveCall({
         target: `${packageId}::personal_kiosk_rule::prove`,
         typeArguments: [itemType],
-        arguments: [txb.object(kiosk), transferRequest],
+        arguments: [tx.object(kiosk), transferRequest],
     });
 }
 
@@ -76,12 +76,12 @@ export function resolvePersonalKioskRule(params: RuleResolvingParams) {
  * Resolves the floor price rule.
  */
 export function resolveFloorPriceRule(params: RuleResolvingParams) {
-    const { transactionBlock: txb, packageId, itemType, policyId, transferRequest } = params;
+    const { transaction: tx, packageId, itemType, policyId, transferRequest } = params;
 
     // proves that the destination kiosk is personal
-    txb.moveCall({
+    tx.moveCall({
         target: `${packageId}::floor_price_rule::prove`,
         typeArguments: [itemType],
-        arguments: [txb.object(policyId), transferRequest],
+        arguments: [tx.object(policyId), transferRequest],
     });
 }

package/src/tx/transfer-policy.ts

@@ -4,8 +4,8 @@
 
 import { bcs } from '@iota/iota-sdk/bcs';
 import type {
+    Transaction,
     TransactionArgument,
-    TransactionBlock,
     TransactionObjectArgument,
 } from '@iota/iota-sdk/transactions';
 
@@ -17,7 +17,7 @@ import { TRANSFER_POLICY_MODULE, TRANSFER_POLICY_TYPE } from '../types/index.js'
  * Returns `transferPolicyCap`
  */
 export function createTransferPolicy(
-    tx: TransactionBlock,
+    tx: Transaction,
     itemType: string,
     publisher: ObjectArgument,
 ): TransactionObjectArgument {
@@ -37,7 +37,7 @@ export function createTransferPolicy(
  * Used if we want to use the policy before making it a shared object.
  */
 export function createTransferPolicyWithoutSharing(
-    tx: TransactionBlock,
+    tx: Transaction,
     itemType: string,
     publisher: ObjectArgument,
 ): [TransactionObjectArgument, TransactionObjectArgument] {
@@ -53,7 +53,7 @@ export function createTransferPolicyWithoutSharing(
  * Converts Transfer Policy to a shared object.
  */
 export function shareTransferPolicy(
-    tx: TransactionBlock,
+    tx: Transaction,
     itemType: string,
     transferPolicy: TransactionObjectArgument,
 ) {
@@ -68,7 +68,7 @@ export function shareTransferPolicy(
  * Call the `transfer_policy::withdraw` function to withdraw profits from a transfer policy.
  */
 export function withdrawFromPolicy(
-    tx: TransactionBlock,
+    tx: Transaction,
     itemType: string,
     policy: ObjectArgument,
     policyCap: ObjectArgument,
@@ -90,7 +90,7 @@ export function withdrawFromPolicy(
  * transaction.
  */
 export function confirmRequest(
-    tx: TransactionBlock,
+    tx: Transaction,
     itemType: string,
     policy: ObjectArgument,
     request: TransactionArgument,
@@ -106,7 +106,7 @@ export function confirmRequest(
  * Calls the `transfer_policy::remove_rule` function to remove a Rule from the transfer policy's ruleset.
  */
 export function removeTransferPolicyRule(
-    tx: TransactionBlock,
+    tx: Transaction,
     itemType: string,
     ruleType: string,
     configType: string,

package/src/types/kiosk.ts

@@ -40,7 +40,6 @@ export type Kiosk = {
     profits: string;
     owner: string;
     itemCount: number;
-    allowExtensions: boolean;
 };
 
 /**

package/src/types/transfer-policy.ts

@@ -3,7 +3,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { ObjectOwner } from '@iota/iota-sdk/client';
-import type { TransactionBlock, TransactionObjectArgument } from '@iota/iota-sdk/transactions';
+import type { Transaction, TransactionObjectArgument } from '@iota/iota-sdk/transactions';
 
 import type { ObjectArgument } from './index.js';
 
@@ -53,7 +53,9 @@ export type TransferPolicyCreated = {
 // Each rule resolving function should check that the key it's seeking is in the object
 // e.g. `if(!'my_key' in ruleParams!) throw new Error("Can't resolve that rule!")`
 export type RuleResolvingParams = {
-    transactionBlock: TransactionBlock;
+    transaction: Transaction;
+    /** @deprecated use transaction instead */
+    transactionBlock: Transaction;
     itemType: string;
     itemId: string;
     price: string;

package/src/utils.ts

@@ -11,11 +11,16 @@ import type {
     IotaObjectDataOptions,
     IotaObjectResponse,
 } from '@iota/iota-sdk/client';
-import { normalizeStructTag, normalizeIotaAddress, parseStructTag } from '@iota/iota-sdk/utils';
-
-import { bcs } from './bcs.js';
+import {
+    fromB64,
+    normalizeStructTag,
+    normalizeIotaAddress,
+    parseStructTag,
+} from '@iota/iota-sdk/utils';
+
+import { KioskType } from './bcs.js';
 import type { Kiosk, KioskData, KioskListing, TransferPolicyCap } from './types/index.js';
-import { KIOSK_TYPE, TRANSFER_POLICY_CAP_TYPE } from './types/index.js';
+import { TRANSFER_POLICY_CAP_TYPE } from './types/index.js';
 
 const DEFAULT_QUERY_LIMIT = 50;
 
@@ -30,7 +35,7 @@ export async function getKioskObject(client: IotaClient, id: string): Promise<Ki
         throw new Error(`Invalid kiosk query: ${id}, expected object, got package`);
     }
 
-    return bcs.de(KIOSK_TYPE, queryRes.data.bcs!.bcsBytes, 'base64');
+    return KioskType.parse(fromB64(queryRes.data.bcs!.bcsBytes));
 }
 
 // helper to extract kiosk data from dynamic fields.