@mysten/kiosk 0.6.0 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/README.md +2 -287
  3. package/dist/client/kiosk-client.d.ts +64 -0
  4. package/dist/client/kiosk-transaction.d.ts +182 -0
  5. package/dist/client/tp-transaction.d.ts +112 -0
  6. package/dist/constants.d.ts +30 -4
  7. package/dist/index.d.ts +3 -6
  8. package/dist/index.js +1256 -264
  9. package/dist/index.js.map +1 -1
  10. package/dist/index.mjs +1239 -230
  11. package/dist/index.mjs.map +1 -1
  12. package/dist/query/kiosk.d.ts +2 -1
  13. package/dist/query/transfer-policy.d.ts +17 -1
  14. package/dist/tx/kiosk.d.ts +11 -27
  15. package/dist/tx/personal-kiosk.d.ts +7 -0
  16. package/dist/tx/rules/attach.d.ts +7 -0
  17. package/dist/tx/rules/resolve.d.ts +15 -0
  18. package/dist/tx/transfer-policy.d.ts +14 -17
  19. package/dist/types/index.d.ts +23 -5
  20. package/dist/types/kiosk.d.ts +30 -1
  21. package/dist/types/transfer-policy.d.ts +27 -1
  22. package/dist/utils.d.ts +32 -18
  23. package/package.json +12 -4
  24. package/src/bcs.ts +1 -0
  25. package/src/client/kiosk-client.ts +156 -0
  26. package/src/client/kiosk-transaction.ts +519 -0
  27. package/src/client/tp-transaction.ts +350 -0
  28. package/src/constants.ts +113 -6
  29. package/src/index.ts +3 -6
  30. package/src/query/kiosk.ts +51 -18
  31. package/src/query/transfer-policy.ts +82 -2
  32. package/src/tx/kiosk.ts +37 -158
  33. package/src/tx/personal-kiosk.ts +35 -0
  34. package/src/tx/rules/attach.ts +74 -0
  35. package/src/tx/rules/resolve.ts +87 -0
  36. package/src/tx/transfer-policy.ts +46 -79
  37. package/src/types/index.ts +26 -5
  38. package/src/types/kiosk.ts +26 -1
  39. package/src/types/transfer-policy.ts +35 -1
  40. package/src/utils.ts +143 -35
  41. package/dist/tx/rules.d.ts +0 -19
  42. package/dist/types/env.d.ts +0 -12
  43. package/src/tx/rules.ts +0 -58
  44. package/src/types/env.ts +0 -20
@@ -1,4 +1,30 @@
1
- /** The Transer Policy Rules package address on testnet */
2
- export declare const TESTNET_RULES_PACKAGE_ADDRESS = "bd8fc1947cf119350184107a3087e2dc27efefa0dd82e25a1f699069fe81a585";
3
- /** The transfer policy rules package address on mainnet */
4
- export declare const MAINNET_RULES_PACKAGE_ADDRESS = "0x434b5bd8f6a7b05fede0ff46c6e511d71ea326ed38056e3bcd681d2d7c2a7879";
1
+ import { Network, type ObjectArgument, type RuleResolvingParams } from './types';
2
+ /**
3
+ * The base rule package ids that can be extended
4
+ */
5
+ export type BaseRulePackageIds = {
6
+ royaltyRulePackageId?: string;
7
+ kioskLockRulePackageId?: string;
8
+ personalKioskRulePackageId?: string;
9
+ floorPriceRulePackageId?: string;
10
+ };
11
+ /**
12
+ * The Transfer Policy rule.
13
+ */
14
+ export type TransferPolicyRule = {
15
+ rule: string;
16
+ packageId: string;
17
+ resolveRuleFunction: (rule: RuleResolvingParams) => ObjectArgument | void;
18
+ hasLockingRule?: boolean;
19
+ };
20
+ export declare const ROYALTY_RULE_ADDRESS: Record<Network, string>;
21
+ export declare const KIOSK_LOCK_RULE_ADDRESS: Record<Network, string>;
22
+ export declare const FLOOR_PRICE_RULE_ADDRESS: Record<Network, string>;
23
+ export declare const PERSONAL_KIOSK_RULE_ADDRESS: Record<Network, string>;
24
+ /**
25
+ * Constructs a list of rule resolvers based on the params.
26
+ */
27
+ export declare function getBaseRules({ royaltyRulePackageId, kioskLockRulePackageId, personalKioskRulePackageId, floorPriceRulePackageId, }: BaseRulePackageIds): TransferPolicyRule[];
28
+ export declare const testnetRules: TransferPolicyRule[];
29
+ export declare const mainnetRules: TransferPolicyRule[];
30
+ export declare const rules: TransferPolicyRule[];
package/dist/index.d.ts CHANGED
@@ -1,9 +1,6 @@
1
- export * from './tx/kiosk';
2
- export * from './tx/transfer-policy';
3
- export * from './tx/rules';
4
- export * from './query/kiosk';
5
- export * from './bcs';
6
1
  export * from './utils';
7
- export * from './query/transfer-policy';
8
2
  export * from './types';
9
3
  export * from './constants';
4
+ export * from './client/kiosk-client';
5
+ export * from './client/tp-transaction';
6
+ export * from './client/kiosk-transaction';