@mysten/kiosk 0.8.10 → 0.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (95) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/dist/cjs/bcs.d.ts +40 -2
  3. package/dist/cjs/bcs.js +22 -19
  4. package/dist/cjs/bcs.js.map +2 -2
  5. package/dist/cjs/client/kiosk-client.d.ts +1 -1
  6. package/dist/cjs/client/kiosk-client.js.map +1 -1
  7. package/dist/cjs/client/kiosk-transaction.d.ts +8 -6
  8. package/dist/cjs/client/kiosk-transaction.js +41 -54
  9. package/dist/cjs/client/kiosk-transaction.js.map +2 -2
  10. package/dist/cjs/client/tp-transaction.d.ts +6 -4
  11. package/dist/cjs/client/tp-transaction.js +24 -19
  12. package/dist/cjs/client/tp-transaction.js.map +2 -2
  13. package/dist/cjs/query/kiosk.d.ts +1 -1
  14. package/dist/cjs/query/kiosk.js +1 -1
  15. package/dist/cjs/query/kiosk.js.map +1 -1
  16. package/dist/cjs/query/transfer-policy.d.ts +2 -1
  17. package/dist/cjs/query/transfer-policy.js +3 -2
  18. package/dist/cjs/query/transfer-policy.js.map +3 -3
  19. package/dist/cjs/tx/kiosk.d.ts +14 -14
  20. package/dist/cjs/tx/kiosk.js +1 -1
  21. package/dist/cjs/tx/kiosk.js.map +2 -2
  22. package/dist/cjs/tx/personal-kiosk.d.ts +3 -3
  23. package/dist/cjs/tx/personal-kiosk.js.map +1 -1
  24. package/dist/cjs/tx/rules/attach.d.ts +5 -5
  25. package/dist/cjs/tx/rules/attach.js.map +1 -1
  26. package/dist/cjs/tx/rules/resolve.js +16 -16
  27. package/dist/cjs/tx/rules/resolve.js.map +2 -2
  28. package/dist/cjs/tx/transfer-policy.d.ts +7 -7
  29. package/dist/cjs/tx/transfer-policy.js +1 -1
  30. package/dist/cjs/tx/transfer-policy.js.map +1 -1
  31. package/dist/cjs/types/index.d.ts +2 -2
  32. package/dist/cjs/types/index.js.map +1 -1
  33. package/dist/cjs/types/kiosk.d.ts +2 -2
  34. package/dist/cjs/types/kiosk.js.map +1 -1
  35. package/dist/cjs/types/transfer-policy.d.ts +5 -3
  36. package/dist/cjs/types/transfer-policy.js.map +1 -1
  37. package/dist/cjs/utils.d.ts +1 -1
  38. package/dist/cjs/utils.js +2 -2
  39. package/dist/cjs/utils.js.map +2 -2
  40. package/dist/esm/bcs.d.ts +40 -2
  41. package/dist/esm/bcs.js +22 -19
  42. package/dist/esm/bcs.js.map +2 -2
  43. package/dist/esm/client/kiosk-client.d.ts +1 -1
  44. package/dist/esm/client/kiosk-client.js.map +1 -1
  45. package/dist/esm/client/kiosk-transaction.d.ts +8 -6
  46. package/dist/esm/client/kiosk-transaction.js +41 -54
  47. package/dist/esm/client/kiosk-transaction.js.map +2 -2
  48. package/dist/esm/client/tp-transaction.d.ts +6 -4
  49. package/dist/esm/client/tp-transaction.js +24 -19
  50. package/dist/esm/client/tp-transaction.js.map +2 -2
  51. package/dist/esm/query/kiosk.d.ts +1 -1
  52. package/dist/esm/query/kiosk.js +1 -1
  53. package/dist/esm/query/kiosk.js.map +1 -1
  54. package/dist/esm/query/transfer-policy.d.ts +2 -1
  55. package/dist/esm/query/transfer-policy.js +4 -3
  56. package/dist/esm/query/transfer-policy.js.map +2 -2
  57. package/dist/esm/tx/kiosk.d.ts +14 -14
  58. package/dist/esm/tx/kiosk.js +1 -1
  59. package/dist/esm/tx/kiosk.js.map +2 -2
  60. package/dist/esm/tx/personal-kiosk.d.ts +3 -3
  61. package/dist/esm/tx/personal-kiosk.js.map +1 -1
  62. package/dist/esm/tx/rules/attach.d.ts +5 -5
  63. package/dist/esm/tx/rules/attach.js.map +1 -1
  64. package/dist/esm/tx/rules/resolve.js +16 -16
  65. package/dist/esm/tx/rules/resolve.js.map +2 -2
  66. package/dist/esm/tx/transfer-policy.d.ts +7 -7
  67. package/dist/esm/tx/transfer-policy.js +1 -1
  68. package/dist/esm/tx/transfer-policy.js.map +1 -1
  69. package/dist/esm/types/index.d.ts +2 -2
  70. package/dist/esm/types/index.js.map +1 -1
  71. package/dist/esm/types/kiosk.d.ts +2 -2
  72. package/dist/esm/types/kiosk.js.map +1 -1
  73. package/dist/esm/types/transfer-policy.d.ts +5 -3
  74. package/dist/esm/types/transfer-policy.js.map +1 -1
  75. package/dist/esm/utils.d.ts +1 -1
  76. package/dist/esm/utils.js +9 -4
  77. package/dist/esm/utils.js.map +2 -2
  78. package/dist/tsconfig.esm.tsbuildinfo +1 -1
  79. package/dist/tsconfig.tsbuildinfo +1 -1
  80. package/package.json +4 -4
  81. package/src/bcs.ts +18 -20
  82. package/src/client/kiosk-client.ts +1 -1
  83. package/src/client/kiosk-transaction.ts +50 -60
  84. package/src/client/tp-transaction.ts +29 -22
  85. package/src/query/kiosk.ts +2 -2
  86. package/src/query/transfer-policy.ts +6 -4
  87. package/src/tx/kiosk.ts +16 -16
  88. package/src/tx/personal-kiosk.ts +3 -3
  89. package/src/tx/rules/attach.ts +5 -5
  90. package/src/tx/rules/resolve.ts +16 -16
  91. package/src/tx/transfer-policy.ts +9 -9
  92. package/src/types/index.ts +2 -2
  93. package/src/types/kiosk.ts +2 -2
  94. package/src/types/transfer-policy.ts +5 -3
  95. package/src/utils.ts +11 -6
@@ -1,12 +1,12 @@
1
1
  // Copyright (c) Mysten Labs, Inc.
2
2
  // SPDX-License-Identifier: Apache-2.0
3
3
 
4
- import type { TransactionBlock } from '@mysten/sui.js/transactions';
4
+ import type { Transaction } from '@mysten/sui/transactions';
5
5
 
6
6
  import type { ObjectArgument } from '../../types/index.js';
7
7
 
8
8
  export function attachKioskLockRuleTx(
9
- tx: TransactionBlock,
9
+ tx: Transaction,
10
10
  type: string,
11
11
  policy: ObjectArgument,
12
12
  policyCap: ObjectArgument,
@@ -20,7 +20,7 @@ export function attachKioskLockRuleTx(
20
20
  }
21
21
 
22
22
  export function attachRoyaltyRuleTx(
23
- tx: TransactionBlock,
23
+ tx: Transaction,
24
24
  type: string,
25
25
  policy: ObjectArgument,
26
26
  policyCap: ObjectArgument,
@@ -44,7 +44,7 @@ export function attachRoyaltyRuleTx(
44
44
  }
45
45
 
46
46
  export function attachPersonalKioskRuleTx(
47
- tx: TransactionBlock,
47
+ tx: Transaction,
48
48
  type: string,
49
49
  policy: ObjectArgument,
50
50
  policyCap: ObjectArgument,
@@ -58,7 +58,7 @@ export function attachPersonalKioskRuleTx(
58
58
  }
59
59
 
60
60
  export function attachFloorPriceRuleTx(
61
- tx: TransactionBlock,
61
+ tx: Transaction,
62
62
  type: string,
63
63
  policy: ObjectArgument,
64
64
  policyCap: ObjectArgument,
@@ -8,22 +8,22 @@ import { lock } from '../kiosk.js';
8
8
  * A helper to resolve the royalty rule.
9
9
  */
10
10
  export function resolveRoyaltyRule(params: RuleResolvingParams) {
11
- const { transactionBlock: txb, itemType, price, packageId, transferRequest, policyId } = params;
11
+ const { transaction: tx, itemType, price, packageId, transferRequest, policyId } = params;
12
12
 
13
- const policyObj = txb.object(policyId);
13
+ const policyObj = tx.object(policyId);
14
14
 
15
15
  // calculates the amount
16
- const [amount] = txb.moveCall({
16
+ const [amount] = tx.moveCall({
17
17
  target: `${packageId}::royalty_rule::fee_amount`,
18
18
  typeArguments: [itemType],
19
- arguments: [policyObj, txb.pure.u64(price || '0')],
19
+ arguments: [policyObj, tx.pure.u64(price || '0')],
20
20
  });
21
21
 
22
22
  // splits the coin.
23
- const feeCoin = txb.splitCoins(txb.gas, [amount]);
23
+ const feeCoin = tx.splitCoins(tx.gas, [amount]);
24
24
 
25
25
  // pays the policy
26
- txb.moveCall({
26
+ tx.moveCall({
27
27
  target: `${packageId}::royalty_rule::pay`,
28
28
  typeArguments: [itemType],
29
29
  arguments: [policyObj, transferRequest, feeCoin],
@@ -32,7 +32,7 @@ export function resolveRoyaltyRule(params: RuleResolvingParams) {
32
32
 
33
33
  export function resolveKioskLockRule(params: RuleResolvingParams) {
34
34
  const {
35
- transactionBlock: txb,
35
+ transaction: tx,
36
36
  packageId,
37
37
  itemType,
38
38
  kiosk,
@@ -44,13 +44,13 @@ export function resolveKioskLockRule(params: RuleResolvingParams) {
44
44
 
45
45
  if (!kiosk || !kioskCap) throw new Error('Missing Owned Kiosk or Owned Kiosk Cap');
46
46
 
47
- lock(txb, itemType, kiosk, kioskCap, policyId, purchasedItem);
47
+ lock(tx, itemType, kiosk, kioskCap, policyId, purchasedItem);
48
48
 
49
49
  // proves that the item is locked in the kiosk to the TP.
50
- txb.moveCall({
50
+ tx.moveCall({
51
51
  target: `${packageId}::kiosk_lock_rule::prove`,
52
52
  typeArguments: [itemType],
53
- arguments: [transferRequest, txb.object(kiosk)],
53
+ arguments: [transferRequest, tx.object(kiosk)],
54
54
  });
55
55
  }
56
56
 
@@ -59,15 +59,15 @@ export function resolveKioskLockRule(params: RuleResolvingParams) {
59
59
  * @param params
60
60
  */
61
61
  export function resolvePersonalKioskRule(params: RuleResolvingParams) {
62
- const { transactionBlock: txb, packageId, itemType, kiosk, transferRequest } = params;
62
+ const { transaction: tx, packageId, itemType, kiosk, transferRequest } = params;
63
63
 
64
64
  if (!kiosk) throw new Error('Missing owned Kiosk.');
65
65
 
66
66
  // proves that the destination kiosk is personal.
67
- txb.moveCall({
67
+ tx.moveCall({
68
68
  target: `${packageId}::personal_kiosk_rule::prove`,
69
69
  typeArguments: [itemType],
70
- arguments: [txb.object(kiosk), transferRequest],
70
+ arguments: [tx.object(kiosk), transferRequest],
71
71
  });
72
72
  }
73
73
 
@@ -75,12 +75,12 @@ export function resolvePersonalKioskRule(params: RuleResolvingParams) {
75
75
  * Resolves the floor price rule.
76
76
  */
77
77
  export function resolveFloorPriceRule(params: RuleResolvingParams) {
78
- const { transactionBlock: txb, packageId, itemType, policyId, transferRequest } = params;
78
+ const { transaction: tx, packageId, itemType, policyId, transferRequest } = params;
79
79
 
80
80
  // proves that the destination kiosk is personal
81
- txb.moveCall({
81
+ tx.moveCall({
82
82
  target: `${packageId}::floor_price_rule::prove`,
83
83
  typeArguments: [itemType],
84
- arguments: [txb.object(policyId), transferRequest],
84
+ arguments: [tx.object(policyId), transferRequest],
85
85
  });
86
86
  }
@@ -1,12 +1,12 @@
1
1
  // Copyright (c) Mysten Labs, Inc.
2
2
  // SPDX-License-Identifier: Apache-2.0
3
3
 
4
- import { bcs } from '@mysten/sui.js/bcs';
4
+ import { bcs } from '@mysten/sui/bcs';
5
5
  import type {
6
+ Transaction,
6
7
  TransactionArgument,
7
- TransactionBlock,
8
8
  TransactionObjectArgument,
9
- } from '@mysten/sui.js/transactions';
9
+ } from '@mysten/sui/transactions';
10
10
 
11
11
  import type { ObjectArgument } from '../types/index.js';
12
12
  import { TRANSFER_POLICY_MODULE, TRANSFER_POLICY_TYPE } from '../types/index.js';
@@ -16,7 +16,7 @@ import { TRANSFER_POLICY_MODULE, TRANSFER_POLICY_TYPE } from '../types/index.js'
16
16
  * Returns `transferPolicyCap`
17
17
  */
18
18
  export function createTransferPolicy(
19
- tx: TransactionBlock,
19
+ tx: Transaction,
20
20
  itemType: string,
21
21
  publisher: ObjectArgument,
22
22
  ): TransactionObjectArgument {
@@ -36,7 +36,7 @@ export function createTransferPolicy(
36
36
  * Used if we want to use the policy before making it a shared object.
37
37
  */
38
38
  export function createTransferPolicyWithoutSharing(
39
- tx: TransactionBlock,
39
+ tx: Transaction,
40
40
  itemType: string,
41
41
  publisher: ObjectArgument,
42
42
  ): [TransactionObjectArgument, TransactionObjectArgument] {
@@ -52,7 +52,7 @@ export function createTransferPolicyWithoutSharing(
52
52
  * Converts Transfer Policy to a shared object.
53
53
  */
54
54
  export function shareTransferPolicy(
55
- tx: TransactionBlock,
55
+ tx: Transaction,
56
56
  itemType: string,
57
57
  transferPolicy: TransactionObjectArgument,
58
58
  ) {
@@ -67,7 +67,7 @@ export function shareTransferPolicy(
67
67
  * Call the `transfer_policy::withdraw` function to withdraw profits from a transfer policy.
68
68
  */
69
69
  export function withdrawFromPolicy(
70
- tx: TransactionBlock,
70
+ tx: Transaction,
71
71
  itemType: string,
72
72
  policy: ObjectArgument,
73
73
  policyCap: ObjectArgument,
@@ -89,7 +89,7 @@ export function withdrawFromPolicy(
89
89
  * transaction.
90
90
  */
91
91
  export function confirmRequest(
92
- tx: TransactionBlock,
92
+ tx: Transaction,
93
93
  itemType: string,
94
94
  policy: ObjectArgument,
95
95
  request: TransactionArgument,
@@ -105,7 +105,7 @@ export function confirmRequest(
105
105
  * Calls the `transfer_policy::remove_rule` function to remove a Rule from the transfer policy's ruleset.
106
106
  */
107
107
  export function removeTransferPolicyRule(
108
- tx: TransactionBlock,
108
+ tx: Transaction,
109
109
  itemType: string,
110
110
  ruleType: string,
111
111
  configType: string,
@@ -1,8 +1,8 @@
1
1
  // Copyright (c) Mysten Labs, Inc.
2
2
  // SPDX-License-Identifier: Apache-2.0
3
3
 
4
- import type { SuiClient } from '@mysten/sui.js/client';
5
- import type { TransactionObjectArgument } from '@mysten/sui.js/transactions';
4
+ import type { SuiClient } from '@mysten/sui/client';
5
+ import type { TransactionObjectArgument } from '@mysten/sui/transactions';
6
6
 
7
7
  import type { BaseRulePackageIds } from '../constants.js';
8
8
 
@@ -5,8 +5,8 @@ import type {
5
5
  PaginatedObjectsResponse,
6
6
  SuiObjectData,
7
7
  SuiObjectDataOptions,
8
- } from '@mysten/sui.js/client';
9
- import type { TransactionArgument } from '@mysten/sui.js/transactions';
8
+ } from '@mysten/sui/client';
9
+ import type { TransactionArgument } from '@mysten/sui/transactions';
10
10
 
11
11
  import type { ObjectArgument } from './index.js';
12
12
 
@@ -1,8 +1,8 @@
1
1
  // Copyright (c) Mysten Labs, Inc.
2
2
  // SPDX-License-Identifier: Apache-2.0
3
3
 
4
- import type { ObjectOwner } from '@mysten/sui.js/client';
5
- import type { TransactionBlock, TransactionObjectArgument } from '@mysten/sui.js/transactions';
4
+ import type { ObjectOwner } from '@mysten/sui/client';
5
+ import type { Transaction, TransactionObjectArgument } from '@mysten/sui/transactions';
6
6
 
7
7
  import type { ObjectArgument } from './index.js';
8
8
 
@@ -52,7 +52,9 @@ export type TransferPolicyCreated = {
52
52
  // Each rule resolving function should check that the key it's seeking is in the object
53
53
  // e.g. `if(!'my_key' in ruleParams!) throw new Error("Can't resolve that rule!")`
54
54
  export type RuleResolvingParams = {
55
- transactionBlock: TransactionBlock;
55
+ transaction: Transaction;
56
+ /** @deprecated use transaction instead */
57
+ transactionBlock: Transaction;
56
58
  itemType: string;
57
59
  itemId: string;
58
60
  price: string;
package/src/utils.ts CHANGED
@@ -9,12 +9,17 @@ import type {
9
9
  SuiObjectDataFilter,
10
10
  SuiObjectDataOptions,
11
11
  SuiObjectResponse,
12
- } from '@mysten/sui.js/client';
13
- import { normalizeStructTag, normalizeSuiAddress, parseStructTag } from '@mysten/sui.js/utils';
14
-
15
- import { bcs } from './bcs.js';
12
+ } from '@mysten/sui/client';
13
+ import {
14
+ fromB64,
15
+ normalizeStructTag,
16
+ normalizeSuiAddress,
17
+ parseStructTag,
18
+ } from '@mysten/sui/utils';
19
+
20
+ import { KioskType } from './bcs.js';
16
21
  import type { Kiosk, KioskData, KioskListing, TransferPolicyCap } from './types/index.js';
17
- import { KIOSK_TYPE, TRANSFER_POLICY_CAP_TYPE } from './types/index.js';
22
+ import { TRANSFER_POLICY_CAP_TYPE } from './types/index.js';
18
23
 
19
24
  const DEFAULT_QUERY_LIMIT = 50;
20
25
 
@@ -29,7 +34,7 @@ export async function getKioskObject(client: SuiClient, id: string): Promise<Kio
29
34
  throw new Error(`Invalid kiosk query: ${id}, expected object, got package`);
30
35
  }
31
36
 
32
- return bcs.de(KIOSK_TYPE, queryRes.data.bcs!.bcsBytes, 'base64');
37
+ return KioskType.parse(fromB64(queryRes.data.bcs!.bcsBytes));
33
38
  }
34
39
 
35
40
  // helper to extract kiosk data from dynamic fields.