@artblocks/abx-cli 0.1.0-alpha.3 → 0.1.0-alpha.30

package/dist/kind.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Centralized token-kind detection — one shared probe for the six concrete ABX token types, from
+ * three plain `eth_call`s (no events, no local index). Before this existed, the same "is this a
+ * 721 or an edition, and which concrete type" question was answered by ad-hoc, slightly different
+ * probes scattered across `commands/project.ts` (`state`), `commands/scaffold.ts`
+ * (`assertMintableSeries`), and `ownerops.ts` (the `set-param-hooks` guard) — this gives it one
+ * name and one place to live, so a new call site (mint/transfer/minter kind-awareness) doesn't
+ * grow a fourth copy.
+ *
+ * The discriminator mirrors the SDK's `ProjectState.contractType` union (reconstruct.ts) exactly,
+ * but this is a LIVE probe, not an event fold: `state`, `mint-page`, and the owner-op guards need a
+ * snapshot with no local index and no getLogs scan.
+ *
+ *   ERC-165 0xd9b67a26 (ERC-1155)  → the edition family (OneOfOneEdition / EditionImage / EditionCode)
+ *   maxInvocations()               → present on the multi-id twins (Series/SeriesCode, EditionImage/Code)
+ *   the Params/ConfigurableParams surface (`paramHooks()`) → present only on the two code twins
+ *
+ * Every probe is defensive (try/catch → false) — a getter absent because the extension isn't
+ * composed and a getter absent because there's no contract at that address read identically here.
+ * That made the three negative probes collapse to the SAME answer for an address with no code at
+ * all: all three fail, so the ladder fell through to its `1of1` default and every empty address was
+ * reported as a confident "OneOfOneImage". Callers were supposed to rule that out first (`state`
+ * does), but `set-max-supply` and `minter buy` did not, and told edition owners "…is a OneOfOneImage
+ * (721) — drop your edition flags" whenever the address was mistyped or the chain was wrong (the
+ * default is base-sepolia, so a Sepolia contract hits this immediately). So the existence check now
+ * lives HERE, once, ahead of the probes — every call site inherits it and cannot forget it.
+ */
+import type { Address, PublicClient } from 'viem';
+/** Mirrors the SDK's `ProjectState.contractType` (reconstruct.ts) — the 721 ladder and its
+ *  ERC-1155 edition twin, one rung apart. */
+export type TokenKind = '1of1' | 'series' | 'code' | '1of1-edition' | 'edition' | 'edition-code';
+export interface TokenKindInfo {
+    kind: TokenKind;
+    /** The single fact most call sites actually branch on — true for the three ERC-1155 twins. */
+    isEdition: boolean;
+    /** The concrete contract name, for a readout ("EditionImage (edition) state"). */
+    label: string;
+}
+/**
+ * Which of the six concrete ABX token types `address` is — the shared discriminator every command
+ * that branches on kind should call instead of re-deriving its own probe. Three live `eth_call`s,
+ * in the order that lets each short-circuit the next: ERC-165 first (edition family or not), then
+ * `maxInvocations()` (multi-id or not), then the Params surface (code or not).
+ */
+export declare function detectTokenKind(client: PublicClient, address: Address): Promise<TokenKindInfo>;
+/** Convenience for a call site that only needs the one boolean (is this an ERC-1155 edition, at
+ *  all) — the cheapest single probe, so a guard that doesn't need the full breakdown doesn't pay
+ *  for the other two calls. */
+export declare function isEditionContract(client: PublicClient, address: Address): Promise<boolean>;
+/** Human, one-line description of a kind — `"EditionImage (edition)"`, `"SeriesImage (series)"` —
+ *  the shared phrasing for a readout header (`state`, `tokens`). */
+export declare function describeKind(info: TokenKindInfo): string;
+/** The ConfigurableParams / PostParams surface — SeriesCode and EditionCode only. */
+export declare function hasParamsSurface(info: TokenKindInfo): boolean;
+/**
+ * Refuse a PostParams command (set-schema / configure-param / retire-param) against a contract
+ * that does not compose ConfigurableParams — before any signing prompt, and as a capability
+ * mismatch rather than a raw viem revert. Same probe `set-param-hooks` already ran.
+ */
+export declare function assertHasParamsSurface(client: PublicClient, address: Address, what: string): Promise<TokenKindInfo>;
+//# sourceMappingURL=kind.d.ts.map

package/dist/kind.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kind.d.ts","sourceRoot":"","sources":["../src/kind.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,OAAO,KAAK,EAAC,OAAO,EAAE,YAAY,EAAC,MAAM,MAAM,CAAC;AAEhD;6CAC6C;AAC7C,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,cAAc,GAAG,SAAS,GAAG,cAAc,CAAC;AAEjG,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,SAAS,CAAC;IAChB,8FAA8F;IAC9F,SAAS,EAAE,OAAO,CAAC;IACnB,kFAAkF;IAClF,KAAK,EAAE,MAAM,CAAC;CACf;AAkED;;;;;GAKG;AACH,wBAAsB,eAAe,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,CAYpG;AAED;;+BAE+B;AAC/B,wBAAsB,iBAAiB,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAEhG;AAED;oEACoE;AACpE,wBAAgB,YAAY,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAExD;AAED,qFAAqF;AACrF,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAE7D;AAED;;;;GAIG;AACH,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,aAAa,CAAC,CASxB"}

package/dist/kind.js

@@ -0,0 +1,111 @@
+/** ERC-165 id of ERC-1155 itself — what sorts a clone into the edition family (anchors.ts's
+ *  `ERC1155_INTERFACE_ID`, restated here rather than imported: it's a fixed standard id, not SDK
+ *  surface). */
+const ERC1155_INTERFACE_ID = '0xd9b67a26';
+const KIND_PROBE_ABI = [
+    { type: 'function', name: 'supportsInterface', stateMutability: 'view', inputs: [{ type: 'bytes4' }], outputs: [{ type: 'bool' }] },
+    { type: 'function', name: 'maxInvocations', stateMutability: 'view', inputs: [], outputs: [{ type: 'uint256' }] },
+    { type: 'function', name: 'paramHooks', stateMutability: 'view', inputs: [], outputs: [{ type: 'address' }, { type: 'address' }, { type: 'address' }] },
+];
+/**
+ * Refuse to infer a kind for an address that holds no contract. Without this the three negative
+ * probes below are indistinguishable from "nothing deployed here", and the ladder's `1of1` default
+ * becomes a confident lie about a specific contract type (see the file docstring).
+ *
+ * Deliberately silent when the check itself can't run (an RPC hiccup → `getCode` throws): a network
+ * blip must not become a "no contract" claim, so we fall through to the probes exactly as before and
+ * let whatever the caller was doing surface its own error. Same stance as `assertContractExists`.
+ */
+async function assertHasCode(client, address) {
+    let code;
+    try {
+        code = await client.getCode({ address });
+    }
+    catch {
+        return; // can't tell — don't manufacture a verdict
+    }
+    if (code && code !== '0x')
+        return;
+    const chain = client.chain?.name ?? 'the active chain';
+    throw new Error(`no contract at ${address} on ${chain} — so there is no token type to read. ` +
+        `Check the address, and check the network: a contract that lives on another chain reads as empty here ` +
+        `(the chain is picked with ABX_CHAIN; base-sepolia is the default). Owner ops run AFTER deploy.`);
+}
+async function supportsErc1155(client, address) {
+    try {
+        return (await client.readContract({ address, abi: KIND_PROBE_ABI, functionName: 'supportsInterface', args: [ERC1155_INTERFACE_ID] }));
+    }
+    catch {
+        return false;
+    }
+}
+async function hasMaxInvocations(client, address) {
+    try {
+        await client.readContract({ address, abi: KIND_PROBE_ABI, functionName: 'maxInvocations' });
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+/** The Params/ConfigurableParams surface probe — `paramHooks()` exists only on SeriesCode/
+ *  EditionCode (mirrors the exact check `ownerops.ts`'s `cmdSetParamHooks` already ran ad-hoc). */
+async function hasConfigurableParams(client, address) {
+    try {
+        await client.readContract({ address, abi: KIND_PROBE_ABI, functionName: 'paramHooks' });
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Which of the six concrete ABX token types `address` is — the shared discriminator every command
+ * that branches on kind should call instead of re-deriving its own probe. Three live `eth_call`s,
+ * in the order that lets each short-circuit the next: ERC-165 first (edition family or not), then
+ * `maxInvocations()` (multi-id or not), then the Params surface (code or not).
+ */
+export async function detectTokenKind(client, address) {
+    await assertHasCode(client, address);
+    const isEdition = await supportsErc1155(client, address);
+    const capped = await hasMaxInvocations(client, address);
+    if (isEdition) {
+        if (!capped)
+            return { kind: '1of1-edition', isEdition: true, label: 'OneOfOneEdition' };
+        const code = await hasConfigurableParams(client, address);
+        return code ? { kind: 'edition-code', isEdition: true, label: 'EditionCode' } : { kind: 'edition', isEdition: true, label: 'EditionImage' };
+    }
+    if (!capped)
+        return { kind: '1of1', isEdition: false, label: 'OneOfOneImage' };
+    const code = await hasConfigurableParams(client, address);
+    return code ? { kind: 'code', isEdition: false, label: 'SeriesCode' } : { kind: 'series', isEdition: false, label: 'SeriesImage' };
+}
+/** Convenience for a call site that only needs the one boolean (is this an ERC-1155 edition, at
+ *  all) — the cheapest single probe, so a guard that doesn't need the full breakdown doesn't pay
+ *  for the other two calls. */
+export async function isEditionContract(client, address) {
+    return supportsErc1155(client, address);
+}
+/** Human, one-line description of a kind — `"EditionImage (edition)"`, `"SeriesImage (series)"` —
+ *  the shared phrasing for a readout header (`state`, `tokens`). */
+export function describeKind(info) {
+    return `${info.label} (${info.kind === '1of1' ? '1/1' : info.kind === '1of1-edition' ? 'edition' : info.kind})`;
+}
+/** The ConfigurableParams / PostParams surface — SeriesCode and EditionCode only. */
+export function hasParamsSurface(info) {
+    return info.kind === 'code' || info.kind === 'edition-code';
+}
+/**
+ * Refuse a PostParams command (set-schema / configure-param / retire-param) against a contract
+ * that does not compose ConfigurableParams — before any signing prompt, and as a capability
+ * mismatch rather than a raw viem revert. Same probe `set-param-hooks` already ran.
+ */
+export async function assertHasParamsSurface(client, address, what) {
+    const kind = await detectTokenKind(client, address);
+    if (!hasParamsSurface(kind)) {
+        throw new Error(`${address} exposes no PostParams — ${what} is a SeriesCode/EditionCode feature. ` +
+            `${kind.label} has no configurable params.`);
+    }
+    return kind;
+}
+//# sourceMappingURL=kind.js.map

package/dist/kind.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kind.js","sourceRoot":"","sources":["../src/kind.ts"],"names":[],"mappings":"AAyCA;;gBAEgB;AAChB,MAAM,oBAAoB,GAAG,YAAqB,CAAC;AAEnD,MAAM,cAAc,GAAG;IACrB,EAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,EAAC,IAAI,EAAE,QAAQ,EAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAC,IAAI,EAAE,MAAM,EAAC,CAAC,EAAC;IAC7H,EAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAC,IAAI,EAAE,SAAS,EAAC,CAAC,EAAC;IAC7G,EAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAC,IAAI,EAAE,SAAS,EAAC,EAAE,EAAC,IAAI,EAAE,SAAS,EAAC,EAAE,EAAC,IAAI,EAAE,SAAS,EAAC,CAAC,EAAC;CACvI,CAAC;AAEX;;;;;;;;GAQG;AACH,KAAK,UAAU,aAAa,CAAC,MAAoB,EAAE,OAAgB;IACjE,IAAI,IAAwB,CAAC;IAC7B,IAAI,CAAC;QACH,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAC,OAAO,EAAC,CAAC,CAAC;IACzC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,CAAC,2CAA2C;IACrD,CAAC;IACD,IAAI,IAAI,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO;IAClC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE,IAAI,IAAI,kBAAkB,CAAC;IACvD,MAAM,IAAI,KAAK,CACb,kBAAkB,OAAO,OAAO,KAAK,wCAAwC;QAC3E,uGAAuG;QACvG,gGAAgG,CACnG,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,MAAoB,EAAE,OAAgB;IACnE,IAAI,CAAC;QACH,OAAO,CAAC,MAAM,MAAM,CAAC,YAAY,CAAC,EAAC,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,YAAY,EAAE,mBAAmB,EAAE,IAAI,EAAE,CAAC,oBAAoB,CAAC,EAAC,CAAC,CAAY,CAAC;IACjJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,KAAK,UAAU,iBAAiB,CAAC,MAAoB,EAAE,OAAgB;IACrE,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,YAAY,CAAC,EAAC,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,YAAY,EAAE,gBAAgB,EAAC,CAAC,CAAC;QAC1F,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;mGACmG;AACnG,KAAK,UAAU,qBAAqB,CAAC,MAAoB,EAAE,OAAgB;IACzE,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,YAAY,CAAC,EAAC,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,YAAY,EAAE,YAAY,EAAC,CAAC,CAAC;QACtF,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,MAAoB,EAAE,OAAgB;IAC1E,MAAM,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,MAAM,SAAS,GAAG,MAAM,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxD,IAAI,SAAS,EAAE,CAAC;QACd,IAAI,CAAC,MAAM;YAAE,OAAO,EAAC,IAAI,EAAE,cAAc,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,iBAAiB,EAAC,CAAC;QACtF,MAAM,IAAI,GAAG,MAAM,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,cAAc,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,aAAa,EAAC,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,EAAC,CAAC;IAC1I,CAAC;IACD,IAAI,CAAC,MAAM;QAAE,OAAO,EAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,eAAe,EAAC,CAAC;IAC7E,MAAM,IAAI,GAAG,MAAM,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1D,OAAO,IAAI,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,EAAC,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,aAAa,EAAC,CAAC;AACjI,CAAC;AAED;;+BAE+B;AAC/B,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,MAAoB,EAAE,OAAgB;IAC5E,OAAO,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC1C,CAAC;AAED;oEACoE;AACpE,MAAM,UAAU,YAAY,CAAC,IAAmB;IAC9C,OAAO,GAAG,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC;AAClH,CAAC;AAED,qFAAqF;AACrF,MAAM,UAAU,gBAAgB,CAAC,IAAmB;IAClD,OAAO,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC;AAC9D,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,MAAoB,EACpB,OAAgB,EAChB,IAAY;IAEZ,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CACb,GAAG,OAAO,4BAA4B,IAAI,wCAAwC;YAChF,GAAG,IAAI,CAAC,KAAK,8BAA8B,CAC9C,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}