@openzeppelin/wizard 0.1.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.
Files changed (235) hide show
  1. package/README.md +82 -0
  2. package/dist/add-pausable.d.ts +4 -0
  3. package/dist/add-pausable.d.ts.map +1 -0
  4. package/dist/add-pausable.js +30 -0
  5. package/dist/add-pausable.js.map +1 -0
  6. package/dist/api.d.ts +24 -0
  7. package/dist/api.d.ts.map +1 -0
  8. package/dist/api.js +24 -0
  9. package/dist/api.js.map +1 -0
  10. package/dist/build-generic.d.ts +21 -0
  11. package/dist/build-generic.d.ts.map +1 -0
  12. package/dist/build-generic.js +24 -0
  13. package/dist/build-generic.js.map +1 -0
  14. package/dist/common-functions.d.ts +3 -0
  15. package/dist/common-functions.d.ts.map +1 -0
  16. package/dist/common-functions.js +13 -0
  17. package/dist/common-functions.js.map +1 -0
  18. package/dist/common-options.d.ts +11 -0
  19. package/dist/common-options.d.ts.map +1 -0
  20. package/dist/common-options.js +19 -0
  21. package/dist/common-options.js.map +1 -0
  22. package/dist/contract.d.ts +86 -0
  23. package/dist/contract.d.ts.map +1 -0
  24. package/dist/contract.js +125 -0
  25. package/dist/contract.js.map +1 -0
  26. package/dist/contract.test.d.ts +2 -0
  27. package/dist/contract.test.d.ts.map +1 -0
  28. package/dist/contract.test.js +147 -0
  29. package/dist/contract.test.js.map +1 -0
  30. package/dist/erc1155.d.ts +14 -0
  31. package/dist/erc1155.d.ts.map +1 -0
  32. package/dist/erc1155.js +130 -0
  33. package/dist/erc1155.js.map +1 -0
  34. package/dist/erc1155.test.d.ts +2 -0
  35. package/dist/erc1155.test.d.ts.map +1 -0
  36. package/dist/erc1155.test.js +80 -0
  37. package/dist/erc1155.test.js.map +1 -0
  38. package/dist/erc20.d.ts +19 -0
  39. package/dist/erc20.d.ts.map +1 -0
  40. package/dist/erc20.js +202 -0
  41. package/dist/erc20.js.map +1 -0
  42. package/dist/erc20.test.d.ts +2 -0
  43. package/dist/erc20.test.d.ts.map +1 -0
  44. package/dist/erc20.test.js +126 -0
  45. package/dist/erc20.test.js.map +1 -0
  46. package/dist/erc721.d.ts +18 -0
  47. package/dist/erc721.d.ts.map +1 -0
  48. package/dist/erc721.js +200 -0
  49. package/dist/erc721.js.map +1 -0
  50. package/dist/erc721.test.d.ts +2 -0
  51. package/dist/erc721.test.d.ts.map +1 -0
  52. package/dist/erc721.test.js +106 -0
  53. package/dist/erc721.test.js.map +1 -0
  54. package/dist/error.d.ts +8 -0
  55. package/dist/error.d.ts.map +1 -0
  56. package/dist/error.js +11 -0
  57. package/dist/error.js.map +1 -0
  58. package/dist/general.d.ts +8 -0
  59. package/dist/general.d.ts.map +1 -0
  60. package/dist/general.js +22 -0
  61. package/dist/general.js.map +1 -0
  62. package/dist/general.test.d.ts +2 -0
  63. package/dist/general.test.d.ts.map +1 -0
  64. package/dist/general.test.js +42 -0
  65. package/dist/general.test.js.map +1 -0
  66. package/dist/generate/alternatives.d.ts +7 -0
  67. package/dist/generate/alternatives.d.ts.map +1 -0
  68. package/dist/generate/alternatives.js +29 -0
  69. package/dist/generate/alternatives.js.map +1 -0
  70. package/dist/generate/erc1155.d.ts +3 -0
  71. package/dist/generate/erc1155.d.ts.map +1 -0
  72. package/dist/generate/erc1155.js +24 -0
  73. package/dist/generate/erc1155.js.map +1 -0
  74. package/dist/generate/erc20.d.ts +3 -0
  75. package/dist/generate/erc20.d.ts.map +1 -0
  76. package/dist/generate/erc20.js +28 -0
  77. package/dist/generate/erc20.js.map +1 -0
  78. package/dist/generate/erc721.d.ts +3 -0
  79. package/dist/generate/erc721.d.ts.map +1 -0
  80. package/dist/generate/erc721.js +28 -0
  81. package/dist/generate/erc721.js.map +1 -0
  82. package/dist/generate/governor.d.ts +3 -0
  83. package/dist/generate/governor.d.ts.map +1 -0
  84. package/dist/generate/governor.js +32 -0
  85. package/dist/generate/governor.js.map +1 -0
  86. package/dist/generate/sources.d.ts +16 -0
  87. package/dist/generate/sources.d.ts.map +1 -0
  88. package/dist/generate/sources.js +79 -0
  89. package/dist/generate/sources.js.map +1 -0
  90. package/dist/governor.d.ts +26 -0
  91. package/dist/governor.d.ts.map +1 -0
  92. package/dist/governor.js +386 -0
  93. package/dist/governor.js.map +1 -0
  94. package/dist/governor.test.d.ts +2 -0
  95. package/dist/governor.test.d.ts.map +1 -0
  96. package/dist/governor.test.js +104 -0
  97. package/dist/governor.test.js.map +1 -0
  98. package/dist/index.d.ts +17 -0
  99. package/dist/index.d.ts.map +1 -0
  100. package/dist/index.js +25 -0
  101. package/dist/index.js.map +1 -0
  102. package/dist/kind.d.ts +4 -0
  103. package/dist/kind.d.ts.map +1 -0
  104. package/dist/kind.js +28 -0
  105. package/dist/kind.js.map +1 -0
  106. package/dist/options.d.ts +11 -0
  107. package/dist/options.d.ts.map +1 -0
  108. package/dist/options.js +40 -0
  109. package/dist/options.js.map +1 -0
  110. package/dist/print-versioned.d.ts +3 -0
  111. package/dist/print-versioned.d.ts.map +1 -0
  112. package/dist/print-versioned.js +12 -0
  113. package/dist/print-versioned.js.map +1 -0
  114. package/dist/print.d.ts +6 -0
  115. package/dist/print.d.ts.map +1 -0
  116. package/dist/print.js +182 -0
  117. package/dist/print.js.map +1 -0
  118. package/dist/scripts/prepare.d.ts +2 -0
  119. package/dist/scripts/prepare.d.ts.map +1 -0
  120. package/dist/scripts/prepare.js +52 -0
  121. package/dist/scripts/prepare.js.map +1 -0
  122. package/dist/set-access-control.d.ts +5 -0
  123. package/dist/set-access-control.d.ts.map +1 -0
  124. package/dist/set-access-control.js +38 -0
  125. package/dist/set-access-control.js.map +1 -0
  126. package/dist/set-info.d.ts +13 -0
  127. package/dist/set-info.d.ts.map +1 -0
  128. package/dist/set-info.js +17 -0
  129. package/dist/set-info.js.map +1 -0
  130. package/dist/set-upgradeable.d.ts +6 -0
  131. package/dist/set-upgradeable.d.ts.map +1 -0
  132. package/dist/set-upgradeable.js +43 -0
  133. package/dist/set-upgradeable.js.map +1 -0
  134. package/dist/test.d.ts +2 -0
  135. package/dist/test.d.ts.map +1 -0
  136. package/dist/test.js +23 -0
  137. package/dist/test.js.map +1 -0
  138. package/dist/utils/define-functions.d.ts +5 -0
  139. package/dist/utils/define-functions.d.ts.map +1 -0
  140. package/dist/utils/define-functions.js +11 -0
  141. package/dist/utils/define-functions.js.map +1 -0
  142. package/dist/utils/duration.d.ts +3 -0
  143. package/dist/utils/duration.d.ts.map +1 -0
  144. package/dist/utils/duration.js +31 -0
  145. package/dist/utils/duration.js.map +1 -0
  146. package/dist/utils/find-cover.d.ts +2 -0
  147. package/dist/utils/find-cover.d.ts.map +1 -0
  148. package/dist/utils/find-cover.js +23 -0
  149. package/dist/utils/find-cover.js.map +1 -0
  150. package/dist/utils/format-lines.d.ts +7 -0
  151. package/dist/utils/format-lines.d.ts.map +1 -0
  152. package/dist/utils/format-lines.js +30 -0
  153. package/dist/utils/format-lines.js.map +1 -0
  154. package/dist/utils/map-values.d.ts +2 -0
  155. package/dist/utils/map-values.d.ts.map +1 -0
  156. package/dist/utils/map-values.js +12 -0
  157. package/dist/utils/map-values.js.map +1 -0
  158. package/dist/utils/sorted-by.d.ts +2 -0
  159. package/dist/utils/sorted-by.d.ts.map +1 -0
  160. package/dist/utils/sorted-by.js +8 -0
  161. package/dist/utils/sorted-by.js.map +1 -0
  162. package/dist/utils/to-identifier.d.ts +2 -0
  163. package/dist/utils/to-identifier.d.ts.map +1 -0
  164. package/dist/utils/to-identifier.js +12 -0
  165. package/dist/utils/to-identifier.js.map +1 -0
  166. package/dist/utils/to-identifier.test.d.ts +2 -0
  167. package/dist/utils/to-identifier.test.d.ts.map +1 -0
  168. package/dist/utils/to-identifier.test.js +21 -0
  169. package/dist/utils/to-identifier.test.js.map +1 -0
  170. package/dist/utils/transitive-closure.d.ts +5 -0
  171. package/dist/utils/transitive-closure.d.ts.map +1 -0
  172. package/dist/utils/transitive-closure.js +27 -0
  173. package/dist/utils/transitive-closure.js.map +1 -0
  174. package/dist/zip.d.ts +4 -0
  175. package/dist/zip.d.ts.map +1 -0
  176. package/dist/zip.js +48 -0
  177. package/dist/zip.js.map +1 -0
  178. package/dist/zip.test.d.ts +2 -0
  179. package/dist/zip.test.d.ts.map +1 -0
  180. package/dist/zip.test.js +37 -0
  181. package/dist/zip.test.js.map +1 -0
  182. package/package.json +37 -0
  183. package/src/add-pausable.ts +32 -0
  184. package/src/api.ts +39 -0
  185. package/src/build-generic.ts +33 -0
  186. package/src/common-functions.ts +11 -0
  187. package/src/common-options.ts +24 -0
  188. package/src/contract.test.ts +164 -0
  189. package/src/contract.test.ts.md +272 -0
  190. package/src/contract.test.ts.snap +0 -0
  191. package/src/contract.ts +201 -0
  192. package/src/erc1155.test.ts +90 -0
  193. package/src/erc1155.test.ts.md +416 -0
  194. package/src/erc1155.test.ts.snap +0 -0
  195. package/src/erc1155.ts +160 -0
  196. package/src/erc20.test.ts +144 -0
  197. package/src/erc20.test.ts.md +571 -0
  198. package/src/erc20.test.ts.snap +0 -0
  199. package/src/erc20.ts +250 -0
  200. package/src/erc721.test.ts +122 -0
  201. package/src/erc721.test.ts.md +517 -0
  202. package/src/erc721.test.ts.snap +0 -0
  203. package/src/erc721.ts +250 -0
  204. package/src/error.ts +7 -0
  205. package/src/generate/alternatives.ts +38 -0
  206. package/src/generate/erc1155.ts +23 -0
  207. package/src/generate/erc20.ts +27 -0
  208. package/src/generate/erc721.ts +27 -0
  209. package/src/generate/governor.ts +30 -0
  210. package/src/generate/sources.ts +91 -0
  211. package/src/governor.test.ts +120 -0
  212. package/src/governor.test.ts.md +1419 -0
  213. package/src/governor.test.ts.snap +0 -0
  214. package/src/governor.ts +445 -0
  215. package/src/index.ts +23 -0
  216. package/src/kind.ts +30 -0
  217. package/src/options.ts +45 -0
  218. package/src/print-versioned.ts +12 -0
  219. package/src/print.ts +236 -0
  220. package/src/scripts/prepare.ts +60 -0
  221. package/src/set-access-control.ts +39 -0
  222. package/src/set-info.ts +24 -0
  223. package/src/set-upgradeable.ts +49 -0
  224. package/src/test.ts +21 -0
  225. package/src/utils/define-functions.ts +18 -0
  226. package/src/utils/duration.ts +34 -0
  227. package/src/utils/find-cover.ts +26 -0
  228. package/src/utils/format-lines.ts +31 -0
  229. package/src/utils/map-values.ts +10 -0
  230. package/src/utils/sorted-by.ts +3 -0
  231. package/src/utils/to-identifier.test.ts +20 -0
  232. package/src/utils/to-identifier.ts +7 -0
  233. package/src/utils/transitive-closure.ts +27 -0
  234. package/src/zip.test.ts +35 -0
  235. package/src/zip.ts +53 -0
@@ -0,0 +1,144 @@
1
+ import test from 'ava';
2
+ import { erc20 } from '.';
3
+
4
+ import { buildERC20, ERC20Options } from './erc20';
5
+ import { printContract } from './print';
6
+
7
+ function testERC20(title: string, opts: Partial<ERC20Options>) {
8
+ test(title, t => {
9
+ const c = buildERC20({
10
+ name: 'MyToken',
11
+ symbol: 'MTK',
12
+ ...opts,
13
+ });
14
+ t.snapshot(printContract(c));
15
+ });
16
+ }
17
+
18
+ /**
19
+ * Tests external API for equivalence with internal API
20
+ */
21
+ function testAPIEquivalence(title: string, opts?: ERC20Options) {
22
+ test(title, t => {
23
+ t.is(erc20.print(opts), printContract(buildERC20({
24
+ name: 'MyToken',
25
+ symbol: 'MTK',
26
+ ...opts,
27
+ })));
28
+ });
29
+ }
30
+
31
+ testERC20('basic erc20', {});
32
+
33
+ testERC20('erc20 with snapshots', {
34
+ snapshots: true,
35
+ });
36
+
37
+ testERC20('erc20 burnable', {
38
+ burnable: true,
39
+ });
40
+
41
+ testERC20('erc20 burnable with snapshots', {
42
+ burnable: true,
43
+ snapshots: true,
44
+ });
45
+
46
+ testERC20('erc20 pausable', {
47
+ pausable: true,
48
+ access: 'ownable',
49
+ });
50
+
51
+ testERC20('erc20 pausable with roles', {
52
+ pausable: true,
53
+ access: 'roles',
54
+ });
55
+
56
+ testERC20('erc20 burnable pausable', {
57
+ burnable: true,
58
+ pausable: true,
59
+ });
60
+
61
+ testERC20('erc20 burnable pausable with snapshots', {
62
+ burnable: true,
63
+ pausable: true,
64
+ snapshots: true,
65
+ });
66
+
67
+ testERC20('erc20 preminted', {
68
+ premint: '1000',
69
+ });
70
+
71
+ testERC20('erc20 premint of 0', {
72
+ premint: '0',
73
+ });
74
+
75
+ testERC20('erc20 mintable', {
76
+ mintable: true,
77
+ access: 'ownable',
78
+ });
79
+
80
+ testERC20('erc20 mintable with roles', {
81
+ mintable: true,
82
+ access: 'roles',
83
+ });
84
+
85
+ testERC20('erc20 permit', {
86
+ permit: true,
87
+ });
88
+
89
+ testERC20('erc20 votes', {
90
+ votes: true,
91
+ });
92
+
93
+ testERC20('erc20 flashmint', {
94
+ flashmint: true,
95
+ });
96
+
97
+ testERC20('erc20 full upgradeable transparent', {
98
+ premint: '2000',
99
+ access: 'roles',
100
+ burnable: true,
101
+ mintable: true,
102
+ pausable: true,
103
+ snapshots: true,
104
+ permit: true,
105
+ votes: true,
106
+ flashmint: true,
107
+ upgradeable: 'transparent',
108
+ });
109
+
110
+ testERC20('erc20 full upgradeable uups', {
111
+ premint: '2000',
112
+ access: 'roles',
113
+ burnable: true,
114
+ mintable: true,
115
+ pausable: true,
116
+ snapshots: true,
117
+ permit: true,
118
+ votes: true,
119
+ flashmint: true,
120
+ upgradeable: 'uups',
121
+ });
122
+
123
+ testAPIEquivalence('erc20 API default');
124
+
125
+ testAPIEquivalence('erc20 API basic', { name: 'CustomToken', symbol: 'CTK' });
126
+
127
+ testAPIEquivalence('erc20 API full upgradeable', {
128
+ name: 'CustomToken',
129
+ symbol: 'CTK',
130
+ premint: '2000',
131
+ access: 'roles',
132
+ burnable: true,
133
+ mintable: true,
134
+ pausable: true,
135
+ snapshots: true,
136
+ permit: true,
137
+ votes: true,
138
+ flashmint: true,
139
+ upgradeable: 'uups',
140
+ });
141
+
142
+ test('erc20 API assert defaults', async t => {
143
+ t.is(erc20.print(erc20.defaults), erc20.print());
144
+ });
@@ -0,0 +1,571 @@
1
+ # Snapshot report for `src/erc20.test.ts`
2
+
3
+ The actual snapshot is saved in `erc20.test.ts.snap`.
4
+
5
+ Generated by [AVA](https://avajs.dev).
6
+
7
+ ## basic erc20
8
+
9
+ > Snapshot 1
10
+
11
+ `// SPDX-License-Identifier: MIT␊
12
+ pragma solidity ^0.8.4;␊
13
+
14
+ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";␊
15
+
16
+ contract MyToken is ERC20 {␊
17
+ constructor() ERC20("MyToken", "MTK") {}␊
18
+ }␊
19
+ `
20
+
21
+ ## erc20 with snapshots
22
+
23
+ > Snapshot 1
24
+
25
+ `// SPDX-License-Identifier: MIT␊
26
+ pragma solidity ^0.8.4;␊
27
+
28
+ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";␊
29
+ import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Snapshot.sol";␊
30
+ import "@openzeppelin/contracts/access/Ownable.sol";␊
31
+
32
+ contract MyToken is ERC20, ERC20Snapshot, Ownable {␊
33
+ constructor() ERC20("MyToken", "MTK") {}␊
34
+
35
+ function snapshot() public onlyOwner {␊
36
+ _snapshot();␊
37
+ }␊
38
+
39
+ // The following functions are overrides required by Solidity.␊
40
+
41
+ function _beforeTokenTransfer(address from, address to, uint256 amount)␊
42
+ internal␊
43
+ override(ERC20, ERC20Snapshot)␊
44
+ {␊
45
+ super._beforeTokenTransfer(from, to, amount);␊
46
+ }␊
47
+ }␊
48
+ `
49
+
50
+ ## erc20 burnable
51
+
52
+ > Snapshot 1
53
+
54
+ `// SPDX-License-Identifier: MIT␊
55
+ pragma solidity ^0.8.4;␊
56
+
57
+ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";␊
58
+ import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Burnable.sol";␊
59
+
60
+ contract MyToken is ERC20, ERC20Burnable {␊
61
+ constructor() ERC20("MyToken", "MTK") {}␊
62
+ }␊
63
+ `
64
+
65
+ ## erc20 burnable with snapshots
66
+
67
+ > Snapshot 1
68
+
69
+ `// SPDX-License-Identifier: MIT␊
70
+ pragma solidity ^0.8.4;␊
71
+
72
+ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";␊
73
+ import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Burnable.sol";␊
74
+ import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Snapshot.sol";␊
75
+ import "@openzeppelin/contracts/access/Ownable.sol";␊
76
+
77
+ contract MyToken is ERC20, ERC20Burnable, ERC20Snapshot, Ownable {␊
78
+ constructor() ERC20("MyToken", "MTK") {}␊
79
+
80
+ function snapshot() public onlyOwner {␊
81
+ _snapshot();␊
82
+ }␊
83
+
84
+ // The following functions are overrides required by Solidity.␊
85
+
86
+ function _beforeTokenTransfer(address from, address to, uint256 amount)␊
87
+ internal␊
88
+ override(ERC20, ERC20Snapshot)␊
89
+ {␊
90
+ super._beforeTokenTransfer(from, to, amount);␊
91
+ }␊
92
+ }␊
93
+ `
94
+
95
+ ## erc20 pausable
96
+
97
+ > Snapshot 1
98
+
99
+ `// SPDX-License-Identifier: MIT␊
100
+ pragma solidity ^0.8.4;␊
101
+
102
+ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";␊
103
+ import "@openzeppelin/contracts/security/Pausable.sol";␊
104
+ import "@openzeppelin/contracts/access/Ownable.sol";␊
105
+
106
+ contract MyToken is ERC20, Pausable, Ownable {␊
107
+ constructor() ERC20("MyToken", "MTK") {}␊
108
+
109
+ function pause() public onlyOwner {␊
110
+ _pause();␊
111
+ }␊
112
+
113
+ function unpause() public onlyOwner {␊
114
+ _unpause();␊
115
+ }␊
116
+
117
+ function _beforeTokenTransfer(address from, address to, uint256 amount)␊
118
+ internal␊
119
+ whenNotPaused␊
120
+ override␊
121
+ {␊
122
+ super._beforeTokenTransfer(from, to, amount);␊
123
+ }␊
124
+ }␊
125
+ `
126
+
127
+ ## erc20 pausable with roles
128
+
129
+ > Snapshot 1
130
+
131
+ `// SPDX-License-Identifier: MIT␊
132
+ pragma solidity ^0.8.4;␊
133
+
134
+ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";␊
135
+ import "@openzeppelin/contracts/security/Pausable.sol";␊
136
+ import "@openzeppelin/contracts/access/AccessControl.sol";␊
137
+
138
+ contract MyToken is ERC20, Pausable, AccessControl {␊
139
+ bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE");␊
140
+
141
+ constructor() ERC20("MyToken", "MTK") {␊
142
+ _grantRole(DEFAULT_ADMIN_ROLE, msg.sender);␊
143
+ _grantRole(PAUSER_ROLE, msg.sender);␊
144
+ }␊
145
+
146
+ function pause() public onlyRole(PAUSER_ROLE) {␊
147
+ _pause();␊
148
+ }␊
149
+
150
+ function unpause() public onlyRole(PAUSER_ROLE) {␊
151
+ _unpause();␊
152
+ }␊
153
+
154
+ function _beforeTokenTransfer(address from, address to, uint256 amount)␊
155
+ internal␊
156
+ whenNotPaused␊
157
+ override␊
158
+ {␊
159
+ super._beforeTokenTransfer(from, to, amount);␊
160
+ }␊
161
+ }␊
162
+ `
163
+
164
+ ## erc20 burnable pausable
165
+
166
+ > Snapshot 1
167
+
168
+ `// SPDX-License-Identifier: MIT␊
169
+ pragma solidity ^0.8.4;␊
170
+
171
+ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";␊
172
+ import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Burnable.sol";␊
173
+ import "@openzeppelin/contracts/security/Pausable.sol";␊
174
+ import "@openzeppelin/contracts/access/Ownable.sol";␊
175
+
176
+ contract MyToken is ERC20, ERC20Burnable, Pausable, Ownable {␊
177
+ constructor() ERC20("MyToken", "MTK") {}␊
178
+
179
+ function pause() public onlyOwner {␊
180
+ _pause();␊
181
+ }␊
182
+
183
+ function unpause() public onlyOwner {␊
184
+ _unpause();␊
185
+ }␊
186
+
187
+ function _beforeTokenTransfer(address from, address to, uint256 amount)␊
188
+ internal␊
189
+ whenNotPaused␊
190
+ override␊
191
+ {␊
192
+ super._beforeTokenTransfer(from, to, amount);␊
193
+ }␊
194
+ }␊
195
+ `
196
+
197
+ ## erc20 burnable pausable with snapshots
198
+
199
+ > Snapshot 1
200
+
201
+ `// SPDX-License-Identifier: MIT␊
202
+ pragma solidity ^0.8.4;␊
203
+
204
+ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";␊
205
+ import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Burnable.sol";␊
206
+ import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Snapshot.sol";␊
207
+ import "@openzeppelin/contracts/access/Ownable.sol";␊
208
+ import "@openzeppelin/contracts/security/Pausable.sol";␊
209
+
210
+ contract MyToken is ERC20, ERC20Burnable, ERC20Snapshot, Ownable, Pausable {␊
211
+ constructor() ERC20("MyToken", "MTK") {}␊
212
+
213
+ function snapshot() public onlyOwner {␊
214
+ _snapshot();␊
215
+ }␊
216
+
217
+ function pause() public onlyOwner {␊
218
+ _pause();␊
219
+ }␊
220
+
221
+ function unpause() public onlyOwner {␊
222
+ _unpause();␊
223
+ }␊
224
+
225
+ function _beforeTokenTransfer(address from, address to, uint256 amount)␊
226
+ internal␊
227
+ whenNotPaused␊
228
+ override(ERC20, ERC20Snapshot)␊
229
+ {␊
230
+ super._beforeTokenTransfer(from, to, amount);␊
231
+ }␊
232
+ }␊
233
+ `
234
+
235
+ ## erc20 preminted
236
+
237
+ > Snapshot 1
238
+
239
+ `// SPDX-License-Identifier: MIT␊
240
+ pragma solidity ^0.8.4;␊
241
+
242
+ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";␊
243
+
244
+ contract MyToken is ERC20 {␊
245
+ constructor() ERC20("MyToken", "MTK") {␊
246
+ _mint(msg.sender, 1000 * 10 ** decimals());␊
247
+ }␊
248
+ }␊
249
+ `
250
+
251
+ ## erc20 premint of 0
252
+
253
+ > Snapshot 1
254
+
255
+ `// SPDX-License-Identifier: MIT␊
256
+ pragma solidity ^0.8.4;␊
257
+
258
+ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";␊
259
+
260
+ contract MyToken is ERC20 {␊
261
+ constructor() ERC20("MyToken", "MTK") {}␊
262
+ }␊
263
+ `
264
+
265
+ ## erc20 mintable
266
+
267
+ > Snapshot 1
268
+
269
+ `// SPDX-License-Identifier: MIT␊
270
+ pragma solidity ^0.8.4;␊
271
+
272
+ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";␊
273
+ import "@openzeppelin/contracts/access/Ownable.sol";␊
274
+
275
+ contract MyToken is ERC20, Ownable {␊
276
+ constructor() ERC20("MyToken", "MTK") {}␊
277
+
278
+ function mint(address to, uint256 amount) public onlyOwner {␊
279
+ _mint(to, amount);␊
280
+ }␊
281
+ }␊
282
+ `
283
+
284
+ ## erc20 mintable with roles
285
+
286
+ > Snapshot 1
287
+
288
+ `// SPDX-License-Identifier: MIT␊
289
+ pragma solidity ^0.8.4;␊
290
+
291
+ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";␊
292
+ import "@openzeppelin/contracts/access/AccessControl.sol";␊
293
+
294
+ contract MyToken is ERC20, AccessControl {␊
295
+ bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");␊
296
+
297
+ constructor() ERC20("MyToken", "MTK") {␊
298
+ _grantRole(DEFAULT_ADMIN_ROLE, msg.sender);␊
299
+ _grantRole(MINTER_ROLE, msg.sender);␊
300
+ }␊
301
+
302
+ function mint(address to, uint256 amount) public onlyRole(MINTER_ROLE) {␊
303
+ _mint(to, amount);␊
304
+ }␊
305
+ }␊
306
+ `
307
+
308
+ ## erc20 permit
309
+
310
+ > Snapshot 1
311
+
312
+ `// SPDX-License-Identifier: MIT␊
313
+ pragma solidity ^0.8.4;␊
314
+
315
+ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";␊
316
+ import "@openzeppelin/contracts/token/ERC20/extensions/draft-ERC20Permit.sol";␊
317
+
318
+ contract MyToken is ERC20, ERC20Permit {␊
319
+ constructor() ERC20("MyToken", "MTK") ERC20Permit("MyToken") {}␊
320
+ }␊
321
+ `
322
+
323
+ ## erc20 votes
324
+
325
+ > Snapshot 1
326
+
327
+ `// SPDX-License-Identifier: MIT␊
328
+ pragma solidity ^0.8.4;␊
329
+
330
+ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";␊
331
+ import "@openzeppelin/contracts/token/ERC20/extensions/draft-ERC20Permit.sol";␊
332
+ import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Votes.sol";␊
333
+
334
+ contract MyToken is ERC20, ERC20Permit, ERC20Votes {␊
335
+ constructor() ERC20("MyToken", "MTK") ERC20Permit("MyToken") {}␊
336
+
337
+ // The following functions are overrides required by Solidity.␊
338
+
339
+ function _afterTokenTransfer(address from, address to, uint256 amount)␊
340
+ internal␊
341
+ override(ERC20, ERC20Votes)␊
342
+ {␊
343
+ super._afterTokenTransfer(from, to, amount);␊
344
+ }␊
345
+
346
+ function _mint(address to, uint256 amount)␊
347
+ internal␊
348
+ override(ERC20, ERC20Votes)␊
349
+ {␊
350
+ super._mint(to, amount);␊
351
+ }␊
352
+
353
+ function _burn(address account, uint256 amount)␊
354
+ internal␊
355
+ override(ERC20, ERC20Votes)␊
356
+ {␊
357
+ super._burn(account, amount);␊
358
+ }␊
359
+ }␊
360
+ `
361
+
362
+ ## erc20 flashmint
363
+
364
+ > Snapshot 1
365
+
366
+ `// SPDX-License-Identifier: MIT␊
367
+ pragma solidity ^0.8.4;␊
368
+
369
+ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";␊
370
+ import "@openzeppelin/contracts/token/ERC20/extensions/ERC20FlashMint.sol";␊
371
+
372
+ contract MyToken is ERC20, ERC20FlashMint {␊
373
+ constructor() ERC20("MyToken", "MTK") {}␊
374
+ }␊
375
+ `
376
+
377
+ ## erc20 full upgradeable transparent
378
+
379
+ > Snapshot 1
380
+
381
+ `// SPDX-License-Identifier: MIT␊
382
+ pragma solidity ^0.8.4;␊
383
+
384
+ import "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";␊
385
+ import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/ERC20BurnableUpgradeable.sol";␊
386
+ import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/ERC20SnapshotUpgradeable.sol";␊
387
+ import "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";␊
388
+ import "@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol";␊
389
+ import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/draft-ERC20PermitUpgradeable.sol";␊
390
+ import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/ERC20VotesUpgradeable.sol";␊
391
+ import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/ERC20FlashMintUpgradeable.sol";␊
392
+ import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";␊
393
+
394
+ contract MyToken is Initializable, ERC20Upgradeable, ERC20BurnableUpgradeable, ERC20SnapshotUpgradeable, AccessControlUpgradeable, PausableUpgradeable, ERC20PermitUpgradeable, ERC20VotesUpgradeable, ERC20FlashMintUpgradeable {␊
395
+ bytes32 public constant SNAPSHOT_ROLE = keccak256("SNAPSHOT_ROLE");␊
396
+ bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE");␊
397
+ bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");␊
398
+
399
+ /// @custom:oz-upgrades-unsafe-allow constructor␊
400
+ constructor() {␊
401
+ _disableInitializers();␊
402
+ }␊
403
+
404
+ function initialize() initializer public {␊
405
+ __ERC20_init("MyToken", "MTK");␊
406
+ __ERC20Burnable_init();␊
407
+ __ERC20Snapshot_init();␊
408
+ __AccessControl_init();␊
409
+ __Pausable_init();␊
410
+ __ERC20Permit_init("MyToken");␊
411
+ __ERC20Votes_init();␊
412
+ __ERC20FlashMint_init();␊
413
+
414
+ _grantRole(DEFAULT_ADMIN_ROLE, msg.sender);␊
415
+ _grantRole(SNAPSHOT_ROLE, msg.sender);␊
416
+ _grantRole(PAUSER_ROLE, msg.sender);␊
417
+ _mint(msg.sender, 2000 * 10 ** decimals());␊
418
+ _grantRole(MINTER_ROLE, msg.sender);␊
419
+ }␊
420
+
421
+ function snapshot() public onlyRole(SNAPSHOT_ROLE) {␊
422
+ _snapshot();␊
423
+ }␊
424
+
425
+ function pause() public onlyRole(PAUSER_ROLE) {␊
426
+ _pause();␊
427
+ }␊
428
+
429
+ function unpause() public onlyRole(PAUSER_ROLE) {␊
430
+ _unpause();␊
431
+ }␊
432
+
433
+ function mint(address to, uint256 amount) public onlyRole(MINTER_ROLE) {␊
434
+ _mint(to, amount);␊
435
+ }␊
436
+
437
+ function _beforeTokenTransfer(address from, address to, uint256 amount)␊
438
+ internal␊
439
+ whenNotPaused␊
440
+ override(ERC20Upgradeable, ERC20SnapshotUpgradeable)␊
441
+ {␊
442
+ super._beforeTokenTransfer(from, to, amount);␊
443
+ }␊
444
+
445
+ // The following functions are overrides required by Solidity.␊
446
+
447
+ function _afterTokenTransfer(address from, address to, uint256 amount)␊
448
+ internal␊
449
+ override(ERC20Upgradeable, ERC20VotesUpgradeable)␊
450
+ {␊
451
+ super._afterTokenTransfer(from, to, amount);␊
452
+ }␊
453
+
454
+ function _mint(address to, uint256 amount)␊
455
+ internal␊
456
+ override(ERC20Upgradeable, ERC20VotesUpgradeable)␊
457
+ {␊
458
+ super._mint(to, amount);␊
459
+ }␊
460
+
461
+ function _burn(address account, uint256 amount)␊
462
+ internal␊
463
+ override(ERC20Upgradeable, ERC20VotesUpgradeable)␊
464
+ {␊
465
+ super._burn(account, amount);␊
466
+ }␊
467
+ }␊
468
+ `
469
+
470
+ ## erc20 full upgradeable uups
471
+
472
+ > Snapshot 1
473
+
474
+ `// SPDX-License-Identifier: MIT␊
475
+ pragma solidity ^0.8.4;␊
476
+
477
+ import "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";␊
478
+ import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/ERC20BurnableUpgradeable.sol";␊
479
+ import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/ERC20SnapshotUpgradeable.sol";␊
480
+ import "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";␊
481
+ import "@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol";␊
482
+ import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/draft-ERC20PermitUpgradeable.sol";␊
483
+ import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/ERC20VotesUpgradeable.sol";␊
484
+ import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/ERC20FlashMintUpgradeable.sol";␊
485
+ import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";␊
486
+ import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";␊
487
+
488
+ contract MyToken is Initializable, ERC20Upgradeable, ERC20BurnableUpgradeable, ERC20SnapshotUpgradeable, AccessControlUpgradeable, PausableUpgradeable, ERC20PermitUpgradeable, ERC20VotesUpgradeable, ERC20FlashMintUpgradeable, UUPSUpgradeable {␊
489
+ bytes32 public constant SNAPSHOT_ROLE = keccak256("SNAPSHOT_ROLE");␊
490
+ bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE");␊
491
+ bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");␊
492
+ bytes32 public constant UPGRADER_ROLE = keccak256("UPGRADER_ROLE");␊
493
+
494
+ /// @custom:oz-upgrades-unsafe-allow constructor␊
495
+ constructor() {␊
496
+ _disableInitializers();␊
497
+ }␊
498
+
499
+ function initialize() initializer public {␊
500
+ __ERC20_init("MyToken", "MTK");␊
501
+ __ERC20Burnable_init();␊
502
+ __ERC20Snapshot_init();␊
503
+ __AccessControl_init();␊
504
+ __Pausable_init();␊
505
+ __ERC20Permit_init("MyToken");␊
506
+ __ERC20Votes_init();␊
507
+ __ERC20FlashMint_init();␊
508
+ __UUPSUpgradeable_init();␊
509
+
510
+ _grantRole(DEFAULT_ADMIN_ROLE, msg.sender);␊
511
+ _grantRole(SNAPSHOT_ROLE, msg.sender);␊
512
+ _grantRole(PAUSER_ROLE, msg.sender);␊
513
+ _mint(msg.sender, 2000 * 10 ** decimals());␊
514
+ _grantRole(MINTER_ROLE, msg.sender);␊
515
+ _grantRole(UPGRADER_ROLE, msg.sender);␊
516
+ }␊
517
+
518
+ function snapshot() public onlyRole(SNAPSHOT_ROLE) {␊
519
+ _snapshot();␊
520
+ }␊
521
+
522
+ function pause() public onlyRole(PAUSER_ROLE) {␊
523
+ _pause();␊
524
+ }␊
525
+
526
+ function unpause() public onlyRole(PAUSER_ROLE) {␊
527
+ _unpause();␊
528
+ }␊
529
+
530
+ function mint(address to, uint256 amount) public onlyRole(MINTER_ROLE) {␊
531
+ _mint(to, amount);␊
532
+ }␊
533
+
534
+ function _beforeTokenTransfer(address from, address to, uint256 amount)␊
535
+ internal␊
536
+ whenNotPaused␊
537
+ override(ERC20Upgradeable, ERC20SnapshotUpgradeable)␊
538
+ {␊
539
+ super._beforeTokenTransfer(from, to, amount);␊
540
+ }␊
541
+
542
+ function _authorizeUpgrade(address newImplementation)␊
543
+ internal␊
544
+ onlyRole(UPGRADER_ROLE)␊
545
+ override␊
546
+ {}␊
547
+
548
+ // The following functions are overrides required by Solidity.␊
549
+
550
+ function _afterTokenTransfer(address from, address to, uint256 amount)␊
551
+ internal␊
552
+ override(ERC20Upgradeable, ERC20VotesUpgradeable)␊
553
+ {␊
554
+ super._afterTokenTransfer(from, to, amount);␊
555
+ }␊
556
+
557
+ function _mint(address to, uint256 amount)␊
558
+ internal␊
559
+ override(ERC20Upgradeable, ERC20VotesUpgradeable)␊
560
+ {␊
561
+ super._mint(to, amount);␊
562
+ }␊
563
+
564
+ function _burn(address account, uint256 amount)␊
565
+ internal␊
566
+ override(ERC20Upgradeable, ERC20VotesUpgradeable)␊
567
+ {␊
568
+ super._burn(account, amount);␊
569
+ }␊
570
+ }␊
571
+ `
Binary file