@iota/kiosk 0.6.2 → 0.8.0
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.
- package/CHANGELOG.md +77 -0
- package/dist/cjs/bcs.d.ts +22 -37
- package/dist/cjs/bcs.d.ts.map +1 -0
- package/dist/cjs/client/kiosk-client.d.ts +1 -0
- package/dist/cjs/client/kiosk-client.d.ts.map +1 -0
- package/dist/cjs/client/kiosk-client.js +1 -8
- package/dist/cjs/client/kiosk-client.js.map +2 -2
- package/dist/cjs/client/kiosk-transaction.d.ts +6 -7
- package/dist/cjs/client/kiosk-transaction.d.ts.map +1 -0
- package/dist/cjs/client/kiosk-transaction.js +8 -10
- package/dist/cjs/client/kiosk-transaction.js.map +2 -2
- package/dist/cjs/client/tp-transaction.d.ts +2 -3
- package/dist/cjs/client/tp-transaction.d.ts.map +1 -0
- package/dist/cjs/client/tp-transaction.js +1 -6
- package/dist/cjs/client/tp-transaction.js.map +2 -2
- package/dist/cjs/constants.d.ts +2 -1
- package/dist/cjs/constants.d.ts.map +1 -0
- package/dist/cjs/constants.js +1 -1
- package/dist/cjs/constants.js.map +2 -2
- package/dist/cjs/index.d.ts +1 -0
- package/dist/cjs/index.d.ts.map +1 -0
- package/dist/cjs/query/kiosk.d.ts +1 -0
- package/dist/cjs/query/kiosk.d.ts.map +1 -0
- package/dist/cjs/query/kiosk.js +81 -22
- package/dist/cjs/query/kiosk.js.map +2 -2
- package/dist/cjs/query/transfer-policy.d.ts +1 -0
- package/dist/cjs/query/transfer-policy.d.ts.map +1 -0
- package/dist/cjs/tx/kiosk.d.ts +1 -0
- package/dist/cjs/tx/kiosk.d.ts.map +1 -0
- package/dist/cjs/tx/personal-kiosk.d.ts +1 -0
- package/dist/cjs/tx/personal-kiosk.d.ts.map +1 -0
- package/dist/cjs/tx/rules/attach.d.ts +1 -0
- package/dist/cjs/tx/rules/attach.d.ts.map +1 -0
- package/dist/cjs/tx/rules/resolve.d.ts +2 -1
- package/dist/cjs/tx/rules/resolve.d.ts.map +1 -0
- package/dist/cjs/tx/rules/resolve.js +35 -5
- package/dist/cjs/tx/rules/resolve.js.map +2 -2
- package/dist/cjs/tx/transfer-policy.d.ts +1 -0
- package/dist/cjs/tx/transfer-policy.d.ts.map +1 -0
- package/dist/cjs/types/index.d.ts +1 -0
- package/dist/cjs/types/index.d.ts.map +1 -0
- package/dist/cjs/types/kiosk.d.ts +1 -0
- package/dist/cjs/types/kiosk.d.ts.map +1 -0
- package/dist/cjs/types/transfer-policy.d.ts +3 -2
- package/dist/cjs/types/transfer-policy.d.ts.map +1 -0
- package/dist/cjs/types/transfer-policy.js.map +2 -2
- package/dist/cjs/utils.d.ts +1 -0
- package/dist/cjs/utils.d.ts.map +1 -0
- package/dist/esm/bcs.d.ts +22 -37
- package/dist/esm/bcs.d.ts.map +1 -0
- package/dist/esm/client/kiosk-client.d.ts +1 -0
- package/dist/esm/client/kiosk-client.d.ts.map +1 -0
- package/dist/esm/client/kiosk-client.js +1 -8
- package/dist/esm/client/kiosk-client.js.map +2 -2
- package/dist/esm/client/kiosk-transaction.d.ts +6 -7
- package/dist/esm/client/kiosk-transaction.d.ts.map +1 -0
- package/dist/esm/client/kiosk-transaction.js +8 -10
- package/dist/esm/client/kiosk-transaction.js.map +2 -2
- package/dist/esm/client/tp-transaction.d.ts +2 -3
- package/dist/esm/client/tp-transaction.d.ts.map +1 -0
- package/dist/esm/client/tp-transaction.js +1 -6
- package/dist/esm/client/tp-transaction.js.map +2 -2
- package/dist/esm/constants.d.ts +2 -1
- package/dist/esm/constants.d.ts.map +1 -0
- package/dist/esm/constants.js +1 -1
- package/dist/esm/constants.js.map +2 -2
- package/dist/esm/index.d.ts +1 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/query/kiosk.d.ts +1 -0
- package/dist/esm/query/kiosk.d.ts.map +1 -0
- package/dist/esm/query/kiosk.js +81 -22
- package/dist/esm/query/kiosk.js.map +2 -2
- package/dist/esm/query/transfer-policy.d.ts +1 -0
- package/dist/esm/query/transfer-policy.d.ts.map +1 -0
- package/dist/esm/tx/kiosk.d.ts +1 -0
- package/dist/esm/tx/kiosk.d.ts.map +1 -0
- package/dist/esm/tx/personal-kiosk.d.ts +1 -0
- package/dist/esm/tx/personal-kiosk.d.ts.map +1 -0
- package/dist/esm/tx/rules/attach.d.ts +1 -0
- package/dist/esm/tx/rules/attach.d.ts.map +1 -0
- package/dist/esm/tx/rules/resolve.d.ts +2 -1
- package/dist/esm/tx/rules/resolve.d.ts.map +1 -0
- package/dist/esm/tx/rules/resolve.js +35 -5
- package/dist/esm/tx/rules/resolve.js.map +2 -2
- package/dist/esm/tx/transfer-policy.d.ts +1 -0
- package/dist/esm/tx/transfer-policy.d.ts.map +1 -0
- package/dist/esm/types/index.d.ts +1 -0
- package/dist/esm/types/index.d.ts.map +1 -0
- package/dist/esm/types/kiosk.d.ts +1 -0
- package/dist/esm/types/kiosk.d.ts.map +1 -0
- package/dist/esm/types/transfer-policy.d.ts +3 -2
- package/dist/esm/types/transfer-policy.d.ts.map +1 -0
- package/dist/esm/types/transfer-policy.js.map +2 -2
- package/dist/esm/utils.d.ts +1 -0
- package/dist/esm/utils.d.ts.map +1 -0
- package/dist/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +5 -5
- package/src/client/kiosk-client.ts +1 -10
- package/src/client/kiosk-transaction.ts +7 -11
- package/src/client/tp-transaction.ts +1 -8
- package/src/constants.ts +5 -3
- package/src/query/kiosk.ts +108 -28
- package/src/tx/rules/resolve.ts +45 -6
- package/src/types/transfer-policy.ts +3 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,82 @@
|
|
|
1
1
|
# @iota/kiosk
|
|
2
2
|
|
|
3
|
+
## 0.8.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 1a2b37f: Add `return this` in some functions in file
|
|
8
|
+
`packages/kiosk/src/client/kiosk-transaction.ts` to make it chainable.
|
|
9
|
+
- bd1fa0b: Removed deprecated `transactionBlock` when resolving rules. Also updated
|
|
10
|
+
@iota/iota-sdk.
|
|
11
|
+
|
|
12
|
+
### Patch Changes
|
|
13
|
+
|
|
14
|
+
- adea573: Enable declarationMap in TS packages
|
|
15
|
+
- b473eb3: Fix double-slash in Kiosk imports.
|
|
16
|
+
- Updated dependencies [fe97265]
|
|
17
|
+
- Updated dependencies [d2ed95a]
|
|
18
|
+
- Updated dependencies [379dd4b]
|
|
19
|
+
- Updated dependencies [1a2b37f]
|
|
20
|
+
- Updated dependencies [1a2b37f]
|
|
21
|
+
- Updated dependencies [66d0c0d]
|
|
22
|
+
- Updated dependencies [9c6137c]
|
|
23
|
+
- Updated dependencies [331b7ab]
|
|
24
|
+
- Updated dependencies [adea573]
|
|
25
|
+
- Updated dependencies [bd1fa0b]
|
|
26
|
+
- Updated dependencies [1a2b37f]
|
|
27
|
+
- Updated dependencies [3f80310]
|
|
28
|
+
- Updated dependencies [2a9a1df]
|
|
29
|
+
- Updated dependencies [999224b]
|
|
30
|
+
- Updated dependencies [1a2b37f]
|
|
31
|
+
- Updated dependencies [f3d9079]
|
|
32
|
+
- Updated dependencies [7849d0e]
|
|
33
|
+
- Updated dependencies [0be1d8d]
|
|
34
|
+
- Updated dependencies [235a8d7]
|
|
35
|
+
- Updated dependencies [46171b1]
|
|
36
|
+
- Updated dependencies [9d88461]
|
|
37
|
+
- @iota/iota-sdk@1.12.0
|
|
38
|
+
|
|
39
|
+
## 0.7.0
|
|
40
|
+
|
|
41
|
+
### Minor Changes
|
|
42
|
+
|
|
43
|
+
- b65347f: Remove MatchAny filter when loading owned kiosks. This may result in an extra request,
|
|
44
|
+
and a change of cursor format when loading owned kiosks
|
|
45
|
+
- c1282a6: Update fee calculation to happen via dry runs to improve the display of transactions
|
|
46
|
+
within the wallet.
|
|
47
|
+
|
|
48
|
+
### Patch Changes
|
|
49
|
+
|
|
50
|
+
- 54c7803: Update @types/node to v24.
|
|
51
|
+
- f5a4569: Fix transaction construction for royalty_rule::fee_amount
|
|
52
|
+
- 40d44e8: Use default pagination limit when loading kiosks
|
|
53
|
+
- Updated dependencies [43cfa2b]
|
|
54
|
+
- Updated dependencies [3bcb711]
|
|
55
|
+
- Updated dependencies [0296e7d]
|
|
56
|
+
- Updated dependencies [54c7803]
|
|
57
|
+
- Updated dependencies [b903c0a]
|
|
58
|
+
- Updated dependencies [f5a4569]
|
|
59
|
+
- Updated dependencies [19c174f]
|
|
60
|
+
- Updated dependencies [8bd4574]
|
|
61
|
+
- Updated dependencies [5fc7e20]
|
|
62
|
+
- Updated dependencies [7a61cb5]
|
|
63
|
+
- Updated dependencies [f2b8160]
|
|
64
|
+
- Updated dependencies [abcdd2f]
|
|
65
|
+
- Updated dependencies [d5923e9]
|
|
66
|
+
- Updated dependencies [6fc20db]
|
|
67
|
+
- Updated dependencies [b72bfd2]
|
|
68
|
+
- Updated dependencies [38657f6]
|
|
69
|
+
- Updated dependencies [7fa1fde]
|
|
70
|
+
- Updated dependencies [2164846]
|
|
71
|
+
- Updated dependencies [4dc4b84]
|
|
72
|
+
- Updated dependencies [58891a9]
|
|
73
|
+
- Updated dependencies [924bf18]
|
|
74
|
+
- Updated dependencies [21a4820]
|
|
75
|
+
- Updated dependencies [ffbb296]
|
|
76
|
+
- Updated dependencies [088c577]
|
|
77
|
+
- Updated dependencies [0cc417d]
|
|
78
|
+
- @iota/iota-sdk@1.11.0
|
|
79
|
+
|
|
3
80
|
## 0.6.2
|
|
4
81
|
|
|
5
82
|
### Patch Changes
|
package/dist/cjs/bcs.d.ts
CHANGED
|
@@ -1,38 +1,23 @@
|
|
|
1
|
-
export declare const KioskType: import("@iota/iota-sdk/bcs").
|
|
2
|
-
id: string
|
|
3
|
-
profits: string
|
|
4
|
-
owner: string
|
|
5
|
-
itemCount: number
|
|
6
|
-
},
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
itemId: string | Uint8Array;
|
|
21
|
-
minPrice: string | number | bigint;
|
|
22
|
-
}>;
|
|
23
|
-
export declare const TransferPolicyCreatedEvent: import("@iota/iota-sdk/bcs").BcsType<{
|
|
24
|
-
id: string;
|
|
25
|
-
}, {
|
|
26
|
-
id: string | Uint8Array;
|
|
27
|
-
}>;
|
|
28
|
-
export declare const TransferPolicyType: import("@iota/iota-sdk/bcs").BcsType<{
|
|
29
|
-
id: string;
|
|
30
|
-
balance: string;
|
|
31
|
-
rules: string[];
|
|
32
|
-
}, {
|
|
33
|
-
id: string | Uint8Array;
|
|
34
|
-
balance: string | number | bigint;
|
|
35
|
-
rules: Iterable<string> & {
|
|
1
|
+
export declare const KioskType: import("@iota/iota-sdk/bcs").BcsStruct<{
|
|
2
|
+
id: import("@iota/iota-sdk/bcs").BcsType<string, string | Uint8Array, "bytes[32]">;
|
|
3
|
+
profits: import("@iota/iota-sdk/bcs").BcsType<string, string | number | bigint, "u64">;
|
|
4
|
+
owner: import("@iota/iota-sdk/bcs").BcsType<string, string | Uint8Array, "bytes[32]">;
|
|
5
|
+
itemCount: import("@iota/iota-sdk/bcs").BcsType<number, number, "u32">;
|
|
6
|
+
}, string>;
|
|
7
|
+
export declare const KioskPurchaseCap: import("@iota/iota-sdk/bcs").BcsStruct<{
|
|
8
|
+
id: import("@iota/iota-sdk/bcs").BcsType<string, string | Uint8Array, "bytes[32]">;
|
|
9
|
+
kioskId: import("@iota/iota-sdk/bcs").BcsType<string, string | Uint8Array, "bytes[32]">;
|
|
10
|
+
itemId: import("@iota/iota-sdk/bcs").BcsType<string, string | Uint8Array, "bytes[32]">;
|
|
11
|
+
minPrice: import("@iota/iota-sdk/bcs").BcsType<string, string | number | bigint, "u64">;
|
|
12
|
+
}, string>;
|
|
13
|
+
export declare const TransferPolicyCreatedEvent: import("@iota/iota-sdk/bcs").BcsStruct<{
|
|
14
|
+
id: import("@iota/iota-sdk/bcs").BcsType<string, string | Uint8Array, "bytes[32]">;
|
|
15
|
+
}, string>;
|
|
16
|
+
export declare const TransferPolicyType: import("@iota/iota-sdk/bcs").BcsStruct<{
|
|
17
|
+
id: import("@iota/iota-sdk/bcs").BcsType<string, string | Uint8Array, "bytes[32]">;
|
|
18
|
+
balance: import("@iota/iota-sdk/bcs").BcsType<string, string | number | bigint, "u64">;
|
|
19
|
+
rules: import("@iota/iota-sdk/bcs").BcsType<string[], Iterable<string> & {
|
|
36
20
|
length: number;
|
|
37
|
-
}
|
|
38
|
-
}>;
|
|
21
|
+
}, string>;
|
|
22
|
+
}, string>;
|
|
23
|
+
//# sourceMappingURL=bcs.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bcs.d.ts","sourceRoot":"","sources":["../../src/bcs.ts"],"names":[],"mappings":"AAcA,eAAO,MAAM,SAAS;;;;;UAKpB,CAAC;AAGH,eAAO,MAAM,gBAAgB;;;;;UAK3B,CAAC;AAGH,eAAO,MAAM,0BAA0B;;UAErC,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;UAI7B,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"kiosk-client.d.ts","sourceRoot":"","sources":["../../../src/client/kiosk-client.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAEvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAG7E,OAAO,KAAK,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAO9E,OAAO,KAAK,EACR,iBAAiB,EACjB,kBAAkB,EAClB,SAAS,EACT,WAAW,EACd,MAAM,mBAAmB,CAAC;AAE3B;;;;;GAKG;AACH,qBAAa,WAAW;IACpB,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,SAAS,CAAC;IACnB,KAAK,EAAE,kBAAkB,EAAE,CAAC;IAC5B,UAAU,CAAC,EAAE,kBAAkB,CAAC;gBAEpB,OAAO,EAAE,kBAAkB;IAavC;;;;;OAKG;IACG,cAAc,CAAC,EACjB,OAAO,EACP,UAAU,GACb,EAAE;QACC,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC;KAC5C,GAAG,OAAO,CAAC,WAAW,CAAC;IAcxB;;;;;OAKG;IACG,QAAQ,CAAC,EACX,EAAE,EACF,OAAO,GACV,EAAE;QACC,EAAE,EAAE,MAAM,CAAC;QACX,OAAO,CAAC,EAAE,iBAAiB,CAAC;KAC/B,GAAG,OAAO,CAAC,SAAS,CAAC;IAItB;;;;OAIG;IACG,iBAAiB,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;IAI5E;;;OAGG;IACG,mBAAmB,CAAC,EAAE,IAAI,EAAE,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;IAIpD;;;;OAIG;IACG,wBAAwB,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE;IAI/D;;;;OAIG;IACG,8BAA8B,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE;IAOzF,eAAe,CAAC,IAAI,EAAE,kBAAkB;IAMxC;;;OAGG;IACH,gBAAgB,CACZ,IAAI,EACE,wBAAwB,GACxB,sBAAsB,GACtB,4BAA4B,GAC5B,yBAAyB;CAgBtC"}
|
|
@@ -60,14 +60,7 @@ class KioskClient {
|
|
|
60
60
|
id,
|
|
61
61
|
options
|
|
62
62
|
}) {
|
|
63
|
-
return (await (0, import_kiosk.fetchKiosk)(
|
|
64
|
-
this.client,
|
|
65
|
-
id,
|
|
66
|
-
{
|
|
67
|
-
limit: 1e3
|
|
68
|
-
},
|
|
69
|
-
options || {}
|
|
70
|
-
)).data;
|
|
63
|
+
return (await (0, import_kiosk.fetchKiosk)(this.client, id, {}, options || {})).data;
|
|
71
64
|
}
|
|
72
65
|
/**
|
|
73
66
|
* Fetch the extension data (if any) for a kiosk, by type
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../src/client/kiosk-client.ts"],
|
|
4
|
-
"sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// Modifications Copyright (c) 2024 IOTA Stiftung\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { NetworkId } from '@iota/iota-sdk/client';\nimport { getNetwork } from '@iota/iota-sdk/client';\nimport type { PaginationArguments, IotaClient } from '@iota/iota-sdk/client';\n\nimport { getBaseRules, rules } from '../constants.js';\nimport type { BaseRulePackageIds, TransferPolicyRule } from '../constants.js';\nimport { fetchKiosk, fetchKioskExtension, getOwnedKiosks } from '../query/kiosk.js';\nimport {\n queryOwnedTransferPolicies,\n queryTransferPolicy,\n queryTransferPolicyCapsByType,\n} from '../query/transfer-policy.js';\nimport type {\n FetchKioskOptions,\n KioskClientOptions,\n KioskData,\n OwnedKiosks,\n} from '../types/index.js';\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 client: IotaClient;\n network: NetworkId;\n rules: TransferPolicyRule[];\n packageIds?: BaseRulePackageIds;\n\n constructor(options: KioskClientOptions) {\n this.client = options.client;\n this.network = options.network;\n this.rules = rules; // add all the default rules.\n this.packageIds = options.packageIds;\n\n // Add the custom Package Ids too on the rule list.\n // Only adds the rules that are passed in the packageId object.\n if (options.packageIds) this.rules.push(...getBaseRules(options.packageIds));\n }\n\n /// Querying\n\n /**\n * Get an addresses's owned kiosks.\n * @param address The address for which we want to retrieve the kiosks.\n * @param pagination Optional pagination arguments.\n * @returns An Object containing all the `kioskOwnerCap` objects as well as the kioskIds.\n */\n async getOwnedKiosks({\n address,\n pagination,\n }: {\n address: string;\n pagination?: PaginationArguments<string>;\n }): Promise<OwnedKiosks> {\n const personalPackageId =\n this.packageIds?.personalKioskRulePackageId ||\n getNetwork(this.network).kiosk?.personalKioskRulePackageId ||\n '';\n\n return getOwnedKiosks(this.client, address, {\n pagination,\n personalKioskType: personalPackageId\n ? `${personalPackageId}::personal_kiosk::PersonalKioskCap`\n : '',\n });\n }\n\n /**\n * Fetches the kiosk contents.\n * @param id The ID of the kiosk to fetch.\n * @param options Optional to control the fetch behavior.\n * @returns\n */\n async getKiosk({\n id,\n options,\n }: {\n id: string;\n options?: FetchKioskOptions;\n }): Promise<KioskData> {\n return (
|
|
5
|
-
"mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAKA,oBAA2B;AAG3B,uBAAoC;AAEpC,mBAAgE;AAChE,6BAIO;AAcA,MAAM,YAAY;AAAA,EAMrB,YAAY,SAA6B;AACrC,SAAK,SAAS,QAAQ;AACtB,SAAK,UAAU,QAAQ;AACvB,SAAK,QAAQ;AACb,SAAK,aAAa,QAAQ;AAI1B,QAAI,QAAQ,WAAY,MAAK,MAAM,KAAK,OAAG,+BAAa,QAAQ,UAAU,CAAC;AAAA,EAC/E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,eAAe;AAAA,IACjB;AAAA,IACA;AAAA,EACJ,GAGyB;AACrB,UAAM,oBACF,KAAK,YAAY,kCACjB,0BAAW,KAAK,OAAO,EAAE,OAAO,8BAChC;AAEJ,eAAO,6BAAe,KAAK,QAAQ,SAAS;AAAA,MACxC;AAAA,MACA,mBAAmB,oBACb,GAAG,iBAAiB,uCACpB;AAAA,IACV,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,SAAS;AAAA,IACX;AAAA,IACA;AAAA,EACJ,GAGuB;AACnB,
|
|
4
|
+
"sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// Modifications Copyright (c) 2024 IOTA Stiftung\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { NetworkId } from '@iota/iota-sdk/client';\nimport { getNetwork } from '@iota/iota-sdk/client';\nimport type { PaginationArguments, IotaClient } from '@iota/iota-sdk/client';\n\nimport { getBaseRules, rules } from '../constants.js';\nimport type { BaseRulePackageIds, TransferPolicyRule } from '../constants.js';\nimport { fetchKiosk, fetchKioskExtension, getOwnedKiosks } from '../query/kiosk.js';\nimport {\n queryOwnedTransferPolicies,\n queryTransferPolicy,\n queryTransferPolicyCapsByType,\n} from '../query/transfer-policy.js';\nimport type {\n FetchKioskOptions,\n KioskClientOptions,\n KioskData,\n OwnedKiosks,\n} from '../types/index.js';\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 client: IotaClient;\n network: NetworkId;\n rules: TransferPolicyRule[];\n packageIds?: BaseRulePackageIds;\n\n constructor(options: KioskClientOptions) {\n this.client = options.client;\n this.network = options.network;\n this.rules = rules; // add all the default rules.\n this.packageIds = options.packageIds;\n\n // Add the custom Package Ids too on the rule list.\n // Only adds the rules that are passed in the packageId object.\n if (options.packageIds) this.rules.push(...getBaseRules(options.packageIds));\n }\n\n /// Querying\n\n /**\n * Get an addresses's owned kiosks.\n * @param address The address for which we want to retrieve the kiosks.\n * @param pagination Optional pagination arguments.\n * @returns An Object containing all the `kioskOwnerCap` objects as well as the kioskIds.\n */\n async getOwnedKiosks({\n address,\n pagination,\n }: {\n address: string;\n pagination?: PaginationArguments<string>;\n }): Promise<OwnedKiosks> {\n const personalPackageId =\n this.packageIds?.personalKioskRulePackageId ||\n getNetwork(this.network).kiosk?.personalKioskRulePackageId ||\n '';\n\n return getOwnedKiosks(this.client, address, {\n pagination,\n personalKioskType: personalPackageId\n ? `${personalPackageId}::personal_kiosk::PersonalKioskCap`\n : '',\n });\n }\n\n /**\n * Fetches the kiosk contents.\n * @param id The ID of the kiosk to fetch.\n * @param options Optional to control the fetch behavior.\n * @returns\n */\n async getKiosk({\n id,\n options,\n }: {\n id: string;\n options?: FetchKioskOptions;\n }): Promise<KioskData> {\n return (await fetchKiosk(this.client, id, {}, options || {})).data;\n }\n\n /**\n * Fetch the extension data (if any) for a kiosk, by type\n * @param kioskId The ID of the kiosk to lookup\n * @param extensionType The Type of the extension (can be used from by using the type returned by `getKiosk()`)\n */\n async getKioskExtension({ kioskId, type }: { kioskId: string; type: string }) {\n return fetchKioskExtension(this.client, kioskId, type);\n }\n\n /**\n * Query the Transfer Policy(ies) for type `T`.\n * @param type The Type we're querying for (E.g `0xMyAddress::hero::Hero`)\n */\n async getTransferPolicies({ type }: { type: string }) {\n return queryTransferPolicy(this.client, type);\n }\n\n /**\n * Query all the owned transfer policies for an address.\n * Returns `TransferPolicyCap` which includes `policyId, policyCapId, type`.\n * @param address The address we're searching the owned transfer policies for.\n */\n async getOwnedTransferPolicies({ address }: { address: string }) {\n return queryOwnedTransferPolicies(this.client, address);\n }\n\n /**\n * Query the Transfer Policy Cap for type `T`, owned by `address`\n * @param type The Type `T` for the object\n * @param address The address that owns the cap.\n */\n async getOwnedTransferPoliciesByType({ type, address }: { type: string; address: string }) {\n return queryTransferPolicyCapsByType(this.client, address, type);\n }\n\n // Someone would just have to create a `kiosk-client.ts` file in their project, initialize a KioskClient\n // and call the `addRuleResolver` function. Each rule has a `resolve` function.\n // The resolve function is automatically called on `purchaseAndResolve` function call.\n addRuleResolver(rule: TransferPolicyRule) {\n if (this.rules.find((x) => x.rule === rule.rule))\n throw new Error(`Rule ${rule.rule} resolver already exists.`);\n this.rules.push(rule);\n }\n\n /**\n * A convenient helper to get the packageIds for our supported ruleset,\n * based on `kioskClient` configuration.\n */\n getRulePackageId(\n rule:\n | 'kioskLockRulePackageId'\n | 'royaltyRulePackageId'\n | 'personalKioskRulePackageId'\n | 'floorPriceRulePackageId',\n ) {\n const rules = this.packageIds || {};\n const network = this.network;\n\n const networkKiosk = getNetwork(network).kiosk;\n\n const rulePackageId = rules[rule] || networkKiosk?.[rule];\n\n /// Check existence of rule throw an error if it's not found.\n if (!rulePackageId) {\n throw new Error(`Missing packageId for rule ${rule}`);\n }\n\n return rulePackageId;\n }\n}\n"],
|
|
5
|
+
"mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAKA,oBAA2B;AAG3B,uBAAoC;AAEpC,mBAAgE;AAChE,6BAIO;AAcA,MAAM,YAAY;AAAA,EAMrB,YAAY,SAA6B;AACrC,SAAK,SAAS,QAAQ;AACtB,SAAK,UAAU,QAAQ;AACvB,SAAK,QAAQ;AACb,SAAK,aAAa,QAAQ;AAI1B,QAAI,QAAQ,WAAY,MAAK,MAAM,KAAK,OAAG,+BAAa,QAAQ,UAAU,CAAC;AAAA,EAC/E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,eAAe;AAAA,IACjB;AAAA,IACA;AAAA,EACJ,GAGyB;AACrB,UAAM,oBACF,KAAK,YAAY,kCACjB,0BAAW,KAAK,OAAO,EAAE,OAAO,8BAChC;AAEJ,eAAO,6BAAe,KAAK,QAAQ,SAAS;AAAA,MACxC;AAAA,MACA,mBAAmB,oBACb,GAAG,iBAAiB,uCACpB;AAAA,IACV,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,SAAS;AAAA,IACX;AAAA,IACA;AAAA,EACJ,GAGuB;AACnB,YAAQ,UAAM,yBAAW,KAAK,QAAQ,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC,GAAG;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,kBAAkB,EAAE,SAAS,KAAK,GAAsC;AAC1E,eAAO,kCAAoB,KAAK,QAAQ,SAAS,IAAI;AAAA,EACzD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,oBAAoB,EAAE,KAAK,GAAqB;AAClD,eAAO,4CAAoB,KAAK,QAAQ,IAAI;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,yBAAyB,EAAE,QAAQ,GAAwB;AAC7D,eAAO,mDAA2B,KAAK,QAAQ,OAAO;AAAA,EAC1D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,+BAA+B,EAAE,MAAM,QAAQ,GAAsC;AACvF,eAAO,sDAA8B,KAAK,QAAQ,SAAS,IAAI;AAAA,EACnE;AAAA;AAAA;AAAA;AAAA,EAKA,gBAAgB,MAA0B;AACtC,QAAI,KAAK,MAAM,KAAK,CAAC,MAAM,EAAE,SAAS,KAAK,IAAI;AAC3C,YAAM,IAAI,MAAM,QAAQ,KAAK,IAAI,2BAA2B;AAChE,SAAK,MAAM,KAAK,IAAI;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,iBACI,MAKF;AACE,UAAMA,SAAQ,KAAK,cAAc,CAAC;AAClC,UAAM,UAAU,KAAK;AAErB,UAAM,mBAAe,0BAAW,OAAO,EAAE;AAEzC,UAAM,gBAAgBA,OAAM,IAAI,KAAK,eAAe,IAAI;AAGxD,QAAI,CAAC,eAAe;AAChB,YAAM,IAAI,MAAM,8BAA8B,IAAI,EAAE;AAAA,IACxD;AAEA,WAAO;AAAA,EACX;AACJ;",
|
|
6
6
|
"names": ["rules"]
|
|
7
7
|
}
|
|
@@ -4,8 +4,6 @@ import type { KioskClient } from './kiosk-client.js';
|
|
|
4
4
|
export type KioskTransactionParams = {
|
|
5
5
|
/** The Transaction for this run */
|
|
6
6
|
transaction: Transaction;
|
|
7
|
-
/** @deprecated use transaction instead */
|
|
8
|
-
transactionBlock?: Transaction;
|
|
9
7
|
/**
|
|
10
8
|
* You can create a new KioskClient by calling `new KioskClient()`
|
|
11
9
|
*/
|
|
@@ -26,7 +24,7 @@ export declare class KioskTransaction {
|
|
|
26
24
|
kioskClient: KioskClient;
|
|
27
25
|
kiosk?: TransactionObjectArgument;
|
|
28
26
|
kioskCap?: TransactionObjectArgument;
|
|
29
|
-
constructor({
|
|
27
|
+
constructor({ transaction, kioskClient, cap }: KioskTransactionParams);
|
|
30
28
|
/**
|
|
31
29
|
* Creates a kiosk and saves `kiosk` and `kioskOwnerCap` in state.
|
|
32
30
|
* Helpful if we want to chain some actions before sharing + transferring the cap to the specified address.
|
|
@@ -47,20 +45,20 @@ export declare class KioskTransaction {
|
|
|
47
45
|
/**
|
|
48
46
|
* Single function way to create a kiosk, share it and transfer the cap to the specified address.
|
|
49
47
|
*/
|
|
50
|
-
createAndShare(address: string):
|
|
48
|
+
createAndShare(address: string): this;
|
|
51
49
|
/**
|
|
52
50
|
* Shares the kiosk.
|
|
53
51
|
*/
|
|
54
|
-
share():
|
|
52
|
+
share(): this;
|
|
55
53
|
/**
|
|
56
54
|
* Should be called only after `create` is called.
|
|
57
55
|
* It shares the kiosk & transfers the cap to the specified address.
|
|
58
56
|
*/
|
|
59
|
-
shareAndTransferCap(address: string):
|
|
57
|
+
shareAndTransferCap(address: string): this;
|
|
60
58
|
/**
|
|
61
59
|
* A function to borrow an item from a kiosk & execute any function with it.
|
|
62
60
|
*/
|
|
63
|
-
borrowTx({ itemType, itemId }: ItemId, callback: (item: TransactionArgument) => void):
|
|
61
|
+
borrowTx({ itemType, itemId }: ItemId, callback: (item: TransactionArgument) => void): this;
|
|
64
62
|
/**
|
|
65
63
|
* Borrows an item from the kiosk.
|
|
66
64
|
* This will fail if the item is listed for sale.
|
|
@@ -183,3 +181,4 @@ export declare class KioskTransaction {
|
|
|
183
181
|
getKiosk(): TransactionObjectArgument;
|
|
184
182
|
getKioskCap(): TransactionObjectArgument;
|
|
185
183
|
}
|
|
184
|
+
//# sourceMappingURL=kiosk-transaction.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"kiosk-transaction.d.ts","sourceRoot":"","sources":["../../../src/client/kiosk-transaction.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACR,WAAW,EACX,mBAAmB,EACnB,yBAAyB,EAC5B,MAAM,6BAA6B,CAAC;AAKrC,OAAO,KAAK,EACR,MAAM,EACN,aAAa,EACb,SAAS,EACT,aAAa,EACb,cAAc,EACd,KAAK,EACL,eAAe,EAClB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD,MAAM,MAAM,sBAAsB,GAAG;IACjC,mCAAmC;IACnC,WAAW,EAAE,WAAW,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB;;;;OAIG;IACH,GAAG,CAAC,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,qBAAa,gBAAgB;;IACzB,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,CAAC,EAAE,yBAAyB,CAAC;IAClC,QAAQ,CAAC,EAAE,yBAAyB,CAAC;gBAYzB,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,EAAE,EAAE,sBAAsB;IAOrE;;;;OAIG;IACH,MAAM;IAYN;;;;OAIG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,OAAO;IAK/B;;;OAGG;IACH,iBAAiB,CAAC,MAAM,CAAC,EAAE,OAAO;IAkBlC;;OAEG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM;IAO9B;;OAEG;IACH,KAAK;IAOL;;;OAGG;IACH,mBAAmB,CAAC,OAAO,EAAE,MAAM;IASnC;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,mBAAmB,KAAK,IAAI;IAepF;;;;;OAKG;IACH,MAAM,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,MAAM,GAAG,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAahF;;;OAGG;IACH,MAAM,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,SAAS,GAAG;QAAE,OAAO,EAAE,mBAAmB,CAAA;KAAE;IAMhF;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;IAY3D;;;;OAIG;IACH,KAAK,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,aAAa;IAMvC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,aAAa,GAAG,KAAK;IAM7D;;;;;OAKG;IACH,IAAI,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,MAAM,GAAG;QAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE;IAMrE;;;;OAIG;IACH,MAAM,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,MAAM;IAMnC;;;;;OAKA;IACA,IAAI,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,MAAM,GAAG,yBAAyB;IAK7D;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,MAAM,GAAG;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE;IAOpE;;;;;;;OAOA;IACA,IAAI,CAAC,EACD,QAAQ,EACR,IAAI,EACJ,MAAM,EACN,MAAM,GACT,EAAE,aAAa,GAAG;QAAE,MAAM,EAAE,cAAc,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;IAa9D;;;;;;;;OAQG;IACH,QAAQ,CAAC,EACL,QAAQ,EACR,MAAM,EACN,KAAK,EACL,WAAW,GACd,EAAE,MAAM,GAAG,KAAK,GAAG;QAAE,WAAW,EAAE,cAAc,CAAA;KAAE,GAAG;QAClD,yBAAyB;QACzB,yBAAyB;KAC5B;IAQD;;;;;;;;;OASG;IACG,kBAAkB,CAAC,EACrB,QAAQ,EACR,MAAM,EACN,KAAK,EACL,WAAW,EACX,SAAS,GACZ,EAAE,MAAM,GAAG,KAAK,GAAG;QAAE,WAAW,EAAE,cAAc,CAAA;KAAE,GAAG,eAAe;IAuDrE;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,aAAa;IAWzB;;;;OAIG;IACH,QAAQ;IAsCR,WAAW,CAAC,GAAG,EAAE,yBAAyB;IAM1C,QAAQ,CAAC,KAAK,EAAE,yBAAyB;IAUzC,QAAQ;IASR,WAAW;CA2Cd"}
|
|
@@ -45,12 +45,7 @@ var import_transfer_policy = require("../tx/transfer-policy.js");
|
|
|
45
45
|
var import_utils = require("../utils.js");
|
|
46
46
|
var _pendingShare, _pendingTransfer, _promise, _personalCap, _finalized, _KioskTransaction_instances, borrowFromPersonalCap_fn, setPendingStatuses_fn, validateKioskIsSet_fn, validateFinalizedStatus_fn;
|
|
47
47
|
class KioskTransaction {
|
|
48
|
-
constructor({
|
|
49
|
-
transactionBlock,
|
|
50
|
-
transaction = transactionBlock,
|
|
51
|
-
kioskClient,
|
|
52
|
-
cap
|
|
53
|
-
}) {
|
|
48
|
+
constructor({ transaction, kioskClient, cap }) {
|
|
54
49
|
__privateAdd(this, _KioskTransaction_instances);
|
|
55
50
|
// If we're pending `share` of a new kiosk, `finalize()` will share it.
|
|
56
51
|
__privateAdd(this, _pendingShare);
|
|
@@ -115,6 +110,7 @@ class KioskTransaction {
|
|
|
115
110
|
__privateMethod(this, _KioskTransaction_instances, validateFinalizedStatus_fn).call(this);
|
|
116
111
|
const cap = kioskTx.createKioskAndShare(this.transaction);
|
|
117
112
|
this.transaction.transferObjects([cap], this.transaction.pure.address(address));
|
|
113
|
+
return this;
|
|
118
114
|
}
|
|
119
115
|
/**
|
|
120
116
|
* Shares the kiosk.
|
|
@@ -123,6 +119,7 @@ class KioskTransaction {
|
|
|
123
119
|
__privateMethod(this, _KioskTransaction_instances, validateKioskIsSet_fn).call(this);
|
|
124
120
|
__privateMethod(this, _KioskTransaction_instances, setPendingStatuses_fn).call(this, { share: false });
|
|
125
121
|
kioskTx.shareKiosk(this.transaction, this.kiosk);
|
|
122
|
+
return this;
|
|
126
123
|
}
|
|
127
124
|
/**
|
|
128
125
|
* Should be called only after `create` is called.
|
|
@@ -134,6 +131,7 @@ class KioskTransaction {
|
|
|
134
131
|
__privateMethod(this, _KioskTransaction_instances, setPendingStatuses_fn).call(this, { transfer: false });
|
|
135
132
|
this.share();
|
|
136
133
|
this.transaction.transferObjects([this.kioskCap], this.transaction.pure.address(address));
|
|
134
|
+
return this;
|
|
137
135
|
}
|
|
138
136
|
/**
|
|
139
137
|
* A function to borrow an item from a kiosk & execute any function with it.
|
|
@@ -148,7 +146,7 @@ class KioskTransaction {
|
|
|
148
146
|
itemId
|
|
149
147
|
);
|
|
150
148
|
callback(itemObj);
|
|
151
|
-
this.return({ itemType, item: itemObj, promise });
|
|
149
|
+
return this.return({ itemType, item: itemObj, promise });
|
|
152
150
|
}
|
|
153
151
|
/**
|
|
154
152
|
* Borrows an item from the kiosk.
|
|
@@ -340,9 +338,8 @@ class KioskTransaction {
|
|
|
340
338
|
);
|
|
341
339
|
if (!ruleDefinition) throw new Error(`No resolver for the following rule: ${rule}.`);
|
|
342
340
|
if (ruleDefinition.hasLockingRule) canTransferOutsideKiosk = false;
|
|
343
|
-
ruleDefinition.resolveRuleFunction({
|
|
341
|
+
await ruleDefinition.resolveRuleFunction({
|
|
344
342
|
packageId: ruleDefinition.packageId,
|
|
345
|
-
transactionBlock: this.transaction,
|
|
346
343
|
transaction: this.transaction,
|
|
347
344
|
itemType,
|
|
348
345
|
itemId,
|
|
@@ -353,7 +350,8 @@ class KioskTransaction {
|
|
|
353
350
|
purchasedItem,
|
|
354
351
|
kiosk: this.kiosk,
|
|
355
352
|
kioskCap: this.kioskCap,
|
|
356
|
-
extraArgs: extraArgs || {}
|
|
353
|
+
extraArgs: extraArgs || {},
|
|
354
|
+
kioskClient: this.kioskClient
|
|
357
355
|
});
|
|
358
356
|
}
|
|
359
357
|
(0, import_transfer_policy.confirmRequest)(this.transaction, itemType, policy.id, transferRequest);
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../src/client/kiosk-transaction.ts"],
|
|
4
|
-
"sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// Modifications Copyright (c) 2024 IOTA Stiftung\n// SPDX-License-Identifier: Apache-2.0\n\nimport type {\n Transaction,\n TransactionArgument,\n TransactionObjectArgument,\n} from '@iota/iota-sdk/transactions';\n\nimport * as kioskTx from '../tx/kiosk.js';\nimport { convertToPersonalTx, transferPersonalCapTx } from '../tx/personal-kiosk.js';\nimport { confirmRequest } from '../tx/transfer-policy.js';\nimport type {\n ItemId,\n ItemReference,\n ItemValue,\n KioskOwnerCap,\n ObjectArgument,\n Price,\n PurchaseOptions,\n} from '../types/index.js';\nimport { getNormalizedRuleType } from '../utils.js';\nimport type { KioskClient } from './kiosk-client.js';\n\nexport type KioskTransactionParams = {\n /** The Transaction for this run */\n transaction: Transaction;\n\n /** @deprecated use transaction instead */\n transactionBlock?: Transaction;\n /**\n * You can create a new KioskClient by calling `new KioskClient()`\n */\n kioskClient: KioskClient;\n /**\n * You can optionally pass in the `cap` as returned\n * from `kioskClient.getOwnedKiosks` when initializing the client\n * Otherwise, you can set it by calling `kioskTransaction.setCap()`\n */\n cap?: KioskOwnerCap;\n};\n\n/**\n * A helper for building transactions that involve kiosk.\n */\nexport class KioskTransaction {\n transaction: Transaction;\n kioskClient: KioskClient;\n kiosk?: TransactionObjectArgument;\n kioskCap?: TransactionObjectArgument;\n // If we're pending `share` of a new kiosk, `finalize()` will share it.\n #pendingShare?: boolean;\n // If we're pending transferring of the cap, `finalize()` will either error or transfer the cap if it's a new personal.\n #pendingTransfer?: boolean;\n // The promise that the personalCap will be returned on `finalize()`.\n #promise?: TransactionArgument | undefined;\n // The personal kiosk argument.\n #personalCap?: TransactionObjectArgument;\n // A flag that checks whether kiosk TX is finalized.\n #finalized: boolean = false;\n\n constructor({\n transactionBlock,\n transaction = transactionBlock!,\n kioskClient,\n cap,\n }: KioskTransactionParams) {\n this.transaction = transaction;\n this.kioskClient = kioskClient;\n\n if (cap) this.setCap(cap);\n }\n\n /**\n * Creates a kiosk and saves `kiosk` and `kioskOwnerCap` in state.\n * Helpful if we want to chain some actions before sharing + transferring the cap to the specified address.\n * @param borrow If true, the `kioskOwnerCap` is borrowed from the `PersonalKioskCap` to be used in next transactions.\n */\n create() {\n this.#validateFinalizedStatus();\n this.#setPendingStatuses({\n share: true,\n transfer: true,\n });\n const [kiosk, cap] = kioskTx.createKiosk(this.transaction);\n this.kiosk = kiosk;\n this.kioskCap = cap;\n return this;\n }\n\n /**\n * Creates a personal kiosk & shares it.\n * The `PersonalKioskCap` is transferred to the signer.\n * @param borrow If true, the `kioskOwnerCap` is borrowed from the `PersonalKioskCap` to be used in next transactions.\n */\n createPersonal(borrow?: boolean) {\n this.#pendingShare = true;\n return this.create().convertToPersonal(borrow);\n }\n\n /**\n * Converts a kiosk to a Personal (Soulbound) Kiosk.\n * Requires initialization by either calling `ktxb.create()` or `ktxb.setCap()`.\n */\n convertToPersonal(borrow?: boolean) {\n this.#validateKioskIsSet();\n\n const cap = convertToPersonalTx(\n this.transaction,\n this.kiosk!,\n this.kioskCap!,\n this.kioskClient.getRulePackageId('personalKioskRulePackageId'),\n );\n\n // if we enable `borrow`, we borrow the kioskCap from the cap.\n if (borrow) this.#borrowFromPersonalCap(cap);\n else this.#personalCap = cap;\n\n this.#setPendingStatuses({ transfer: true });\n return this;\n }\n\n /**\n * Single function way to create a kiosk, share it and transfer the cap to the specified address.\n */\n createAndShare(address: string) {\n this.#validateFinalizedStatus();\n const cap = kioskTx.createKioskAndShare(this.transaction);\n this.transaction.transferObjects([cap], this.transaction.pure.address(address));\n }\n\n /**\n * Shares the kiosk.\n */\n share() {\n this.#validateKioskIsSet();\n this.#setPendingStatuses({ share: false });\n kioskTx.shareKiosk(this.transaction, this.kiosk!);\n }\n\n /**\n * Should be called only after `create` is called.\n * It shares the kiosk & transfers the cap to the specified address.\n */\n shareAndTransferCap(address: string) {\n if (this.#personalCap)\n throw new Error('You can only call `shareAndTransferCap` on a non-personal kiosk.');\n this.#setPendingStatuses({ transfer: false });\n this.share();\n this.transaction.transferObjects([this.kioskCap!], this.transaction.pure.address(address));\n }\n\n /**\n * A function to borrow an item from a kiosk & execute any function with it.\n */\n borrowTx({ itemType, itemId }: ItemId, callback: (item: TransactionArgument) => void) {\n this.#validateKioskIsSet();\n const [itemObj, promise] = kioskTx.borrowValue(\n this.transaction,\n itemType,\n this.kiosk!,\n this.kioskCap!,\n itemId,\n );\n\n callback(itemObj);\n\n this.return({ itemType, item: itemObj, promise });\n }\n\n /**\n * Borrows an item from the kiosk.\n * This will fail if the item is listed for sale.\n *\n * Requires calling `return`.\n */\n borrow({ itemType, itemId }: ItemId): [TransactionArgument, TransactionArgument] {\n this.#validateKioskIsSet();\n const [itemObj, promise] = kioskTx.borrowValue(\n this.transaction,\n itemType,\n this.kiosk!,\n this.kioskCap!,\n itemId,\n );\n\n return [itemObj, promise];\n }\n\n /**\n * Returns the item back to the kiosk.\n * Accepts the parameters returned from the `borrow` function.\n */\n return({ itemType, item, promise }: ItemValue & { promise: TransactionArgument }) {\n this.#validateKioskIsSet();\n kioskTx.returnValue(this.transaction, itemType, this.kiosk!, item, promise);\n return this;\n }\n\n /**\n * A function to withdraw from kiosk\n * @param address Where to transfer the coin.\n * @param amount The amount we aim to withdraw.\n */\n withdraw(address: string, amount?: string | bigint | number) {\n this.#validateKioskIsSet();\n const coin = kioskTx.withdrawFromKiosk(\n this.transaction,\n this.kiosk!,\n this.kioskCap!,\n amount,\n );\n this.transaction.transferObjects([coin], this.transaction.pure.address(address));\n return this;\n }\n\n /**\n * A function to place an item in the kiosk.\n * @param itemType The type `T` of the item\n * @param item The ID or Transaction Argument of the item\n */\n place({ itemType, item }: ItemReference) {\n this.#validateKioskIsSet();\n kioskTx.place(this.transaction, itemType, this.kiosk!, this.kioskCap!, item);\n return this;\n }\n\n /**\n * A function to place an item in the kiosk and list it for sale in one transaction.\n * @param itemType The type `T` of the item\n * @param item The ID or Transaction Argument of the item\n * @param price The price in NANOS\n */\n placeAndList({ itemType, item, price }: ItemReference & Price) {\n this.#validateKioskIsSet();\n kioskTx.placeAndList(this.transaction, itemType, this.kiosk!, this.kioskCap!, item, price);\n return this;\n }\n\n /**\n * A function to list an item in the kiosk.\n * @param itemType The type `T` of the item\n * @param itemId The ID of the item\n * @param price The price in NANOS\n */\n list({ itemType, itemId, price }: ItemId & { price: string | bigint }) {\n this.#validateKioskIsSet();\n kioskTx.list(this.transaction, itemType, this.kiosk!, this.kioskCap!, itemId, price);\n return this;\n }\n\n /**\n * A function to delist an item from the kiosk.\n * @param itemType The type `T` of the item\n * @param itemId The ID of the item\n */\n delist({ itemType, itemId }: ItemId) {\n this.#validateKioskIsSet();\n kioskTx.delist(this.transaction, itemType, this.kiosk!, this.kioskCap!, itemId);\n return this;\n }\n\n /**\n\t * A function to take an item from the kiosk. The transaction won't succeed if the item is listed or locked.\n\n\t * @param itemType The type `T` of the item\n\t * @param itemId The ID of the item\n\t */\n take({ itemType, itemId }: ItemId): TransactionObjectArgument {\n this.#validateKioskIsSet();\n return kioskTx.take(this.transaction, itemType, this.kiosk!, this.kioskCap!, itemId);\n }\n\n /**\n * Transfer a non-locked/non-listed item to an address.\n *\n * @param itemType The type `T` of the item\n * @param itemId The ID of the item\n * @param address The destination address\n */\n transfer({ itemType, itemId, address }: ItemId & { address: string }) {\n this.#validateKioskIsSet();\n const item = this.take({ itemType, itemId });\n this.transaction.transferObjects([item], this.transaction.pure.address(address));\n return this;\n }\n\n /**\n\t * A function to take lock an item in the kiosk.\n\n\t * @param itemType The type `T` of the item\n\t * @param item The ID or Transaction Argument of the item\n\t * @param itemId The ID of the item - Deprecated: Use `item` instead.\n\t * @param policy The Policy ID or Transaction Argument for item T\n\t */\n lock({\n itemType,\n item,\n itemId,\n policy,\n }: ItemReference & { policy: ObjectArgument; itemId?: string }) {\n this.#validateKioskIsSet();\n kioskTx.lock(\n this.transaction,\n itemType,\n this.kiosk!,\n this.kioskCap!,\n policy,\n itemId ?? item,\n );\n return this;\n }\n\n /**\n * Purchase an item from a seller's kiosk.\n * Returns [item, transferRequest]\n * Can be called like: `const [item, transferRequest] = kioskTx.purchase({...})`\n * @param itemType The type `T` of the item\n * @param itemId The ID of the item\n * @param price The price in NANOS\n * @param sellerKiosk The kiosk which is selling the item. Can be an id or an object argument.\n */\n purchase({\n itemType,\n itemId,\n price,\n sellerKiosk,\n }: ItemId & Price & { sellerKiosk: ObjectArgument }): [\n TransactionObjectArgument,\n TransactionObjectArgument,\n ] {\n // Split the coin for the amount of the listing.\n const coin = this.transaction.splitCoins(this.transaction.gas, [\n this.transaction.pure.u64(price),\n ]);\n return kioskTx.purchase(this.transaction, itemType, sellerKiosk, itemId, coin);\n }\n\n /**\n * A function to purchase and resolve a transfer policy.\n * If the transfer policy has the `lock` rule, the item is locked in the kiosk.\n * Otherwise, the item is placed in the kiosk.\n * @param itemType The type of the item\n * @param itemId The id of the item\n * @param price The price of the specified item\n * @param sellerKiosk The kiosk which is selling the item. Can be an id or an object argument.\n * @param extraArgs Used to pass arguments for custom rule resolvers.\n */\n async purchaseAndResolve({\n itemType,\n itemId,\n price,\n sellerKiosk,\n extraArgs,\n }: ItemId & Price & { sellerKiosk: ObjectArgument } & PurchaseOptions) {\n this.#validateKioskIsSet();\n // Get a list of the transfer policies.\n const policies = await this.kioskClient.getTransferPolicies({ type: itemType });\n\n if (policies.length === 0) {\n throw new Error(\n `The type ${itemType} doesn't have a Transfer Policy so it can't be traded through kiosk.`,\n );\n }\n\n const policy = policies[0]; // we now pick the first one. We need to add an option to define which one.\n\n // initialize the purchase `kiosk::purchase`\n const [purchasedItem, transferRequest] = this.purchase({\n itemType,\n itemId,\n price,\n sellerKiosk,\n });\n\n let canTransferOutsideKiosk = true;\n\n for (const rule of policy.rules) {\n const ruleDefinition = this.kioskClient.rules.find(\n (x) => getNormalizedRuleType(x.rule) === getNormalizedRuleType(rule),\n );\n if (!ruleDefinition) throw new Error(`No resolver for the following rule: ${rule}.`);\n\n if (ruleDefinition.hasLockingRule) canTransferOutsideKiosk = false;\n\n ruleDefinition.resolveRuleFunction({\n packageId: ruleDefinition.packageId,\n transactionBlock: this.transaction,\n transaction: this.transaction,\n itemType,\n itemId,\n price: price.toString(),\n sellerKiosk,\n policyId: policy.id,\n transferRequest,\n purchasedItem,\n kiosk: this.kiosk!,\n kioskCap: this.kioskCap!,\n extraArgs: extraArgs || {},\n });\n }\n\n confirmRequest(this.transaction, itemType, policy.id, transferRequest);\n\n if (canTransferOutsideKiosk) this.place({ itemType, item: purchasedItem });\n\n return this;\n }\n\n /**\n * A function to setup the client using an existing `ownerCap`,\n * as return from the `kioskClient.getOwnedKiosks` function.\n * @param cap `KioskOwnerCap` object as returned from `getOwnedKiosks` SDK call.\n */\n setCap(cap: KioskOwnerCap) {\n this.#validateFinalizedStatus();\n this.kiosk = this.transaction.object(cap.kioskId);\n if (!cap.isPersonal) {\n this.kioskCap = this.transaction.object(cap.objectId);\n return;\n }\n\n return this.#borrowFromPersonalCap(cap.objectId);\n }\n\n /**\n *\tA function that ends up the kiosk building tx & returns the `kioskOwnerCap` back to the\n * `PersonalKioskCap`, in case we are operating on a personal kiosk.\n * \tIt will also share the `kiosk` if it's not shared, and finalize the transfer of the personal cap if it's pending.\n */\n finalize() {\n this.#validateKioskIsSet();\n // If we're pending the sharing of the new kiosk, share it.\n if (this.#pendingShare) this.share();\n\n // If we're operating on a non-personal kiosk, we don't need to do anything else.\n if (!this.#personalCap) {\n // If we're pending transfer though, we inform user to call `shareAndTransferCap()`.\n if (this.#pendingTransfer)\n throw new Error(\n 'You need to transfer the `kioskOwnerCap` by calling `shareAndTransferCap()` before wrap',\n );\n return;\n }\n\n const packageId = this.kioskClient.getRulePackageId('personalKioskRulePackageId');\n\n // if we have a promise, return the `ownerCap` back to the personal cap.\n if (this.#promise) {\n this.transaction.moveCall({\n target: `${packageId}::personal_kiosk::return_val`,\n arguments: [\n this.#personalCap,\n this.transaction.object(this.kioskCap!),\n this.#promise!,\n ],\n });\n }\n\n // If we are pending transferring the personalCap, we do it here.\n if (this.#pendingTransfer)\n transferPersonalCapTx(this.transaction, this.#personalCap, packageId);\n\n // Mark the transaction as finalized, so no other functions can be called.\n this.#finalized = true;\n }\n\n // Some setters in case we want custom behavior.\n setKioskCap(cap: TransactionObjectArgument) {\n this.#validateFinalizedStatus();\n this.kioskCap = cap;\n return this;\n }\n\n setKiosk(kiosk: TransactionObjectArgument) {\n this.#validateFinalizedStatus();\n this.kiosk = kiosk;\n return this;\n }\n\n // Some getters\n /*\n * Returns the active transaction's kiosk, or undefined if `setCap` or `create()` hasn't been called yet.\n */\n getKiosk() {\n this.#validateFinalizedStatus();\n if (!this.kiosk) throw new Error('Kiosk is not set.');\n return this.kiosk;\n }\n\n /*\n * Returns the active transaction's kioskOwnerCap, or undefined if `setCap` or `create()` hasn't been called yet.\n */\n getKioskCap() {\n this.#validateFinalizedStatus();\n if (!this.kioskCap) throw new Error('Kiosk cap is not set');\n return this.kioskCap;\n }\n\n /**\n * A function to borrow from `personalCap`.\n */\n #borrowFromPersonalCap(personalCap: ObjectArgument) {\n const [kioskCap, promise] = this.transaction.moveCall({\n target: `${this.kioskClient.getRulePackageId(\n 'personalKioskRulePackageId',\n )}::personal_kiosk::borrow_val`,\n arguments: [this.transaction.object(personalCap)],\n });\n\n this.kioskCap = kioskCap;\n this.#personalCap = this.transaction.object(personalCap);\n this.#promise = promise;\n\n return this;\n }\n\n #setPendingStatuses({ share, transfer }: { share?: boolean; transfer?: boolean }) {\n if (transfer !== undefined) this.#pendingTransfer = transfer;\n if (share !== undefined) this.#pendingShare = share;\n }\n\n #validateKioskIsSet() {\n this.#validateFinalizedStatus();\n\n if (!this.kiosk || !this.kioskCap)\n throw new Error(\n 'You need to initialize the client by either supplying an existing owner cap or by creating a new by calling `.create()`',\n );\n }\n\n // Validates that `finalize`\n #validateFinalizedStatus() {\n if (this.#finalized)\n throw new Error(\"You can't add more transactions to a finalized kiosk transaction.\");\n }\n}\n"],
|
|
5
|
-
"mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA,cAAyB;AACzB,4BAA2D;AAC3D,6BAA+B;AAU/B,mBAAsC;AAtBtC;
|
|
4
|
+
"sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// Modifications Copyright (c) 2024 IOTA Stiftung\n// SPDX-License-Identifier: Apache-2.0\n\nimport type {\n Transaction,\n TransactionArgument,\n TransactionObjectArgument,\n} from '@iota/iota-sdk/transactions';\n\nimport * as kioskTx from '../tx/kiosk.js';\nimport { convertToPersonalTx, transferPersonalCapTx } from '../tx/personal-kiosk.js';\nimport { confirmRequest } from '../tx/transfer-policy.js';\nimport type {\n ItemId,\n ItemReference,\n ItemValue,\n KioskOwnerCap,\n ObjectArgument,\n Price,\n PurchaseOptions,\n} from '../types/index.js';\nimport { getNormalizedRuleType } from '../utils.js';\nimport type { KioskClient } from './kiosk-client.js';\n\nexport type KioskTransactionParams = {\n /** The Transaction for this run */\n transaction: Transaction;\n\n /**\n * You can create a new KioskClient by calling `new KioskClient()`\n */\n kioskClient: KioskClient;\n /**\n * You can optionally pass in the `cap` as returned\n * from `kioskClient.getOwnedKiosks` when initializing the client\n * Otherwise, you can set it by calling `kioskTransaction.setCap()`\n */\n cap?: KioskOwnerCap;\n};\n\n/**\n * A helper for building transactions that involve kiosk.\n */\nexport class KioskTransaction {\n transaction: Transaction;\n kioskClient: KioskClient;\n kiosk?: TransactionObjectArgument;\n kioskCap?: TransactionObjectArgument;\n // If we're pending `share` of a new kiosk, `finalize()` will share it.\n #pendingShare?: boolean;\n // If we're pending transferring of the cap, `finalize()` will either error or transfer the cap if it's a new personal.\n #pendingTransfer?: boolean;\n // The promise that the personalCap will be returned on `finalize()`.\n #promise?: TransactionArgument | undefined;\n // The personal kiosk argument.\n #personalCap?: TransactionObjectArgument;\n // A flag that checks whether kiosk TX is finalized.\n #finalized: boolean = false;\n\n constructor({ transaction, kioskClient, cap }: KioskTransactionParams) {\n this.transaction = transaction;\n this.kioskClient = kioskClient;\n\n if (cap) this.setCap(cap);\n }\n\n /**\n * Creates a kiosk and saves `kiosk` and `kioskOwnerCap` in state.\n * Helpful if we want to chain some actions before sharing + transferring the cap to the specified address.\n * @param borrow If true, the `kioskOwnerCap` is borrowed from the `PersonalKioskCap` to be used in next transactions.\n */\n create() {\n this.#validateFinalizedStatus();\n this.#setPendingStatuses({\n share: true,\n transfer: true,\n });\n const [kiosk, cap] = kioskTx.createKiosk(this.transaction);\n this.kiosk = kiosk;\n this.kioskCap = cap;\n return this;\n }\n\n /**\n * Creates a personal kiosk & shares it.\n * The `PersonalKioskCap` is transferred to the signer.\n * @param borrow If true, the `kioskOwnerCap` is borrowed from the `PersonalKioskCap` to be used in next transactions.\n */\n createPersonal(borrow?: boolean) {\n this.#pendingShare = true;\n return this.create().convertToPersonal(borrow);\n }\n\n /**\n * Converts a kiosk to a Personal (Soulbound) Kiosk.\n * Requires initialization by either calling `ktxb.create()` or `ktxb.setCap()`.\n */\n convertToPersonal(borrow?: boolean) {\n this.#validateKioskIsSet();\n\n const cap = convertToPersonalTx(\n this.transaction,\n this.kiosk!,\n this.kioskCap!,\n this.kioskClient.getRulePackageId('personalKioskRulePackageId'),\n );\n\n // if we enable `borrow`, we borrow the kioskCap from the cap.\n if (borrow) this.#borrowFromPersonalCap(cap);\n else this.#personalCap = cap;\n\n this.#setPendingStatuses({ transfer: true });\n return this;\n }\n\n /**\n * Single function way to create a kiosk, share it and transfer the cap to the specified address.\n */\n createAndShare(address: string) {\n this.#validateFinalizedStatus();\n const cap = kioskTx.createKioskAndShare(this.transaction);\n this.transaction.transferObjects([cap], this.transaction.pure.address(address));\n return this;\n }\n\n /**\n * Shares the kiosk.\n */\n share() {\n this.#validateKioskIsSet();\n this.#setPendingStatuses({ share: false });\n kioskTx.shareKiosk(this.transaction, this.kiosk!);\n return this;\n }\n\n /**\n * Should be called only after `create` is called.\n * It shares the kiosk & transfers the cap to the specified address.\n */\n shareAndTransferCap(address: string) {\n if (this.#personalCap)\n throw new Error('You can only call `shareAndTransferCap` on a non-personal kiosk.');\n this.#setPendingStatuses({ transfer: false });\n this.share();\n this.transaction.transferObjects([this.kioskCap!], this.transaction.pure.address(address));\n return this;\n }\n\n /**\n * A function to borrow an item from a kiosk & execute any function with it.\n */\n borrowTx({ itemType, itemId }: ItemId, callback: (item: TransactionArgument) => void) {\n this.#validateKioskIsSet();\n const [itemObj, promise] = kioskTx.borrowValue(\n this.transaction,\n itemType,\n this.kiosk!,\n this.kioskCap!,\n itemId,\n );\n\n callback(itemObj);\n\n return this.return({ itemType, item: itemObj, promise });\n }\n\n /**\n * Borrows an item from the kiosk.\n * This will fail if the item is listed for sale.\n *\n * Requires calling `return`.\n */\n borrow({ itemType, itemId }: ItemId): [TransactionArgument, TransactionArgument] {\n this.#validateKioskIsSet();\n const [itemObj, promise] = kioskTx.borrowValue(\n this.transaction,\n itemType,\n this.kiosk!,\n this.kioskCap!,\n itemId,\n );\n\n return [itemObj, promise];\n }\n\n /**\n * Returns the item back to the kiosk.\n * Accepts the parameters returned from the `borrow` function.\n */\n return({ itemType, item, promise }: ItemValue & { promise: TransactionArgument }) {\n this.#validateKioskIsSet();\n kioskTx.returnValue(this.transaction, itemType, this.kiosk!, item, promise);\n return this;\n }\n\n /**\n * A function to withdraw from kiosk\n * @param address Where to transfer the coin.\n * @param amount The amount we aim to withdraw.\n */\n withdraw(address: string, amount?: string | bigint | number) {\n this.#validateKioskIsSet();\n const coin = kioskTx.withdrawFromKiosk(\n this.transaction,\n this.kiosk!,\n this.kioskCap!,\n amount,\n );\n this.transaction.transferObjects([coin], this.transaction.pure.address(address));\n return this;\n }\n\n /**\n * A function to place an item in the kiosk.\n * @param itemType The type `T` of the item\n * @param item The ID or Transaction Argument of the item\n */\n place({ itemType, item }: ItemReference) {\n this.#validateKioskIsSet();\n kioskTx.place(this.transaction, itemType, this.kiosk!, this.kioskCap!, item);\n return this;\n }\n\n /**\n * A function to place an item in the kiosk and list it for sale in one transaction.\n * @param itemType The type `T` of the item\n * @param item The ID or Transaction Argument of the item\n * @param price The price in NANOS\n */\n placeAndList({ itemType, item, price }: ItemReference & Price) {\n this.#validateKioskIsSet();\n kioskTx.placeAndList(this.transaction, itemType, this.kiosk!, this.kioskCap!, item, price);\n return this;\n }\n\n /**\n * A function to list an item in the kiosk.\n * @param itemType The type `T` of the item\n * @param itemId The ID of the item\n * @param price The price in NANOS\n */\n list({ itemType, itemId, price }: ItemId & { price: string | bigint }) {\n this.#validateKioskIsSet();\n kioskTx.list(this.transaction, itemType, this.kiosk!, this.kioskCap!, itemId, price);\n return this;\n }\n\n /**\n * A function to delist an item from the kiosk.\n * @param itemType The type `T` of the item\n * @param itemId The ID of the item\n */\n delist({ itemType, itemId }: ItemId) {\n this.#validateKioskIsSet();\n kioskTx.delist(this.transaction, itemType, this.kiosk!, this.kioskCap!, itemId);\n return this;\n }\n\n /**\n\t * A function to take an item from the kiosk. The transaction won't succeed if the item is listed or locked.\n\n\t * @param itemType The type `T` of the item\n\t * @param itemId The ID of the item\n\t */\n take({ itemType, itemId }: ItemId): TransactionObjectArgument {\n this.#validateKioskIsSet();\n return kioskTx.take(this.transaction, itemType, this.kiosk!, this.kioskCap!, itemId);\n }\n\n /**\n * Transfer a non-locked/non-listed item to an address.\n *\n * @param itemType The type `T` of the item\n * @param itemId The ID of the item\n * @param address The destination address\n */\n transfer({ itemType, itemId, address }: ItemId & { address: string }) {\n this.#validateKioskIsSet();\n const item = this.take({ itemType, itemId });\n this.transaction.transferObjects([item], this.transaction.pure.address(address));\n return this;\n }\n\n /**\n\t * A function to take lock an item in the kiosk.\n\n\t * @param itemType The type `T` of the item\n\t * @param item The ID or Transaction Argument of the item\n\t * @param itemId The ID of the item - Deprecated: Use `item` instead.\n\t * @param policy The Policy ID or Transaction Argument for item T\n\t */\n lock({\n itemType,\n item,\n itemId,\n policy,\n }: ItemReference & { policy: ObjectArgument; itemId?: string }) {\n this.#validateKioskIsSet();\n kioskTx.lock(\n this.transaction,\n itemType,\n this.kiosk!,\n this.kioskCap!,\n policy,\n itemId ?? item,\n );\n return this;\n }\n\n /**\n * Purchase an item from a seller's kiosk.\n * Returns [item, transferRequest]\n * Can be called like: `const [item, transferRequest] = kioskTx.purchase({...})`\n * @param itemType The type `T` of the item\n * @param itemId The ID of the item\n * @param price The price in NANOS\n * @param sellerKiosk The kiosk which is selling the item. Can be an id or an object argument.\n */\n purchase({\n itemType,\n itemId,\n price,\n sellerKiosk,\n }: ItemId & Price & { sellerKiosk: ObjectArgument }): [\n TransactionObjectArgument,\n TransactionObjectArgument,\n ] {\n // Split the coin for the amount of the listing.\n const coin = this.transaction.splitCoins(this.transaction.gas, [\n this.transaction.pure.u64(price),\n ]);\n return kioskTx.purchase(this.transaction, itemType, sellerKiosk, itemId, coin);\n }\n\n /**\n * A function to purchase and resolve a transfer policy.\n * If the transfer policy has the `lock` rule, the item is locked in the kiosk.\n * Otherwise, the item is placed in the kiosk.\n * @param itemType The type of the item\n * @param itemId The id of the item\n * @param price The price of the specified item\n * @param sellerKiosk The kiosk which is selling the item. Can be an id or an object argument.\n * @param extraArgs Used to pass arguments for custom rule resolvers.\n */\n async purchaseAndResolve({\n itemType,\n itemId,\n price,\n sellerKiosk,\n extraArgs,\n }: ItemId & Price & { sellerKiosk: ObjectArgument } & PurchaseOptions) {\n this.#validateKioskIsSet();\n // Get a list of the transfer policies.\n const policies = await this.kioskClient.getTransferPolicies({ type: itemType });\n\n if (policies.length === 0) {\n throw new Error(\n `The type ${itemType} doesn't have a Transfer Policy so it can't be traded through kiosk.`,\n );\n }\n\n const policy = policies[0]; // we now pick the first one. We need to add an option to define which one.\n\n // initialize the purchase `kiosk::purchase`\n const [purchasedItem, transferRequest] = this.purchase({\n itemType,\n itemId,\n price,\n sellerKiosk,\n });\n\n let canTransferOutsideKiosk = true;\n\n for (const rule of policy.rules) {\n const ruleDefinition = this.kioskClient.rules.find(\n (x) => getNormalizedRuleType(x.rule) === getNormalizedRuleType(rule),\n );\n if (!ruleDefinition) throw new Error(`No resolver for the following rule: ${rule}.`);\n\n if (ruleDefinition.hasLockingRule) canTransferOutsideKiosk = false;\n\n await ruleDefinition.resolveRuleFunction({\n packageId: ruleDefinition.packageId,\n transaction: this.transaction,\n itemType,\n itemId,\n price: price.toString(),\n sellerKiosk,\n policyId: policy.id,\n transferRequest,\n purchasedItem,\n kiosk: this.kiosk!,\n kioskCap: this.kioskCap!,\n extraArgs: extraArgs || {},\n kioskClient: this.kioskClient,\n });\n }\n\n confirmRequest(this.transaction, itemType, policy.id, transferRequest);\n\n if (canTransferOutsideKiosk) this.place({ itemType, item: purchasedItem });\n\n return this;\n }\n\n /**\n * A function to setup the client using an existing `ownerCap`,\n * as return from the `kioskClient.getOwnedKiosks` function.\n * @param cap `KioskOwnerCap` object as returned from `getOwnedKiosks` SDK call.\n */\n setCap(cap: KioskOwnerCap) {\n this.#validateFinalizedStatus();\n this.kiosk = this.transaction.object(cap.kioskId);\n if (!cap.isPersonal) {\n this.kioskCap = this.transaction.object(cap.objectId);\n return;\n }\n\n return this.#borrowFromPersonalCap(cap.objectId);\n }\n\n /**\n *\tA function that ends up the kiosk building tx & returns the `kioskOwnerCap` back to the\n * `PersonalKioskCap`, in case we are operating on a personal kiosk.\n * \tIt will also share the `kiosk` if it's not shared, and finalize the transfer of the personal cap if it's pending.\n */\n finalize() {\n this.#validateKioskIsSet();\n // If we're pending the sharing of the new kiosk, share it.\n if (this.#pendingShare) this.share();\n\n // If we're operating on a non-personal kiosk, we don't need to do anything else.\n if (!this.#personalCap) {\n // If we're pending transfer though, we inform user to call `shareAndTransferCap()`.\n if (this.#pendingTransfer)\n throw new Error(\n 'You need to transfer the `kioskOwnerCap` by calling `shareAndTransferCap()` before wrap',\n );\n return;\n }\n\n const packageId = this.kioskClient.getRulePackageId('personalKioskRulePackageId');\n\n // if we have a promise, return the `ownerCap` back to the personal cap.\n if (this.#promise) {\n this.transaction.moveCall({\n target: `${packageId}::personal_kiosk::return_val`,\n arguments: [\n this.#personalCap,\n this.transaction.object(this.kioskCap!),\n this.#promise!,\n ],\n });\n }\n\n // If we are pending transferring the personalCap, we do it here.\n if (this.#pendingTransfer)\n transferPersonalCapTx(this.transaction, this.#personalCap, packageId);\n\n // Mark the transaction as finalized, so no other functions can be called.\n this.#finalized = true;\n }\n\n // Some setters in case we want custom behavior.\n setKioskCap(cap: TransactionObjectArgument) {\n this.#validateFinalizedStatus();\n this.kioskCap = cap;\n return this;\n }\n\n setKiosk(kiosk: TransactionObjectArgument) {\n this.#validateFinalizedStatus();\n this.kiosk = kiosk;\n return this;\n }\n\n // Some getters\n /*\n * Returns the active transaction's kiosk, or undefined if `setCap` or `create()` hasn't been called yet.\n */\n getKiosk() {\n this.#validateFinalizedStatus();\n if (!this.kiosk) throw new Error('Kiosk is not set.');\n return this.kiosk;\n }\n\n /*\n * Returns the active transaction's kioskOwnerCap, or undefined if `setCap` or `create()` hasn't been called yet.\n */\n getKioskCap() {\n this.#validateFinalizedStatus();\n if (!this.kioskCap) throw new Error('Kiosk cap is not set');\n return this.kioskCap;\n }\n\n /**\n * A function to borrow from `personalCap`.\n */\n #borrowFromPersonalCap(personalCap: ObjectArgument) {\n const [kioskCap, promise] = this.transaction.moveCall({\n target: `${this.kioskClient.getRulePackageId(\n 'personalKioskRulePackageId',\n )}::personal_kiosk::borrow_val`,\n arguments: [this.transaction.object(personalCap)],\n });\n\n this.kioskCap = kioskCap;\n this.#personalCap = this.transaction.object(personalCap);\n this.#promise = promise;\n\n return this;\n }\n\n #setPendingStatuses({ share, transfer }: { share?: boolean; transfer?: boolean }) {\n if (transfer !== undefined) this.#pendingTransfer = transfer;\n if (share !== undefined) this.#pendingShare = share;\n }\n\n #validateKioskIsSet() {\n this.#validateFinalizedStatus();\n\n if (!this.kiosk || !this.kioskCap)\n throw new Error(\n 'You need to initialize the client by either supplying an existing owner cap or by creating a new by calling `.create()`',\n );\n }\n\n // Validates that `finalize`\n #validateFinalizedStatus() {\n if (this.#finalized)\n throw new Error(\"You can't add more transactions to a finalized kiosk transaction.\");\n }\n}\n"],
|
|
5
|
+
"mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA,cAAyB;AACzB,4BAA2D;AAC3D,6BAA+B;AAU/B,mBAAsC;AAtBtC;AA4CO,MAAM,iBAAiB;AAAA,EAgB1B,YAAY,EAAE,aAAa,aAAa,IAAI,GAA2B;AAhBpE;AAMH;AAAA;AAEA;AAAA;AAEA;AAAA;AAEA;AAAA;AAEA;AAAA,mCAAsB;AAGlB,SAAK,cAAc;AACnB,SAAK,cAAc;AAEnB,QAAI,IAAK,MAAK,OAAO,GAAG;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAS;AACL,0BAAK,yDAAL;AACA,0BAAK,oDAAL,WAAyB;AAAA,MACrB,OAAO;AAAA,MACP,UAAU;AAAA,IACd;AACA,UAAM,CAAC,OAAO,GAAG,IAAI,QAAQ,YAAY,KAAK,WAAW;AACzD,SAAK,QAAQ;AACb,SAAK,WAAW;AAChB,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,eAAe,QAAkB;AAC7B,uBAAK,eAAgB;AACrB,WAAO,KAAK,OAAO,EAAE,kBAAkB,MAAM;AAAA,EACjD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,kBAAkB,QAAkB;AAChC,0BAAK,oDAAL;AAEA,UAAM,UAAM;AAAA,MACR,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK,YAAY,iBAAiB,4BAA4B;AAAA,IAClE;AAGA,QAAI,OAAQ,uBAAK,uDAAL,WAA4B;AAAA,QACnC,oBAAK,cAAe;AAEzB,0BAAK,oDAAL,WAAyB,EAAE,UAAU,KAAK;AAC1C,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA,EAKA,eAAe,SAAiB;AAC5B,0BAAK,yDAAL;AACA,UAAM,MAAM,QAAQ,oBAAoB,KAAK,WAAW;AACxD,SAAK,YAAY,gBAAgB,CAAC,GAAG,GAAG,KAAK,YAAY,KAAK,QAAQ,OAAO,CAAC;AAC9E,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA,EAKA,QAAQ;AACJ,0BAAK,oDAAL;AACA,0BAAK,oDAAL,WAAyB,EAAE,OAAO,MAAM;AACxC,YAAQ,WAAW,KAAK,aAAa,KAAK,KAAM;AAChD,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,oBAAoB,SAAiB;AACjC,QAAI,mBAAK;AACL,YAAM,IAAI,MAAM,kEAAkE;AACtF,0BAAK,oDAAL,WAAyB,EAAE,UAAU,MAAM;AAC3C,SAAK,MAAM;AACX,SAAK,YAAY,gBAAgB,CAAC,KAAK,QAAS,GAAG,KAAK,YAAY,KAAK,QAAQ,OAAO,CAAC;AACzF,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA,EAKA,SAAS,EAAE,UAAU,OAAO,GAAW,UAA+C;AAClF,0BAAK,oDAAL;AACA,UAAM,CAAC,SAAS,OAAO,IAAI,QAAQ;AAAA,MAC/B,KAAK;AAAA,MACL;AAAA,MACA,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,IACJ;AAEA,aAAS,OAAO;AAEhB,WAAO,KAAK,OAAO,EAAE,UAAU,MAAM,SAAS,QAAQ,CAAC;AAAA,EAC3D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAO,EAAE,UAAU,OAAO,GAAuD;AAC7E,0BAAK,oDAAL;AACA,UAAM,CAAC,SAAS,OAAO,IAAI,QAAQ;AAAA,MAC/B,KAAK;AAAA,MACL;AAAA,MACA,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,IACJ;AAEA,WAAO,CAAC,SAAS,OAAO;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO,EAAE,UAAU,MAAM,QAAQ,GAAiD;AAC9E,0BAAK,oDAAL;AACA,YAAQ,YAAY,KAAK,aAAa,UAAU,KAAK,OAAQ,MAAM,OAAO;AAC1E,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAS,SAAiB,QAAmC;AACzD,0BAAK,oDAAL;AACA,UAAM,OAAO,QAAQ;AAAA,MACjB,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,IACJ;AACA,SAAK,YAAY,gBAAgB,CAAC,IAAI,GAAG,KAAK,YAAY,KAAK,QAAQ,OAAO,CAAC;AAC/E,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,EAAE,UAAU,KAAK,GAAkB;AACrC,0BAAK,oDAAL;AACA,YAAQ,MAAM,KAAK,aAAa,UAAU,KAAK,OAAQ,KAAK,UAAW,IAAI;AAC3E,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,aAAa,EAAE,UAAU,MAAM,MAAM,GAA0B;AAC3D,0BAAK,oDAAL;AACA,YAAQ,aAAa,KAAK,aAAa,UAAU,KAAK,OAAQ,KAAK,UAAW,MAAM,KAAK;AACzF,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,KAAK,EAAE,UAAU,QAAQ,MAAM,GAAwC;AACnE,0BAAK,oDAAL;AACA,YAAQ,KAAK,KAAK,aAAa,UAAU,KAAK,OAAQ,KAAK,UAAW,QAAQ,KAAK;AACnF,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,EAAE,UAAU,OAAO,GAAW;AACjC,0BAAK,oDAAL;AACA,YAAQ,OAAO,KAAK,aAAa,UAAU,KAAK,OAAQ,KAAK,UAAW,MAAM;AAC9E,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,KAAK,EAAE,UAAU,OAAO,GAAsC;AAC1D,0BAAK,oDAAL;AACA,WAAO,QAAQ,KAAK,KAAK,aAAa,UAAU,KAAK,OAAQ,KAAK,UAAW,MAAM;AAAA,EACvF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,SAAS,EAAE,UAAU,QAAQ,QAAQ,GAAiC;AAClE,0BAAK,oDAAL;AACA,UAAM,OAAO,KAAK,KAAK,EAAE,UAAU,OAAO,CAAC;AAC3C,SAAK,YAAY,gBAAgB,CAAC,IAAI,GAAG,KAAK,YAAY,KAAK,QAAQ,OAAO,CAAC;AAC/E,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,KAAK;AAAA,IACD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ,GAAgE;AAC5D,0BAAK,oDAAL;AACA,YAAQ;AAAA,MACJ,KAAK;AAAA,MACL;AAAA,MACA,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,MACA,UAAU;AAAA,IACd;AACA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,SAAS;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ,GAGE;AAEE,UAAM,OAAO,KAAK,YAAY,WAAW,KAAK,YAAY,KAAK;AAAA,MAC3D,KAAK,YAAY,KAAK,IAAI,KAAK;AAAA,IACnC,CAAC;AACD,WAAO,QAAQ,SAAS,KAAK,aAAa,UAAU,aAAa,QAAQ,IAAI;AAAA,EACjF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,MAAM,mBAAmB;AAAA,IACrB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ,GAAuE;AACnE,0BAAK,oDAAL;AAEA,UAAM,WAAW,MAAM,KAAK,YAAY,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAE9E,QAAI,SAAS,WAAW,GAAG;AACvB,YAAM,IAAI;AAAA,QACN,YAAY,QAAQ;AAAA,MACxB;AAAA,IACJ;AAEA,UAAM,SAAS,SAAS,CAAC;AAGzB,UAAM,CAAC,eAAe,eAAe,IAAI,KAAK,SAAS;AAAA,MACnD;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ,CAAC;AAED,QAAI,0BAA0B;AAE9B,eAAW,QAAQ,OAAO,OAAO;AAC7B,YAAM,iBAAiB,KAAK,YAAY,MAAM;AAAA,QAC1C,CAAC,UAAM,oCAAsB,EAAE,IAAI,UAAM,oCAAsB,IAAI;AAAA,MACvE;AACA,UAAI,CAAC,eAAgB,OAAM,IAAI,MAAM,uCAAuC,IAAI,GAAG;AAEnF,UAAI,eAAe,eAAgB,2BAA0B;AAE7D,YAAM,eAAe,oBAAoB;AAAA,QACrC,WAAW,eAAe;AAAA,QAC1B,aAAa,KAAK;AAAA,QAClB;AAAA,QACA;AAAA,QACA,OAAO,MAAM,SAAS;AAAA,QACtB;AAAA,QACA,UAAU,OAAO;AAAA,QACjB;AAAA,QACA;AAAA,QACA,OAAO,KAAK;AAAA,QACZ,UAAU,KAAK;AAAA,QACf,WAAW,aAAa,CAAC;AAAA,QACzB,aAAa,KAAK;AAAA,MACtB,CAAC;AAAA,IACL;AAEA,+CAAe,KAAK,aAAa,UAAU,OAAO,IAAI,eAAe;AAErE,QAAI,wBAAyB,MAAK,MAAM,EAAE,UAAU,MAAM,cAAc,CAAC;AAEzE,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,KAAoB;AACvB,0BAAK,yDAAL;AACA,SAAK,QAAQ,KAAK,YAAY,OAAO,IAAI,OAAO;AAChD,QAAI,CAAC,IAAI,YAAY;AACjB,WAAK,WAAW,KAAK,YAAY,OAAO,IAAI,QAAQ;AACpD;AAAA,IACJ;AAEA,WAAO,sBAAK,uDAAL,WAA4B,IAAI;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,WAAW;AACP,0BAAK,oDAAL;AAEA,QAAI,mBAAK,eAAe,MAAK,MAAM;AAGnC,QAAI,CAAC,mBAAK,eAAc;AAEpB,UAAI,mBAAK;AACL,cAAM,IAAI;AAAA,UACN;AAAA,QACJ;AACJ;AAAA,IACJ;AAEA,UAAM,YAAY,KAAK,YAAY,iBAAiB,4BAA4B;AAGhF,QAAI,mBAAK,WAAU;AACf,WAAK,YAAY,SAAS;AAAA,QACtB,QAAQ,GAAG,SAAS;AAAA,QACpB,WAAW;AAAA,UACP,mBAAK;AAAA,UACL,KAAK,YAAY,OAAO,KAAK,QAAS;AAAA,UACtC,mBAAK;AAAA,QACT;AAAA,MACJ,CAAC;AAAA,IACL;AAGA,QAAI,mBAAK;AACL,uDAAsB,KAAK,aAAa,mBAAK,eAAc,SAAS;AAGxE,uBAAK,YAAa;AAAA,EACtB;AAAA;AAAA,EAGA,YAAY,KAAgC;AACxC,0BAAK,yDAAL;AACA,SAAK,WAAW;AAChB,WAAO;AAAA,EACX;AAAA,EAEA,SAAS,OAAkC;AACvC,0BAAK,yDAAL;AACA,SAAK,QAAQ;AACb,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,WAAW;AACP,0BAAK,yDAAL;AACA,QAAI,CAAC,KAAK,MAAO,OAAM,IAAI,MAAM,mBAAmB;AACpD,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA,EAKA,cAAc;AACV,0BAAK,yDAAL;AACA,QAAI,CAAC,KAAK,SAAU,OAAM,IAAI,MAAM,sBAAsB;AAC1D,WAAO,KAAK;AAAA,EAChB;AAuCJ;AAneI;AAEA;AAEA;AAEA;AAEA;AAdG;AAAA;AAAA;AAAA;AAucH,2BAAsB,SAAC,aAA6B;AAChD,QAAM,CAAC,UAAU,OAAO,IAAI,KAAK,YAAY,SAAS;AAAA,IAClD,QAAQ,GAAG,KAAK,YAAY;AAAA,MACxB;AAAA,IACJ,CAAC;AAAA,IACD,WAAW,CAAC,KAAK,YAAY,OAAO,WAAW,CAAC;AAAA,EACpD,CAAC;AAED,OAAK,WAAW;AAChB,qBAAK,cAAe,KAAK,YAAY,OAAO,WAAW;AACvD,qBAAK,UAAW;AAEhB,SAAO;AACX;AAEA,wBAAmB,SAAC,EAAE,OAAO,SAAS,GAA4C;AAC9E,MAAI,aAAa,OAAW,oBAAK,kBAAmB;AACpD,MAAI,UAAU,OAAW,oBAAK,eAAgB;AAClD;AAEA,wBAAmB,WAAG;AAClB,wBAAK,yDAAL;AAEA,MAAI,CAAC,KAAK,SAAS,CAAC,KAAK;AACrB,UAAM,IAAI;AAAA,MACN;AAAA,IACJ;AACR;AAAA;AAGA,6BAAwB,WAAG;AACvB,MAAI,mBAAK;AACL,UAAM,IAAI,MAAM,mEAAmE;AAC3F;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -9,8 +9,6 @@ export type TransferPolicyBaseParams = {
|
|
|
9
9
|
export type TransferPolicyTransactionParams = {
|
|
10
10
|
kioskClient: KioskClient;
|
|
11
11
|
transaction: Transaction;
|
|
12
|
-
/** @deprecated use transaction instead */
|
|
13
|
-
transactionBlock?: Transaction;
|
|
14
12
|
cap?: TransferPolicyCap;
|
|
15
13
|
};
|
|
16
14
|
export declare class TransferPolicyTransaction {
|
|
@@ -20,7 +18,7 @@ export declare class TransferPolicyTransaction {
|
|
|
20
18
|
policy?: ObjectArgument;
|
|
21
19
|
policyCap?: ObjectArgument;
|
|
22
20
|
type?: string;
|
|
23
|
-
constructor({ kioskClient,
|
|
21
|
+
constructor({ kioskClient, transaction, cap }: TransferPolicyTransactionParams);
|
|
24
22
|
/**
|
|
25
23
|
* A function to create a new transfer policy.
|
|
26
24
|
* Checks if there's already an existing transfer policy to prevent
|
|
@@ -112,3 +110,4 @@ export declare class TransferPolicyTransaction {
|
|
|
112
110
|
getPolicy(): ObjectArgument;
|
|
113
111
|
getPolicyCap(): ObjectArgument;
|
|
114
112
|
}
|
|
113
|
+
//# sourceMappingURL=tp-transaction.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tp-transaction.d.ts","sourceRoot":"","sources":["../../../src/client/tp-transaction.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAA6B,MAAM,6BAA6B,CAAC;AAe1F,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAC3E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD,MAAM,MAAM,wBAAwB,GAAG;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,cAAc,CAAC;IAC1B,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC1C,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,WAAW,CAAC;IACzB,GAAG,CAAC,EAAE,iBAAiB,CAAC;CAC3B,CAAC;AAEF,qBAAa,yBAAyB;;IAClC,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,WAAW,CAAC;IACzB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEF,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,EAAE,EAAE,+BAA+B;IAM9E;;;;;;;;;;;OAWG;IACG,cAAc,CAAC,EACjB,IAAI,EACJ,SAAS,EACT,OAAO,EACP,SAAS,GACZ,EAAE,wBAAwB,GAAG;QAC1B,OAAO,EAAE,MAAM,CAAC;KACnB;IAUD;;;;;;;OAOG;IACG,MAAM,CAAC,EACT,IAAI,EACJ,SAAS,EACT,SAAS,GACZ,EAAE,wBAAwB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAgBhE;;;;;OAKG;IACH,mBAAmB,CAAC,OAAO,EAAE,MAAM;IAanC;;;;OAIG;IACH,MAAM,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,iBAAiB;IAIzD;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM;IAgBlD;;;;;;;;;OASG;IACH,cAAc,CACV,aAAa,EAAE,MAAM,GAAG,MAAM,EAAE,2BAA2B;IAC3D,SAAS,EAAE,MAAM,GAAG,MAAM;IAmB9B;;;OAGG;IACH,WAAW;IAaX;;OAEG;IACH,oBAAoB;IAapB;;;OAGG;IACH,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAc3C;;;;OAIG;IACH,UAAU,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE;IAa7E;;OAEG;IACH,cAAc;IAgBd;;OAEG;IACH,iBAAiB;IAgBjB,uBAAuB;IAgBvB,oBAAoB;IAgBpB,SAAS;IAKT,YAAY;CA2Bf"}
|
|
@@ -31,12 +31,7 @@ var import_attach = require("../tx/rules/attach.js");
|
|
|
31
31
|
var import_transfer_policy = require("../tx/transfer-policy.js");
|
|
32
32
|
var _TransferPolicyTransaction_instances, validateInputs_fn, setup_fn;
|
|
33
33
|
class TransferPolicyTransaction {
|
|
34
|
-
constructor({
|
|
35
|
-
kioskClient,
|
|
36
|
-
transactionBlock,
|
|
37
|
-
transaction = transactionBlock,
|
|
38
|
-
cap
|
|
39
|
-
}) {
|
|
34
|
+
constructor({ kioskClient, transaction, cap }) {
|
|
40
35
|
__privateAdd(this, _TransferPolicyTransaction_instances);
|
|
41
36
|
this.kioskClient = kioskClient;
|
|
42
37
|
this.transaction = transaction;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../src/client/tp-transaction.ts"],
|
|
4
|
-
"sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// Modifications Copyright (c) 2024 IOTA Stiftung\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { Transaction, TransactionObjectArgument } from '@iota/iota-sdk/transactions';\n\nimport {\n attachFloorPriceRuleTx,\n attachKioskLockRuleTx,\n attachPersonalKioskRuleTx,\n attachRoyaltyRuleTx,\n} from '../tx/rules/attach.js';\nimport {\n createTransferPolicy,\n createTransferPolicyWithoutSharing,\n removeTransferPolicyRule,\n shareTransferPolicy,\n withdrawFromPolicy,\n} from '../tx/transfer-policy.js';\nimport type { ObjectArgument, TransferPolicyCap } from '../types/index.js';\nimport type { KioskClient } from './kiosk-client.js';\n\nexport type TransferPolicyBaseParams = {\n type: string;\n publisher: ObjectArgument;\n skipCheck?: boolean;\n};\n\nexport type TransferPolicyTransactionParams = {\n kioskClient: KioskClient;\n transaction: Transaction;\n /** @deprecated use transaction instead */\n transactionBlock?: Transaction;\n cap?: TransferPolicyCap;\n};\n\nexport class TransferPolicyTransaction {\n transaction: Transaction;\n kioskClient: KioskClient;\n policy?: ObjectArgument;\n policyCap?: ObjectArgument;\n type?: string;\n\n constructor({\n kioskClient,\n transactionBlock,\n transaction = transactionBlock!,\n cap,\n }: TransferPolicyTransactionParams) {\n this.kioskClient = kioskClient;\n this.transaction = transaction;\n if (cap) this.setCap(cap);\n }\n\n /**\n * A function to create a new transfer policy.\n * Checks if there's already an existing transfer policy to prevent\n * double transfer policy mistakes.\n * There's an optional `skipCheck` flag that will just create the policy\n * without checking\n *\n * @param type The Type (`T`) for which we're creating the transfer policy.\n * @param publisher The Publisher Object Id.\n * @param address Address to save the `TransferPolicyCap` object to.\n * @param skipCheck (Optional) skip checking if a transfer policy already exists\n */\n async createAndShare({\n type,\n publisher,\n address,\n skipCheck,\n }: TransferPolicyBaseParams & {\n address: string;\n }) {\n if (!skipCheck) {\n const policies = await this.kioskClient.getTransferPolicies({ type });\n if (policies.length > 0)\n throw new Error(\"There's already transfer policy for this Type.\");\n }\n const cap = createTransferPolicy(this.transaction, type, publisher);\n this.transaction.transferObjects([cap], this.transaction.pure.address(address));\n }\n\n /**\n * A convenient function to create a Transfer Policy and attach some rules\n * before sharing it (so you can prepare it in a single PTB)\n * @param type The Type (`T`) for which we're creating the transfer policy.\n * @param publisher The Publisher Object Id.\n * @param address Address to save the `TransferPolicyCap` object to.\n * @param skipCheck (Optional) skip checking if a transfer policy already exists\n */\n async create({\n type,\n publisher,\n skipCheck,\n }: TransferPolicyBaseParams): Promise<TransferPolicyTransaction> {\n if (!skipCheck) {\n const policies = await this.kioskClient.getTransferPolicies({ type });\n if (policies.length > 0)\n throw new Error(\"There's already transfer policy for this Type.\");\n }\n const [policy, policyCap] = createTransferPolicyWithoutSharing(\n this.transaction,\n type,\n publisher,\n );\n\n this.#setup(policy, policyCap, type); // sets the client's TP to the newly created one.\n return this;\n }\n\n /**\n * This can be called after calling the `create` function to share the `TransferPolicy`,\n * and transfer the `TransferPolicyCap` to the specified address\n *\n * @param address The address to transfer the `TransferPolicyCap`\n */\n shareAndTransferCap(address: string) {\n if (!this.type || !this.policyCap || !this.policy)\n throw new Error(\n 'This function can only be called after `transferPolicyManager.create`',\n );\n\n shareTransferPolicy(this.transaction, this.type, this.policy as TransactionObjectArgument);\n this.transaction.transferObjects(\n [this.policyCap as TransactionObjectArgument],\n this.transaction.pure.address(address),\n );\n }\n\n /**\n * Setup the TransferPolicy by passing a `cap` returned from `kioskClient.getOwnedTransferPolicies` or\n * `kioskClient.getOwnedTransferPoliciesByType`.\n * @param policyCapId The `TransferPolicyCap`\n */\n setCap({ policyId, policyCapId, type }: TransferPolicyCap) {\n return this.#setup(policyId, policyCapId, type);\n }\n\n /**\n * Withdraw from the transfer policy's profits.\n * @param address Address to transfer the profits to.\n * @param amount (Optional) amount parameter. Will withdraw all profits if the amount is not specified.\n */\n withdraw(address: string, amount?: string | bigint) {\n this.#validateInputs();\n // Withdraw coin for specified amount (or none)\n const coin = withdrawFromPolicy(\n this.transaction,\n this.type!,\n this.policy!,\n this.policyCap!,\n amount,\n );\n\n this.transaction.transferObjects([coin], this.transaction.pure.address(address));\n\n return this;\n }\n\n /**\n * Adds the Kiosk Royalty rule to the Transfer Policy.\n * You can pass the percentage, as well as a minimum amount.\n * The royalty that will be paid is the MAX(percentage, minAmount).\n * \tYou can pass 0 in either value if you want only percentage royalty, or a fixed amount fee.\n * \t(but you should define at least one of them for the rule to make sense).\n *\n * \t@param percentageBps The royalty percentage in basis points. Use `percentageToBasisPoints` helper to convert from percentage [0,100].\n * \t@param minAmount The minimum royalty amount per request in NANOS.\n */\n addRoyaltyRule(\n percentageBps: number | string, // this is in basis points.\n minAmount: number | string,\n ) {\n this.#validateInputs();\n\n // Hard-coding package Ids as these don't change.\n // Also, it's hard to keep versioning as with network wipes, mainnet\n // and testnet will conflict.\n attachRoyaltyRuleTx(\n this.transaction,\n this.type!,\n this.policy!,\n this.policyCap!,\n percentageBps,\n minAmount,\n this.kioskClient.getRulePackageId('royaltyRulePackageId'),\n );\n return this;\n }\n\n /**\n * Adds the Kiosk Lock Rule to the Transfer Policy.\n * This Rule forces buyer to lock the item in the kiosk, preserving strong royalties.\n */\n addLockRule() {\n this.#validateInputs();\n\n attachKioskLockRuleTx(\n this.transaction,\n this.type!,\n this.policy!,\n this.policyCap!,\n this.kioskClient.getRulePackageId('kioskLockRulePackageId'),\n );\n return this;\n }\n\n /**\n * Attaches the Personal Kiosk Rule, making a purchase valid only for `SoulBound` kiosks.\n */\n addPersonalKioskRule() {\n this.#validateInputs();\n\n attachPersonalKioskRuleTx(\n this.transaction,\n this.type!,\n this.policy!,\n this.policyCap!,\n this.kioskClient.getRulePackageId('personalKioskRulePackageId'),\n );\n return this;\n }\n\n /**\n * A function to add the floor price rule to a transfer policy.\n * @param minPrice The minimum price in NANOS.\n */\n addFloorPriceRule(minPrice: string | bigint) {\n this.#validateInputs();\n\n attachFloorPriceRuleTx(\n this.transaction,\n this.type!,\n this.policy!,\n this.policyCap!,\n minPrice,\n this.kioskClient.getRulePackageId('floorPriceRulePackageId'),\n );\n return this;\n }\n\n /**\n * Generic helper to remove a rule, not from the SDK's base ruleset.\n * @param ruleType The Rule Type\n * @param configType The Config Type\n */\n removeRule({ ruleType, configType }: { ruleType: string; configType: string }) {\n this.#validateInputs();\n\n removeTransferPolicyRule(\n this.transaction,\n this.type!,\n ruleType,\n configType,\n this.policy!,\n this.policyCap!,\n );\n }\n\n /**\n * Removes the lock rule.\n */\n removeLockRule() {\n this.#validateInputs();\n\n const packageId = this.kioskClient.getRulePackageId('kioskLockRulePackageId');\n\n removeTransferPolicyRule(\n this.transaction,\n this.type!,\n `${packageId}::kiosk_lock_rule::Rule`,\n `${packageId}::kiosk_lock_rule::Config`,\n this.policy!,\n this.policyCap!,\n );\n return this;\n }\n\n /**\n * Removes the Royalty rule\n */\n removeRoyaltyRule() {\n this.#validateInputs();\n\n const packageId = this.kioskClient.getRulePackageId('royaltyRulePackageId');\n\n removeTransferPolicyRule(\n this.transaction,\n this.type!,\n `${packageId}::royalty_rule::Rule`,\n `${packageId}::royalty_rule::Config`,\n this.policy!,\n this.policyCap!,\n );\n return this;\n }\n\n removePersonalKioskRule() {\n this.#validateInputs();\n\n const packageId = this.kioskClient.getRulePackageId('personalKioskRulePackageId');\n\n removeTransferPolicyRule(\n this.transaction,\n this.type!,\n `${packageId}::personal_kiosk_rule::Rule`,\n `bool`,\n this.policy!,\n this.policyCap!,\n );\n return this;\n }\n\n removeFloorPriceRule() {\n this.#validateInputs();\n\n const packageId = this.kioskClient.getRulePackageId('floorPriceRulePackageId');\n\n removeTransferPolicyRule(\n this.transaction,\n this.type!,\n `${packageId}::floor_price_rule::Rule`,\n `${packageId}::floor_price_rule::Config`,\n this.policy!,\n this.policyCap!,\n );\n return this;\n }\n\n getPolicy() {\n if (!this.policy) throw new Error('Policy not set.');\n return this.policy;\n }\n\n getPolicyCap() {\n if (!this.policyCap) throw new Error('Transfer Policy Cap not set.');\n return this.policyCap;\n }\n\n // Internal function that that the policy's Id + Cap + type have been set.\n #validateInputs() {\n const genericErrorMessage = `Please use 'setCap()' to setup the TransferPolicy.`;\n if (!this.policy)\n throw new Error(`${genericErrorMessage} Missing: Transfer Policy Object.`);\n if (!this.policyCap)\n throw new Error(`${genericErrorMessage} Missing: TransferPolicyCap Object ID`);\n if (!this.type)\n throw new Error(\n `${genericErrorMessage} Missing: Transfer Policy object type (e.g. {packageId}::item::Item)`,\n );\n }\n\n /**\n * Setup the state of the TransferPolicyTransaction.\n */\n #setup(policyId: ObjectArgument, policyCap: ObjectArgument, type: string) {\n this.policy = policyId;\n this.policyCap = policyCap;\n this.type = type;\n return this;\n }\n}\n"],
|
|
5
|
-
"mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,oBAKO;AACP,6BAMO;AAlBP;
|
|
4
|
+
"sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// Modifications Copyright (c) 2024 IOTA Stiftung\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { Transaction, TransactionObjectArgument } from '@iota/iota-sdk/transactions';\n\nimport {\n attachFloorPriceRuleTx,\n attachKioskLockRuleTx,\n attachPersonalKioskRuleTx,\n attachRoyaltyRuleTx,\n} from '../tx/rules/attach.js';\nimport {\n createTransferPolicy,\n createTransferPolicyWithoutSharing,\n removeTransferPolicyRule,\n shareTransferPolicy,\n withdrawFromPolicy,\n} from '../tx/transfer-policy.js';\nimport type { ObjectArgument, TransferPolicyCap } from '../types/index.js';\nimport type { KioskClient } from './kiosk-client.js';\n\nexport type TransferPolicyBaseParams = {\n type: string;\n publisher: ObjectArgument;\n skipCheck?: boolean;\n};\n\nexport type TransferPolicyTransactionParams = {\n kioskClient: KioskClient;\n transaction: Transaction;\n cap?: TransferPolicyCap;\n};\n\nexport class TransferPolicyTransaction {\n transaction: Transaction;\n kioskClient: KioskClient;\n policy?: ObjectArgument;\n policyCap?: ObjectArgument;\n type?: string;\n\n constructor({ kioskClient, transaction, cap }: TransferPolicyTransactionParams) {\n this.kioskClient = kioskClient;\n this.transaction = transaction;\n if (cap) this.setCap(cap);\n }\n\n /**\n * A function to create a new transfer policy.\n * Checks if there's already an existing transfer policy to prevent\n * double transfer policy mistakes.\n * There's an optional `skipCheck` flag that will just create the policy\n * without checking\n *\n * @param type The Type (`T`) for which we're creating the transfer policy.\n * @param publisher The Publisher Object Id.\n * @param address Address to save the `TransferPolicyCap` object to.\n * @param skipCheck (Optional) skip checking if a transfer policy already exists\n */\n async createAndShare({\n type,\n publisher,\n address,\n skipCheck,\n }: TransferPolicyBaseParams & {\n address: string;\n }) {\n if (!skipCheck) {\n const policies = await this.kioskClient.getTransferPolicies({ type });\n if (policies.length > 0)\n throw new Error(\"There's already transfer policy for this Type.\");\n }\n const cap = createTransferPolicy(this.transaction, type, publisher);\n this.transaction.transferObjects([cap], this.transaction.pure.address(address));\n }\n\n /**\n * A convenient function to create a Transfer Policy and attach some rules\n * before sharing it (so you can prepare it in a single PTB)\n * @param type The Type (`T`) for which we're creating the transfer policy.\n * @param publisher The Publisher Object Id.\n * @param address Address to save the `TransferPolicyCap` object to.\n * @param skipCheck (Optional) skip checking if a transfer policy already exists\n */\n async create({\n type,\n publisher,\n skipCheck,\n }: TransferPolicyBaseParams): Promise<TransferPolicyTransaction> {\n if (!skipCheck) {\n const policies = await this.kioskClient.getTransferPolicies({ type });\n if (policies.length > 0)\n throw new Error(\"There's already transfer policy for this Type.\");\n }\n const [policy, policyCap] = createTransferPolicyWithoutSharing(\n this.transaction,\n type,\n publisher,\n );\n\n this.#setup(policy, policyCap, type); // sets the client's TP to the newly created one.\n return this;\n }\n\n /**\n * This can be called after calling the `create` function to share the `TransferPolicy`,\n * and transfer the `TransferPolicyCap` to the specified address\n *\n * @param address The address to transfer the `TransferPolicyCap`\n */\n shareAndTransferCap(address: string) {\n if (!this.type || !this.policyCap || !this.policy)\n throw new Error(\n 'This function can only be called after `transferPolicyManager.create`',\n );\n\n shareTransferPolicy(this.transaction, this.type, this.policy as TransactionObjectArgument);\n this.transaction.transferObjects(\n [this.policyCap as TransactionObjectArgument],\n this.transaction.pure.address(address),\n );\n }\n\n /**\n * Setup the TransferPolicy by passing a `cap` returned from `kioskClient.getOwnedTransferPolicies` or\n * `kioskClient.getOwnedTransferPoliciesByType`.\n * @param policyCapId The `TransferPolicyCap`\n */\n setCap({ policyId, policyCapId, type }: TransferPolicyCap) {\n return this.#setup(policyId, policyCapId, type);\n }\n\n /**\n * Withdraw from the transfer policy's profits.\n * @param address Address to transfer the profits to.\n * @param amount (Optional) amount parameter. Will withdraw all profits if the amount is not specified.\n */\n withdraw(address: string, amount?: string | bigint) {\n this.#validateInputs();\n // Withdraw coin for specified amount (or none)\n const coin = withdrawFromPolicy(\n this.transaction,\n this.type!,\n this.policy!,\n this.policyCap!,\n amount,\n );\n\n this.transaction.transferObjects([coin], this.transaction.pure.address(address));\n\n return this;\n }\n\n /**\n * Adds the Kiosk Royalty rule to the Transfer Policy.\n * You can pass the percentage, as well as a minimum amount.\n * The royalty that will be paid is the MAX(percentage, minAmount).\n * \tYou can pass 0 in either value if you want only percentage royalty, or a fixed amount fee.\n * \t(but you should define at least one of them for the rule to make sense).\n *\n * \t@param percentageBps The royalty percentage in basis points. Use `percentageToBasisPoints` helper to convert from percentage [0,100].\n * \t@param minAmount The minimum royalty amount per request in NANOS.\n */\n addRoyaltyRule(\n percentageBps: number | string, // this is in basis points.\n minAmount: number | string,\n ) {\n this.#validateInputs();\n\n // Hard-coding package Ids as these don't change.\n // Also, it's hard to keep versioning as with network wipes, mainnet\n // and testnet will conflict.\n attachRoyaltyRuleTx(\n this.transaction,\n this.type!,\n this.policy!,\n this.policyCap!,\n percentageBps,\n minAmount,\n this.kioskClient.getRulePackageId('royaltyRulePackageId'),\n );\n return this;\n }\n\n /**\n * Adds the Kiosk Lock Rule to the Transfer Policy.\n * This Rule forces buyer to lock the item in the kiosk, preserving strong royalties.\n */\n addLockRule() {\n this.#validateInputs();\n\n attachKioskLockRuleTx(\n this.transaction,\n this.type!,\n this.policy!,\n this.policyCap!,\n this.kioskClient.getRulePackageId('kioskLockRulePackageId'),\n );\n return this;\n }\n\n /**\n * Attaches the Personal Kiosk Rule, making a purchase valid only for `SoulBound` kiosks.\n */\n addPersonalKioskRule() {\n this.#validateInputs();\n\n attachPersonalKioskRuleTx(\n this.transaction,\n this.type!,\n this.policy!,\n this.policyCap!,\n this.kioskClient.getRulePackageId('personalKioskRulePackageId'),\n );\n return this;\n }\n\n /**\n * A function to add the floor price rule to a transfer policy.\n * @param minPrice The minimum price in NANOS.\n */\n addFloorPriceRule(minPrice: string | bigint) {\n this.#validateInputs();\n\n attachFloorPriceRuleTx(\n this.transaction,\n this.type!,\n this.policy!,\n this.policyCap!,\n minPrice,\n this.kioskClient.getRulePackageId('floorPriceRulePackageId'),\n );\n return this;\n }\n\n /**\n * Generic helper to remove a rule, not from the SDK's base ruleset.\n * @param ruleType The Rule Type\n * @param configType The Config Type\n */\n removeRule({ ruleType, configType }: { ruleType: string; configType: string }) {\n this.#validateInputs();\n\n removeTransferPolicyRule(\n this.transaction,\n this.type!,\n ruleType,\n configType,\n this.policy!,\n this.policyCap!,\n );\n }\n\n /**\n * Removes the lock rule.\n */\n removeLockRule() {\n this.#validateInputs();\n\n const packageId = this.kioskClient.getRulePackageId('kioskLockRulePackageId');\n\n removeTransferPolicyRule(\n this.transaction,\n this.type!,\n `${packageId}::kiosk_lock_rule::Rule`,\n `${packageId}::kiosk_lock_rule::Config`,\n this.policy!,\n this.policyCap!,\n );\n return this;\n }\n\n /**\n * Removes the Royalty rule\n */\n removeRoyaltyRule() {\n this.#validateInputs();\n\n const packageId = this.kioskClient.getRulePackageId('royaltyRulePackageId');\n\n removeTransferPolicyRule(\n this.transaction,\n this.type!,\n `${packageId}::royalty_rule::Rule`,\n `${packageId}::royalty_rule::Config`,\n this.policy!,\n this.policyCap!,\n );\n return this;\n }\n\n removePersonalKioskRule() {\n this.#validateInputs();\n\n const packageId = this.kioskClient.getRulePackageId('personalKioskRulePackageId');\n\n removeTransferPolicyRule(\n this.transaction,\n this.type!,\n `${packageId}::personal_kiosk_rule::Rule`,\n `bool`,\n this.policy!,\n this.policyCap!,\n );\n return this;\n }\n\n removeFloorPriceRule() {\n this.#validateInputs();\n\n const packageId = this.kioskClient.getRulePackageId('floorPriceRulePackageId');\n\n removeTransferPolicyRule(\n this.transaction,\n this.type!,\n `${packageId}::floor_price_rule::Rule`,\n `${packageId}::floor_price_rule::Config`,\n this.policy!,\n this.policyCap!,\n );\n return this;\n }\n\n getPolicy() {\n if (!this.policy) throw new Error('Policy not set.');\n return this.policy;\n }\n\n getPolicyCap() {\n if (!this.policyCap) throw new Error('Transfer Policy Cap not set.');\n return this.policyCap;\n }\n\n // Internal function that that the policy's Id + Cap + type have been set.\n #validateInputs() {\n const genericErrorMessage = `Please use 'setCap()' to setup the TransferPolicy.`;\n if (!this.policy)\n throw new Error(`${genericErrorMessage} Missing: Transfer Policy Object.`);\n if (!this.policyCap)\n throw new Error(`${genericErrorMessage} Missing: TransferPolicyCap Object ID`);\n if (!this.type)\n throw new Error(\n `${genericErrorMessage} Missing: Transfer Policy object type (e.g. {packageId}::item::Item)`,\n );\n }\n\n /**\n * Setup the state of the TransferPolicyTransaction.\n */\n #setup(policyId: ObjectArgument, policyCap: ObjectArgument, type: string) {\n this.policy = policyId;\n this.policyCap = policyCap;\n this.type = type;\n return this;\n }\n}\n"],
|
|
5
|
+
"mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,oBAKO;AACP,6BAMO;AAlBP;AAkCO,MAAM,0BAA0B;AAAA,EAOnC,YAAY,EAAE,aAAa,aAAa,IAAI,GAAoC;AAP7E;AAQC,SAAK,cAAc;AACnB,SAAK,cAAc;AACnB,QAAI,IAAK,MAAK,OAAO,GAAG;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,MAAM,eAAe;AAAA,IACjB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ,GAEG;AACC,QAAI,CAAC,WAAW;AACZ,YAAM,WAAW,MAAM,KAAK,YAAY,oBAAoB,EAAE,KAAK,CAAC;AACpE,UAAI,SAAS,SAAS;AAClB,cAAM,IAAI,MAAM,gDAAgD;AAAA,IACxE;AACA,UAAM,UAAM,6CAAqB,KAAK,aAAa,MAAM,SAAS;AAClE,SAAK,YAAY,gBAAgB,CAAC,GAAG,GAAG,KAAK,YAAY,KAAK,QAAQ,OAAO,CAAC;AAAA,EAClF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,OAAO;AAAA,IACT;AAAA,IACA;AAAA,IACA;AAAA,EACJ,GAAiE;AAC7D,QAAI,CAAC,WAAW;AACZ,YAAM,WAAW,MAAM,KAAK,YAAY,oBAAoB,EAAE,KAAK,CAAC;AACpE,UAAI,SAAS,SAAS;AAClB,cAAM,IAAI,MAAM,gDAAgD;AAAA,IACxE;AACA,UAAM,CAAC,QAAQ,SAAS,QAAI;AAAA,MACxB,KAAK;AAAA,MACL;AAAA,MACA;AAAA,IACJ;AAEA,0BAAK,gDAAL,WAAY,QAAQ,WAAW;AAC/B,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,oBAAoB,SAAiB;AACjC,QAAI,CAAC,KAAK,QAAQ,CAAC,KAAK,aAAa,CAAC,KAAK;AACvC,YAAM,IAAI;AAAA,QACN;AAAA,MACJ;AAEJ,oDAAoB,KAAK,aAAa,KAAK,MAAM,KAAK,MAAmC;AACzF,SAAK,YAAY;AAAA,MACb,CAAC,KAAK,SAAsC;AAAA,MAC5C,KAAK,YAAY,KAAK,QAAQ,OAAO;AAAA,IACzC;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,EAAE,UAAU,aAAa,KAAK,GAAsB;AACvD,WAAO,sBAAK,gDAAL,WAAY,UAAU,aAAa;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAS,SAAiB,QAA0B;AAChD,0BAAK,yDAAL;AAEA,UAAM,WAAO;AAAA,MACT,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,IACJ;AAEA,SAAK,YAAY,gBAAgB,CAAC,IAAI,GAAG,KAAK,YAAY,KAAK,QAAQ,OAAO,CAAC;AAE/E,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,eACI,eACA,WACF;AACE,0BAAK,yDAAL;AAKA;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,MACA;AAAA,MACA,KAAK,YAAY,iBAAiB,sBAAsB;AAAA,IAC5D;AACA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,cAAc;AACV,0BAAK,yDAAL;AAEA;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK,YAAY,iBAAiB,wBAAwB;AAAA,IAC9D;AACA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA,EAKA,uBAAuB;AACnB,0BAAK,yDAAL;AAEA;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK,YAAY,iBAAiB,4BAA4B;AAAA,IAClE;AACA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,kBAAkB,UAA2B;AACzC,0BAAK,yDAAL;AAEA;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,MACA,KAAK,YAAY,iBAAiB,yBAAyB;AAAA,IAC/D;AACA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,WAAW,EAAE,UAAU,WAAW,GAA6C;AAC3E,0BAAK,yDAAL;AAEA;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,MACA;AAAA,MACA,KAAK;AAAA,MACL,KAAK;AAAA,IACT;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA,EAKA,iBAAiB;AACb,0BAAK,yDAAL;AAEA,UAAM,YAAY,KAAK,YAAY,iBAAiB,wBAAwB;AAE5E;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL,GAAG,SAAS;AAAA,MACZ,GAAG,SAAS;AAAA,MACZ,KAAK;AAAA,MACL,KAAK;AAAA,IACT;AACA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA,EAKA,oBAAoB;AAChB,0BAAK,yDAAL;AAEA,UAAM,YAAY,KAAK,YAAY,iBAAiB,sBAAsB;AAE1E;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL,GAAG,SAAS;AAAA,MACZ,GAAG,SAAS;AAAA,MACZ,KAAK;AAAA,MACL,KAAK;AAAA,IACT;AACA,WAAO;AAAA,EACX;AAAA,EAEA,0BAA0B;AACtB,0BAAK,yDAAL;AAEA,UAAM,YAAY,KAAK,YAAY,iBAAiB,4BAA4B;AAEhF;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL,GAAG,SAAS;AAAA,MACZ;AAAA,MACA,KAAK;AAAA,MACL,KAAK;AAAA,IACT;AACA,WAAO;AAAA,EACX;AAAA,EAEA,uBAAuB;AACnB,0BAAK,yDAAL;AAEA,UAAM,YAAY,KAAK,YAAY,iBAAiB,yBAAyB;AAE7E;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL,GAAG,SAAS;AAAA,MACZ,GAAG,SAAS;AAAA,MACZ,KAAK;AAAA,MACL,KAAK;AAAA,IACT;AACA,WAAO;AAAA,EACX;AAAA,EAEA,YAAY;AACR,QAAI,CAAC,KAAK,OAAQ,OAAM,IAAI,MAAM,iBAAiB;AACnD,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,eAAe;AACX,QAAI,CAAC,KAAK,UAAW,OAAM,IAAI,MAAM,8BAA8B;AACnE,WAAO,KAAK;AAAA,EAChB;AAwBJ;AAjUO;AAAA;AA4SH,oBAAe,WAAG;AACd,QAAM,sBAAsB;AAC5B,MAAI,CAAC,KAAK;AACN,UAAM,IAAI,MAAM,GAAG,mBAAmB,mCAAmC;AAC7E,MAAI,CAAC,KAAK;AACN,UAAM,IAAI,MAAM,GAAG,mBAAmB,uCAAuC;AACjF,MAAI,CAAC,KAAK;AACN,UAAM,IAAI;AAAA,MACN,GAAG,mBAAmB;AAAA,IAC1B;AACR;AAAA;AAAA;AAAA;AAKA,WAAM,SAAC,UAA0B,WAA2B,MAAc;AACtE,OAAK,SAAS;AACd,OAAK,YAAY;AACjB,OAAK,OAAO;AACZ,SAAO;AACX;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
package/dist/cjs/constants.d.ts
CHANGED
|
@@ -14,7 +14,7 @@ export type BaseRulePackageIds = {
|
|
|
14
14
|
export type TransferPolicyRule = {
|
|
15
15
|
rule: string;
|
|
16
16
|
packageId: string;
|
|
17
|
-
resolveRuleFunction: (rule: RuleResolvingParams) => ObjectArgument | void
|
|
17
|
+
resolveRuleFunction: (rule: RuleResolvingParams) => ObjectArgument | void | Promise<ObjectArgument | void>;
|
|
18
18
|
hasLockingRule?: boolean;
|
|
19
19
|
};
|
|
20
20
|
/**
|
|
@@ -22,3 +22,4 @@ export type TransferPolicyRule = {
|
|
|
22
22
|
*/
|
|
23
23
|
export declare function getBaseRules({ royaltyRulePackageId, kioskLockRulePackageId, personalKioskRulePackageId, floorPriceRulePackageId, }: BaseRulePackageIds): TransferPolicyRule[];
|
|
24
24
|
export declare const rules: TransferPolicyRule[];
|
|
25
|
+
//# sourceMappingURL=constants.d.ts.map
|