@artblocks/abx-cli 0.1.0-alpha.4 → 0.1.0-alpha.41

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 (189) hide show
  1. package/CHANGELOG.md +161 -0
  2. package/assets/renderer-scaffold/README.md +41 -11
  3. package/assets/renderer-scaffold/foundry.toml +5 -0
  4. package/assets/renderer-scaffold/remappings.txt +1 -1
  5. package/assets/renderer-scaffold/script/DeployHooks.s.sol +24 -0
  6. package/assets/renderer-scaffold/script/Preview.s.sol +99 -0
  7. package/assets/renderer-scaffold/src/MyHooks.sol +20 -0
  8. package/assets/renderer-scaffold/src/MyRenderer.sol +4 -4
  9. package/assets/renderer-scaffold/src/MyTraits.sol +2 -2
  10. package/assets/renderer-scaffold/test/MyRenderer.t.sol +60 -3
  11. package/dist/bin.d.ts +26 -0
  12. package/dist/bin.d.ts.map +1 -0
  13. package/dist/bin.js +63 -0
  14. package/dist/bin.js.map +1 -0
  15. package/dist/capabilities.d.ts +99 -0
  16. package/dist/capabilities.d.ts.map +1 -0
  17. package/dist/capabilities.js +144 -0
  18. package/dist/capabilities.js.map +1 -0
  19. package/dist/commands/auth.d.ts +54 -0
  20. package/dist/commands/auth.d.ts.map +1 -0
  21. package/dist/commands/auth.js +447 -0
  22. package/dist/commands/auth.js.map +1 -0
  23. package/dist/commands/deploy.d.ts +242 -0
  24. package/dist/commands/deploy.d.ts.map +1 -0
  25. package/dist/commands/deploy.js +5429 -0
  26. package/dist/commands/deploy.js.map +1 -0
  27. package/dist/commands/feedback.d.ts +7 -0
  28. package/dist/commands/feedback.d.ts.map +1 -0
  29. package/dist/commands/feedback.js +147 -0
  30. package/dist/commands/feedback.js.map +1 -0
  31. package/dist/commands/maintenance.d.ts +4 -0
  32. package/dist/commands/maintenance.d.ts.map +1 -0
  33. package/dist/commands/maintenance.js +114 -0
  34. package/dist/commands/maintenance.js.map +1 -0
  35. package/dist/commands/project.d.ts +429 -0
  36. package/dist/commands/project.d.ts.map +1 -0
  37. package/dist/commands/project.js +1720 -0
  38. package/dist/commands/project.js.map +1 -0
  39. package/dist/commands/reads.d.ts +85 -0
  40. package/dist/commands/reads.d.ts.map +1 -0
  41. package/dist/commands/reads.js +868 -0
  42. package/dist/commands/reads.js.map +1 -0
  43. package/dist/commands/scaffold.d.ts +89 -0
  44. package/dist/commands/scaffold.d.ts.map +1 -0
  45. package/dist/commands/scaffold.js +738 -0
  46. package/dist/commands/scaffold.js.map +1 -0
  47. package/dist/commands/service.d.ts +67 -0
  48. package/dist/commands/service.d.ts.map +1 -0
  49. package/dist/commands/service.js +748 -0
  50. package/dist/commands/service.js.map +1 -0
  51. package/dist/commands/storage.d.ts +51 -0
  52. package/dist/commands/storage.d.ts.map +1 -0
  53. package/dist/commands/storage.js +399 -0
  54. package/dist/commands/storage.js.map +1 -0
  55. package/dist/commands/submit-app.d.ts +102 -0
  56. package/dist/commands/submit-app.d.ts.map +1 -0
  57. package/dist/commands/submit-app.js +622 -0
  58. package/dist/commands/submit-app.js.map +1 -0
  59. package/dist/config.d.ts +105 -2
  60. package/dist/config.d.ts.map +1 -1
  61. package/dist/config.js +351 -12
  62. package/dist/config.js.map +1 -1
  63. package/dist/conformance.d.ts +31 -0
  64. package/dist/conformance.d.ts.map +1 -0
  65. package/dist/conformance.js +390 -0
  66. package/dist/conformance.js.map +1 -0
  67. package/dist/contract-read-error.d.ts +5 -0
  68. package/dist/contract-read-error.d.ts.map +1 -0
  69. package/dist/contract-read-error.js +37 -0
  70. package/dist/contract-read-error.js.map +1 -0
  71. package/dist/deploy-plan.d.ts +150 -0
  72. package/dist/deploy-plan.d.ts.map +1 -0
  73. package/dist/deploy-plan.js +31 -0
  74. package/dist/deploy-plan.js.map +1 -0
  75. package/dist/deps.d.ts +6 -39
  76. package/dist/deps.d.ts.map +1 -1
  77. package/dist/deps.js +4 -68
  78. package/dist/deps.js.map +1 -1
  79. package/dist/errors.d.ts +20 -0
  80. package/dist/errors.d.ts.map +1 -0
  81. package/dist/errors.js +25 -0
  82. package/dist/errors.js.map +1 -0
  83. package/dist/flag-allowlists.d.ts +53 -0
  84. package/dist/flag-allowlists.d.ts.map +1 -0
  85. package/dist/flag-allowlists.js +184 -0
  86. package/dist/flag-allowlists.js.map +1 -0
  87. package/dist/flags.d.ts +47 -0
  88. package/dist/flags.d.ts.map +1 -1
  89. package/dist/flags.js +125 -1
  90. package/dist/flags.js.map +1 -1
  91. package/dist/jsonout.d.ts +37 -0
  92. package/dist/jsonout.d.ts.map +1 -0
  93. package/dist/jsonout.js +79 -0
  94. package/dist/jsonout.js.map +1 -0
  95. package/dist/kind.d.ts +57 -0
  96. package/dist/kind.d.ts.map +1 -0
  97. package/dist/kind.js +122 -0
  98. package/dist/kind.js.map +1 -0
  99. package/dist/main.js +786 -4838
  100. package/dist/main.js.map +1 -1
  101. package/dist/mintpage.d.ts +17 -2
  102. package/dist/mintpage.d.ts.map +1 -1
  103. package/dist/mintpage.js +241 -54
  104. package/dist/mintpage.js.map +1 -1
  105. package/dist/output.d.ts +179 -0
  106. package/dist/output.d.ts.map +1 -0
  107. package/dist/output.js +780 -0
  108. package/dist/output.js.map +1 -0
  109. package/dist/ownerops.d.ts +381 -57
  110. package/dist/ownerops.d.ts.map +1 -1
  111. package/dist/ownerops.js +2014 -359
  112. package/dist/ownerops.js.map +1 -1
  113. package/dist/preview.d.ts +23 -5
  114. package/dist/preview.d.ts.map +1 -1
  115. package/dist/preview.js +95 -43
  116. package/dist/preview.js.map +1 -1
  117. package/dist/prompt.d.ts +17 -0
  118. package/dist/prompt.d.ts.map +1 -0
  119. package/dist/prompt.js +19 -0
  120. package/dist/prompt.js.map +1 -0
  121. package/dist/provision.d.ts +3 -13
  122. package/dist/provision.d.ts.map +1 -1
  123. package/dist/provision.js +19 -21
  124. package/dist/provision.js.map +1 -1
  125. package/dist/remote.d.ts +157 -52
  126. package/dist/remote.d.ts.map +1 -1
  127. package/dist/remote.js +435 -46
  128. package/dist/remote.js.map +1 -1
  129. package/dist/riskgate.d.ts +62 -0
  130. package/dist/riskgate.d.ts.map +1 -0
  131. package/dist/riskgate.js +234 -0
  132. package/dist/riskgate.js.map +1 -0
  133. package/dist/scaffold.d.ts +12 -0
  134. package/dist/scaffold.d.ts.map +1 -0
  135. package/dist/scaffold.js +56 -0
  136. package/dist/scaffold.js.map +1 -0
  137. package/dist/schema.d.ts +36 -1
  138. package/dist/schema.d.ts.map +1 -1
  139. package/dist/schema.js +121 -26
  140. package/dist/schema.js.map +1 -1
  141. package/dist/script-chunks.d.ts +8 -0
  142. package/dist/script-chunks.d.ts.map +1 -0
  143. package/dist/script-chunks.js +35 -0
  144. package/dist/script-chunks.js.map +1 -0
  145. package/dist/served.d.ts +30 -0
  146. package/dist/served.d.ts.map +1 -0
  147. package/dist/served.js +112 -0
  148. package/dist/served.js.map +1 -0
  149. package/dist/signer.d.ts +13 -0
  150. package/dist/signer.d.ts.map +1 -1
  151. package/dist/signer.js +84 -15
  152. package/dist/signer.js.map +1 -1
  153. package/dist/update-check.d.ts +86 -5
  154. package/dist/update-check.d.ts.map +1 -1
  155. package/dist/update-check.js +161 -20
  156. package/dist/update-check.js.map +1 -1
  157. package/package.json +13 -12
  158. package/skill/SKILL.md +181 -347
  159. package/skill/agents/openai.yaml +4 -0
  160. package/skill/reference/capabilities.md +188 -0
  161. package/skill/reference/code.md +220 -0
  162. package/skill/reference/creator-token.md +94 -0
  163. package/skill/reference/deploy.md +174 -0
  164. package/skill/reference/diagnose.md +178 -0
  165. package/skill/reference/hosting.md +186 -93
  166. package/skill/reference/operate.md +220 -0
  167. package/skill/reference/services.md +121 -0
  168. package/skill/reference/setup.md +154 -36
  169. package/assets/renderer-scaffold/src/interfaces/IAbxFieldRenderer.sol +0 -32
  170. package/assets/renderer-scaffold/src/interfaces/IAbxParams.sol +0 -26
  171. package/dist/inspect.d.ts +0 -48
  172. package/dist/inspect.d.ts.map +0 -1
  173. package/dist/inspect.js +0 -184
  174. package/dist/inspect.js.map +0 -1
  175. package/dist/migrate.d.ts +0 -65
  176. package/dist/migrate.d.ts.map +0 -1
  177. package/dist/migrate.js +0 -180
  178. package/dist/migrate.js.map +0 -1
  179. package/dist/onchain-uri.d.ts +0 -97
  180. package/dist/onchain-uri.d.ts.map +0 -1
  181. package/dist/onchain-uri.js +0 -243
  182. package/dist/onchain-uri.js.map +0 -1
  183. package/dist/upload.d.ts +0 -28
  184. package/dist/upload.d.ts.map +0 -1
  185. package/dist/upload.js +0 -41
  186. package/dist/upload.js.map +0 -1
  187. package/skill/reference/code-projects.md +0 -246
  188. package/skill/reference/operating.md +0 -116
  189. package/skill/reference/troubleshooting.md +0 -28
@@ -0,0 +1,4 @@
1
+ interface:
2
+ display_name: "ABX"
3
+ short_description: "Launch, host, and operate ABX NFT projects"
4
+ default_prompt: "Use $abx to plan and safely execute this ABX project workflow."
@@ -0,0 +1,188 @@
1
+ # Capability questions and extension seams
2
+
3
+ Use this reference before answering whether ABX can support an unusual mechanic. The goal is neither
4
+ automatic optimism nor reflexive refusal; it is a proven route with explicit cost and limits.
5
+
6
+ ## Contents
7
+
8
+ - [Use the four-way classification](#use-the-four-way-classification)
9
+ - [Inspect the machine-readable contract](#inspect-the-machine-readable-contract)
10
+ - [Use canonical extension seams](#use-canonical-extension-seams)
11
+ - [Map mechanics to seams](#map-mechanics-to-seams)
12
+ - [Respect deploy-time prerequisites](#respect-deploy-time-prerequisites)
13
+ - [Know the supported boundary](#know-the-supported-boundary)
14
+
15
+ ## Use the four-way classification
16
+
17
+ Classify the request as one of:
18
+
19
+ 1. **Native** — a current CLI command/flag combination performs it directly.
20
+ 2. **Extension** — a custom minter, hook, field renderer, seed source, or transfer validator performs
21
+ it while the token remains a canonical factory clone.
22
+ 3. **Unsupported/foreclosed** — the capability contract lists it as unsupported, or the existing
23
+ contract's immutable type/options exclude the prerequisite.
24
+ 4. **Unknown** — no supported route has been demonstrated. Inspect help, implementation/contracts,
25
+ and state; report uncertainty if it remains unproven.
26
+
27
+ Never infer “unsupported” from the absence of a flag. Never infer “possible” merely because an item is
28
+ absent from a short no-list. A capability claim needs a native lane or an exact extension seam.
29
+
30
+ Give the creator the route, engineering required, authority model, gas/hosting/reach tradeoff,
31
+ irreversible prerequisites, and verification plan. “Possible” without those qualifiers is not useful.
32
+
33
+ ## Inspect the machine-readable contract
34
+
35
+ Run:
36
+
37
+ ```bash
38
+ abx capabilities --json
39
+ abx help <relevant-command>
40
+ ```
41
+
42
+ The capability contract reports native deployment lanes, EditionCode/static edition differences,
43
+ extension seams, deploy-time choices, and currently unsupported product boundaries. For an existing
44
+ collection, also run `abx state`; capability depends on the contract already deployed, not only on
45
+ what the newest CLI could deploy today.
46
+
47
+ Use a deploy command's `--dry-run --json` for a concrete plan. It is the source of truth for the
48
+ active chain, artifacts, signer, storage, addresses, transaction count, and measured warnings.
49
+
50
+ ## Use canonical extension seams
51
+
52
+ A custom mechanic normally lives beside a canonical token rather than replacing it.
53
+
54
+ | Seam | Wired with | Runs | Can veto? |
55
+ |---|---|---|---|
56
+ | Custom minter | `abx set-minter --minter 0x…` | before/calling issuance | it controls whether it calls mint |
57
+ | Configure hook | `abx set-param-hooks --configure 0x…` | before a governed parameter write persists | yes |
58
+ | Transfer hook | `abx set-param-hooks --transfer 0x…` | on mint, transfer, and burn | yes |
59
+ | Augment hook | `abx set-param-hooks --augment 0x…` | while token data is assembled | no; computes/adds/overrides data |
60
+ | Image/traits renderer | deploy-code renderer flags | while on-chain metadata fields render | a revert can break that read; design never-revert |
61
+ | Seed source | `abx set-seed-source` | future code-token mints | supplies mint-time seed input |
62
+ | Transfer validator | `--721c` then `set-transfer-validator` | standards-track transfer validation | yes, according to validator |
63
+
64
+ One external contract may implement several hook/minter roles. Test it against a real deployed clone,
65
+ not a mock that approximates ABX callbacks.
66
+
67
+ ABX scaffolds a Foundry renderer project but does not compile or deploy custom Solidity. The creator
68
+ or their contract engineer owns code review, deployment, verification, upgrade policy, and audits.
69
+
70
+ ### Custom minter
71
+
72
+ Series and editions can authorize one minter contract. Use it for pricing/allocation rules that do not
73
+ fit the shared fixed-price minter: auctions, allowlists, raffles, free claims, ERC-20 payment, escrowed
74
+ issuance, or other pre-mint logic. The minter eventually calls the token's canonical mint entry point.
75
+
76
+ A plain 1/1 has no Series minter seam. Decide whether the requested issuance model actually requires
77
+ a Series/edition before deploying.
78
+
79
+ ### Configure hook
80
+
81
+ The configure hook receives the proposed typed parameter write before it persists. Its revert rejects
82
+ the write. It can enforce monotonicity, one-time writes, cross-contract authorization, payload shape,
83
+ or size bounds. For blob-backed strings/bytes, validate length before reading large data and read the
84
+ provided data pointer using the documented SSTORE2 convention.
85
+
86
+ The previously stored value remains visible during validation, enabling comparisons. A rejected
87
+ write may still have paid for preparatory blob storage; front ends should simulate before asking for a
88
+ signature.
89
+
90
+ ### Transfer hook
91
+
92
+ The transfer hook runs for mints (`from == 0`), ordinary transfers, and burns (`to == 0`). Reverting
93
+ vetoes the entire operation. It can implement vesting, soulbinding, redemption, escrow settlement,
94
+ provenance counters, and lifecycle rules.
95
+
96
+ It cannot initiate a transfer; it only observes or rejects one. Burn-based mechanics require the
97
+ collection to have been deployed burnable. On editions, ids may have many holders, so shared per-id
98
+ state cannot model a single current owner.
99
+
100
+ ### Augment hook
101
+
102
+ The augment hook is a read-time view seam. It may read other contracts, an oracle, block state, or
103
+ stored params and return final token-data strings. Use it for live/derived state or computed data that
104
+ should not be stored.
105
+
106
+ Volatile augmentation makes the live view change without an event or stored write. A marketplace still
107
+ remains a snapshot until it is rendered again. If a custom Solidity field renderer needs augmented
108
+ state, it must read/call the relevant hook/state itself; field-renderer calls do not receive a prepared
109
+ token-data object.
110
+
111
+ ## Map mechanics to seams
112
+
113
+ | Request | Primary route | Prerequisites/limits |
114
+ |---|---|---|
115
+ | Auction, allowlist, raffle, free claim | custom minter | Series or edition mint authority |
116
+ | ERC-20 priced mint | custom minter | payment logic/audit outside ABX |
117
+ | Soulbound or timed transfer lock | transfer hook | deploy-code; hook also sees mint |
118
+ | Burn-to-redeem/combine | external controller/minter + burnable; optional transfer/augment hooks | ABX provides seams, not the atomic combine implementation |
119
+ | Escrow tied to token lifecycle | minter + transfer hook | external value-holding contract |
120
+ | Monotonic level/high-water mark | governed param + configure hook | schema and old-value comparison |
121
+ | Structured collector configuration | governed param + configure hook | typed payload and bounded size |
122
+ | Holder of another token may configure | schema address auth or configure hook | cross-contract read |
123
+ | Art reacts to oracle/block/other contract | augment hook or renderer direct read | disclose live/non-deterministic behavior |
124
+ | Timed reveal | augment hook or renderer logic | live view versus still refresh distinction |
125
+ | On-chain SVG and coherent traits | image + attributes renderers | never-revert Solidity implementations |
126
+ | Large raster stored on-chain | `--onchain-image` | measured write cost and endpoint-dependent read reach |
127
+ | One program, each token carries its own data | `deploy-code --script` + `<key>:Bytes:Creator` | mint, then set the creator payload with `configure-param --file`; no on-chain size budget on the param itself |
128
+ | Royalty-aware transfer validation | ERC-721C/ERC-1155C validator | opt-in at deploy; marketplace compatibility varies |
129
+
130
+ When several routes work, prefer the smallest authority surface. Use the stock fixed-price minter
131
+ instead of custom Solidity for an ordinary sale; use a schema without a hook when static authorization
132
+ is sufficient; use an on-chain renderer only when its durability/reach/cost trade is desired.
133
+
134
+ A transfer hook only observes or vetoes a burn; it does not initiate two burns or mint a replacement.
135
+ For combine mechanics, prove the controller's burn authorization and canonical mint call against a
136
+ real clone, make the transition atomic and replay-safe, and define pair/history storage. On ERC-721,
137
+ `--max` is a lifetime id cap and burns do not reopen slots, so reserve replacement-id headroom or use
138
+ a supply policy that does not require new ids. On a burnable edition, a burn frees live per-id supply,
139
+ but every copy of an id shares its id-level seed and PostParams.
140
+
141
+ ## Respect deploy-time prerequisites
142
+
143
+ Ask about mechanics before deployment. These decisions cannot be retrofitted:
144
+
145
+ - static versus code-capable contract type; hooks/PostParams require SeriesCode or EditionCode;
146
+ - ERC-721 versus ERC-1155 edition shape through `--copies`;
147
+ - burnability;
148
+ - ERC-721C/ERC-1155C enrollment.
149
+
150
+ Other choices may be mutable but become irreversible when locked: URI configuration, fields, script,
151
+ dependencies, hooks, governed values/schema, royalty ceiling, and owner authority. An existing project
152
+ may therefore be capable in protocol terms but foreclosed by its current type or locks. Say that
153
+ specifically instead of saying ABX as a whole cannot do it.
154
+
155
+ Use `abx predict` to break address cycles where an external controller needs the token address at its
156
+ own construction and the token must reference the controller during deployment. Confirm the guarded
157
+ salt/deployer and predicted address before deploying either side.
158
+
159
+ ## Know the supported boundary
160
+
161
+ The toolkit currently does not provide:
162
+
163
+ - mainnet deployment or unsupported-chain recipes;
164
+ - a secondary-market listing/order-book feature;
165
+ - Solidity compilation/deployment through `abx`;
166
+ - CLI replacement of a deployed code project's script;
167
+ - retrofitting a deploy-time contract type, burnability, token standard, or creator-token enrollment.
168
+
169
+ Do not recommend another protocol automatically when one of these applies. State the boundary and
170
+ stop unless the creator asks for alternatives.
171
+
172
+ Also distinguish unsupported tooling from possible external engineering. For example, ABX does not
173
+ compile a custom hook, but a hook is an intentional supported seam once independently built and
174
+ deployed. Conversely, “arbitrary Solidity exists” is not proof that every behavior is safe or
175
+ compatible: analyze callback timing, authority, reverts, reentrancy, shared edition state, gas, and
176
+ upgradeability.
177
+
178
+ Before finalizing a custom mechanic, document:
179
+
180
+ 1. canonical token family and deploy-time prerequisites;
181
+ 2. external contracts and their roles/owners/upgrade paths;
182
+ 3. callback inputs, state transitions, and every veto path;
183
+ 4. mint/transfer/burn behavior including editions;
184
+ 5. parameter schema and authorization;
185
+ 6. live versus settled/rendered state;
186
+ 7. locks and the exact guarantee they create;
187
+ 8. unit, fork, and end-to-end test plan;
188
+ 9. collector-facing disclosure of remaining powers.
@@ -0,0 +1,220 @@
1
+ # Code projects, renderers, and PostParams
2
+
3
+ Use this reference for `preview`, `inspect`, `deploy-code`, JavaScript/build projects, Solidity field
4
+ renderers, marketplace stills and traits, seeds, dependencies, parameters, and code-project locks.
5
+
6
+ ## Contents
7
+
8
+ - [Choose the runtime lane](#choose-the-runtime-lane)
9
+ - [Design every public surface](#design-every-public-surface)
10
+ - [Preview and inspect honestly](#preview-and-inspect-honestly)
11
+ - [Plan JavaScript projects](#plan-javascript-projects)
12
+ - [Plan Solidity field renderers](#plan-solidity-field-renderers)
13
+ - [Use PostParams and hooks](#use-postparams-and-hooks)
14
+ - [Handle seeds and dependencies](#handle-seeds-and-dependencies)
15
+ - [Verify and freeze](#verify-and-freeze)
16
+
17
+ ## Choose the runtime lane
18
+
19
+ `deploy-code` selects a code-capable canonical contract. It supports four useful input shapes:
20
+
21
+ | Shape | Core flags | Typical surfaces |
22
+ |---|---|---|
23
+ | On-chain JavaScript template | `--script <file>` | on-chain program; hosted or on-chain assembled live document |
24
+ | Shared program + per-token payload | `--script` + `--schema <key>:Bytes:Creator` | one chunked engine; after mint, set each token's `Bytes` PostParam with `configure-param --file` |
25
+ | Build directory | `--code-dir <dir>` | uploaded application bundle; resolver/live view |
26
+ | Solidity-computed fields | `--image-renderer` and/or `--attributes-renderer` | on-chain SVG image and/or traits |
27
+ | Hybrid | script plus field renderers | program animation plus Solidity image/traits |
28
+
29
+ Without `--copies`, the contract is SeriesCode (ERC-721). With `--copies <n|open>`, it is EditionCode
30
+ (ERC-1155): N generated ids, each with multiple copies. EditionCode currently supports scripts,
31
+ directory builds (`--code-dir`), dependencies, field renderers, deterministic per-id off-chain stills
32
+ (`--image-base`), and `--resume` for an incomplete deployment (see
33
+ [diagnose.md](diagnose.md#incomplete-deployments) — the mint leg diffs per id, with a new
34
+ `--mint-amount` naming each premint id's intended copy count). Run `abx capabilities --json`
35
+ immediately before planning.
36
+
37
+ For one generated work with 100 copies, use `--max 1 --copies 100`. Omitting `--max 1` leaves the
38
+ default multi-id space, producing multiple generated ids with 100 copies available for each id.
39
+
40
+ A creator who needs parameters or hooks must use a code-capable contract even if the output is a
41
+ static-looking SVG or image. This is a deploy-time type decision.
42
+
43
+ ## Design every public surface
44
+
45
+ A code project is not one URL. Decide each surface separately:
46
+
47
+ - **Program/animation** — the live JavaScript document or absence of one.
48
+ - **Marketplace image** — a rendered still, a deterministic image URL, an on-chain Solidity SVG, or
49
+ an explicit placeholder during development.
50
+ - **Marketplace traits** — renderer-computed JSON, resolver/effects output, or intentionally omitted.
51
+ - **PostParams** — canonical typed state on the token contract, consumed by the program/renderers.
52
+ - **Attachments** — named files served through a resolver's artifacts/data surface.
53
+
54
+ “The program is on-chain” does not prove that image and traits are on-chain. “The animation works”
55
+ does not prove a marketplace thumbnail exists. Write a surface matrix before deployment and verify
56
+ each row after minting.
57
+
58
+ ## Preview and inspect honestly
59
+
60
+ Use `abx preview` while authoring and `abx inspect` before choosing a deployment lane.
61
+
62
+ Preview uses the canonical runtime envelope, dependency order, and token-data shape with synthetic
63
+ inputs. It is a high-fidelity authoring preview, not an end-to-end deployment proof. It does not prove:
64
+
65
+ - that a chosen dependency resolves on the target chain;
66
+ - that the deployed generator or renderer fits an RPC's read allowance;
67
+ - that real minted seeds and PostParams are consumed correctly in every state;
68
+ - that marketplace metadata contains image and attributes;
69
+ - that a hosted resolver/effects/storage path is reachable.
70
+
71
+ Use `--shoot` for representative frames. Exercise more than the default seed and every user-facing
72
+ parameter. Then run `abx inspect` to analyze dependencies, deterministic seed usage, declared traits,
73
+ document size, and lane fit. Treat findings as evidence and the deploy dry run/testnet verification as
74
+ the final proof.
75
+
76
+ Avoid unseeded randomness, wall-clock dependence, environment-only assets, and network fetches when
77
+ claiming reproducibility. A live-data design is valid; label it live rather than deterministic.
78
+
79
+ ## Plan JavaScript projects
80
+
81
+ ### On-chain program, hosted resolution
82
+
83
+ Use `--script` with `--public-base-url` when a resolver should assemble the live document and expose
84
+ mutable metadata/render surfaces. The script remains on-chain; the public metadata path is HTTP.
85
+ This is normally the most interoperable lane for a sale where thumbnails must update continuously.
86
+
87
+ Run an effects service for derived stills and traits:
88
+
89
+ - `abx effects` runs locally and blocks; use it for development or a co-located operator.
90
+ - `abx deploy-effects --resolver-url <url>` scaffolds a continuously running service.
91
+ - `abx render <addr> [ids] --remote <resolver>` performs a one-shot/backfill render.
92
+
93
+ The renderer must store its bytes in a backend the resolver can retrieve. A hosted resolver cannot
94
+ read a laptop-local `fs` store. Managed providers may advertise managed rendering; confirm with
95
+ `abx remote <name>` rather than assuming it.
96
+
97
+ ### On-chain program and on-chain live document
98
+
99
+ Use `--script --onchain-uri` when the generator can assemble the animation document entirely from
100
+ on-chain program/dependency bytes. This can remove an always-on resolver for the live program.
101
+
102
+ Check the deploy dependency report and `abx verify` before calling it chain-complete: a registry
103
+ dependency may resolve through a CDN instead of on-chain bytes. Large assembled documents may exceed
104
+ some endpoints' `eth_call` allowance; report the measured reach, not “any RPC forever.”
105
+
106
+ For a JavaScript lane, the marketplace image remains a separate decision. With no resolver watcher,
107
+ a still published to a deterministic public `--image-base` is a manual/backfill surface: rerun render
108
+ after relevant parameter changes. An on-chain animation plus automatically updating off-chain still
109
+ requires an operator watching state.
110
+
111
+ EditionCode now accepts `--image-base` too: the same `{base}/{id}.png` url-template, one id space
112
+ finer — `{id}` is the EditionCode id, and every copy of that id shares the one image (there is no
113
+ per-copy addressing). The effect runner never renders an id with zero live copies (no mint-time seed
114
+ has been drawn yet for it), so an unminted premint id is skipped, not errored — it renders once the
115
+ first copy mints. `--image-base` stays mutually exclusive with `--image-renderer` on both lanes.
116
+
117
+ ### Build directory
118
+
119
+ Use `--code-dir` for an application bundle whose files are uploaded and addressed as a code artifact.
120
+ It requires external storage and public resolution — a backend without directory upload (`fs`, the
121
+ local default) is refused; pick `--backend ipfs` or `--backend arweave`. Inspect the built output, not
122
+ only the source tree, and verify that every referenced asset is included. The live view 302s through
123
+ the gateway, so the gateway must serve HTML (the shared Pinata public gateway does not — use a
124
+ dedicated gateway or Arweave). `--code-dir` works with `--copies` too (EditionCode): the same upload,
125
+ the same on-chain `code` field, the same gateway rules — `--script` and `--code-dir` remain mutually
126
+ exclusive on both lanes.
127
+
128
+ ## Plan Solidity field renderers
129
+
130
+ `--image-renderer <address>` stores an `IAbxFieldRenderer` pointer for the metadata image field;
131
+ `--attributes-renderer <address>` does the same for traits. With `--onchain-uri`, the canonical
132
+ metadata renderer calls them on-chain. A renderer-only project needs no JavaScript program and no
133
+ effects runner.
134
+
135
+ Start with `abx scaffold-renderer`, then build, test, and deploy the Solidity project using Foundry.
136
+ ABX does not compile or deploy custom Solidity. A real deploy refuses a renderer address with no
137
+ code.
138
+
139
+ Enforce these invariants in renderer tests:
140
+
141
+ - `render(token, tokenId, field)` must not revert for unminted ids, missing params, boundary values,
142
+ unexpected callers, or retired schema state.
143
+ - Return the correct media type and valid complete content: SVG for image, JSON attributes array for
144
+ traits.
145
+ - Derive image and traits from the same seed/state model.
146
+ - Bound loops and output. Test realistic worst cases through an RPC call, not only local unit gas.
147
+ - Treat a renderer or hook address lock as a pointer lock. Use immutable deployments for stronger
148
+ permanence claims; an upgradeable proxy can change behavior behind a locked address.
149
+
150
+ Solidity image/attributes renderers work on both SeriesCode and EditionCode, including renderer-only
151
+ editions. They eliminate off-chain stills only for the fields they compute; a separate JavaScript
152
+ animation may still exist.
153
+
154
+ ## Use PostParams and hooks
155
+
156
+ PostParams are typed, schema-governed state stored on-chain. Use `--schema` at deployment or
157
+ `abx set-schema` later, then `abx configure-param` through the governed path. Inspect current type,
158
+ authorization, and lock grammar with command help instead of memorizing it.
159
+
160
+ Model parameters deliberately:
161
+
162
+ - Define a stable key and type; do not change a key's meaning across versions.
163
+ - Choose creator, token-owner/holder, or address authorization to match the actual state model.
164
+ - Validate input in the UI and again in a configure hook when the rule must be enforced on-chain.
165
+ - Treat string/bytes values as potentially large and price/limit them appropriately.
166
+ - Retire or weld a governed parameter only after the current value and defaults are verified.
167
+
168
+ ### Edition shared state
169
+
170
+ On EditionCode, parameters belong to an **id**, not an individual physical copy. If token id 3 has
171
+ 100 holders, they all read the same value for id 3. With holder authorization any holder may write it;
172
+ the last valid writer wins. This is good for communal state and wrong for “name my personal copy.”
173
+ Use one id per personalized work when per-holder state is required.
174
+
175
+ A holder-writable large string/bytes parameter can also expand the shared id's metadata beyond common
176
+ RPC read reach. State this before deployment and use schema validation/hooks to bound it when needed.
177
+
178
+ ### Hooks
179
+
180
+ SeriesCode and EditionCode expose three configurable hook addresses:
181
+
182
+ - configure hook: validates/vetoes governed writes before they persist;
183
+ - transfer hook: observes every mint, transfer, and burn and may veto the operation;
184
+ - augment hook: computes additional/overriding token data during reads.
185
+
186
+ Hooks are extension seams, not ordinary CLI flags. Build and deploy them outside ABX, wire them with
187
+ `abx set-param-hooks`, test against a real clone, and read [capabilities.md](capabilities.md). A
188
+ transfer-hook revert fails mints as well as secondary transfers. Freeze the addresses with
189
+ `abx lock-param-hooks` only after testing every lifecycle transition.
190
+
191
+ ## Handle seeds and dependencies
192
+
193
+ Seeds are generated at mint and drive reproducible variation. `abx inspect` identifies common seed
194
+ misuse, but test multiple real token-data fixtures. A custom seed source affects future mints and is
195
+ an external contract pointer; verify its code/interface and disclose who can change its behavior.
196
+
197
+ Dependencies are ordered; index 0 is the runtime. A `name@version` reference resolves through the
198
+ collection's dependency-registry pointer, while a `0x…` reference reads a data contract directly.
199
+ Registry availability is chain-specific. Read the deploy dependency report: a named dependency can
200
+ be valid yet served from a CDN, which means the document is not chain-complete.
201
+
202
+ `lock-dependencies` freezes the reference list and registry pointer, not necessarily the bytes a live
203
+ registry entry returns. Use immutable on-chain data contracts for a stronger frozen-dependency claim.
204
+
205
+ ## Verify and freeze
206
+
207
+ After deploying and minting representative ids:
208
+
209
+ 1. Read `abx state`, `abx tokens --json`, and `abx tokenuri`.
210
+ 2. Open the animation/live view using actual minted token data.
211
+ 3. Fetch the marketplace image and inspect `attributes` from token metadata.
212
+ 4. Run `abx verify` and resolve placeholder, chain-complete, dependency, or render warnings.
213
+ 5. Change every intended parameter through its authorized path; confirm still refresh behavior.
214
+ 6. Exercise mint, transfer, and burn paths if hooks or burnability are involved.
215
+ 7. Verify dependency and renderer addresses and whether their code is upgradeable.
216
+ 8. Lock only the surfaces the creator has explicitly chosen to freeze.
217
+
218
+ A fully frozen code-project posture may involve URI/field locks, `lock-script`,
219
+ `lock-dependencies`, `lock-param-hooks`, and governed parameter locks. Those locks cover different
220
+ state. Describe exactly what each freezes; never summarize them as “the output can never change.”
@@ -0,0 +1,94 @@
1
+ # ERC-721C / ERC-1155C transfer validation
2
+
3
+ Use this reference only when the creator asks about creator-token standards, transfer validation,
4
+ royalty-enforcement compatibility, validator selection, or changing/suspending validation.
5
+
6
+ ## Separate three mechanisms
7
+
8
+ - **Royalties** declare a receiver and basis points through the token's royalty interface. They do
9
+ not force a marketplace to pay.
10
+ - **Creator-token enrollment** opts the collection into ERC-721C or ERC-1155C validation at deploy.
11
+ Transfers consult a validator selected by the owner.
12
+ - **ABX transfer hooks** are code-project extension callbacks and may implement arbitrary project
13
+ lifecycle rules. They are not creator-token validators.
14
+
15
+ These mechanisms can coexist and may each reject a transfer for a different reason. Diagnose the
16
+ actual contract state and revert path.
17
+
18
+ ## Enrollment is deploy-time
19
+
20
+ Pass `--721c recommended|0x…` on the selected deploy command to create the creator-token variant. The
21
+ same flag chooses the ERC-1155C twin when `--copies` selects an edition. Absence creates the ordinary
22
+ ERC-721/ERC-1155 family.
23
+
24
+ Enrollment cannot be added or removed after deployment. Ask before spending:
25
+
26
+ - Does the creator actually want standards-track transfer validation?
27
+ - Which validator and security policy should govern transfers?
28
+ - Is the intended marketplace/wallet flow compatible on the target chain today?
29
+ - Who may later change or suspend the validator?
30
+ - Is the stronger restriction worth the interoperability and owner-power tradeoff?
31
+
32
+ Do not default into enrollment merely because the creator set a royalty. Do not present it as a
33
+ guarantee of payment across all marketplaces.
34
+
35
+ ## Select and validate the validator
36
+
37
+ `recommended` resolves the toolkit's current recommended creator-fee validator for the active chain.
38
+ An explicit address must be a deployed validator contract that actually implements the expected
39
+ interface and rejects unsupported calls. A Safe, EOA, empty proxy, or permissive fallback is not an
40
+ enforcement policy even if it has code.
41
+
42
+ Let the CLI probe the address. Do not bypass a refusal with a raw transaction. For a custom validator,
43
+ review and test:
44
+
45
+ - transfer behavior for owner, approved operator, marketplace conduit, and ordinary recipient;
46
+ - mint and burn behavior where the standard invokes validation;
47
+ - upgrade/administration powers and who controls them;
48
+ - failure behavior when external registries are unavailable;
49
+ - ERC-721 versus ERC-1155 amount/batch semantics;
50
+ - interaction with an ABX transfer hook.
51
+
52
+ Marketplace allowlists, registry addresses, and supported flows change. Use current command output,
53
+ the validator's primary documentation, and a testnet transaction rather than a dated compatibility
54
+ table in this skill.
55
+
56
+ ## Operate an enrolled collection
57
+
58
+ Read current enrollment and validator state with `abx state`. Use:
59
+
60
+ ```bash
61
+ abx set-transfer-validator <address> recommended
62
+ abx set-transfer-validator <address> 0x...
63
+ abx set-transfer-validator <address> none
64
+ ```
65
+
66
+ Run command help for current syntax and a dry run before writing. Setting `none` suspends the active
67
+ validator where supported; it does not convert the contract back to a plain non-C token. Enrollment
68
+ and the associated owner power remain part of the contract's permanent type.
69
+
70
+ Before changing the validator:
71
+
72
+ 1. Read the current validator, owner, royalty, minter, and transfer-hook state.
73
+ 2. Explain whether the change tightens, loosens, or suspends transfer policy.
74
+ 3. Test representative transfers using the intended marketplace/operator on testnet.
75
+ 4. Receive exact human confirmation.
76
+ 5. Execute once and re-read state.
77
+
78
+ If a transfer fails, do not clear the validator as a generic repair. Determine whether the failure
79
+ comes from the creator-token validator, an ABX transfer hook, token ownership/approval, pause/mint
80
+ rules, or the receiving contract. Changing enforcement is a policy decision, not troubleshooting.
81
+
82
+ ## Disclose owner powers precisely
83
+
84
+ Collectors should know:
85
+
86
+ - the collection is permanently enrolled in the creator-token variant;
87
+ - the current validator address and whether it is upgradeable;
88
+ - who can change or suspend that validator;
89
+ - whether a separate ABX transfer hook can veto transfers/mints;
90
+ - whether hook addresses are locked;
91
+ - the royalty rate, receiver, and permanent ceiling.
92
+
93
+ A locked ABX hook set does not lock the creator-token validator, and creator-token enrollment does not
94
+ freeze royalties. List each power separately.