@bannynet/core-v6 0.0.22 → 0.0.24
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ADMINISTRATION.md +60 -109
- package/ARCHITECTURE.md +69 -44
- package/AUDIT_INSTRUCTIONS.md +48 -57
- package/README.md +56 -17
- package/RISKS.md +39 -48
- package/SKILLS.md +9 -7
- package/USER_JOURNEYS.md +151 -41
- package/foundry.toml +2 -0
- package/package.json +35 -35
- package/references/operations.md +2 -2
- package/references/runtime.md +1 -1
- package/src/Banny721TokenUriResolver.sol +0 -5
package/ADMINISTRATION.md
CHANGED
|
@@ -1,136 +1,87 @@
|
|
|
1
1
|
# Administration
|
|
2
2
|
|
|
3
|
-
Admin privileges and their scope in banny-retail-v6. The contract (`Banny721TokenUriResolver`) is a single-file system with one admin role (Ownable) and per-token owner privileges.
|
|
4
|
-
|
|
5
3
|
## At A Glance
|
|
6
4
|
|
|
7
5
|
| Item | Details |
|
|
8
|
-
|
|
9
|
-
| Scope |
|
|
10
|
-
|
|
|
11
|
-
| Highest-risk actions |
|
|
12
|
-
| Recovery posture |
|
|
13
|
-
|
|
14
|
-
## Routine Operations
|
|
6
|
+
| --- | --- |
|
|
7
|
+
| Scope | `Banny721TokenUriResolver` metadata, SVG commitments, and outfit-state control |
|
|
8
|
+
| Control posture | Global `Ownable` metadata control plus per-body owner control |
|
|
9
|
+
| Highest-risk actions | Wrong SVG hash commitments, incorrect metadata updates, and long outfit locks |
|
|
10
|
+
| Recovery posture | Metadata is editable, but committed hashes, uploaded SVGs, and active locks are not reversible |
|
|
15
11
|
|
|
16
|
-
|
|
17
|
-
- Treat metadata and product-name changes as ecosystem-wide display changes that affect every token rendered through the resolver.
|
|
18
|
-
- Remind users that equipped assets are held by the resolver contract until they are unequipped through the supported flow.
|
|
19
|
-
- Use outfit locks deliberately, because they freeze body-level changes for the fixed lock window.
|
|
12
|
+
## Purpose
|
|
20
13
|
|
|
21
|
-
|
|
14
|
+
`banny-retail-v6` has a small but real control plane. The resolver owner controls collection-wide metadata and SVG commitments. Body owners control decoration and outfit locks. No admin can rescue equipped NFTs if resolver logic fails.
|
|
22
15
|
|
|
23
|
-
|
|
24
|
-
- `setSvgContentsOf` is also write-once once valid content is uploaded.
|
|
25
|
-
- `lockOutfitChangesFor` can only extend the active lock, never shorten it.
|
|
26
|
-
- There is no admin rescue path for custodially held outfit NFTs.
|
|
16
|
+
## Control Model
|
|
27
17
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
-
|
|
31
|
-
-
|
|
18
|
+
- `Banny721TokenUriResolver` is `Ownable`.
|
|
19
|
+
- Global admin power is limited to metadata, product naming, and SVG hash commitments.
|
|
20
|
+
- Actual SVG upload is permissionless once the hash is committed.
|
|
21
|
+
- Body owners control decoration and locking for their own bodies.
|
|
22
|
+
- Equipped accessories are held by the resolver while attached.
|
|
32
23
|
|
|
33
24
|
## Roles
|
|
34
25
|
|
|
35
|
-
| Role | How Assigned | Scope |
|
|
36
|
-
|
|
37
|
-
|
|
|
38
|
-
|
|
|
39
|
-
|
|
|
40
|
-
| **Anyone (Permissionless)** | No restriction. | Upload SVG content (if matching hash exists) |
|
|
41
|
-
| **Trusted Forwarder** | Set at construction via `ERC2771Context(trustedForwarder)`. Immutable after deploy. | Meta-transaction relay: `_msgSender()` resolves to the relayed sender |
|
|
42
|
-
|
|
43
|
-
## Privileged Functions
|
|
44
|
-
|
|
45
|
-
### Banny721TokenUriResolver -- Owner-Only Functions
|
|
46
|
-
|
|
47
|
-
| Function | Guard | What It Does |
|
|
48
|
-
|----------|-------|-------------|
|
|
49
|
-
| `setMetadata(description, url, baseUri)` | `onlyOwner` | Overwrites the token metadata description, external URL, and SVG base URI. All three fields are always written (pass current value to keep, empty string to clear). |
|
|
50
|
-
| `setProductNames(upcs, names)` | `onlyOwner` | Sets custom display names for products identified by UPC. Names are stored in `_customProductNameOf` mapping. Can overwrite previously set names. |
|
|
51
|
-
| `setSvgHashesOf(upcs, svgHashes)` | `onlyOwner` | Commits keccak256 hashes for SVG content keyed by UPC. Each hash can only be set once -- reverts with `HashAlreadyStored` if the UPC already has a hash. This is the gating step that controls which SVG content can later be uploaded permissionlessly. |
|
|
52
|
-
|
|
53
|
-
### Banny721TokenUriResolver -- Permissionless Functions
|
|
54
|
-
|
|
55
|
-
| Function | Guard | What It Does |
|
|
56
|
-
|----------|-------|-------------|
|
|
57
|
-
| `setSvgContentsOf(upcs, svgContents)` | None (anyone) | Stores SVG content for a UPC, but only if: (1) a hash was previously committed by the owner via `setSvgHashesOf`, (2) `keccak256(content) == storedHash`, and (3) content has not already been stored (`ContentsAlreadyStored`). This is the permissionless "lazy upload" mechanism. |
|
|
26
|
+
| Role | How Assigned | Scope | Notes |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| Resolver owner | `Ownable(owner)` at construction | Global | Can transfer ownership with `transferOwnership()` |
|
|
29
|
+
| Body owner | `IERC721(hook).ownerOf(bannyBodyId)` | Per body | Can decorate and lock that body |
|
|
30
|
+
| Anyone | No assignment | Global | Can upload SVG bytes only if they match a committed hash |
|
|
58
31
|
|
|
59
|
-
|
|
32
|
+
## Privileged Surfaces
|
|
60
33
|
|
|
61
|
-
|
|
|
62
|
-
|
|
63
|
-
| `
|
|
64
|
-
| `
|
|
34
|
+
| Contract | Function | Who Can Call | Effect |
|
|
35
|
+
| --- | --- | --- | --- |
|
|
36
|
+
| `Banny721TokenUriResolver` | `setMetadata(...)` | Resolver owner | Changes global description, URL, and base URI |
|
|
37
|
+
| `Banny721TokenUriResolver` | `setProductNames(...)` | Resolver owner | Changes display names for products |
|
|
38
|
+
| `Banny721TokenUriResolver` | `setSvgHashesOf(...)` | Resolver owner | Commits write-once SVG hashes for UPCs |
|
|
39
|
+
| `Banny721TokenUriResolver` | `setSvgContentsOf(...)` | Anyone with matching bytes | Uploads write-once SVG payloads for committed hashes |
|
|
40
|
+
| `Banny721TokenUriResolver` | `decorateBannyWith(...)` | Current body owner | Equips or unequips accessories and updates custody |
|
|
41
|
+
| `Banny721TokenUriResolver` | `lockOutfitChangesFor(...)` | Current body owner | Extends the outfit lock window for that body |
|
|
65
42
|
|
|
66
|
-
|
|
43
|
+
## Immutable And One-Way
|
|
67
44
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
45
|
+
- SVG hash commitments are write-once.
|
|
46
|
+
- SVG contents are write-once once uploaded.
|
|
47
|
+
- `lockOutfitChangesFor(...)` only extends the active lock.
|
|
48
|
+
- The lock duration is fixed by `_LOCK_DURATION`.
|
|
49
|
+
- Default art fragments, category semantics, and the trusted forwarder are constructor or code immutables.
|
|
71
50
|
|
|
72
|
-
##
|
|
51
|
+
## Operational Notes
|
|
73
52
|
|
|
74
|
-
|
|
53
|
+
- Treat `setSvgHashesOf(...)` like a release gate. A wrong hash usually means a new resolver or new UPC strategy, not a small edit.
|
|
54
|
+
- Treat `setMetadata(...)` and `setProductNames(...)` as collection-wide display changes.
|
|
55
|
+
- Remind users that equipped assets are in resolver custody while attached.
|
|
56
|
+
- Only lock outfits when temporary non-editability is the intended experience.
|
|
57
|
+
- Use safe ERC-721 transfer flows when assets enter the resolver path. Plain `transferFrom` can strand NFTs without a recovery path.
|
|
75
58
|
|
|
76
|
-
|
|
77
|
-
2. **Anyone** can then upload the actual SVG content via `setSvgContentsOf()`, provided the content's keccak256 hash matches the owner-committed hash. This is intentional: the owner sets the commitment, and anyone can fulfill it (useful for gas-efficient lazy uploading).
|
|
59
|
+
## Machine Notes
|
|
78
60
|
|
|
79
|
-
|
|
80
|
-
-
|
|
81
|
-
-
|
|
82
|
-
-
|
|
61
|
+
- Do not assume there is a rescue path for equipped assets. There is none.
|
|
62
|
+
- Treat `src/Banny721TokenUriResolver.sol` as the source of truth for lock extension and write-once SVG behavior.
|
|
63
|
+
- If a committed hash and intended asset bytes differ, stop. The contract does not support overwrite repair.
|
|
64
|
+
- If an asset arrived through non-safe ERC-721 transfer semantics, do not assume the resolver can detect or recover it.
|
|
83
65
|
|
|
84
|
-
|
|
85
|
-
- Can be overwritten by the owner at any time via `setProductNames()`. There is no immutability guard on names -- the owner can rename products freely. The built-in names for UPCs 1-4 (Alien, Pink, Orange, Original) are hardcoded in `_productNameOf()` and cannot be overridden.
|
|
66
|
+
## Recovery
|
|
86
67
|
|
|
87
|
-
|
|
88
|
-
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
When a user equips an outfit or background on a banny body via `decorateBannyWith()`, the outfit/background NFT is transferred from the user's wallet into the `Banny721TokenUriResolver` contract. The resolver holds these NFTs in custody until the user unequips them (by calling `decorateBannyWith()` again with different outfits).
|
|
93
|
-
|
|
94
|
-
**Trust assumptions:**
|
|
95
|
-
- Users must trust that the resolver contract's `decorateBannyWith()` function correctly returns NFTs when outfits are changed. There is no separate `withdraw()` or `rescue()` function.
|
|
96
|
-
- The `onERC721Received` guard (`operator == address(this)`) prevents anyone from sending arbitrary NFTs to the resolver. Only self-initiated transfers during `decorateBannyWith()` are accepted.
|
|
97
|
-
- If the banny body NFT is transferred to a new owner while outfits are equipped, the new body owner can unequip and claim the outfit NFTs (the ownership check in `_checkIfSenderIsOwner` is against the current body owner).
|
|
98
|
-
- The `lockOutfitChangesFor()` function can lock outfits for up to 7 days per call (extendable). During a lock, neither the body owner nor anyone else can change the equipped outfits.
|
|
99
|
-
- There is no admin override to rescue stuck outfit NFTs. If a bug in `decorateBannyWith()` prevents unequipping, the outfits remain locked in the resolver permanently.
|
|
100
|
-
|
|
101
|
-
## Immutable Configuration
|
|
102
|
-
|
|
103
|
-
The following are set at construction and cannot be changed:
|
|
104
|
-
|
|
105
|
-
| Property | Set At | Value |
|
|
106
|
-
|----------|--------|-------|
|
|
107
|
-
| `BANNY_BODY` | Constructor | Base SVG path for all banny body rendering |
|
|
108
|
-
| `DEFAULT_NECKLACE` | Constructor | Default necklace SVG injected when no custom necklace equipped |
|
|
109
|
-
| `DEFAULT_MOUTH` | Constructor | Default mouth SVG injected when no custom mouth equipped |
|
|
110
|
-
| `DEFAULT_STANDARD_EYES` | Constructor | Default eyes SVG for non-alien bodies |
|
|
111
|
-
| `DEFAULT_ALIEN_EYES` | Constructor | Default eyes SVG for alien bodies |
|
|
112
|
-
| `trustedForwarder` | Constructor | ERC-2771 forwarder address for meta-transactions |
|
|
113
|
-
| `_LOCK_DURATION` | Constant | 7 days -- hardcoded, not configurable |
|
|
114
|
-
| Body color fills | Hardcoded in `_fillsFor()` | Color palettes for Alien, Pink, Orange, Original body types |
|
|
115
|
-
| Category IDs | Constants | 18 category slots (0-17), hardcoded |
|
|
68
|
+
- Bad metadata can be changed by the owner.
|
|
69
|
+
- Bad SVG commitments or uploaded content cannot be corrected in place.
|
|
70
|
+
- If equipped assets become stuck because of resolver logic, there is no owner rescue path.
|
|
71
|
+
- If NFTs are stranded through non-safe transfer semantics, this contract does not provide recovery.
|
|
116
72
|
|
|
117
73
|
## Admin Boundaries
|
|
118
74
|
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
-
|
|
122
|
-
-
|
|
123
|
-
-
|
|
124
|
-
- **Cannot change the lock duration.** The 7-day lock is a compile-time constant.
|
|
125
|
-
- **Cannot force-equip or force-unequip outfits.** Only the body NFT's owner can call `decorateBannyWith` and `lockOutfitChangesFor`.
|
|
126
|
-
- **Cannot override hardcoded body names.** UPCs 1-4 always resolve to Alien, Pink, Orange, Original regardless of `_customProductNameOf`.
|
|
127
|
-
- **Cannot change the trusted forwarder.** It is immutable after construction.
|
|
128
|
-
- **Cannot pause the contract.** There is no pause mechanism.
|
|
129
|
-
- **Cannot upgrade the contract.** It is not upgradeable.
|
|
75
|
+
- The owner cannot arbitrarily withdraw equipped user NFTs.
|
|
76
|
+
- The owner cannot overwrite committed hashes or uploaded SVG contents.
|
|
77
|
+
- The owner cannot bypass body-owner checks on decoration or locking.
|
|
78
|
+
- Nobody can shorten an active outfit lock.
|
|
79
|
+
- There is no pause, upgrade, or rescue mechanism.
|
|
130
80
|
|
|
131
|
-
|
|
81
|
+
## Source Map
|
|
132
82
|
|
|
133
|
-
-
|
|
134
|
-
-
|
|
135
|
-
-
|
|
136
|
-
-
|
|
83
|
+
- `src/Banny721TokenUriResolver.sol`
|
|
84
|
+
- `src/interfaces/IBanny721TokenUriResolver.sol`
|
|
85
|
+
- `script/Deploy.s.sol`
|
|
86
|
+
- `test/TestAuditGaps.sol`
|
|
87
|
+
- `test/TestQALastMile.t.sol`
|
package/ARCHITECTURE.md
CHANGED
|
@@ -2,75 +2,100 @@
|
|
|
2
2
|
|
|
3
3
|
## Purpose
|
|
4
4
|
|
|
5
|
-
`banny-retail-v6`
|
|
5
|
+
`banny-retail-v6` is the Banny-specific metadata and attachment layer for Juicebox 721 collections. It does not mint NFTs or own treasury logic. It owns attachment custody, outfit-lock rules, and final token rendering.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## System Overview
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
- `nana-721-hook-v6` still owns token minting, transfers, and collection-level ERC-721 behavior.
|
|
11
|
-
- The resolver is intentionally application-specific. Generic 721 hook behavior should stay in `nana-721-hook-v6`.
|
|
9
|
+
The repo centers on `Banny721TokenUriResolver`. A 721 hook from `nana-721-hook-v6` points to this resolver for `tokenURI(...)`. Bodies, outfits, and backgrounds remain separate NFTs at the collection layer. The resolver escrows equipped accessories, records which assets are attached to each body, and composes the final SVG and JSON metadata on demand.
|
|
12
10
|
|
|
13
|
-
##
|
|
11
|
+
## Core Invariants
|
|
14
12
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
13
|
+
- A body can only reference accessories that are currently escrowed by the resolver.
|
|
14
|
+
- Replacing an equipped item must atomically return the old item and escrow the new item.
|
|
15
|
+
- Outfit locks must block both explicit removal and implicit replacement until the lock expires.
|
|
16
|
+
- Equipped assets move with the body NFT on transfer until the new owner unequips them.
|
|
17
|
+
- Registered SVG payloads must match their committed content hash before they can render.
|
|
18
|
+
- Rendering must stay deterministic for the same stored body state.
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Modules
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
| Module | Responsibility | Notes |
|
|
23
|
+
| --- | --- | --- |
|
|
24
|
+
| `Banny721TokenUriResolver` | Escrow, attachment state, lock windows, and metadata rendering | Main contract |
|
|
25
|
+
| `IBanny721TokenUriResolver` | External integration surface | Used by hooks and offchain tooling |
|
|
26
|
+
|
|
27
|
+
## Trust Boundaries
|
|
28
|
+
|
|
29
|
+
- Minting, ownership transfer, and collection-level ERC-721 semantics live in `nana-721-hook-v6`.
|
|
30
|
+
- This repo is trusted for rendering correctness and custody of equipped assets.
|
|
31
|
+
- Asset-content upload is controlled by the registered content owner, but the contract verifies uploaded bytes against the stored hash.
|
|
32
|
+
|
|
33
|
+
## Critical Flows
|
|
34
|
+
|
|
35
|
+
### Decorate
|
|
23
36
|
|
|
24
37
|
```text
|
|
25
38
|
body owner
|
|
26
39
|
-> calls decorateBannyWith(...)
|
|
27
|
-
-> resolver verifies ownership
|
|
28
|
-
-> resolver pulls
|
|
29
|
-
-> resolver
|
|
30
|
-
-> resolver returns
|
|
40
|
+
-> resolver verifies body ownership and lock status
|
|
41
|
+
-> resolver pulls new accessories into escrow
|
|
42
|
+
-> resolver updates equipped slots
|
|
43
|
+
-> resolver returns replaced accessories to the owner
|
|
31
44
|
```
|
|
32
45
|
|
|
33
|
-
###
|
|
46
|
+
### Render
|
|
34
47
|
|
|
35
48
|
```text
|
|
36
49
|
tokenURI(bodyId)
|
|
37
|
-
->
|
|
38
|
-
->
|
|
39
|
-
->
|
|
40
|
-
->
|
|
50
|
+
-> resolver loads body, background, and equipped slot state
|
|
51
|
+
-> fetches registered SVG fragments
|
|
52
|
+
-> composes layered SVG in Banny-specific order
|
|
53
|
+
-> returns base64 JSON metadata
|
|
41
54
|
```
|
|
42
55
|
|
|
43
|
-
###
|
|
56
|
+
### Lock Outfit
|
|
44
57
|
|
|
45
58
|
```text
|
|
46
|
-
owner
|
|
47
|
-
-> lockOutfitChangesFor(...)
|
|
48
|
-
->
|
|
49
|
-
-> decoration and removal paths must respect
|
|
59
|
+
body owner
|
|
60
|
+
-> calls lockOutfitChangesFor(...)
|
|
61
|
+
-> resolver stores a no-change window
|
|
62
|
+
-> later decoration and removal paths must respect it
|
|
50
63
|
```
|
|
51
64
|
|
|
52
|
-
##
|
|
65
|
+
## Accounting Model
|
|
53
66
|
|
|
54
|
-
|
|
55
|
-
- Slot replacement must be one-for-one. Replacing an equipped item returns the old item instead of orphaning it.
|
|
56
|
-
- Outfit locks must block both direct edits and indirect attempts to reclaim an equipped item through another decoration call.
|
|
57
|
-
- Asset registration is split between hash registration and content upload so content can be trustlessly verified before it is stored on-chain.
|
|
67
|
+
This repo does not own treasury accounting. Its critical state is custody accounting: which NFTs are escrowed, which body they belong to, and when a body is locked against changes.
|
|
58
68
|
|
|
59
|
-
|
|
69
|
+
That custody model uses lazy reconciliation for some stale attachment records. Read paths filter against current ownership and attachment state instead of rewriting storage on every outside transfer.
|
|
60
70
|
|
|
61
|
-
|
|
62
|
-
- Lock enforcement has to cover both explicit removal and implicit replacement paths.
|
|
63
|
-
- SVG composition order is application logic, not a cosmetic detail.
|
|
71
|
+
## Security Model
|
|
64
72
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
-
|
|
68
|
-
-
|
|
73
|
+
- The main failure mode is custody drift between slot state and actual escrowed NFTs.
|
|
74
|
+
- Rendering order is part of app semantics, not cosmetic output.
|
|
75
|
+
- Lazy reconciliation is intentional. Changes that assume storage is always perfectly clean can strand assets or mis-render bodies.
|
|
76
|
+
- Any new asset category adds both a rendering concern and a custody concern.
|
|
69
77
|
|
|
70
78
|
## Safe Change Guide
|
|
71
79
|
|
|
72
|
-
-
|
|
73
|
-
-
|
|
74
|
-
-
|
|
75
|
-
- If
|
|
76
|
-
- If
|
|
80
|
+
- Keep generic ERC-721 behavior in `nana-721-hook-v6`, not here.
|
|
81
|
+
- Review escrow writes and transfer behavior together whenever changing attachment logic.
|
|
82
|
+
- If transfer or cleanup behavior changes, re-check lazy reconciliation alongside body-transfer inheritance.
|
|
83
|
+
- If `tokenURI(...)` changes, test stable output for unchanged state and replacement behavior for changed state.
|
|
84
|
+
- If adding slots or asset classes, update rendering order, slot replacement, and lock enforcement in one change.
|
|
85
|
+
|
|
86
|
+
## Canonical Checks
|
|
87
|
+
|
|
88
|
+
- accessory escrow, replacement, and decoration flow:
|
|
89
|
+
`test/DecorateFlow.t.sol`
|
|
90
|
+
- burned-body custody edge cases:
|
|
91
|
+
`test/audit/BurnedBodyStrandsAssets.t.sol`
|
|
92
|
+
- transfer-path protection against stranded attachments:
|
|
93
|
+
`test/audit/TryTransferFromStrandsAssets.t.sol`
|
|
94
|
+
|
|
95
|
+
## Source Map
|
|
96
|
+
|
|
97
|
+
- `src/Banny721TokenUriResolver.sol`
|
|
98
|
+
- `test/DecorateFlow.t.sol`
|
|
99
|
+
- `test/audit/BurnedBodyStrandsAssets.t.sol`
|
|
100
|
+
- `test/audit/TryTransferFromStrandsAssets.t.sol`
|
|
101
|
+
- `script/Deploy.s.sol`
|
package/AUDIT_INSTRUCTIONS.md
CHANGED
|
@@ -1,87 +1,78 @@
|
|
|
1
1
|
# Audit Instructions
|
|
2
2
|
|
|
3
|
-
This repo is the Banny avatar composition layer.
|
|
3
|
+
This repo is the Banny avatar composition layer. It does not mint the base NFTs, but it does hold equipped accessories and define the metadata users see.
|
|
4
4
|
|
|
5
|
-
## Objective
|
|
5
|
+
## Audit Objective
|
|
6
6
|
|
|
7
7
|
Find issues that:
|
|
8
|
-
|
|
9
|
-
-
|
|
10
|
-
-
|
|
11
|
-
-
|
|
12
|
-
-
|
|
8
|
+
|
|
9
|
+
- strand outfits or backgrounds in resolver custody
|
|
10
|
+
- let the wrong actor equip, unequip, overwrite, or recover accessories
|
|
11
|
+
- break outfit-lock timing or freeze a body longer than intended
|
|
12
|
+
- return metadata that does not match stored attachment state
|
|
13
|
+
- bypass category or layering constraints
|
|
13
14
|
|
|
14
15
|
## Scope
|
|
15
16
|
|
|
16
17
|
In scope:
|
|
18
|
+
|
|
17
19
|
- `src/Banny721TokenUriResolver.sol`
|
|
18
20
|
- `src/interfaces/IBanny721TokenUriResolver.sol`
|
|
19
|
-
- deployment
|
|
20
|
-
|
|
21
|
-
Primary integration assumptions to verify:
|
|
22
|
-
- the resolver is used as a token URI resolver for a `JB721TiersHook`
|
|
23
|
-
- the underlying 721 hook remains the token contract and tier source
|
|
24
|
-
- the resolver temporarily holds accessory NFTs while they are equipped
|
|
21
|
+
- deployment helpers in `script/`
|
|
25
22
|
|
|
26
|
-
##
|
|
23
|
+
## Start Here
|
|
27
24
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
- records which body currently has which attachments
|
|
32
|
-
- enforces category and conflict rules
|
|
33
|
-
- renders composed metadata and SVG output
|
|
25
|
+
1. `src/Banny721TokenUriResolver.sol`
|
|
26
|
+
2. accessory receipt and release paths
|
|
27
|
+
3. deployment wiring in `script/`
|
|
34
28
|
|
|
35
|
-
|
|
36
|
-
- body owner controls decoration
|
|
37
|
-
- resolver holds equipped accessories
|
|
38
|
-
- on unequip or invalidation, assets must become recoverable by the rightful owner
|
|
29
|
+
## Security Model
|
|
39
30
|
|
|
40
|
-
|
|
31
|
+
The resolver is an attachment and rendering layer around a `JB721TiersHook` collection.
|
|
41
32
|
|
|
42
|
-
|
|
43
|
-
|
|
33
|
+
- the underlying 721 hook remains the token contract and source of body ownership
|
|
34
|
+
- the resolver temporarily holds accessory NFTs while they are equipped
|
|
35
|
+
- body ownership should be the only authority that changes equipped state
|
|
36
|
+
- accessory contracts may be hostile or malformed, so receipt and release ordering matters
|
|
44
37
|
|
|
45
|
-
|
|
46
|
-
Only an authorized actor for the body may change its equipped state.
|
|
38
|
+
## Roles And Privileges
|
|
47
39
|
|
|
48
|
-
|
|
49
|
-
|
|
40
|
+
| Role | Powers | How constrained |
|
|
41
|
+
|------|--------|-----------------|
|
|
42
|
+
| Body owner | Equip, unequip, and lock accessories | Must be derived from the current hook-reported owner |
|
|
43
|
+
| Resolver owner | Update metadata and SVG-related admin state | Must not control equipped-state authorization |
|
|
44
|
+
| Accessory NFT contract | Execute callbacks during custody changes | Must not corrupt bookkeeping or steal custody |
|
|
50
45
|
|
|
51
|
-
|
|
52
|
-
`lockOutfitChangesFor` must only prevent changes for the intended body and duration. It must not be bypassable, extendable by unauthorized actors, or accidentally permanent.
|
|
46
|
+
## Integration Assumptions
|
|
53
47
|
|
|
54
|
-
|
|
55
|
-
|
|
48
|
+
| Dependency | Assumption | What breaks if wrong |
|
|
49
|
+
|------------|------------|----------------------|
|
|
50
|
+
| `JB721TiersHook` | Reports authentic body ownership and tier metadata | Unauthorized decoration or incorrect rendering |
|
|
51
|
+
| Accessory ERC-721s | Behave like standard transferable NFTs | Custody or release flows fail unexpectedly |
|
|
56
52
|
|
|
57
|
-
##
|
|
53
|
+
## Critical Invariants
|
|
58
54
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
-
|
|
63
|
-
|
|
64
|
-
- attempt to steal accessories by redecorating around lock windows
|
|
55
|
+
1. Every accessory transferred into the resolver remains attributable to one body or is recoverable by the rightful owner.
|
|
56
|
+
2. Only the current body owner or an intended delegate can change that body's equipped state.
|
|
57
|
+
3. Conflicting categories cannot be equipped together, including through replacement or invalidation edge paths.
|
|
58
|
+
4. Outfit-lock state only affects the intended body for the intended duration.
|
|
59
|
+
5. Metadata and SVG generation reflect current state and do not show impossible combinations.
|
|
65
60
|
|
|
66
|
-
##
|
|
61
|
+
## Attack Surfaces
|
|
67
62
|
|
|
68
|
-
-
|
|
69
|
-
- any path that accepts
|
|
70
|
-
-
|
|
63
|
+
- decoration entrypoints that replace one accessory with another
|
|
64
|
+
- ERC-721 receipt hooks and any path that accepts custody
|
|
65
|
+
- release paths after redecorating, burning, or invalid token state
|
|
71
66
|
- category validation and conflict checks
|
|
72
|
-
-
|
|
73
|
-
|
|
67
|
+
- metadata assembly that assumes onchain assets or tier data remain available
|
|
68
|
+
|
|
69
|
+
## Accepted Risks Or Behaviors
|
|
70
|
+
|
|
71
|
+
- Equipped accessories intentionally follow the body unless they are unequipped first.
|
|
72
|
+
- Preserving attribution on failed transfer-out is safer than dropping custody state.
|
|
74
73
|
|
|
75
|
-
##
|
|
74
|
+
## Verification
|
|
76
75
|
|
|
77
|
-
Standard workflow:
|
|
78
76
|
- `npm install`
|
|
79
77
|
- `forge build`
|
|
80
78
|
- `forge test`
|
|
81
|
-
|
|
82
|
-
The current test tree emphasizes:
|
|
83
|
-
- attack and regression coverage around stranding and exclusivity
|
|
84
|
-
- decoration lifecycle flows
|
|
85
|
-
- fork and QA scenarios
|
|
86
|
-
|
|
87
|
-
Prefer proofs that show a body or accessory becoming inaccessible, transferable by the wrong party, or rendered inconsistently with stored state.
|
package/README.md
CHANGED
|
@@ -1,40 +1,72 @@
|
|
|
1
1
|
# Banny Retail
|
|
2
2
|
|
|
3
|
-
Banny Retail is an
|
|
3
|
+
Banny Retail is an onchain avatar system for Juicebox 721 collections. A body NFT can wear outfit NFTs, use a background NFT, and resolve to a base64 JSON token URI whose image is an onchain SVG.
|
|
4
4
|
|
|
5
5
|
Docs: <https://docs.juicebox.money>
|
|
6
|
-
Architecture: [ARCHITECTURE.md](./ARCHITECTURE.md)
|
|
6
|
+
Architecture: [ARCHITECTURE.md](./ARCHITECTURE.md)
|
|
7
|
+
User journeys: [USER_JOURNEYS.md](./USER_JOURNEYS.md)
|
|
8
|
+
Skills: [SKILLS.md](./SKILLS.md)
|
|
9
|
+
Risks: [RISKS.md](./RISKS.md)
|
|
10
|
+
Administration: [ADMINISTRATION.md](./ADMINISTRATION.md)
|
|
11
|
+
Audit instructions: [AUDIT_INSTRUCTIONS.md](./AUDIT_INSTRUCTIONS.md)
|
|
7
12
|
|
|
8
13
|
## Overview
|
|
9
14
|
|
|
10
|
-
This is a resolver-centric
|
|
15
|
+
This is a resolver-centric app built on top of [`@bananapus/721-hook-v6`](https://www.npmjs.com/package/@bananapus/721-hook-v6). The resolver holds attached outfit and background NFTs while a body is decorated, then composes the active layers into a single token URI response.
|
|
11
16
|
|
|
12
17
|
The main user flows are:
|
|
13
18
|
|
|
14
19
|
- mint body, outfit, and background NFTs through a Juicebox 721 hook
|
|
15
20
|
- attach accessories to a body with `decorateBannyWith`
|
|
16
|
-
- optionally freeze the
|
|
17
|
-
- upload SVG payloads
|
|
21
|
+
- optionally freeze the look for seven days with `lockOutfitChangesFor`
|
|
22
|
+
- upload SVG payloads after an owner registers the content hashes
|
|
18
23
|
|
|
19
|
-
Use this repo when you need collection-specific, fully
|
|
20
|
-
|
|
21
|
-
If a bug changes tier pricing, mint eligibility, or treasury flow, it is probably not here first. Start in the 721 hook repo and only come here once the issue is clearly in attachment, custody, or rendering behavior.
|
|
24
|
+
Use this repo when you need collection-specific, fully onchain metadata composition on top of Juicebox NFTs. Do not use it as a generic 721 hook. It is an app-layer resolver, not a protocol NFT primitive.
|
|
22
25
|
|
|
23
26
|
## Key Contract
|
|
24
27
|
|
|
25
28
|
| Contract | Role |
|
|
26
29
|
| --- | --- |
|
|
27
|
-
| `Banny721TokenUriResolver` | Resolves
|
|
30
|
+
| `Banny721TokenUriResolver` | Resolves metadata, stores equipped accessories, enforces outfit locks, and renders layered SVG output for Banny collections. |
|
|
28
31
|
|
|
29
32
|
## Mental Model
|
|
30
33
|
|
|
31
34
|
This repo owns three things:
|
|
32
35
|
|
|
33
|
-
1. custody of
|
|
34
|
-
2. rules
|
|
35
|
-
3. rendering of the final
|
|
36
|
+
1. custody of outfit and background NFTs while they are equipped
|
|
37
|
+
2. rules for what a body can wear and when that can change
|
|
38
|
+
3. rendering of the final metadata payload
|
|
39
|
+
|
|
40
|
+
It does not own mint pricing, tier issuance, or treasury accounting.
|
|
41
|
+
|
|
42
|
+
## Read These Files First
|
|
43
|
+
|
|
44
|
+
1. `src/Banny721TokenUriResolver.sol`
|
|
45
|
+
2. `test/DecorateFlow.t.sol`
|
|
46
|
+
3. `test/OutfitTransferLifecycle.t.sol`
|
|
47
|
+
4. `nana-721-hook-v6/src/JB721TiersHook.sol` for upstream mint and tier behavior
|
|
48
|
+
|
|
49
|
+
## High-Signal Tests
|
|
50
|
+
|
|
51
|
+
1. `test/DecorateFlow.t.sol`
|
|
52
|
+
2. `test/OutfitTransferLifecycle.t.sol`
|
|
53
|
+
3. `test/audit/BurnedBodyStrandsAssets.t.sol`
|
|
54
|
+
4. `test/audit/TryTransferFromStrandsAssets.t.sol`
|
|
55
|
+
5. `test/TestQALastMile.t.sol`
|
|
36
56
|
|
|
37
|
-
|
|
57
|
+
## Integration Traps
|
|
58
|
+
|
|
59
|
+
- the resolver holds equipped assets, so transfer edge cases matter as much as rendering output
|
|
60
|
+
- transferred bodies carry their equipped assets, so a new body holder can inherit control of them
|
|
61
|
+
- burned bodies and non-safe transfer patterns can strand expectations around resolver-held assets
|
|
62
|
+
- outfit locks survive body transfers until expiry
|
|
63
|
+
- metadata quality depends on lazily uploaded asset payloads, not only token state
|
|
64
|
+
|
|
65
|
+
## Where State Lives
|
|
66
|
+
|
|
67
|
+
- equipped outfit and background state live in `Banny721TokenUriResolver`
|
|
68
|
+
- layer rendering and token URI generation live in the same resolver
|
|
69
|
+
- mint pricing, tier inventory, and treasury behavior live upstream in `nana-721-hook-v6`
|
|
38
70
|
|
|
39
71
|
## Install
|
|
40
72
|
|
|
@@ -61,7 +93,7 @@ Useful scripts:
|
|
|
61
93
|
|
|
62
94
|
## Deployment Notes
|
|
63
95
|
|
|
64
|
-
Deployments are handled through Sphinx using the environments configured in `script/Deploy.s.sol`. The resolver is
|
|
96
|
+
Deployments are handled through Sphinx using the environments configured in `script/Deploy.s.sol`. The resolver is meant to be plugged into a Juicebox 721 hook as that hook's token URI resolver.
|
|
65
97
|
|
|
66
98
|
## Repository Layout
|
|
67
99
|
|
|
@@ -80,7 +112,14 @@ script/
|
|
|
80
112
|
|
|
81
113
|
## Risks And Notes
|
|
82
114
|
|
|
83
|
-
- attached outfits and backgrounds are
|
|
115
|
+
- attached outfits and backgrounds are held by the resolver while equipped
|
|
84
116
|
- outfit locks are fixed-duration and cannot be shortened once set
|
|
85
|
-
-
|
|
86
|
-
-
|
|
117
|
+
- onchain SVG content is immutable once uploaded for a committed hash
|
|
118
|
+
- plain `transferFrom` can still create asset-tracking surprises around resolver custody
|
|
119
|
+
- rendering quality depends on the integrity of uploaded SVG assets
|
|
120
|
+
|
|
121
|
+
## For AI Agents
|
|
122
|
+
|
|
123
|
+
- Treat this repo as an app-layer resolver, not as the NFT issuance primitive.
|
|
124
|
+
- Start with `Banny721TokenUriResolver` and the lifecycle tests before summarizing attachment behavior.
|
|
125
|
+
- If the question is about mint economics or tier availability, inspect `nana-721-hook-v6` instead.
|
package/RISKS.md
CHANGED
|
@@ -1,89 +1,80 @@
|
|
|
1
1
|
# Banny Retail Risk Register
|
|
2
2
|
|
|
3
|
-
This file focuses on failure modes that can break NFT custody,
|
|
3
|
+
This file focuses on the failure modes that can break NFT custody, bypass hook assumptions, or leave a rendered Banny in a state that does not match the assets users think they own.
|
|
4
4
|
|
|
5
5
|
## How to use this file
|
|
6
6
|
|
|
7
|
-
- Read `Priority risks` first
|
|
8
|
-
- Use `Accepted Behaviors` to separate intentional tradeoffs from
|
|
7
|
+
- Read `Priority risks` first.
|
|
8
|
+
- Use `Accepted Behaviors` to separate intentional tradeoffs from bugs.
|
|
9
9
|
- Treat `Invariants to Verify` as required test and audit targets.
|
|
10
10
|
|
|
11
11
|
## Priority risks
|
|
12
12
|
|
|
13
13
|
| Priority | Risk | Why it matters | Primary controls |
|
|
14
14
|
|----------|------|----------------|------------------|
|
|
15
|
-
| P0 | Untrusted `hook` or store integration | The
|
|
16
|
-
| P1 | Silent transfer
|
|
17
|
-
| P1 | Sale-time outfit
|
|
18
|
-
|
|
15
|
+
| P0 | Untrusted `hook` or store integration | The resolver trusts the supplied hook for ownership checks, tier metadata, and transfers. A bad hook can fake authority or trap assets. | Restrict supported hooks, scrutinize the hook boundary, and test hostile hook behavior. |
|
|
16
|
+
| P1 | Silent transfer-failure retention | Failed returns intentionally keep attachment records to avoid stranding NFTs, but this can leave phantom render state if the asset is gone forever. | Explicit accepted-behavior rules, retained-item handling, and custody/state invariants. |
|
|
17
|
+
| P1 | Sale-time outfit-lock griefing | A seller can transfer a locked body and force the buyer to wait up to 7 days before changing outfits. | Fixed-duration lock, marketplace disclosure, and user education. |
|
|
19
18
|
|
|
20
19
|
## 1. Trust Assumptions
|
|
21
20
|
|
|
22
|
-
- **Trusted forwarder.** ERC-2771 `_msgSender()` is trusted for
|
|
23
|
-
- **Hook contract.** The `hook` parameter is caller-supplied and not validated against
|
|
24
|
-
- **Owner
|
|
25
|
-
- **721 hook store.** `_storeOf(hook)`
|
|
21
|
+
- **Trusted forwarder.** ERC-2771 `_msgSender()` is trusted for ownership checks and admin functions.
|
|
22
|
+
- **Hook contract.** The `hook` parameter is caller-supplied and not validated against a registry.
|
|
23
|
+
- **Owner.** The contract owner controls SVG hashes, product names, and metadata URIs.
|
|
24
|
+
- **721 hook store.** `_storeOf(hook)` trusts the hook to return a legitimate store.
|
|
26
25
|
|
|
27
|
-
## 2. Economic
|
|
26
|
+
## 2. Economic And Manipulation Risks
|
|
28
27
|
|
|
29
|
-
- **Outfit theft via
|
|
30
|
-
- **
|
|
31
|
-
- **Lock griefing.** `lockOutfitChangesFor` extends the lock to `block.timestamp + 7 days`. Locking just before
|
|
28
|
+
- **Outfit theft via body transfer.** Equipped outfits and backgrounds move with the body NFT. If a body is sold while wearing valuable items, the buyer gains control of them.
|
|
29
|
+
- **Try-catch silent failures with retention.** Failed transfer-outs preserve attachment records instead of clearing state. This avoids stranding but can create phantom render entries for burned or removed assets.
|
|
30
|
+
- **Lock griefing.** `lockOutfitChangesFor` extends the lock to `block.timestamp + 7 days`. Locking just before a sale can block the buyer from changing the look for up to 7 days.
|
|
32
31
|
|
|
33
32
|
## 3. Access Control
|
|
34
33
|
|
|
35
|
-
- **No hook validation
|
|
36
|
-
- **SVG content upload is permissionless
|
|
37
|
-
-
|
|
34
|
+
- **No hook validation.** Any address can be passed as `hook`. A malicious hook can fake `ownerOf`, execute arbitrary code during transfers, or return manipulated tier data.
|
|
35
|
+
- **SVG content upload is permissionless once the hash is committed.** This is safe only if the committed hash is correct.
|
|
36
|
+
- **`onERC721Received` restriction.** The contract only accepts NFTs when `operator == address(this)`. Plain `transferFrom` bypasses that and can permanently lock NFTs.
|
|
38
37
|
|
|
39
38
|
## 4. DoS Vectors
|
|
40
39
|
|
|
41
|
-
- **External call iteration scales with outfit count.** `
|
|
42
|
-
- **External hook calls in view functions.** `tokenUriOf` and `svgOf` call into the hook's store multiple times
|
|
40
|
+
- **External call iteration scales with outfit count.** `decorateBannyWith` iterates both old and new outfit arrays, so gas cost scales with the number of outfits changed in one call.
|
|
41
|
+
- **External hook calls in view functions.** `tokenUriOf` and `svgOf` call into the hook's store multiple times. A malicious or gas-heavy hook can make metadata unreadable.
|
|
43
42
|
|
|
44
43
|
## 5. Integration Risks
|
|
45
44
|
|
|
46
|
-
- **Cross-contract NFT custody.** Outfits are held by
|
|
47
|
-
- **Tier removal desync.** If a tier is removed
|
|
48
|
-
- **Non-safe transfer loss.** Outfits sent directly
|
|
49
|
-
- **
|
|
45
|
+
- **Cross-contract NFT custody.** Outfits are held by the resolver via `safeTransferFrom`. If approval is revoked on the hook contract, equipping fails.
|
|
46
|
+
- **Tier removal desync.** If a tier is removed while an outfit from that tier is equipped, the outfit may remain attached but render empty.
|
|
47
|
+
- **Non-safe transfer loss.** Outfits sent directly via `transferFrom` can be permanently stuck because there is no rescue function.
|
|
48
|
+
- **Reentrancy assumptions.** `decorateBannyWith` uses `nonReentrant`, but other functions rely on ordering and limited state impact instead.
|
|
50
49
|
|
|
51
50
|
## 6. Invariants to Verify
|
|
52
51
|
|
|
53
|
-
- Every outfit held by
|
|
54
|
-
- Every background held by
|
|
55
|
-
- `outfitLockedUntil
|
|
56
|
-
- After `decorateBannyWith`,
|
|
57
|
-
-
|
|
58
|
-
- SVG content integrity
|
|
59
|
-
-
|
|
52
|
+
- Every outfit held by the contract has a corresponding wearer mapping to a valid body.
|
|
53
|
+
- Every background held by the contract has a corresponding user mapping to a valid body.
|
|
54
|
+
- `outfitLockedUntil` is monotonically non-decreasing per body.
|
|
55
|
+
- After `decorateBannyWith`, old outfits not in the new set are either returned or explicitly retained because transfer-out failed.
|
|
56
|
+
- Category exclusivity holds on the merged set of retained and newly supplied outfits.
|
|
57
|
+
- SVG content integrity holds for all populated entries.
|
|
58
|
+
- The number of held outfit NFTs should match the number of outfits still tracked as equipped for that hook.
|
|
60
59
|
|
|
61
60
|
## 7. Accepted Behaviors
|
|
62
61
|
|
|
63
|
-
### 7.1 Failed transfers retain attachment records
|
|
64
|
-
|
|
65
|
-
`_tryTransferFrom` catches all transfer failures and returns `false`. When returning a previously equipped item fails, the resolver preserves the attachment record rather than clearing state:
|
|
66
|
-
|
|
67
|
-
- **Backgrounds**: If returning the old background fails, the entire background change is aborted (`return` in `_decorateBannyWithBackground`). The old background stays attached and the new one is not equipped.
|
|
68
|
-
- **Background removal**: If returning the background fails during removal (backgroundId=0), `_attachedBackgroundIdOf` is not cleared. The background stays attached.
|
|
69
|
-
- **Outfits**: Failed-to-return outfits remain non-zero in the `previousOutfitIds` array. `_storeOutfitsWithRetained` appends them to the new outfit list, preserving their attachment record. After merging, the resolver verifies no two outfits share the same category (reverts with `DuplicateCategory` if a retained outfit conflicts with a newly supplied one).
|
|
70
|
-
|
|
71
|
-
This prevents NFT stranding — assets held by the resolver stay tracked and recoverable. Once the transfer issue is resolved (e.g., the owner contract implements `IERC721Receiver`), a subsequent `decorateBannyWith` call will successfully return the retained items.
|
|
62
|
+
### 7.1 Failed transfers retain attachment records
|
|
72
63
|
|
|
73
|
-
|
|
64
|
+
If returning a previously equipped item fails, the resolver keeps the attachment record instead of dropping it. This avoids stranding NFTs held by the resolver, but it can leave cosmetic phantom state for permanently unrecoverable assets.
|
|
74
65
|
|
|
75
|
-
### 7.2 Lock griefing
|
|
66
|
+
### 7.2 Lock griefing is bounded at 7 days
|
|
76
67
|
|
|
77
|
-
`lockOutfitChangesFor`
|
|
68
|
+
`lockOutfitChangesFor` can force a buyer to wait, but the window is fixed and cannot be extended arbitrarily beyond the current maximum.
|
|
78
69
|
|
|
79
|
-
### 7.3
|
|
70
|
+
### 7.3 Onchain SVG rendering gas is acceptable
|
|
80
71
|
|
|
81
|
-
`tokenUriOf`
|
|
72
|
+
Full `tokenUriOf` rendering is expensive but still within practical RPC limits for the supported outfit counts.
|
|
82
73
|
|
|
83
74
|
### 7.4 Outfits burn alongside the body
|
|
84
75
|
|
|
85
|
-
|
|
76
|
+
If a body NFT is burned while outfits are equipped, those outfits are intentionally unrecoverable. Users who want to keep them must unequip first.
|
|
86
77
|
|
|
87
|
-
### 7.5 Reentrancy in non-guarded functions is harmless
|
|
78
|
+
### 7.5 Reentrancy in non-guarded functions is treated as harmless under the current model
|
|
88
79
|
|
|
89
|
-
`lockOutfitChangesFor`
|
|
80
|
+
`lockOutfitChangesFor` only extends a timestamp, and view functions do not write storage. That keeps the remaining reentrancy surface narrow.
|
package/SKILLS.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Use This File For
|
|
4
4
|
|
|
5
5
|
- Use this file when the task involves Banny outfit attachment, layered SVG rendering, token URI composition, or asset custody and lock behavior.
|
|
6
|
-
- Start here, then
|
|
6
|
+
- Start here, then decide whether the issue is custody state, lock timing, stored SVG content, or final token-URI composition.
|
|
7
7
|
|
|
8
8
|
## Read This Next
|
|
9
9
|
|
|
@@ -11,9 +11,10 @@
|
|
|
11
11
|
|---|---|
|
|
12
12
|
| Repo overview and user-facing behavior | [`README.md`](./README.md), [`ARCHITECTURE.md`](./ARCHITECTURE.md) |
|
|
13
13
|
| Resolver implementation | [`src/Banny721TokenUriResolver.sol`](./src/Banny721TokenUriResolver.sol) |
|
|
14
|
+
| Runtime and content-management invariants | [`references/runtime.md`](./references/runtime.md), [`references/operations.md`](./references/operations.md) |
|
|
14
15
|
| Deployment or scripted drops | [`script/Deploy.s.sol`](./script/Deploy.s.sol), [`script/Drop1.s.sol`](./script/Drop1.s.sol), [`script/Add.Denver.s.sol`](./script/Add.Denver.s.sol) |
|
|
15
|
-
| Decoration lifecycle and
|
|
16
|
-
| Adversarial or QA coverage | [`test/BannyAttacks.t.sol`](./test/BannyAttacks.t.sol), [`test/
|
|
16
|
+
| Decoration lifecycle and custody invariants | [`test/DecorateFlow.t.sol`](./test/DecorateFlow.t.sol), [`test/OutfitTransferLifecycle.t.sol`](./test/OutfitTransferLifecycle.t.sol) |
|
|
17
|
+
| Adversarial, fork, or final QA coverage | [`test/BannyAttacks.t.sol`](./test/BannyAttacks.t.sol), [`test/Fork.t.sol`](./test/Fork.t.sol), [`test/TestAuditGaps.sol`](./test/TestAuditGaps.sol), [`test/TestQALastMile.t.sol`](./test/TestQALastMile.t.sol) |
|
|
17
18
|
|
|
18
19
|
## Repo Map
|
|
19
20
|
|
|
@@ -25,16 +26,17 @@
|
|
|
25
26
|
|
|
26
27
|
## Purpose
|
|
27
28
|
|
|
28
|
-
|
|
29
|
+
App-layer token URI resolver for Juicebox 721 collections. It lets Banny body NFTs equip outfit and background NFTs, holds them while equipped, and renders fully onchain layered SVG metadata.
|
|
29
30
|
|
|
30
31
|
## Reference Files
|
|
31
32
|
|
|
32
|
-
- Open [`references/runtime.md`](./references/runtime.md)
|
|
33
|
-
- Open [`references/operations.md`](./references/operations.md)
|
|
33
|
+
- Open [`references/runtime.md`](./references/runtime.md) for attachment and custody behavior, rendering order, and the main invariants that protect equipped assets.
|
|
34
|
+
- Open [`references/operations.md`](./references/operations.md) for upload and metadata-management behavior, deployment breadcrumbs, and common stale-data traps around SVG content.
|
|
34
35
|
|
|
35
36
|
## Working Rules
|
|
36
37
|
|
|
37
|
-
- Start in [`src/Banny721TokenUriResolver.sol`](./src/Banny721TokenUriResolver.sol) for both rendering and attachment behavior.
|
|
38
|
+
- Start in [`src/Banny721TokenUriResolver.sol`](./src/Banny721TokenUriResolver.sol) for both rendering and attachment behavior.
|
|
38
39
|
- Treat custody, stale attachment cleanup, and lock timing as high-risk. Rendering bugs are visible, but custody bugs are worse.
|
|
40
|
+
- Equipped outfits and backgrounds travel with the body NFT. Treat that inheritance as intentional before calling it a bug.
|
|
39
41
|
- When a task mentions minting, pricing, or terminal accounting, verify that the problem is not actually in the upstream 721 hook repo.
|
|
40
42
|
- If you touch SVG or metadata behavior, check whether the issue is in stored content, rendering composition, or the hook-to-resolver integration point before patching.
|
package/USER_JOURNEYS.md
CHANGED
|
@@ -1,80 +1,190 @@
|
|
|
1
1
|
# User Journeys
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Repo Purpose
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
This repo is the Banny-specific composition and metadata layer on top of a Juicebox 721 collection. It owns attachment custody, compatibility rules, outfit locks, and rendered token metadata. It does not own tier pricing, treasury accounting, or mint eligibility outside resolver-specific checks.
|
|
6
|
+
|
|
7
|
+
## Primary Actors
|
|
8
|
+
|
|
9
|
+
- collection operators publishing bodies, outfits, backgrounds, and metadata
|
|
10
|
+
- collectors equipping and unequipping avatar pieces
|
|
11
|
+
- auditors reviewing custody, lock, and rendering behavior
|
|
12
|
+
|
|
13
|
+
## Key Surfaces
|
|
14
|
+
|
|
15
|
+
- `Banny721TokenUriResolver`: custody, compatibility, locks, and rendered SVG metadata
|
|
16
|
+
- `decorateBannyWith(...)`: equips outfits and a background to a body and returns old items when possible
|
|
17
|
+
- `lockOutfitChangesFor(...)`: freezes appearance changes for the fixed lock window
|
|
18
|
+
- `setSvgHashesOf(...)` / `setSvgContentsOf(...)`: publish or repair art payloads
|
|
19
|
+
- `setMetadata(...)` / `setProductNames(...)`: update collection metadata and UPC naming
|
|
8
20
|
|
|
9
21
|
## Journey 1: Mint A Body, Outfit, And Background Set
|
|
10
22
|
|
|
11
|
-
**
|
|
23
|
+
**Actor:** collector.
|
|
24
|
+
|
|
25
|
+
**Intent:** acquire the pieces needed to build a composed Banny.
|
|
26
|
+
|
|
27
|
+
**Preconditions**
|
|
12
28
|
|
|
13
|
-
|
|
29
|
+
- the Banny collection is live through the 721 hook
|
|
30
|
+
- the required body, outfit, and background tiers exist
|
|
14
31
|
|
|
15
|
-
**Flow**
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
32
|
+
**Main Flow**
|
|
33
|
+
|
|
34
|
+
1. Mint the body, outfit, and background NFTs through the underlying 721 project.
|
|
35
|
+
2. Keep mint pricing and issuance assumptions anchored in the 721 hook, not this repo.
|
|
36
|
+
3. Move to this resolver only once the user owns compatible pieces.
|
|
37
|
+
|
|
38
|
+
**Failure Modes**
|
|
39
|
+
|
|
40
|
+
- the wrong tiers are minted or the pieces are incompatible
|
|
41
|
+
- teams misread this repo as the minting or accounting surface
|
|
42
|
+
|
|
43
|
+
**Postconditions**
|
|
44
|
+
|
|
45
|
+
- the user holds the components needed for later composition
|
|
19
46
|
|
|
20
47
|
## Journey 2: Dress A Banny And Put Accessories Into Resolver Custody
|
|
21
48
|
|
|
22
|
-
**
|
|
49
|
+
**Actor:** body owner.
|
|
50
|
+
|
|
51
|
+
**Intent:** equip a body with a background and outfits so the resolver serves the composed avatar.
|
|
23
52
|
|
|
24
|
-
**
|
|
53
|
+
**Preconditions**
|
|
54
|
+
|
|
55
|
+
- the caller controls the body and the accessories being equipped
|
|
56
|
+
- no active outfit lock blocks the change
|
|
57
|
+
- the selected pieces are compatible by category and collection rules
|
|
58
|
+
|
|
59
|
+
**Main Flow**
|
|
25
60
|
|
|
26
|
-
**Flow**
|
|
27
61
|
1. Call `decorateBannyWith(...)` for the target body.
|
|
28
|
-
2.
|
|
29
|
-
3.
|
|
62
|
+
2. The resolver checks compatibility and diffs old versus new attachments.
|
|
63
|
+
3. Equipped accessories move into resolver custody while attached.
|
|
64
|
+
4. The token URI for the body now reflects the combined SVG and metadata.
|
|
65
|
+
|
|
66
|
+
**Failure Modes**
|
|
67
|
+
|
|
68
|
+
- duplicate outfit categories or incompatible combinations are provided
|
|
69
|
+
- transfer-back of previously attached items fails, leaving retained custody state for later recovery
|
|
70
|
+
- reviewers forget that the resolver, not the wallet, holds equipped accessories while active
|
|
71
|
+
|
|
72
|
+
**Postconditions**
|
|
73
|
+
|
|
74
|
+
- the body renders with the new composition
|
|
75
|
+
- attached accessories stay in resolver custody until replaced or cleared
|
|
30
76
|
|
|
31
77
|
## Journey 3: Lock A Banny's Appearance For A Period
|
|
32
78
|
|
|
33
|
-
**
|
|
79
|
+
**Actor:** body owner.
|
|
80
|
+
|
|
81
|
+
**Intent:** freeze the current appearance for the fixed lock window.
|
|
82
|
+
|
|
83
|
+
**Preconditions**
|
|
84
|
+
|
|
85
|
+
- the body already has a state worth freezing
|
|
86
|
+
- the caller understands the lock is fixed-duration
|
|
87
|
+
|
|
88
|
+
**Main Flow**
|
|
89
|
+
|
|
90
|
+
1. Call `lockOutfitChangesFor(...)`.
|
|
91
|
+
2. The resolver extends the lock for that body.
|
|
92
|
+
3. Future decoration or removal attempts must wait until the lock expires.
|
|
93
|
+
|
|
94
|
+
**Failure Modes**
|
|
34
95
|
|
|
35
|
-
|
|
96
|
+
- a seller locks just before transfer and the buyer cannot restyle immediately
|
|
97
|
+
- integrations fail to show lock state before listing or sale
|
|
36
98
|
|
|
37
|
-
**
|
|
38
|
-
1. Call `lockOutfitChangesFor(...)` on the resolver.
|
|
39
|
-
2. The resolver records the lock period for that body.
|
|
40
|
-
3. Future decorate or removal actions respect the lock until it expires.
|
|
99
|
+
**Postconditions**
|
|
41
100
|
|
|
42
|
-
|
|
101
|
+
- appearance changes are blocked until the lock expires
|
|
43
102
|
|
|
44
|
-
|
|
103
|
+
## Journey 4: Publish Or Repair Onchain Art Assets
|
|
45
104
|
|
|
46
|
-
**
|
|
105
|
+
**Actor:** collection operator or art publisher.
|
|
47
106
|
|
|
48
|
-
**
|
|
49
|
-
1. Register the content hashes for bodies, outfits, or backgrounds with `setSvgHashesOf(...)`.
|
|
50
|
-
2. Upload or repair the corresponding SVG payloads with `setSvgContentsOf(...)`.
|
|
51
|
-
3. Re-resolve token URIs to confirm the on-chain composition now renders correctly.
|
|
107
|
+
**Intent:** make token URIs render complete onchain art.
|
|
52
108
|
|
|
53
|
-
**
|
|
109
|
+
**Preconditions**
|
|
110
|
+
|
|
111
|
+
- the relevant UPCs and content hashes are known
|
|
112
|
+
- the operator understands that the hash is the commitment and SVG content must match it exactly
|
|
113
|
+
|
|
114
|
+
**Main Flow**
|
|
115
|
+
|
|
116
|
+
1. Register hashes with `setSvgHashesOf(...)`.
|
|
117
|
+
2. Upload matching payloads with `setSvgContentsOf(...)`.
|
|
118
|
+
3. Re-check token URI output after publication or repair.
|
|
119
|
+
|
|
120
|
+
**Failure Modes**
|
|
121
|
+
|
|
122
|
+
- uploaded SVG does not match the committed hash
|
|
123
|
+
- product names are missing or stale
|
|
124
|
+
- teams assume the 721 hook owns rendered output when this repo does
|
|
125
|
+
|
|
126
|
+
**Postconditions**
|
|
127
|
+
|
|
128
|
+
- token URIs can render the intended onchain art payloads
|
|
54
129
|
|
|
55
130
|
## Journey 5: Update Collection Metadata And Product Catalog Entries
|
|
56
131
|
|
|
57
|
-
**
|
|
132
|
+
**Actor:** collection operator.
|
|
133
|
+
|
|
134
|
+
**Intent:** change collection-level metadata and human-readable product labels.
|
|
135
|
+
|
|
136
|
+
**Preconditions**
|
|
58
137
|
|
|
59
|
-
|
|
138
|
+
- the operator has authority over the resolver metadata surface
|
|
139
|
+
|
|
140
|
+
**Main Flow**
|
|
60
141
|
|
|
61
|
-
**Flow**
|
|
62
142
|
1. Update collection metadata with `setMetadata(...)`.
|
|
63
|
-
2. Set or repair
|
|
64
|
-
3. Re-check token URI
|
|
143
|
+
2. Set or repair UPC names with `setProductNames(...)`.
|
|
144
|
+
3. Re-check a representative token URI so labels and art agree.
|
|
145
|
+
|
|
146
|
+
**Failure Modes**
|
|
147
|
+
|
|
148
|
+
- metadata and SVG state drift apart
|
|
149
|
+
- operators update catalog labels without checking already-minted assets
|
|
150
|
+
|
|
151
|
+
**Postconditions**
|
|
152
|
+
|
|
153
|
+
- collection-level metadata and UPC names line up with the published art set
|
|
65
154
|
|
|
66
155
|
## Journey 6: Unequip And Recover Custodied Accessories
|
|
67
156
|
|
|
68
|
-
**
|
|
157
|
+
**Actor:** body owner.
|
|
158
|
+
|
|
159
|
+
**Intent:** recover attached accessories from resolver custody.
|
|
160
|
+
|
|
161
|
+
**Preconditions**
|
|
162
|
+
|
|
163
|
+
- the current lock window, if any, has expired
|
|
164
|
+
- the owner understands that old pieces may only be returned as part of a later decoration update
|
|
165
|
+
|
|
166
|
+
**Main Flow**
|
|
167
|
+
|
|
168
|
+
1. Replace or clear the equipped items through `decorateBannyWith(...)`.
|
|
169
|
+
2. The resolver attempts to return no-longer-equipped accessories.
|
|
170
|
+
3. Once returned, those NFTs can be transferred or reused independently.
|
|
171
|
+
|
|
172
|
+
**Failure Modes**
|
|
173
|
+
|
|
174
|
+
- previously equipped pieces remain retained because transfer-back failed
|
|
175
|
+
- burned or otherwise unrecoverable pieces leave cosmetic phantom state until corrected
|
|
176
|
+
|
|
177
|
+
**Postconditions**
|
|
178
|
+
|
|
179
|
+
- no-longer-equipped accessories are either returned or remain explicitly retained pending recovery
|
|
69
180
|
|
|
70
|
-
|
|
181
|
+
## Trust Boundaries
|
|
71
182
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
3. The owner can now transfer, burn, or re-equip those pieces elsewhere.
|
|
183
|
+
- this repo is trusted for custody of equipped accessories while attached
|
|
184
|
+
- the underlying 721 hook remains the source of mint pricing, tier issuance, and treasury behavior
|
|
185
|
+
- metadata correctness depends on operators publishing the intended SVG hashes and contents
|
|
76
186
|
|
|
77
187
|
## Hand-Offs
|
|
78
188
|
|
|
79
189
|
- Use [nana-721-hook-v6](../nana-721-hook-v6/USER_JOURNEYS.md) for mint pricing, tier issuance, reserves, and treasury behavior.
|
|
80
|
-
- Use this repo
|
|
190
|
+
- Use this repo once the question is about custody, compatibility, outfit locks, or SVG composition.
|
package/foundry.toml
CHANGED
package/package.json
CHANGED
|
@@ -1,37 +1,37 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
"version": "0.0.
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
2
|
+
"name": "@bannynet/core-v6",
|
|
3
|
+
"version": "0.0.24",
|
|
4
|
+
"license": "MIT",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "git+https://github.com/mejango/banny-retail-v6"
|
|
8
|
+
},
|
|
9
|
+
"engines": {
|
|
10
|
+
"node": ">=20.0.0"
|
|
11
|
+
},
|
|
12
|
+
"scripts": {
|
|
13
|
+
"test": "forge test",
|
|
14
|
+
"coverage": "forge coverage --match-path \"./src/*.sol\" --report lcov --report summary",
|
|
15
|
+
"generate:migration": "node ./script/outfit_drop/generate-migration.js",
|
|
16
|
+
"deploy:mainnets": "source ./.env && export START_TIME=$(date +%s) && npx sphinx propose ./script/Deploy.s.sol --networks mainnets",
|
|
17
|
+
"deploy:testnets": "source ./.env && export START_TIME=$(date +%s) && npx sphinx propose ./script/Deploy.s.sol --networks testnets",
|
|
18
|
+
"deploy:testnets:drop:1": "source ./.env && npx sphinx propose ./script/Drop1.s.sol --networks testnets",
|
|
19
|
+
"deploy:mainnets:drop:1": "source ./.env && npx sphinx propose ./script/Drop1.s.sol --networks mainnets",
|
|
20
|
+
"artifacts": "source ./.env && npx sphinx artifacts --org-id 'ea165b21-7cdc-4d7b-be59-ecdd4c26bee4' --project-name 'banny-core-v6'"
|
|
21
|
+
},
|
|
22
|
+
"dependencies": {
|
|
23
|
+
"@bananapus/721-hook-v6": "^0.0.38",
|
|
24
|
+
"@bananapus/core-v6": "^0.0.36",
|
|
25
|
+
"@bananapus/permission-ids-v6": "^0.0.19",
|
|
26
|
+
"@bananapus/router-terminal-v6": "^0.0.30",
|
|
27
|
+
"@bananapus/suckers-v6": "^0.0.28",
|
|
28
|
+
"@croptop/core-v6": "^0.0.36",
|
|
29
|
+
"@openzeppelin/contracts": "^5.6.1",
|
|
30
|
+
"@rev-net/core-v6": "^0.0.35",
|
|
31
|
+
"keccak": "^3.0.4"
|
|
32
|
+
},
|
|
33
|
+
"devDependencies": {
|
|
34
|
+
"@bananapus/address-registry-v6": "^0.0.17",
|
|
35
|
+
"@sphinx-labs/plugins": "^0.33.3"
|
|
36
|
+
}
|
|
37
37
|
}
|
package/references/operations.md
CHANGED
|
@@ -21,5 +21,5 @@
|
|
|
21
21
|
|
|
22
22
|
## Useful Proof Points
|
|
23
23
|
|
|
24
|
-
- [`test/
|
|
25
|
-
- [`script/
|
|
24
|
+
- [`test/BannyAttacks.t.sol`](../test/BannyAttacks.t.sol) and [`test/TestAuditGaps.sol`](../test/TestAuditGaps.sol) for security-sensitive assumptions.
|
|
25
|
+
- [`script/Drop1.s.sol`](../script/Drop1.s.sol) and [`script/Add.Denver.s.sol`](../script/Add.Denver.s.sol) when a deployment issue is really a script/config problem.
|
package/references/runtime.md
CHANGED
|
@@ -24,4 +24,4 @@
|
|
|
24
24
|
- [`test/DecorateFlow.t.sol`](../test/DecorateFlow.t.sol) for the main equip/unequip lifecycle.
|
|
25
25
|
- [`test/OutfitTransferLifecycle.t.sol`](../test/OutfitTransferLifecycle.t.sol) for custody and return behavior.
|
|
26
26
|
- [`test/BannyAttacks.t.sol`](../test/BannyAttacks.t.sol) for adversarial flows.
|
|
27
|
-
- [`test/
|
|
27
|
+
- [`test/Fork.t.sol`](../test/Fork.t.sol), [`test/TestAuditGaps.sol`](../test/TestAuditGaps.sol), and [`test/TestQALastMile.t.sol`](../test/TestQALastMile.t.sol) for integration and pinned edge cases.
|
|
@@ -109,15 +109,10 @@ contract Banny721TokenUriResolver is
|
|
|
109
109
|
/// @custom:param upc The universal product code that the SVG hash represent.
|
|
110
110
|
mapping(uint256 upc => bytes32) public override svgHashOf;
|
|
111
111
|
|
|
112
|
-
// forge-lint: disable-next-line(mixed-case-variable)
|
|
113
112
|
string public override DEFAULT_ALIEN_EYES;
|
|
114
|
-
// forge-lint: disable-next-line(mixed-case-variable)
|
|
115
113
|
string public override DEFAULT_MOUTH;
|
|
116
|
-
// forge-lint: disable-next-line(mixed-case-variable)
|
|
117
114
|
string public override DEFAULT_NECKLACE;
|
|
118
|
-
// forge-lint: disable-next-line(mixed-case-variable)
|
|
119
115
|
string public override DEFAULT_STANDARD_EYES;
|
|
120
|
-
// forge-lint: disable-next-line(mixed-case-variable)
|
|
121
116
|
string public override BANNY_BODY;
|
|
122
117
|
|
|
123
118
|
//*********************************************************************//
|