@openzeppelin/wizard 0.1.0 → 0.1.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 (110) hide show
  1. package/README.md +26 -1
  2. package/dist/add-pausable.d.ts.map +1 -1
  3. package/dist/add-pausable.js +2 -2
  4. package/dist/add-pausable.js.map +1 -1
  5. package/dist/api.d.ts +8 -0
  6. package/dist/api.d.ts.map +1 -1
  7. package/dist/api.js +15 -5
  8. package/dist/api.js.map +1 -1
  9. package/dist/build-generic.d.ts +4 -0
  10. package/dist/build-generic.d.ts.map +1 -1
  11. package/dist/build-generic.js +3 -0
  12. package/dist/build-generic.js.map +1 -1
  13. package/dist/common-options.js +2 -2
  14. package/dist/common-options.js.map +1 -1
  15. package/dist/custom.d.ts +11 -0
  16. package/dist/custom.d.ts.map +1 -0
  17. package/dist/custom.js +47 -0
  18. package/dist/custom.js.map +1 -0
  19. package/dist/custom.test.d.ts +2 -0
  20. package/dist/custom.test.d.ts.map +1 -0
  21. package/dist/custom.test.js +70 -0
  22. package/dist/custom.test.js.map +1 -0
  23. package/dist/erc1155.d.ts +2 -0
  24. package/dist/erc1155.d.ts.map +1 -1
  25. package/dist/erc1155.js +16 -7
  26. package/dist/erc1155.js.map +1 -1
  27. package/dist/erc1155.test.js +11 -0
  28. package/dist/erc1155.test.js.map +1 -1
  29. package/dist/erc20.d.ts +1 -0
  30. package/dist/erc20.d.ts.map +1 -1
  31. package/dist/erc20.js +8 -3
  32. package/dist/erc20.js.map +1 -1
  33. package/dist/erc20.test.js +7 -0
  34. package/dist/erc20.test.js.map +1 -1
  35. package/dist/erc721.d.ts +1 -0
  36. package/dist/erc721.d.ts.map +1 -1
  37. package/dist/erc721.js +7 -2
  38. package/dist/erc721.js.map +1 -1
  39. package/dist/erc721.test.js +6 -0
  40. package/dist/erc721.test.js.map +1 -1
  41. package/dist/generate/custom.d.ts +3 -0
  42. package/dist/generate/custom.d.ts.map +1 -0
  43. package/dist/generate/custom.js +20 -0
  44. package/dist/generate/custom.js.map +1 -0
  45. package/dist/generate/erc1155.d.ts.map +1 -1
  46. package/dist/generate/erc1155.js +1 -0
  47. package/dist/generate/erc1155.js.map +1 -1
  48. package/dist/generate/sources.d.ts.map +1 -1
  49. package/dist/generate/sources.js +5 -1
  50. package/dist/generate/sources.js.map +1 -1
  51. package/dist/governor.d.ts +1 -0
  52. package/dist/governor.d.ts.map +1 -1
  53. package/dist/governor.js +7 -1
  54. package/dist/governor.js.map +1 -1
  55. package/dist/governor.test.js +4 -0
  56. package/dist/governor.test.js.map +1 -1
  57. package/dist/index.d.ts +1 -1
  58. package/dist/index.d.ts.map +1 -1
  59. package/dist/index.js +2 -1
  60. package/dist/index.js.map +1 -1
  61. package/dist/kind.js +1 -0
  62. package/dist/kind.js.map +1 -1
  63. package/dist/print.d.ts.map +1 -1
  64. package/dist/print.js +16 -12
  65. package/dist/print.js.map +1 -1
  66. package/dist/set-access-control.d.ts +9 -2
  67. package/dist/set-access-control.d.ts.map +1 -1
  68. package/dist/set-access-control.js +27 -6
  69. package/dist/set-access-control.js.map +1 -1
  70. package/dist/set-upgradeable.d.ts.map +1 -1
  71. package/dist/set-upgradeable.js +1 -1
  72. package/dist/set-upgradeable.js.map +1 -1
  73. package/dist/test.js +30 -1
  74. package/dist/test.js.map +1 -1
  75. package/package.json +3 -3
  76. package/src/add-pausable.ts +3 -3
  77. package/src/api.ts +25 -8
  78. package/src/build-generic.ts +5 -0
  79. package/src/common-options.ts +2 -2
  80. package/src/custom.test.ts +80 -0
  81. package/src/custom.test.ts.md +154 -0
  82. package/src/custom.test.ts.snap +0 -0
  83. package/src/custom.ts +55 -0
  84. package/src/erc1155.test.ts +13 -0
  85. package/src/erc1155.test.ts.md +16 -0
  86. package/src/erc1155.test.ts.snap +0 -0
  87. package/src/erc1155.ts +17 -7
  88. package/src/erc20.test.ts +8 -0
  89. package/src/erc20.ts +8 -4
  90. package/src/erc721.test.ts +7 -0
  91. package/src/erc721.ts +7 -3
  92. package/src/generate/custom.ts +19 -0
  93. package/src/generate/erc1155.ts +1 -0
  94. package/src/generate/sources.ts +6 -1
  95. package/src/governor.test.ts +5 -0
  96. package/src/governor.ts +6 -1
  97. package/src/index.ts +1 -1
  98. package/src/kind.ts +1 -0
  99. package/src/print.ts +17 -12
  100. package/src/set-access-control.ts +27 -4
  101. package/src/set-upgradeable.ts +2 -2
  102. package/src/test.ts +34 -2
  103. package/dist/general.d.ts +0 -8
  104. package/dist/general.d.ts.map +0 -1
  105. package/dist/general.js +0 -22
  106. package/dist/general.js.map +0 -1
  107. package/dist/general.test.d.ts +0 -2
  108. package/dist/general.test.d.ts.map +0 -1
  109. package/dist/general.test.js +0 -42
  110. package/dist/general.test.js.map +0 -1
package/README.md CHANGED
@@ -15,8 +15,9 @@ The following contract types are supported:
15
15
  - `erc721`
16
16
  - `erc1155`
17
17
  - `governor`
18
+ - `custom`
18
19
 
19
- Each contract type has a `print` function and a `defaults` constant as defined below.
20
+ Each contract type has functions/constants as defined below.
20
21
 
21
22
  ### Functions
22
23
 
@@ -33,6 +34,9 @@ function print(opts?: ERC1155Options): string
33
34
  ```js
34
35
  function print(opts?: GovernorOptions): string
35
36
  ```
37
+ ```js
38
+ function print(opts?: CustomOptions): string
39
+ ```
36
40
  Returns a string representation of a contract generated using the provided options. If `opts` is not provided, uses [`defaults`](#defaults).
37
41
 
38
42
  #### `defaults`
@@ -48,8 +52,29 @@ const defaults: Required<ERC1155Options>
48
52
  ```js
49
53
  const defaults: Required<GovernorOptions>
50
54
  ```
55
+ ```js
56
+ const defaults: Required<CustomOptions>
57
+ ```
51
58
  The default options that are used for [`print`](#print).
52
59
 
60
+ #### `isAccessControlRequired`
61
+ ```js
62
+ function isAccessControlRequired(opts: Partial<ERC20Options>): boolean
63
+ ```
64
+ ```js
65
+ function isAccessControlRequired(opts: Partial<ERC721Options>): boolean
66
+ ```
67
+ ```js
68
+ function isAccessControlRequired(opts: Partial<ERC1155Options>): boolean
69
+ ```
70
+ ```js
71
+ function isAccessControlRequired(opts: Partial<GovernorOptions>): boolean
72
+ ```
73
+ ```js
74
+ function isAccessControlRequired(opts: Partial<CustomOptions>): boolean
75
+ ```
76
+ Whether any of the provided options require access control to be enabled. If this returns `true`, then calling `print` with the same options would cause the `access` option to default to `'ownable'` if it was `undefined` or `false`.
77
+
53
78
  ### Examples
54
79
 
55
80
  Import the contract type(s) that you want to use from the `@openzeppelin/wizard` package:
@@ -1 +1 @@
1
- {"version":3,"file":"add-pausable.d.ts","sourceRoot":"","sources":["../src/add-pausable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAChE,OAAO,EAAE,MAAM,EAAoB,MAAM,sBAAsB,CAAC;AAGhE,wBAAgB,WAAW,CAAC,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,QAe1F"}
1
+ {"version":3,"file":"add-pausable.d.ts","sourceRoot":"","sources":["../src/add-pausable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAChE,OAAO,EAAE,MAAM,EAAwB,MAAM,sBAAsB,CAAC;AAGpE,wBAAgB,WAAW,CAAC,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,QAe1F"}
@@ -11,9 +11,9 @@ function addPausable(c, access, pausableFns) {
11
11
  for (const fn of pausableFns) {
12
12
  c.addModifier('whenNotPaused', fn);
13
13
  }
14
- (0, set_access_control_1.setAccessControl)(c, functions.pause, access, 'PAUSER');
14
+ (0, set_access_control_1.requireAccessControl)(c, functions.pause, access, 'PAUSER');
15
15
  c.addFunctionCode('_pause();', functions.pause);
16
- (0, set_access_control_1.setAccessControl)(c, functions.unpause, access, 'PAUSER');
16
+ (0, set_access_control_1.requireAccessControl)(c, functions.unpause, access, 'PAUSER');
17
17
  c.addFunctionCode('_unpause();', functions.unpause);
18
18
  }
19
19
  exports.addPausable = addPausable;
@@ -1 +1 @@
1
- {"version":3,"file":"add-pausable.js","sourceRoot":"","sources":["../src/add-pausable.ts"],"names":[],"mappings":";;;AACA,6DAAgE;AAChE,+DAA2D;AAE3D,SAAgB,WAAW,CAAC,CAAkB,EAAE,MAAc,EAAE,WAA2B;IACzF,CAAC,CAAC,SAAS,CAAC;QACV,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,+CAA+C;KACtD,CAAC,CAAC;IAEH,KAAK,MAAM,EAAE,IAAI,WAAW,EAAE;QAC5B,CAAC,CAAC,WAAW,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;KACpC;IAED,IAAA,qCAAgB,EAAC,CAAC,EAAE,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC,CAAC,eAAe,CAAC,WAAW,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;IAEhD,IAAA,qCAAgB,EAAC,CAAC,EAAE,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC,CAAC,eAAe,CAAC,aAAa,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;AACtD,CAAC;AAfD,kCAeC;AAED,MAAM,SAAS,GAAG,IAAA,kCAAe,EAAC;IAChC,KAAK,EAAE;QACL,IAAI,EAAE,QAAiB;QACvB,IAAI,EAAE,EAAE;KACT;IAED,OAAO,EAAE;QACP,IAAI,EAAE,QAAiB;QACvB,IAAI,EAAE,EAAE;KACT;CACF,CAAC,CAAC"}
1
+ {"version":3,"file":"add-pausable.js","sourceRoot":"","sources":["../src/add-pausable.ts"],"names":[],"mappings":";;;AACA,6DAAoE;AACpE,+DAA2D;AAE3D,SAAgB,WAAW,CAAC,CAAkB,EAAE,MAAc,EAAE,WAA2B;IACzF,CAAC,CAAC,SAAS,CAAC;QACV,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,+CAA+C;KACtD,CAAC,CAAC;IAEH,KAAK,MAAM,EAAE,IAAI,WAAW,EAAE;QAC5B,CAAC,CAAC,WAAW,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;KACpC;IAED,IAAA,yCAAoB,EAAC,CAAC,EAAE,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC,CAAC,eAAe,CAAC,WAAW,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;IAEhD,IAAA,yCAAoB,EAAC,CAAC,EAAE,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC7D,CAAC,CAAC,eAAe,CAAC,aAAa,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;AACtD,CAAC;AAfD,kCAeC;AAED,MAAM,SAAS,GAAG,IAAA,kCAAe,EAAC;IAChC,KAAK,EAAE;QACL,IAAI,EAAE,QAAiB;QACvB,IAAI,EAAE,EAAE;KACT;IAED,OAAO,EAAE;QACP,IAAI,EAAE,QAAiB;QACvB,IAAI,EAAE,EAAE;KACT;CACF,CAAC,CAAC"}
package/dist/api.d.ts CHANGED
@@ -3,6 +3,7 @@ import { ERC20Options } from './erc20';
3
3
  import { ERC721Options } from './erc721';
4
4
  import { ERC1155Options } from './erc1155';
5
5
  import { GovernorOptions } from './governor';
6
+ import { CustomOptions } from './custom';
6
7
  export interface WizardContractAPI<Options extends CommonOptions> {
7
8
  /**
8
9
  * Returns a string representation of a contract generated using the provided options. If opts is not provided, uses `defaults`.
@@ -12,13 +13,20 @@ export interface WizardContractAPI<Options extends CommonOptions> {
12
13
  * The default options that are used for `print`.
13
14
  */
14
15
  defaults: Required<Options>;
16
+ /**
17
+ * Whether any of the provided options require access control to be enabled. If this returns `true`, then calling `print` with the
18
+ * same options would cause the `access` option to default to `'ownable'` if it was `undefined` or `false`.
19
+ */
20
+ isAccessControlRequired: (opts: Partial<Options>) => boolean;
15
21
  }
16
22
  export declare type ERC20 = WizardContractAPI<ERC20Options>;
17
23
  export declare type ERC721 = WizardContractAPI<ERC721Options>;
18
24
  export declare type ERC1155 = WizardContractAPI<ERC1155Options>;
19
25
  export declare type Governor = WizardContractAPI<GovernorOptions>;
26
+ export declare type Custom = WizardContractAPI<CustomOptions>;
20
27
  export declare const erc20: ERC20;
21
28
  export declare const erc721: ERC721;
22
29
  export declare const erc1155: ERC1155;
23
30
  export declare const governor: Governor;
31
+ export declare const custom: Custom;
24
32
  //# sourceMappingURL=api.d.ts.map
package/dist/api.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAyC,YAAY,EAAE,MAAM,SAAS,CAAC;AAC9E,OAAO,EAA2C,aAAa,EAAE,MAAM,UAAU,CAAC;AAClF,OAAO,EAA6C,cAAc,EAAE,MAAM,WAAW,CAAC;AACtF,OAAO,EAA+C,eAAe,EAAE,MAAM,YAAY,CAAC;AAE1F,MAAM,WAAW,iBAAiB,CAAC,OAAO,SAAS,aAAa;IAC9D;;OAEG;IACH,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,KAAK,MAAM,CAAC;IAElC;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;CAC7B;AAED,oBAAY,KAAK,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAAC;AACpD,oBAAY,MAAM,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;AACtD,oBAAY,OAAO,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC;AACxD,oBAAY,QAAQ,GAAG,iBAAiB,CAAC,eAAe,CAAC,CAAC;AAE1D,eAAO,MAAM,KAAK,EAAE,KAGnB,CAAA;AACD,eAAO,MAAM,MAAM,EAAE,MAGpB,CAAA;AACD,eAAO,MAAM,OAAO,EAAE,OAGrB,CAAA;AACD,eAAO,MAAM,QAAQ,EAAE,QAGtB,CAAA"}
1
+ {"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAkG,YAAY,EAAE,MAAM,SAAS,CAAC;AACvI,OAAO,EAAqG,aAAa,EAAE,MAAM,UAAU,CAAC;AAC5I,OAAO,EAAwG,cAAc,EAAE,MAAM,WAAW,CAAC;AACjJ,OAAO,EAA2G,eAAe,EAAE,MAAM,YAAY,CAAC;AACtJ,OAAO,EAAqG,aAAa,EAAE,MAAM,UAAU,CAAC;AAE5I,MAAM,WAAW,iBAAiB,CAAC,OAAO,SAAS,aAAa;IAC9D;;OAEG;IACH,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,KAAK,MAAM,CAAC;IAElC;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAE5B;;;OAGG;IACH,uBAAuB,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC;CAC9D;AAED,oBAAY,KAAK,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAAC;AACpD,oBAAY,MAAM,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;AACtD,oBAAY,OAAO,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC;AACxD,oBAAY,QAAQ,GAAG,iBAAiB,CAAC,eAAe,CAAC,CAAC;AAC1D,oBAAY,MAAM,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;AAEtD,eAAO,MAAM,KAAK,EAAE,KAInB,CAAA;AACD,eAAO,MAAM,MAAM,EAAE,MAIpB,CAAA;AACD,eAAO,MAAM,OAAO,EAAE,OAIrB,CAAA;AACD,eAAO,MAAM,QAAQ,EAAE,QAItB,CAAA;AACD,eAAO,MAAM,MAAM,EAAE,MAIpB,CAAA"}
package/dist/api.js CHANGED
@@ -1,24 +1,34 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.governor = exports.erc1155 = exports.erc721 = exports.erc20 = void 0;
3
+ exports.custom = exports.governor = exports.erc1155 = exports.erc721 = exports.erc20 = void 0;
4
4
  const erc20_1 = require("./erc20");
5
5
  const erc721_1 = require("./erc721");
6
6
  const erc1155_1 = require("./erc1155");
7
7
  const governor_1 = require("./governor");
8
+ const custom_1 = require("./custom");
8
9
  exports.erc20 = {
9
10
  print: erc20_1.printERC20,
10
- defaults: erc20_1.defaults
11
+ defaults: erc20_1.defaults,
12
+ isAccessControlRequired: erc20_1.isAccessControlRequired
11
13
  };
12
14
  exports.erc721 = {
13
15
  print: erc721_1.printERC721,
14
- defaults: erc721_1.defaults
16
+ defaults: erc721_1.defaults,
17
+ isAccessControlRequired: erc721_1.isAccessControlRequired
15
18
  };
16
19
  exports.erc1155 = {
17
20
  print: erc1155_1.printERC1155,
18
- defaults: erc1155_1.defaults
21
+ defaults: erc1155_1.defaults,
22
+ isAccessControlRequired: erc1155_1.isAccessControlRequired
19
23
  };
20
24
  exports.governor = {
21
25
  print: governor_1.printGovernor,
22
- defaults: governor_1.defaults
26
+ defaults: governor_1.defaults,
27
+ isAccessControlRequired: governor_1.isAccessControlRequired
28
+ };
29
+ exports.custom = {
30
+ print: custom_1.printCustom,
31
+ defaults: custom_1.defaults,
32
+ isAccessControlRequired: custom_1.isAccessControlRequired
23
33
  };
24
34
  //# sourceMappingURL=api.js.map
package/dist/api.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;AACA,mCAA8E;AAC9E,qCAAkF;AAClF,uCAAsF;AACtF,yCAA0F;AAmB7E,QAAA,KAAK,GAAU;IAC1B,KAAK,EAAE,kBAAU;IACjB,QAAQ,EAAE,gBAAa;CACxB,CAAA;AACY,QAAA,MAAM,GAAW;IAC5B,KAAK,EAAE,oBAAW;IAClB,QAAQ,EAAE,iBAAc;CACzB,CAAA;AACY,QAAA,OAAO,GAAY;IAC9B,KAAK,EAAE,sBAAY;IACnB,QAAQ,EAAE,kBAAe;CAC1B,CAAA;AACY,QAAA,QAAQ,GAAa;IAChC,KAAK,EAAE,wBAAa;IACpB,QAAQ,EAAE,mBAAgB;CAC3B,CAAA"}
1
+ {"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;AACA,mCAAuI;AACvI,qCAA4I;AAC5I,uCAAiJ;AACjJ,yCAAsJ;AACtJ,qCAA4I;AA0B/H,QAAA,KAAK,GAAU;IAC1B,KAAK,EAAE,kBAAU;IACjB,QAAQ,EAAE,gBAAa;IACvB,uBAAuB,EAAE,+BAA4B;CACtD,CAAA;AACY,QAAA,MAAM,GAAW;IAC5B,KAAK,EAAE,oBAAW;IAClB,QAAQ,EAAE,iBAAc;IACxB,uBAAuB,EAAE,gCAA6B;CACvD,CAAA;AACY,QAAA,OAAO,GAAY;IAC9B,KAAK,EAAE,sBAAY;IACnB,QAAQ,EAAE,kBAAe;IACzB,uBAAuB,EAAE,iCAA8B;CACxD,CAAA;AACY,QAAA,QAAQ,GAAa;IAChC,KAAK,EAAE,wBAAa;IACpB,QAAQ,EAAE,mBAAgB;IAC1B,uBAAuB,EAAE,kCAA+B;CACzD,CAAA;AACY,QAAA,MAAM,GAAW;IAC5B,KAAK,EAAE,oBAAW;IAClB,QAAQ,EAAE,iBAAc;IACxB,uBAAuB,EAAE,gCAA6B;CACvD,CAAA"}
@@ -1,3 +1,4 @@
1
+ import { CustomOptions } from './custom';
1
2
  import { ERC20Options } from './erc20';
2
3
  import { ERC721Options } from './erc721';
3
4
  import { ERC1155Options } from './erc1155';
@@ -15,6 +16,9 @@ export interface KindedOptions {
15
16
  Governor: {
16
17
  kind: 'Governor';
17
18
  } & GovernorOptions;
19
+ Custom: {
20
+ kind: 'Custom';
21
+ } & CustomOptions;
18
22
  }
19
23
  export declare type GenericOptions = KindedOptions[keyof KindedOptions];
20
24
  export declare function buildGeneric(opts: GenericOptions): import("./contract").Contract;
@@ -1 +1 @@
1
- {"version":3,"file":"build-generic.d.ts","sourceRoot":"","sources":["../src/build-generic.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAc,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,aAAa,EAAe,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,cAAc,EAAgB,MAAM,WAAW,CAAC;AACzD,OAAO,EAAE,eAAe,EAAiB,MAAM,YAAY,CAAC;AAE5D,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAK;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE,GAAM,YAAY,CAAC;IAC9C,MAAM,EAAI;QAAE,IAAI,EAAE,QAAQ,CAAA;KAAE,GAAK,aAAa,CAAC;IAC/C,OAAO,EAAG;QAAE,IAAI,EAAE,SAAS,CAAA;KAAE,GAAI,cAAc,CAAC;IAChD,QAAQ,EAAE;QAAE,IAAI,EAAE,UAAU,CAAA;KAAE,GAAG,eAAe,CAAC;CAClD;AAED,oBAAY,cAAc,GAAG,aAAa,CAAC,MAAM,aAAa,CAAC,CAAC;AAEhE,wBAAgB,YAAY,CAAC,IAAI,EAAE,cAAc,iCAkBhD"}
1
+ {"version":3,"file":"build-generic.d.ts","sourceRoot":"","sources":["../src/build-generic.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAe,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,YAAY,EAAc,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,aAAa,EAAe,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,cAAc,EAAgB,MAAM,WAAW,CAAC;AACzD,OAAO,EAAE,eAAe,EAAiB,MAAM,YAAY,CAAC;AAE5D,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAK;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE,GAAM,YAAY,CAAC;IAC9C,MAAM,EAAI;QAAE,IAAI,EAAE,QAAQ,CAAA;KAAE,GAAK,aAAa,CAAC;IAC/C,OAAO,EAAG;QAAE,IAAI,EAAE,SAAS,CAAA;KAAE,GAAI,cAAc,CAAC;IAChD,QAAQ,EAAE;QAAE,IAAI,EAAE,UAAU,CAAA;KAAE,GAAG,eAAe,CAAC;IACjD,MAAM,EAAG;QAAE,IAAI,EAAE,QAAQ,CAAA;KAAE,GAAI,aAAa,CAAC;CAC9C;AAED,oBAAY,cAAc,GAAG,aAAa,CAAC,MAAM,aAAa,CAAC,CAAC;AAEhE,wBAAgB,YAAY,CAAC,IAAI,EAAE,cAAc,iCAqBhD"}
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.buildGeneric = void 0;
4
+ const custom_1 = require("./custom");
4
5
  const erc20_1 = require("./erc20");
5
6
  const erc721_1 = require("./erc721");
6
7
  const erc1155_1 = require("./erc1155");
@@ -15,6 +16,8 @@ function buildGeneric(opts) {
15
16
  return (0, erc1155_1.buildERC1155)(opts);
16
17
  case 'Governor':
17
18
  return (0, governor_1.buildGovernor)(opts);
19
+ case 'Custom':
20
+ return (0, custom_1.buildCustom)(opts);
18
21
  default:
19
22
  const _ = opts;
20
23
  throw new Error('Unknown ERC');
@@ -1 +1 @@
1
- {"version":3,"file":"build-generic.js","sourceRoot":"","sources":["../src/build-generic.ts"],"names":[],"mappings":";;;AAAA,mCAAmD;AACnD,qCAAsD;AACtD,uCAAyD;AACzD,yCAA4D;AAW5D,SAAgB,YAAY,CAAC,IAAoB;IAC/C,QAAQ,IAAI,CAAC,IAAI,EAAE;QACjB,KAAK,OAAO;YACV,OAAO,IAAA,kBAAU,EAAC,IAAI,CAAC,CAAC;QAE1B,KAAK,QAAQ;YACX,OAAO,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAE3B,KAAK,SAAS;YACZ,OAAO,IAAA,sBAAY,EAAC,IAAI,CAAC,CAAC;QAE5B,KAAK,UAAU;YACb,OAAO,IAAA,wBAAa,EAAC,IAAI,CAAC,CAAC;QAE7B;YACE,MAAM,CAAC,GAAU,IAAI,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;KAClC;AACH,CAAC;AAlBD,oCAkBC"}
1
+ {"version":3,"file":"build-generic.js","sourceRoot":"","sources":["../src/build-generic.ts"],"names":[],"mappings":";;;AAAA,qCAAsD;AACtD,mCAAmD;AACnD,qCAAsD;AACtD,uCAAyD;AACzD,yCAA4D;AAY5D,SAAgB,YAAY,CAAC,IAAoB;IAC/C,QAAQ,IAAI,CAAC,IAAI,EAAE;QACjB,KAAK,OAAO;YACV,OAAO,IAAA,kBAAU,EAAC,IAAI,CAAC,CAAC;QAE1B,KAAK,QAAQ;YACX,OAAO,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAE3B,KAAK,SAAS;YACZ,OAAO,IAAA,sBAAY,EAAC,IAAI,CAAC,CAAC;QAE5B,KAAK,UAAU;YACb,OAAO,IAAA,wBAAa,EAAC,IAAI,CAAC,CAAC;QAE7B,KAAK,QAAQ;YACX,OAAO,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAE3B;YACE,MAAM,CAAC,GAAU,IAAI,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;KAClC;AACH,CAAC;AArBD,oCAqBC"}
@@ -3,14 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.withCommonDefaults = exports.defaults = void 0;
4
4
  const set_info_1 = require("./set-info");
5
5
  exports.defaults = {
6
- access: 'ownable',
6
+ access: false,
7
7
  upgradeable: false,
8
8
  info: set_info_1.defaults,
9
9
  };
10
10
  function withCommonDefaults(opts) {
11
11
  var _a, _b, _c;
12
12
  return {
13
- access: (_a = opts.access) !== null && _a !== void 0 ? _a : 'ownable',
13
+ access: (_a = opts.access) !== null && _a !== void 0 ? _a : false,
14
14
  upgradeable: (_b = opts.upgradeable) !== null && _b !== void 0 ? _b : false,
15
15
  info: (_c = opts.info) !== null && _c !== void 0 ? _c : {},
16
16
  };
@@ -1 +1 @@
1
- {"version":3,"file":"common-options.js","sourceRoot":"","sources":["../src/common-options.ts"],"names":[],"mappings":";;;AAEA,yCAAsD;AAGzC,QAAA,QAAQ,GAA4B;IAC/C,MAAM,EAAE,SAAS;IACjB,WAAW,EAAE,KAAK;IAClB,IAAI,EAAE,mBAAY;CACV,CAAC;AAQX,SAAgB,kBAAkB,CAAC,IAAmB;;IACpD,OAAO;QACL,MAAM,EAAE,MAAA,IAAI,CAAC,MAAM,mCAAI,SAAS;QAChC,WAAW,EAAE,MAAA,IAAI,CAAC,WAAW,mCAAI,KAAK;QACtC,IAAI,EAAE,MAAA,IAAI,CAAC,IAAI,mCAAI,EAAE;KACtB,CAAC;AACJ,CAAC;AAND,gDAMC"}
1
+ {"version":3,"file":"common-options.js","sourceRoot":"","sources":["../src/common-options.ts"],"names":[],"mappings":";;;AAEA,yCAAsD;AAGzC,QAAA,QAAQ,GAA4B;IAC/C,MAAM,EAAE,KAAK;IACb,WAAW,EAAE,KAAK;IAClB,IAAI,EAAE,mBAAY;CACV,CAAC;AAQX,SAAgB,kBAAkB,CAAC,IAAmB;;IACpD,OAAO;QACL,MAAM,EAAE,MAAA,IAAI,CAAC,MAAM,mCAAI,KAAK;QAC5B,WAAW,EAAE,MAAA,IAAI,CAAC,WAAW,mCAAI,KAAK;QACtC,IAAI,EAAE,MAAA,IAAI,CAAC,IAAI,mCAAI,EAAE;KACtB,CAAC;AACJ,CAAC;AAND,gDAMC"}
@@ -0,0 +1,11 @@
1
+ import { Contract } from './contract';
2
+ import { CommonOptions } from './common-options';
3
+ export interface CustomOptions extends CommonOptions {
4
+ name: string;
5
+ pausable?: boolean;
6
+ }
7
+ export declare const defaults: Required<CustomOptions>;
8
+ export declare function printCustom(opts?: CustomOptions): string;
9
+ export declare function isAccessControlRequired(opts: Partial<CustomOptions>): boolean;
10
+ export declare function buildCustom(opts: CustomOptions): Contract;
11
+ //# sourceMappingURL=custom.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"custom.d.ts","sourceRoot":"","sources":["../src/custom.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAmB,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,aAAa,EAAkD,MAAM,kBAAkB,CAAC;AAOjG,MAAM,WAAW,aAAc,SAAQ,aAAa;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAAC,aAAa,CAMnC,CAAC;AAUX,wBAAgB,WAAW,CAAC,IAAI,GAAE,aAAwB,GAAG,MAAM,CAElE;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,OAAO,CAE7E;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,aAAa,GAAG,QAAQ,CAgBzD"}
package/dist/custom.js ADDED
@@ -0,0 +1,47 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.buildCustom = exports.isAccessControlRequired = exports.printCustom = exports.defaults = void 0;
4
+ const contract_1 = require("./contract");
5
+ const common_options_1 = require("./common-options");
6
+ const set_upgradeable_1 = require("./set-upgradeable");
7
+ const set_info_1 = require("./set-info");
8
+ const set_access_control_1 = require("./set-access-control");
9
+ const add_pausable_1 = require("./add-pausable");
10
+ const print_1 = require("./print");
11
+ exports.defaults = {
12
+ name: 'MyContract',
13
+ pausable: false,
14
+ access: common_options_1.defaults.access,
15
+ upgradeable: common_options_1.defaults.upgradeable,
16
+ info: common_options_1.defaults.info,
17
+ };
18
+ function withDefaults(opts) {
19
+ var _a;
20
+ return {
21
+ ...opts,
22
+ ...(0, common_options_1.withCommonDefaults)(opts),
23
+ pausable: (_a = opts.pausable) !== null && _a !== void 0 ? _a : exports.defaults.pausable,
24
+ };
25
+ }
26
+ function printCustom(opts = exports.defaults) {
27
+ return (0, print_1.printContract)(buildCustom(opts));
28
+ }
29
+ exports.printCustom = printCustom;
30
+ function isAccessControlRequired(opts) {
31
+ return opts.pausable || opts.upgradeable === 'uups';
32
+ }
33
+ exports.isAccessControlRequired = isAccessControlRequired;
34
+ function buildCustom(opts) {
35
+ const allOpts = withDefaults(opts);
36
+ const c = new contract_1.ContractBuilder(allOpts.name);
37
+ const { access, upgradeable, info } = allOpts;
38
+ if (allOpts.pausable) {
39
+ (0, add_pausable_1.addPausable)(c, access, []);
40
+ }
41
+ (0, set_access_control_1.setAccessControl)(c, access);
42
+ (0, set_upgradeable_1.setUpgradeable)(c, upgradeable, access);
43
+ (0, set_info_1.setInfo)(c, info);
44
+ return c;
45
+ }
46
+ exports.buildCustom = buildCustom;
47
+ //# sourceMappingURL=custom.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"custom.js","sourceRoot":"","sources":["../src/custom.ts"],"names":[],"mappings":";;;AAAA,yCAAuD;AACvD,qDAAiG;AACjG,uDAAmD;AACnD,yCAAqC;AACrC,6DAAwD;AACxD,iDAA6C;AAC7C,mCAAwC;AAO3B,QAAA,QAAQ,GAA4B;IAC/C,IAAI,EAAE,YAAY;IAClB,QAAQ,EAAE,KAAK;IACf,MAAM,EAAE,yBAAc,CAAC,MAAM;IAC7B,WAAW,EAAE,yBAAc,CAAC,WAAW;IACvC,IAAI,EAAE,yBAAc,CAAC,IAAI;CACjB,CAAC;AAEX,SAAS,YAAY,CAAC,IAAmB;;IACvC,OAAO;QACL,GAAG,IAAI;QACP,GAAG,IAAA,mCAAkB,EAAC,IAAI,CAAC;QAC3B,QAAQ,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,gBAAQ,CAAC,QAAQ;KAC7C,CAAC;AACJ,CAAC;AAED,SAAgB,WAAW,CAAC,OAAsB,gBAAQ;IACxD,OAAO,IAAA,qBAAa,EAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;AAC1C,CAAC;AAFD,kCAEC;AAED,SAAgB,uBAAuB,CAAC,IAA4B;IAClE,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,WAAW,KAAK,MAAM,CAAC;AACtD,CAAC;AAFD,0DAEC;AAED,SAAgB,WAAW,CAAC,IAAmB;IAC7C,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAEnC,MAAM,CAAC,GAAG,IAAI,0BAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAE9C,IAAI,OAAO,CAAC,QAAQ,EAAE;QACpB,IAAA,0BAAW,EAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;KAC5B;IAED,IAAA,qCAAgB,EAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IAC5B,IAAA,gCAAc,EAAC,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;IACvC,IAAA,kBAAO,EAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAEjB,OAAO,CAAC,CAAC;AACX,CAAC;AAhBD,kCAgBC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=custom.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"custom.test.d.ts","sourceRoot":"","sources":["../src/custom.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,70 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ const ava_1 = __importDefault(require("ava"));
7
+ const _1 = require(".");
8
+ const custom_1 = require("./custom");
9
+ const print_1 = require("./print");
10
+ function testCustom(title, opts) {
11
+ (0, ava_1.default)(title, t => {
12
+ const c = (0, custom_1.buildCustom)({
13
+ name: 'MyContract',
14
+ ...opts,
15
+ });
16
+ t.snapshot((0, print_1.printContract)(c));
17
+ });
18
+ }
19
+ /**
20
+ * Tests external API for equivalence with internal API
21
+ */
22
+ function testAPIEquivalence(title, opts) {
23
+ (0, ava_1.default)(title, t => {
24
+ t.is(_1.custom.print(opts), (0, print_1.printContract)((0, custom_1.buildCustom)({
25
+ name: 'MyContract',
26
+ ...opts,
27
+ })));
28
+ });
29
+ }
30
+ testCustom('custom', {});
31
+ testCustom('pausable', {
32
+ pausable: true,
33
+ });
34
+ testCustom('upgradeable transparent', {
35
+ upgradeable: 'transparent',
36
+ });
37
+ testCustom('upgradeable uups', {
38
+ upgradeable: 'uups',
39
+ });
40
+ testCustom('access control disabled', {
41
+ access: false,
42
+ });
43
+ testCustom('access control ownable', {
44
+ access: 'ownable',
45
+ });
46
+ testCustom('access control roles', {
47
+ access: 'roles',
48
+ });
49
+ testCustom('upgradeable uups with access control disabled', {
50
+ // API should override access to true since it is required for UUPS
51
+ access: false,
52
+ upgradeable: 'uups',
53
+ });
54
+ testAPIEquivalence('custom API default');
55
+ testAPIEquivalence('custom API basic', { name: 'CustomContract' });
56
+ testAPIEquivalence('custom API full upgradeable', {
57
+ name: 'CustomContract',
58
+ access: 'roles',
59
+ pausable: true,
60
+ upgradeable: 'uups',
61
+ });
62
+ (0, ava_1.default)('custom API assert defaults', async (t) => {
63
+ t.is(_1.custom.print(_1.custom.defaults), _1.custom.print());
64
+ });
65
+ (0, ava_1.default)('API isAccessControlRequired', async (t) => {
66
+ t.is(_1.custom.isAccessControlRequired({ pausable: true }), true);
67
+ t.is(_1.custom.isAccessControlRequired({ upgradeable: 'uups' }), true);
68
+ t.is(_1.custom.isAccessControlRequired({ upgradeable: 'transparent' }), false);
69
+ });
70
+ //# sourceMappingURL=custom.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"custom.test.js","sourceRoot":"","sources":["../src/custom.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAuB;AACvB,wBAA2B;AAE3B,qCAAsD;AACtD,mCAAwC;AAExC,SAAS,UAAU,CAAC,KAAa,EAAE,IAA4B;IAC7D,IAAA,aAAI,EAAC,KAAK,EAAE,CAAC,CAAC,EAAE;QACd,MAAM,CAAC,GAAG,IAAA,oBAAW,EAAC;YACpB,IAAI,EAAE,YAAY;YAClB,GAAG,IAAI;SACR,CAAC,CAAC;QACH,CAAC,CAAC,QAAQ,CAAC,IAAA,qBAAa,EAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACF,SAAS,kBAAkB,CAAC,KAAa,EAAE,IAAoB;IAC9D,IAAA,aAAI,EAAC,KAAK,EAAE,CAAC,CAAC,EAAE;QACd,CAAC,CAAC,EAAE,CAAC,SAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAA,qBAAa,EAAC,IAAA,oBAAW,EAAC;YACjD,IAAI,EAAE,YAAY;YAClB,GAAG,IAAI;SACR,CAAC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC;AAED,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAEzB,UAAU,CAAC,UAAU,EAAE;IACrB,QAAQ,EAAE,IAAI;CACf,CAAC,CAAC;AAEH,UAAU,CAAC,yBAAyB,EAAE;IACpC,WAAW,EAAE,aAAa;CAC3B,CAAC,CAAC;AAEH,UAAU,CAAC,kBAAkB,EAAE;IAC7B,WAAW,EAAE,MAAM;CACpB,CAAC,CAAC;AAEH,UAAU,CAAC,yBAAyB,EAAE;IACpC,MAAM,EAAE,KAAK;CACd,CAAC,CAAC;AAEH,UAAU,CAAC,wBAAwB,EAAE;IACnC,MAAM,EAAE,SAAS;CAClB,CAAC,CAAC;AAEH,UAAU,CAAC,sBAAsB,EAAE;IACjC,MAAM,EAAE,OAAO;CAChB,CAAC,CAAC;AAEH,UAAU,CAAC,+CAA+C,EAAE;IAC1D,mEAAmE;IACnE,MAAM,EAAE,KAAK;IACb,WAAW,EAAE,MAAM;CACpB,CAAC,CAAC;AAEH,kBAAkB,CAAC,oBAAoB,CAAC,CAAC;AAEzC,kBAAkB,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC,CAAC;AAEnE,kBAAkB,CAAC,6BAA6B,EAAE;IAChD,IAAI,EAAE,gBAAgB;IACtB,MAAM,EAAE,OAAO;IACf,QAAQ,EAAE,IAAI;IACd,WAAW,EAAE,MAAM;CACpB,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,4BAA4B,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC3C,CAAC,CAAC,EAAE,CAAC,SAAM,CAAC,KAAK,CAAC,SAAM,CAAC,QAAQ,CAAC,EAAE,SAAM,CAAC,KAAK,EAAE,CAAC,CAAC;AACtD,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,6BAA6B,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC5C,CAAC,CAAC,EAAE,CAAC,SAAM,CAAC,uBAAuB,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IAC/D,CAAC,CAAC,EAAE,CAAC,SAAM,CAAC,uBAAuB,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IACpE,CAAC,CAAC,EAAE,CAAC,SAAM,CAAC,uBAAuB,CAAC,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;AAC9E,CAAC,CAAC,CAAC"}
package/dist/erc1155.d.ts CHANGED
@@ -7,8 +7,10 @@ export interface ERC1155Options extends CommonOptions {
7
7
  pausable?: boolean;
8
8
  mintable?: boolean;
9
9
  supply?: boolean;
10
+ updatableUri?: boolean;
10
11
  }
11
12
  export declare const defaults: Required<ERC1155Options>;
12
13
  export declare function printERC1155(opts?: ERC1155Options): string;
14
+ export declare function isAccessControlRequired(opts: Partial<ERC1155Options>): boolean;
13
15
  export declare function buildERC1155(opts: ERC1155Options): Contract;
14
16
  //# sourceMappingURL=erc1155.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"erc1155.d.ts","sourceRoot":"","sources":["../src/erc1155.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAmB,MAAM,YAAY,CAAC;AAKvD,OAAO,EAAE,aAAa,EAAkD,MAAM,kBAAkB,CAAC;AAKjG,MAAM,WAAW,cAAe,SAAQ,aAAa;IACnD,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAAC,cAAc,CAUpC,CAAC;AAaX,wBAAgB,YAAY,CAAC,IAAI,GAAE,cAAyB,GAAG,MAAM,CAEpE;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,cAAc,GAAG,QAAQ,CA+B3D"}
1
+ {"version":3,"file":"erc1155.d.ts","sourceRoot":"","sources":["../src/erc1155.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAmB,MAAM,YAAY,CAAC;AAKvD,OAAO,EAAE,aAAa,EAAkD,MAAM,kBAAkB,CAAC;AAKjG,MAAM,WAAW,cAAe,SAAQ,aAAa;IACnD,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAAC,cAAc,CAWpC,CAAC;AAcX,wBAAgB,YAAY,CAAC,IAAI,GAAE,cAAyB,GAAG,MAAM,CAEpE;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAE9E;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,cAAc,GAAG,QAAQ,CAkC3D"}
package/dist/erc1155.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.buildERC1155 = exports.printERC1155 = exports.defaults = void 0;
3
+ exports.buildERC1155 = exports.isAccessControlRequired = exports.printERC1155 = exports.defaults = void 0;
4
4
  const contract_1 = require("./contract");
5
5
  const set_access_control_1 = require("./set-access-control");
6
6
  const add_pausable_1 = require("./add-pausable");
@@ -17,12 +17,13 @@ exports.defaults = {
17
17
  pausable: false,
18
18
  mintable: false,
19
19
  supply: false,
20
- access: common_options_1.defaults.access,
20
+ updatableUri: true,
21
+ access: false,
21
22
  upgradeable: common_options_1.defaults.upgradeable,
22
23
  info: common_options_1.defaults.info
23
24
  };
24
25
  function withDefaults(opts) {
25
- var _a, _b, _c, _d;
26
+ var _a, _b, _c, _d, _e;
26
27
  return {
27
28
  ...opts,
28
29
  ...(0, common_options_1.withCommonDefaults)(opts),
@@ -30,18 +31,25 @@ function withDefaults(opts) {
30
31
  pausable: (_b = opts.pausable) !== null && _b !== void 0 ? _b : exports.defaults.pausable,
31
32
  mintable: (_c = opts.mintable) !== null && _c !== void 0 ? _c : exports.defaults.mintable,
32
33
  supply: (_d = opts.supply) !== null && _d !== void 0 ? _d : exports.defaults.supply,
34
+ updatableUri: (_e = opts.updatableUri) !== null && _e !== void 0 ? _e : exports.defaults.updatableUri,
33
35
  };
34
36
  }
35
37
  function printERC1155(opts = exports.defaults) {
36
38
  return (0, print_1.printContract)(buildERC1155(opts));
37
39
  }
38
40
  exports.printERC1155 = printERC1155;
41
+ function isAccessControlRequired(opts) {
42
+ return opts.mintable || opts.pausable || opts.updatableUri !== false || opts.upgradeable === 'uups';
43
+ }
44
+ exports.isAccessControlRequired = isAccessControlRequired;
39
45
  function buildERC1155(opts) {
40
46
  const allOpts = withDefaults(opts);
41
47
  const c = new contract_1.ContractBuilder(allOpts.name);
42
48
  const { access, upgradeable, info } = allOpts;
43
49
  addBase(c, allOpts.uri);
44
- addSetUri(c, access);
50
+ if (allOpts.updatableUri) {
51
+ addSetUri(c, access);
52
+ }
45
53
  if (allOpts.pausable) {
46
54
  (0, add_pausable_1.addPausable)(c, access, [functions._beforeTokenTransfer]);
47
55
  }
@@ -54,6 +62,7 @@ function buildERC1155(opts) {
54
62
  if (allOpts.supply) {
55
63
  addSupply(c);
56
64
  }
65
+ (0, set_access_control_1.setAccessControl)(c, access);
57
66
  (0, set_upgradeable_1.setUpgradeable)(c, upgradeable, access);
58
67
  (0, set_info_1.setInfo)(c, info);
59
68
  return c;
@@ -74,13 +83,13 @@ function addBurnable(c) {
74
83
  });
75
84
  }
76
85
  function addMintable(c, access) {
77
- (0, set_access_control_1.setAccessControl)(c, functions.mint, access, 'MINTER');
78
- (0, set_access_control_1.setAccessControl)(c, functions.mintBatch, access, 'MINTER');
86
+ (0, set_access_control_1.requireAccessControl)(c, functions.mint, access, 'MINTER');
87
+ (0, set_access_control_1.requireAccessControl)(c, functions.mintBatch, access, 'MINTER');
79
88
  c.addFunctionCode('_mint(account, id, amount, data);', functions.mint);
80
89
  c.addFunctionCode('_mintBatch(to, ids, amounts, data);', functions.mintBatch);
81
90
  }
82
91
  function addSetUri(c, access) {
83
- (0, set_access_control_1.setAccessControl)(c, functions.setURI, access, 'URI_SETTER');
92
+ (0, set_access_control_1.requireAccessControl)(c, functions.setURI, access, 'URI_SETTER');
84
93
  c.addFunctionCode('_setURI(newuri);', functions.setURI);
85
94
  }
86
95
  function addSupply(c) {
@@ -1 +1 @@
1
- {"version":3,"file":"erc1155.js","sourceRoot":"","sources":["../src/erc1155.ts"],"names":[],"mappings":";;;AAAA,yCAAuD;AACvD,6DAAgE;AAChE,iDAA6C;AAC7C,yDAAuD;AACvD,+DAA2D;AAC3D,qDAAiG;AACjG,uDAAmD;AACnD,yCAAqC;AACrC,mCAAwC;AAW3B,QAAA,QAAQ,GAA6B;IAChD,IAAI,EAAE,SAAS;IACf,GAAG,EAAE,EAAE;IACP,QAAQ,EAAE,KAAK;IACf,QAAQ,EAAE,KAAK;IACf,QAAQ,EAAE,KAAK;IACf,MAAM,EAAE,KAAK;IACb,MAAM,EAAE,yBAAc,CAAC,MAAM;IAC7B,WAAW,EAAE,yBAAc,CAAC,WAAW;IACvC,IAAI,EAAE,yBAAc,CAAC,IAAI;CACjB,CAAC;AAEX,SAAS,YAAY,CAAC,IAAoB;;IACxC,OAAO;QACL,GAAG,IAAI;QACP,GAAG,IAAA,mCAAkB,EAAC,IAAI,CAAC;QAC3B,QAAQ,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,gBAAQ,CAAC,QAAQ;QAC5C,QAAQ,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,gBAAQ,CAAC,QAAQ;QAC5C,QAAQ,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,gBAAQ,CAAC,QAAQ;QAC5C,MAAM,EAAE,MAAA,IAAI,CAAC,MAAM,mCAAI,gBAAQ,CAAC,MAAM;KACvC,CAAC;AACJ,CAAC;AAED,SAAgB,YAAY,CAAC,OAAuB,gBAAQ;IAC1D,OAAO,IAAA,qBAAa,EAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3C,CAAC;AAFD,oCAEC;AAED,SAAgB,YAAY,CAAC,IAAoB;IAC/C,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAEnC,MAAM,CAAC,GAAG,IAAI,0BAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAE9C,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACxB,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IAErB,IAAI,OAAO,CAAC,QAAQ,EAAE;QACpB,IAAA,0BAAW,EAAC,CAAC,EAAE,MAAM,EAAE,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC,CAAC;KAC1D;IAED,IAAI,OAAO,CAAC,QAAQ,EAAE;QACpB,WAAW,CAAC,CAAC,CAAC,CAAC;KAChB;IAED,IAAI,OAAO,CAAC,QAAQ,EAAE;QACpB,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;KACxB;IAED,IAAI,OAAO,CAAC,MAAM,EAAE;QAClB,SAAS,CAAC,CAAC,CAAC,CAAC;KACd;IAED,IAAA,gCAAc,EAAC,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;IAEvC,IAAA,kBAAO,EAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAEjB,OAAO,CAAC,CAAC;AACX,CAAC;AA/BD,oCA+BC;AAED,SAAS,OAAO,CAAC,CAAkB,EAAE,GAAW;IAC9C,CAAC,CAAC,SAAS,CACT;QACE,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,mDAAmD;KAC1D,EACD,CAAC,GAAG,CAAC,CACN,CAAC;IAEF,CAAC,CAAC,WAAW,CAAC,SAAS,EAAE,SAAS,CAAC,oBAAoB,CAAC,CAAC;IACzD,CAAC,CAAC,WAAW,CAAC,SAAS,EAAE,oCAAiB,CAAC,CAAC;AAC9C,CAAC;AAED,SAAS,WAAW,CAAC,CAAkB;IACrC,CAAC,CAAC,SAAS,CAAC;QACV,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,sEAAsE;KAC7E,CAAC,CAAC;AACL,CAAC;AAED,SAAS,WAAW,CAAC,CAAkB,EAAE,MAAc;IACrD,IAAA,qCAAgB,EAAC,CAAC,EAAE,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACtD,IAAA,qCAAgB,EAAC,CAAC,EAAE,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC,CAAC,eAAe,CAAC,mCAAmC,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IACvE,CAAC,CAAC,eAAe,CAAC,qCAAqC,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;AAChF,CAAC;AAED,SAAS,SAAS,CAAC,CAAkB,EAAE,MAAc;IACnD,IAAA,qCAAgB,EAAC,CAAC,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;IAC5D,CAAC,CAAC,eAAe,CAAC,kBAAkB,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;AAC1D,CAAC;AAED,SAAS,SAAS,CAAC,CAAkB;IACnC,CAAC,CAAC,SAAS,CAAC;QACV,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,oEAAoE;KAC3E,CAAC,CAAC;IACH,CAAC,CAAC,WAAW,CAAC,eAAe,EAAE,SAAS,CAAC,oBAAoB,CAAC,CAAC;AACjE,CAAC;AAED,MAAM,SAAS,GAAG,IAAA,kCAAe,EAAC;IAChC,oBAAoB,EAAE;QACpB,IAAI,EAAE,UAAmB;QACzB,IAAI,EAAE;YACJ,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;YACrC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE;YACjC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE;YAC/B,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,kBAAkB,EAAE;YACzC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,kBAAkB,EAAE;YAC7C,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE;SACvC;KACF;IAED,MAAM,EAAE;QACN,IAAI,EAAE,QAAiB;QACvB,IAAI,EAAE;YACJ,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,eAAe,EAAE;SAC1C;KACF;IAED,IAAI,EAAE;QACJ,IAAI,EAAE,QAAiB;QACvB,IAAI,EAAE;YACJ,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;YACpC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE;YAC/B,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;YACnC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE;SACvC;KACF;IAED,SAAS,EAAE;QACT,IAAI,EAAE,QAAiB;QACvB,IAAI,EAAE;YACJ,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE;YAC/B,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,kBAAkB,EAAE;YACzC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,kBAAkB,EAAE;YAC7C,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE;SACvC;KACF;CAEF,CAAC,CAAC"}
1
+ {"version":3,"file":"erc1155.js","sourceRoot":"","sources":["../src/erc1155.ts"],"names":[],"mappings":";;;AAAA,yCAAuD;AACvD,6DAAsF;AACtF,iDAA6C;AAC7C,yDAAuD;AACvD,+DAA2D;AAC3D,qDAAiG;AACjG,uDAAmD;AACnD,yCAAqC;AACrC,mCAAwC;AAY3B,QAAA,QAAQ,GAA6B;IAChD,IAAI,EAAE,SAAS;IACf,GAAG,EAAE,EAAE;IACP,QAAQ,EAAE,KAAK;IACf,QAAQ,EAAE,KAAK;IACf,QAAQ,EAAE,KAAK;IACf,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,IAAI;IAClB,MAAM,EAAE,KAAK;IACb,WAAW,EAAE,yBAAc,CAAC,WAAW;IACvC,IAAI,EAAE,yBAAc,CAAC,IAAI;CACjB,CAAC;AAEX,SAAS,YAAY,CAAC,IAAoB;;IACxC,OAAO;QACL,GAAG,IAAI;QACP,GAAG,IAAA,mCAAkB,EAAC,IAAI,CAAC;QAC3B,QAAQ,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,gBAAQ,CAAC,QAAQ;QAC5C,QAAQ,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,gBAAQ,CAAC,QAAQ;QAC5C,QAAQ,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,gBAAQ,CAAC,QAAQ;QAC5C,MAAM,EAAE,MAAA,IAAI,CAAC,MAAM,mCAAI,gBAAQ,CAAC,MAAM;QACtC,YAAY,EAAE,MAAA,IAAI,CAAC,YAAY,mCAAI,gBAAQ,CAAC,YAAY;KACzD,CAAC;AACJ,CAAC;AAED,SAAgB,YAAY,CAAC,OAAuB,gBAAQ;IAC1D,OAAO,IAAA,qBAAa,EAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3C,CAAC;AAFD,oCAEC;AAED,SAAgB,uBAAuB,CAAC,IAA6B;IACnE,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,IAAI,IAAI,CAAC,WAAW,KAAK,MAAM,CAAC;AACtG,CAAC;AAFD,0DAEC;AAED,SAAgB,YAAY,CAAC,IAAoB;IAC/C,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAEnC,MAAM,CAAC,GAAG,IAAI,0BAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAE9C,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IAExB,IAAI,OAAO,CAAC,YAAY,EAAE;QACxB,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;KACtB;IAED,IAAI,OAAO,CAAC,QAAQ,EAAE;QACpB,IAAA,0BAAW,EAAC,CAAC,EAAE,MAAM,EAAE,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC,CAAC;KAC1D;IAED,IAAI,OAAO,CAAC,QAAQ,EAAE;QACpB,WAAW,CAAC,CAAC,CAAC,CAAC;KAChB;IAED,IAAI,OAAO,CAAC,QAAQ,EAAE;QACpB,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;KACxB;IAED,IAAI,OAAO,CAAC,MAAM,EAAE;QAClB,SAAS,CAAC,CAAC,CAAC,CAAC;KACd;IAED,IAAA,qCAAgB,EAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IAC5B,IAAA,gCAAc,EAAC,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;IACvC,IAAA,kBAAO,EAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAEjB,OAAO,CAAC,CAAC;AACX,CAAC;AAlCD,oCAkCC;AAED,SAAS,OAAO,CAAC,CAAkB,EAAE,GAAW;IAC9C,CAAC,CAAC,SAAS,CACT;QACE,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,mDAAmD;KAC1D,EACD,CAAC,GAAG,CAAC,CACN,CAAC;IAEF,CAAC,CAAC,WAAW,CAAC,SAAS,EAAE,SAAS,CAAC,oBAAoB,CAAC,CAAC;IACzD,CAAC,CAAC,WAAW,CAAC,SAAS,EAAE,oCAAiB,CAAC,CAAC;AAC9C,CAAC;AAED,SAAS,WAAW,CAAC,CAAkB;IACrC,CAAC,CAAC,SAAS,CAAC;QACV,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,sEAAsE;KAC7E,CAAC,CAAC;AACL,CAAC;AAED,SAAS,WAAW,CAAC,CAAkB,EAAE,MAAc;IACrD,IAAA,yCAAoB,EAAC,CAAC,EAAE,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC1D,IAAA,yCAAoB,EAAC,CAAC,EAAE,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC/D,CAAC,CAAC,eAAe,CAAC,mCAAmC,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IACvE,CAAC,CAAC,eAAe,CAAC,qCAAqC,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;AAChF,CAAC;AAED,SAAS,SAAS,CAAC,CAAkB,EAAE,MAAc;IACnD,IAAA,yCAAoB,EAAC,CAAC,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;IAChE,CAAC,CAAC,eAAe,CAAC,kBAAkB,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;AAC1D,CAAC;AAED,SAAS,SAAS,CAAC,CAAkB;IACnC,CAAC,CAAC,SAAS,CAAC;QACV,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,oEAAoE;KAC3E,CAAC,CAAC;IACH,CAAC,CAAC,WAAW,CAAC,eAAe,EAAE,SAAS,CAAC,oBAAoB,CAAC,CAAC;AACjE,CAAC;AAED,MAAM,SAAS,GAAG,IAAA,kCAAe,EAAC;IAChC,oBAAoB,EAAE;QACpB,IAAI,EAAE,UAAmB;QACzB,IAAI,EAAE;YACJ,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;YACrC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE;YACjC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE;YAC/B,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,kBAAkB,EAAE;YACzC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,kBAAkB,EAAE;YAC7C,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE;SACvC;KACF;IAED,MAAM,EAAE;QACN,IAAI,EAAE,QAAiB;QACvB,IAAI,EAAE;YACJ,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,eAAe,EAAE;SAC1C;KACF;IAED,IAAI,EAAE;QACJ,IAAI,EAAE,QAAiB;QACvB,IAAI,EAAE;YACJ,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;YACpC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE;YAC/B,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;YACnC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE;SACvC;KACF;IAED,SAAS,EAAE;QACT,IAAI,EAAE,QAAiB;QACvB,IAAI,EAAE;YACJ,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE;YAC/B,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,kBAAkB,EAAE;YACzC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,kBAAkB,EAAE;YAC7C,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE;SACvC;KACF;CAEF,CAAC,CAAC"}
@@ -33,6 +33,9 @@ testERC1155('basic', {});
33
33
  testERC1155('basic + roles', {
34
34
  access: 'roles',
35
35
  });
36
+ testERC1155('no updatable uri', {
37
+ updatableUri: false,
38
+ });
36
39
  testERC1155('burnable', {
37
40
  burnable: true,
38
41
  });
@@ -77,4 +80,12 @@ testAPIEquivalence('API full upgradeable', {
77
80
  (0, ava_1.default)('API assert defaults', async (t) => {
78
81
  t.is(_1.erc1155.print(_1.erc1155.defaults), _1.erc1155.print());
79
82
  });
83
+ (0, ava_1.default)('API isAccessControlRequired', async (t) => {
84
+ t.is(_1.erc1155.isAccessControlRequired({ updatableUri: false, mintable: true }), true);
85
+ t.is(_1.erc1155.isAccessControlRequired({ updatableUri: false, pausable: true }), true);
86
+ t.is(_1.erc1155.isAccessControlRequired({ updatableUri: false, upgradeable: 'uups' }), true);
87
+ t.is(_1.erc1155.isAccessControlRequired({ updatableUri: true }), true);
88
+ t.is(_1.erc1155.isAccessControlRequired({ updatableUri: false }), false);
89
+ t.is(_1.erc1155.isAccessControlRequired({}), true); // updatableUri is true by default
90
+ });
80
91
  //# sourceMappingURL=erc1155.test.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"erc1155.test.js","sourceRoot":"","sources":["../src/erc1155.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAuB;AACvB,wBAA4B;AAE5B,uCAAyD;AACzD,mCAAwC;AAExC,SAAS,WAAW,CAAC,KAAa,EAAE,IAA6B;IAC/D,IAAA,aAAI,EAAC,KAAK,EAAE,CAAC,CAAC,EAAE;QACd,MAAM,CAAC,GAAG,IAAA,sBAAY,EAAC;YACrB,IAAI,EAAE,SAAS;YACf,GAAG,EAAE,mFAAmF;YACxF,GAAG,IAAI;SACR,CAAC,CAAC;QACH,CAAC,CAAC,QAAQ,CAAC,IAAA,qBAAa,EAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACF,SAAS,kBAAkB,CAAC,KAAa,EAAE,IAAqB;IAC/D,IAAA,aAAI,EAAC,KAAK,EAAE,CAAC,CAAC,EAAE;QACd,CAAC,CAAC,EAAE,CAAC,UAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAA,qBAAa,EAAC,IAAA,sBAAY,EAAC;YACnD,IAAI,EAAE,SAAS;YACf,GAAG,EAAE,EAAE;YACP,GAAG,IAAI;SACR,CAAC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC;AAED,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AAEzB,WAAW,CAAC,eAAe,EAAE;IAC3B,MAAM,EAAE,OAAO;CAChB,CAAC,CAAC;AAEH,WAAW,CAAC,UAAU,EAAE;IACtB,QAAQ,EAAE,IAAI;CACf,CAAC,CAAC;AAEH,WAAW,CAAC,UAAU,EAAE;IACtB,QAAQ,EAAE,IAAI;CACf,CAAC,CAAC;AAEH,WAAW,CAAC,UAAU,EAAE;IACtB,QAAQ,EAAE,IAAI;CACf,CAAC,CAAC;AAEH,WAAW,CAAC,kBAAkB,EAAE;IAC9B,QAAQ,EAAE,IAAI;IACd,MAAM,EAAE,OAAO;CAChB,CAAC,CAAC;AAEH,WAAW,CAAC,iBAAiB,EAAE;IAC7B,MAAM,EAAE,IAAI;CACb,CAAC,CAAC;AAEH,WAAW,CAAC,8BAA8B,EAAE;IAC1C,QAAQ,EAAE,IAAI;IACd,MAAM,EAAE,OAAO;IACf,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,IAAI;IACd,WAAW,EAAE,aAAa;CAC3B,CAAC,CAAC;AAEH,WAAW,CAAC,uBAAuB,EAAE;IACnC,QAAQ,EAAE,IAAI;IACd,MAAM,EAAE,OAAO;IACf,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,IAAI;IACd,WAAW,EAAE,MAAM;CACpB,CAAC,CAAC;AAEH,kBAAkB,CAAC,aAAa,CAAC,CAAC;AAElC,kBAAkB,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,GAAG,EAAE,mFAAmF,EAAE,CAAC,CAAC;AAEnJ,kBAAkB,CAAC,sBAAsB,EAAE;IACzC,IAAI,EAAE,aAAa;IACnB,GAAG,EAAE,mFAAmF;IACxF,QAAQ,EAAE,IAAI;IACd,MAAM,EAAE,OAAO;IACf,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,IAAI;IACd,WAAW,EAAE,MAAM;CACpB,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,qBAAqB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACpC,CAAC,CAAC,EAAE,CAAC,UAAO,CAAC,KAAK,CAAC,UAAO,CAAC,QAAQ,CAAC,EAAE,UAAO,CAAC,KAAK,EAAE,CAAC,CAAC;AACzD,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"erc1155.test.js","sourceRoot":"","sources":["../src/erc1155.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAuB;AACvB,wBAA4B;AAE5B,uCAAyD;AACzD,mCAAwC;AAExC,SAAS,WAAW,CAAC,KAAa,EAAE,IAA6B;IAC/D,IAAA,aAAI,EAAC,KAAK,EAAE,CAAC,CAAC,EAAE;QACd,MAAM,CAAC,GAAG,IAAA,sBAAY,EAAC;YACrB,IAAI,EAAE,SAAS;YACf,GAAG,EAAE,mFAAmF;YACxF,GAAG,IAAI;SACR,CAAC,CAAC;QACH,CAAC,CAAC,QAAQ,CAAC,IAAA,qBAAa,EAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACF,SAAS,kBAAkB,CAAC,KAAa,EAAE,IAAqB;IAC/D,IAAA,aAAI,EAAC,KAAK,EAAE,CAAC,CAAC,EAAE;QACd,CAAC,CAAC,EAAE,CAAC,UAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAA,qBAAa,EAAC,IAAA,sBAAY,EAAC;YACnD,IAAI,EAAE,SAAS;YACf,GAAG,EAAE,EAAE;YACP,GAAG,IAAI;SACR,CAAC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC;AAED,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AAEzB,WAAW,CAAC,eAAe,EAAE;IAC3B,MAAM,EAAE,OAAO;CAChB,CAAC,CAAC;AAEH,WAAW,CAAC,kBAAkB,EAAE;IAC9B,YAAY,EAAE,KAAK;CACpB,CAAC,CAAC;AAEH,WAAW,CAAC,UAAU,EAAE;IACtB,QAAQ,EAAE,IAAI;CACf,CAAC,CAAC;AAEH,WAAW,CAAC,UAAU,EAAE;IACtB,QAAQ,EAAE,IAAI;CACf,CAAC,CAAC;AAEH,WAAW,CAAC,UAAU,EAAE;IACtB,QAAQ,EAAE,IAAI;CACf,CAAC,CAAC;AAEH,WAAW,CAAC,kBAAkB,EAAE;IAC9B,QAAQ,EAAE,IAAI;IACd,MAAM,EAAE,OAAO;CAChB,CAAC,CAAC;AAEH,WAAW,CAAC,iBAAiB,EAAE;IAC7B,MAAM,EAAE,IAAI;CACb,CAAC,CAAC;AAEH,WAAW,CAAC,8BAA8B,EAAE;IAC1C,QAAQ,EAAE,IAAI;IACd,MAAM,EAAE,OAAO;IACf,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,IAAI;IACd,WAAW,EAAE,aAAa;CAC3B,CAAC,CAAC;AAEH,WAAW,CAAC,uBAAuB,EAAE;IACnC,QAAQ,EAAE,IAAI;IACd,MAAM,EAAE,OAAO;IACf,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,IAAI;IACd,WAAW,EAAE,MAAM;CACpB,CAAC,CAAC;AAEH,kBAAkB,CAAC,aAAa,CAAC,CAAC;AAElC,kBAAkB,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,GAAG,EAAE,mFAAmF,EAAE,CAAC,CAAC;AAEnJ,kBAAkB,CAAC,sBAAsB,EAAE;IACzC,IAAI,EAAE,aAAa;IACnB,GAAG,EAAE,mFAAmF;IACxF,QAAQ,EAAE,IAAI;IACd,MAAM,EAAE,OAAO;IACf,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,IAAI;IACd,WAAW,EAAE,MAAM;CACpB,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,qBAAqB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACpC,CAAC,CAAC,EAAE,CAAC,UAAO,CAAC,KAAK,CAAC,UAAO,CAAC,QAAQ,CAAC,EAAE,UAAO,CAAC,KAAK,EAAE,CAAC,CAAC;AACzD,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,6BAA6B,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC5C,CAAC,CAAC,EAAE,CAAC,UAAO,CAAC,uBAAuB,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IACrF,CAAC,CAAC,EAAE,CAAC,UAAO,CAAC,uBAAuB,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IACrF,CAAC,CAAC,EAAE,CAAC,UAAO,CAAC,uBAAuB,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IAC1F,CAAC,CAAC,EAAE,CAAC,UAAO,CAAC,uBAAuB,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IACpE,CAAC,CAAC,EAAE,CAAC,UAAO,CAAC,uBAAuB,CAAC,EAAE,YAAY,EAAE,KAAK,EAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACrE,CAAC,CAAC,EAAE,CAAC,UAAO,CAAC,uBAAuB,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,kCAAkC;AACrF,CAAC,CAAC,CAAC"}
package/dist/erc20.d.ts CHANGED
@@ -14,6 +14,7 @@ export interface ERC20Options extends CommonOptions {
14
14
  }
15
15
  export declare const defaults: Required<ERC20Options>;
16
16
  export declare function printERC20(opts?: ERC20Options): string;
17
+ export declare function isAccessControlRequired(opts: Partial<ERC20Options>): boolean;
17
18
  export declare function buildERC20(opts: ERC20Options): Contract;
18
19
  export declare const premintPattern: RegExp;
19
20
  //# sourceMappingURL=erc20.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"erc20.d.ts","sourceRoot":"","sources":["../src/erc20.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAmB,MAAM,YAAY,CAAC;AAIvD,OAAO,EAAE,aAAa,EAAkD,MAAM,kBAAkB,CAAC;AAKjG,MAAM,WAAW,YAAa,SAAQ,aAAa;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAAC,YAAY,CAclC,CAAC;AAiBX,wBAAgB,UAAU,CAAC,IAAI,GAAE,YAAuB,GAAG,MAAM,CAEhE;AAED,wBAAgB,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,QAAQ,CA+CvD;AAoCD,eAAO,MAAM,cAAc,QAAmC,CAAC"}
1
+ {"version":3,"file":"erc20.d.ts","sourceRoot":"","sources":["../src/erc20.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAmB,MAAM,YAAY,CAAC;AAIvD,OAAO,EAAE,aAAa,EAAkD,MAAM,kBAAkB,CAAC;AAKjG,MAAM,WAAW,YAAa,SAAQ,aAAa;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAAC,YAAY,CAclC,CAAC;AAiBX,wBAAgB,UAAU,CAAC,IAAI,GAAE,YAAuB,GAAG,MAAM,CAEhE;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,OAAO,CAE5E;AAED,wBAAgB,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,QAAQ,CA+CvD;AAoCD,eAAO,MAAM,cAAc,QAAmC,CAAC"}
package/dist/erc20.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.premintPattern = exports.buildERC20 = exports.printERC20 = exports.defaults = void 0;
3
+ exports.premintPattern = exports.buildERC20 = exports.isAccessControlRequired = exports.printERC20 = exports.defaults = void 0;
4
4
  const contract_1 = require("./contract");
5
5
  const set_access_control_1 = require("./set-access-control");
6
6
  const add_pausable_1 = require("./add-pausable");
@@ -43,6 +43,10 @@ function printERC20(opts = exports.defaults) {
43
43
  return (0, print_1.printContract)(buildERC20(opts));
44
44
  }
45
45
  exports.printERC20 = printERC20;
46
+ function isAccessControlRequired(opts) {
47
+ return opts.mintable || opts.pausable || opts.snapshots || opts.upgradeable === 'uups';
48
+ }
49
+ exports.isAccessControlRequired = isAccessControlRequired;
46
50
  function buildERC20(opts) {
47
51
  const allOpts = withDefaults(opts);
48
52
  const c = new contract_1.ContractBuilder(allOpts.name);
@@ -73,6 +77,7 @@ function buildERC20(opts) {
73
77
  if (allOpts.flashmint) {
74
78
  addFlashMint(c);
75
79
  }
80
+ (0, set_access_control_1.setAccessControl)(c, access);
76
81
  (0, set_upgradeable_1.setUpgradeable)(c, upgradeable, access);
77
82
  (0, set_info_1.setInfo)(c, info);
78
83
  return c;
@@ -100,7 +105,7 @@ function addSnapshot(c, access) {
100
105
  path: '@openzeppelin/contracts/token/ERC20/extensions/ERC20Snapshot.sol',
101
106
  });
102
107
  c.addOverride('ERC20Snapshot', functions._beforeTokenTransfer);
103
- (0, set_access_control_1.setAccessControl)(c, functions.snapshot, access, 'SNAPSHOT');
108
+ (0, set_access_control_1.requireAccessControl)(c, functions.snapshot, access, 'SNAPSHOT');
104
109
  c.addFunctionCode('_snapshot();', functions.snapshot);
105
110
  }
106
111
  exports.premintPattern = /^(\d*)(?:\.(\d+))?(?:e(\d+))?$/;
@@ -121,7 +126,7 @@ function addPremint(c, amount) {
121
126
  }
122
127
  }
123
128
  function addMintable(c, access) {
124
- (0, set_access_control_1.setAccessControl)(c, functions.mint, access, 'MINTER');
129
+ (0, set_access_control_1.requireAccessControl)(c, functions.mint, access, 'MINTER');
125
130
  c.addFunctionCode('_mint(to, amount);', functions.mint);
126
131
  }
127
132
  function addPermit(c, name) {