@bannynet/core-v6 0.0.16 → 0.0.18

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 (32) hide show
  1. package/ADMINISTRATION.md +28 -0
  2. package/ARCHITECTURE.md +51 -75
  3. package/AUDIT_INSTRUCTIONS.md +64 -331
  4. package/CHANGELOG.md +31 -0
  5. package/README.md +53 -167
  6. package/RISKS.md +18 -1
  7. package/SKILLS.md +27 -243
  8. package/STYLE_GUIDE.md +56 -17
  9. package/USER_JOURNEYS.md +51 -496
  10. package/package.json +3 -3
  11. package/references/operations.md +25 -0
  12. package/references/runtime.md +27 -0
  13. package/script/Add.Denver.s.sol +10 -7
  14. package/script/Deploy.s.sol +37 -28
  15. package/script/Drop1.s.sol +424 -329
  16. package/src/Banny721TokenUriResolver.sol +7 -7
  17. package/test/Banny721TokenUriResolver.t.sol +8 -5
  18. package/test/BannyAttacks.t.sol +8 -5
  19. package/test/DecorateFlow.t.sol +8 -5
  20. package/test/Fork.t.sol +25 -17
  21. package/test/OutfitTransferLifecycle.t.sol +8 -5
  22. package/test/TestAuditGaps.sol +8 -5
  23. package/test/TestQALastMile.t.sol +8 -5
  24. package/test/audit/AntiStrandingRetention.t.sol +8 -5
  25. package/test/audit/BurnedBodyStrandsAssets.t.sol +8 -5
  26. package/test/audit/MergedOutfitExclusivity.t.sol +8 -5
  27. package/test/audit/TryTransferFromStrandsAssets.t.sol +8 -5
  28. package/test/regression/BodyCategoryValidation.t.sol +8 -5
  29. package/test/regression/BurnedTokenCheck.t.sol +8 -5
  30. package/test/regression/CEIReorder.t.sol +8 -5
  31. package/test/regression/RemovedTierDesync.t.sol +8 -5
  32. package/CHANGE_LOG.md +0 -243
package/STYLE_GUIDE.md CHANGED
@@ -26,8 +26,8 @@ pragma solidity 0.8.28;
26
26
  // Interfaces, structs, enums — caret for forward compatibility
27
27
  pragma solidity ^0.8.0;
28
28
 
29
- // Libraries — caret, may use newer features
30
- pragma solidity ^0.8.17;
29
+ // Libraries — pin to exact version like contracts
30
+ pragma solidity 0.8.28;
31
31
  ```
32
32
 
33
33
  ## Imports
@@ -86,12 +86,20 @@ contract JBExample is JBPermissioned, IJBExample {
86
86
 
87
87
  uint256 internal constant _FEE_BENEFICIARY_PROJECT_ID = 1;
88
88
 
89
+ //*********************************************************************//
90
+ // ------------------------ private constants ------------------------ //
91
+ //*********************************************************************//
92
+
89
93
  //*********************************************************************//
90
94
  // --------------- public immutable stored properties ---------------- //
91
95
  //*********************************************************************//
92
96
 
93
97
  IJBDirectory public immutable override DIRECTORY;
94
98
 
99
+ //*********************************************************************//
100
+ // -------------- internal immutable stored properties -------------- //
101
+ //*********************************************************************//
102
+
95
103
  //*********************************************************************//
96
104
  // --------------------- public stored properties -------------------- //
97
105
  //*********************************************************************//
@@ -100,10 +108,26 @@ contract JBExample is JBPermissioned, IJBExample {
100
108
  // -------------------- internal stored properties ------------------- //
101
109
  //*********************************************************************//
102
110
 
111
+ //*********************************************************************//
112
+ // -------------------- private stored properties -------------------- //
113
+ //*********************************************************************//
114
+
115
+ //*********************************************************************//
116
+ // ------------------- transient stored properties ------------------- //
117
+ //*********************************************************************//
118
+
103
119
  //*********************************************************************//
104
120
  // -------------------------- constructor ---------------------------- //
105
121
  //*********************************************************************//
106
122
 
123
+ //*********************************************************************//
124
+ // ---------------------------- modifiers ---------------------------- //
125
+ //*********************************************************************//
126
+
127
+ //*********************************************************************//
128
+ // ------------------------- receive / fallback ---------------------- //
129
+ //*********************************************************************//
130
+
107
131
  //*********************************************************************//
108
132
  // ---------------------- external transactions ---------------------- //
109
133
  //*********************************************************************//
@@ -112,10 +136,18 @@ contract JBExample is JBPermissioned, IJBExample {
112
136
  // ----------------------- external views ---------------------------- //
113
137
  //*********************************************************************//
114
138
 
139
+ //*********************************************************************//
140
+ // -------------------------- public views --------------------------- //
141
+ //*********************************************************************//
142
+
115
143
  //*********************************************************************//
116
144
  // ----------------------- public transactions ----------------------- //
117
145
  //*********************************************************************//
118
146
 
147
+ //*********************************************************************//
148
+ // ---------------------- internal transactions ---------------------- //
149
+ //*********************************************************************//
150
+
119
151
  //*********************************************************************//
120
152
  // ----------------------- internal helpers -------------------------- //
121
153
  //*********************************************************************//
@@ -134,17 +166,28 @@ contract JBExample is JBPermissioned, IJBExample {
134
166
  1. Custom errors
135
167
  2. Public constants
136
168
  3. Internal constants
137
- 4. Public immutable stored properties
138
- 5. Internal immutable stored properties
139
- 6. Public stored properties
140
- 7. Internal stored properties
141
- 8. Constructor
142
- 9. External transactions
143
- 10. External views
144
- 11. Public transactions
145
- 12. Internal helpers
146
- 13. Internal views
147
- 14. Private helpers
169
+ 4. Private constants
170
+ 5. Public immutable stored properties
171
+ 6. Internal immutable stored properties
172
+ 7. Public stored properties
173
+ 8. Internal stored properties
174
+ 9. Private stored properties
175
+ 10. Transient stored properties
176
+ 11. Constructor
177
+ 12. Modifiers
178
+ 13. Receive / fallback
179
+ 14. External transactions
180
+ 15. External views
181
+ 16. Public views
182
+ 17. Public transactions
183
+ 18. Internal transactions
184
+ 19. Internal helpers
185
+ 20. Internal views
186
+ 21. Private helpers
187
+
188
+ Use these additional section labels where they better match the contents of the block:
189
+ - `internal functions` is accepted as equivalent to `internal helpers`
190
+ - `events` and `structs` are acceptable in specialized contracts that define them explicitly
148
191
 
149
192
  Functions are alphabetized within each section.
150
193
 
@@ -565,7 +608,3 @@ CI checks formatting via `forge fmt --check`.
565
608
  ### Contract Size Checks
566
609
 
567
610
  CI runs `forge build --sizes` to catch contracts approaching the 24KB limit. When the repo's default `optimizer_runs` differs from what you want for size checking, use `FOUNDRY_PROFILE=ci_sizes forge build --sizes` with a `[profile.ci_sizes]` section in `foundry.toml`.
568
-
569
- ## Repo-Specific Deviations
570
-
571
- None. This repo follows the standard configuration exactly.