@artblocks/abx-sdk 0.1.0-alpha.0

package/dist/types.d.ts

@@ -0,0 +1,145 @@
+import type { Address, Hex } from 'viem';
+/** One extension a contract has enabled, as learned from `AbxExtensionVersionSet`. */
+export interface ExtensionInfo {
+    id: Hex;
+    name: string;
+    version: number;
+}
+/**
+ * One on-chain metadata value, decoded from the spine: a `field` (the *what*, e.g.
+ * "image") carried in a `representation` (the *how*, e.g. "inline" / "keccak256" /
+ * "arweave"). See the protocol registry (specs/protocol/onchain-metadata.md).
+ */
+export interface MetadataField {
+    field: string;
+    representation: string;
+    value: Hex;
+}
+/** One param (Params extension): `key → bytes32` with the hash flag + write provenance. */
+export interface ParamValue {
+    key: string;
+    value: Hex;
+    valueIsHash: boolean;
+    updatedBy: Address;
+}
+/** One key's governance (Configurable Params): what it means, who may set it, until when. */
+export interface ParamSchema {
+    key: string;
+    paramType: string;
+    auth: string;
+    authAddress: Address | null;
+    lockAfter: string;
+    min: Hex;
+    max: Hex;
+    selectOptions: string[];
+}
+/** The three param lifecycle hooks (any may be null = none). */
+export interface ParamHooks {
+    configureHook: Address | null;
+    augmentHook: Address | null;
+    transferHook: Address | null;
+}
+/** One declared code dependency (Dependencies extension); index 0 = the runtime. */
+export interface DependencyInfo {
+    resolution: 'registry' | 'onchain';
+    ref: Hex;
+    refDecoded: string;
+}
+/** On-chain script custody state. Chunk content is a head read (too large to log). */
+export interface ScriptState {
+    chunkCount: number | null;
+    locked: boolean;
+    /** keccak256 over the concatenated chunk contents (head read) — the content digest
+     *  effect `inputsHash` values commit to. Null when unread or no chunks. */
+    digest?: Hex | null;
+}
+/** The declared dependency set (fully log-foldable — events carry full values). */
+export interface DependenciesState {
+    list: DependencyInfo[];
+    registry: Address | null;
+    locked: boolean;
+}
+/** A decoded spine log, kept verbatim as reconstruction provenance. */
+export interface SpineEvent {
+    name: string;
+    register: 1 | 2;
+    what: string;
+    blockNumber: string;
+    logIndex: number;
+    txHash: Hex;
+    args: Record<string, string>;
+}
+export interface TokenState {
+    tokenId: string;
+    minted: boolean;
+    owner: Address | null;
+    tokenURI: string | null;
+    fields: MetadataField[];
+    lockedFields: string[];
+    /** Token-scope params (Params extension) — `seed`, PostParam values, … Absent/empty ⇒ none. */
+    params?: ParamValue[];
+}
+/**
+ * The full reconstructed state of an ABX project — rebuilt from the event log
+ * (structure) plus targeted head reads (string values the events only ping).
+ * This is the object the reconstructability property produces: derivable from
+ * the chain alone, with no provider's cooperation.
+ */
+export interface ProjectState {
+    address: Address;
+    chainId: number;
+    abxVersion: number | null;
+    deployBlock: string | null;
+    deployTx: Hex | null;
+    factory: Address | null;
+    implementation: Address | null;
+    isCanonical: boolean | null;
+    name: string | null;
+    symbol: string | null;
+    owner: Address | null;
+    contractURI: string | null;
+    royalty: {
+        receiver: Address;
+        bps: number;
+    } | null;
+    tokenURIRenderer: Address | null;
+    tokenURILocked: boolean | null;
+    contractURIRenderer: Address | null;
+    contractURILocked: boolean | null;
+    collectionFields: MetadataField[];
+    lockedCollectionFields: string[];
+    /** Which concrete token type this is, inferred from the enabled extensions. */
+    contractType?: '1of1' | 'series' | 'code';
+    /** Supply cap "X of Y" (Max Invocations extension); null/absent ⇒ uncapped 1/1. */
+    maxInvocations?: string | null;
+    /** The single authorized minter (External Minter extension); null ⇒ owner-only. */
+    minter?: Address | null;
+    /** Whether minting is paused (Paused extension) — true ⇒ owner-only. Absent/false ⇒ open. */
+    paused?: boolean;
+    /** Primary-sale payout destination (Primary Payee extension); null ⇒ none. */
+    primaryPayee?: Address | null;
+    /** Contract-scope params (Params extension). */
+    contractParams?: ParamValue[];
+    /** Per-key PostParam schemas (Configurable Params) — emitted in full, log-foldable. */
+    paramSchemas?: ParamSchema[];
+    /** The param lifecycle hooks; null ⇒ extension absent, all-null ⇒ none wired. */
+    paramHooks?: ParamHooks | null;
+    /** TokenOwner-auth delegation resolver: address, or null = disabled. Absence of the
+     *  event resolves to the canonical delegate.xyz default when the extension is present. */
+    delegateRegistry?: Address | null;
+    /** Mint-time seed source (Seed Source extension); null ⇒ no mint-time seed. */
+    seedSource?: Address | null;
+    /** On-chain script custody (On-Chain Script extension); null ⇒ extension absent. */
+    script?: ScriptState | null;
+    /** Declared code dependencies (Dependencies extension); null ⇒ extension absent. */
+    dependencies?: DependenciesState | null;
+    extensions: ExtensionInfo[];
+    tokens: TokenState[];
+    events: SpineEvent[];
+    fromBlock: string;
+    toBlock: string;
+    eventCount: number;
+    reconstructedAt: string;
+    rpcUrl?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,OAAO,EAAE,GAAG,EAAC,MAAM,MAAM,CAAC;AAEvC,sFAAsF;AACtF,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,GAAG,CAAC;IACR,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,GAAG,CAAC;CACZ;AAED,2FAA2F;AAC3F,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,GAAG,CAAC;IACX,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,6FAA6F;AAC7F,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,GAAG,CAAC;IACT,GAAG,EAAE,GAAG,CAAC;IACT,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,gEAAgE;AAChE,MAAM,WAAW,UAAU;IACzB,aAAa,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9B,WAAW,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5B,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;CAC9B;AAED,oFAAoF;AACpF,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,UAAU,GAAG,SAAS,CAAC;IACnC,GAAG,EAAE,GAAG,CAAC;IACT,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,sFAAsF;AACtF,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,EAAE,OAAO,CAAC;IAChB;+EAC2E;IAC3E,MAAM,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CACrB;AAED,mFAAmF;AACnF,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,cAAc,EAAE,CAAC;IACvB,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,uEAAuE;AACvE,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,GAAG,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IACtB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,+FAA+F;IAC/F,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAGhB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,EAAE,GAAG,GAAG,IAAI,CAAC;IACrB,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACxB,cAAc,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/B,WAAW,EAAE,OAAO,GAAG,IAAI,CAAC;IAG5B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IACtB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,EAAE;QAAC,QAAQ,EAAE,OAAO,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI,CAAC;IAKjD,gBAAgB,EAAE,OAAO,GAAG,IAAI,CAAC;IACjC,cAAc,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/B,mBAAmB,EAAE,OAAO,GAAG,IAAI,CAAC;IACpC,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;IAGlC,gBAAgB,EAAE,aAAa,EAAE,CAAC;IAClC,sBAAsB,EAAE,MAAM,EAAE,CAAC;IAGjC,+EAA+E;IAC/E,YAAY,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;IAC1C,mFAAmF;IACnF,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,mFAAmF;IACnF,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACxB,6FAA6F;IAC7F,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,8EAA8E;IAC9E,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAG9B,gDAAgD;IAChD,cAAc,CAAC,EAAE,UAAU,EAAE,CAAC;IAC9B,uFAAuF;IACvF,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,iFAAiF;IACjF,UAAU,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAC/B;8FAC0F;IAC1F,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAClC,+EAA+E;IAC/E,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5B,oFAAoF;IACpF,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAC5B,oFAAoF;IACpF,YAAY,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAExC,UAAU,EAAE,aAAa,EAAE,CAAC;IAC5B,MAAM,EAAE,UAAU,EAAE,CAAC;IAGrB,MAAM,EAAE,UAAU,EAAE,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@artblocks/abx-sdk",
+  "version": "0.1.0-alpha.0",
+  "license": "MIT",
+  "description": "ABX SDK (Layer 2) — the neutral, low-level library that turns protocol operations into typed function calls. No provider, no chain, no UX baked in.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./abi": {
+      "types": "./dist/abi/index.d.ts",
+      "import": "./dist/abi/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22.5.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ArtBlocks/abx.git",
+    "directory": "packages/sdk"
+  },
+  "homepage": "https://github.com/ArtBlocks/abx#readme",
+  "bugs": "https://github.com/ArtBlocks/abx/issues",
+  "keywords": [
+    "abx",
+    "nft",
+    "erc721",
+    "ethereum",
+    "viem",
+    "art-blocks",
+    "sdk"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "viem": "^2.21.0"
+  },
+  "scripts": {
+    "build": "tsc -b tsconfig.build.json",
+    "sync-abis": "tsx scripts/sync-abis.ts"
+  },
+  "types": "./dist/index.d.ts"
+}