@seedprotocol/publish 0.4.8

package/README.md

@@ -0,0 +1,75 @@
+# @seedprotocol/publish
+
+Publish UI components and helpers for Seed Protocol.
+
+The publish flow (ConnectButton, etc.) runs `ensureEasSchemasForItem` before `getPublishPayload`, which registers EAS schemas and adds naming attestations so EASSCAN displays them. If you build a custom publish flow that calls `item.getPublishPayload()` directly, you must run schema setup first or use this package's flow.
+
+## Setup
+
+Wrap your app with `PublishProvider` so that `ConnectButton` and other publish components work correctly. The provider includes:
+
+- Thirdweb's required context (React Query, connection manager)
+- SeedProvider (React Query for Seed SDK hooks like `useItems`, `useModels`, `useSchemas`)
+
+You can optionally pass `queryClient` or `queryClientRef` to customize the Seed QueryClient.
+
+`thirdwebClientId` and `uploadApiBaseUrl` are required. Other values (account factory, EAS contract) are defined as constants in the package.
+
+### useIntegerLocalIds
+
+When using the new contract that expects `uint256` localIdIndex/publishLocalIdIndex instead of string localId/publishLocalId (gas-efficient), set `useIntegerLocalIds: true`:
+
+```tsx
+initPublish({
+  thirdwebClientId: '...',
+  uploadApiBaseUrl: '...',
+  useIntegerLocalIds: true,  // Use integer-based payload for new contract
+})
+```
+
+To revert to the old contract (string-based), set `useIntegerLocalIds: false` or omit the flag. No code changes required beyond config.
+
+### Option A: Config via provider
+
+```tsx
+import { PublishProvider, ConnectButton } from '@seedprotocol/publish'
+
+function App() {
+  return (
+    <PublishProvider
+      config={{
+        thirdwebClientId: import.meta.env.VITE_THIRDWEB_CLIENT_ID,
+        uploadApiBaseUrl: import.meta.env.VITE_UPLOAD_API_BASE_URL,
+      }}
+    >
+      <ConnectButton />
+    </PublishProvider>
+  )
+}
+```
+
+### Option B: Config via initPublish
+
+```tsx
+import { PublishProvider, ConnectButton, initPublish } from '@seedprotocol/publish'
+
+initPublish({
+  thirdwebClientId: import.meta.env.VITE_THIRDWEB_CLIENT_ID,
+  uploadApiBaseUrl: import.meta.env.VITE_UPLOAD_API_BASE_URL,
+})
+
+function App() {
+  return (
+    <PublishProvider>
+      <ConnectButton />
+    </PublishProvider>
+  )
+}
+```
+
+## Development
+
+```bash
+bun install
+bun run build
+```

package/dist/config.d.ts

@@ -0,0 +1,40 @@
+export interface PublishConfig {
+    thirdwebClientId: string;
+    /** Upload API base URL (e.g. from VITE_UPLOAD_API_BASE_URL or NEXT_PUBLIC_UPLOAD_API_BASE_URL) */
+    uploadApiBaseUrl: string;
+    /**
+     * Use integer indices instead of string localId/publishLocalId for multiPublish (gas-efficient).
+     * Set to true when using the new contract that expects uint256 localIdIndex/publishLocalIdIndex.
+     * Default: false (uses string-based payload for backward compatibility).
+     */
+    useIntegerLocalIds?: boolean;
+    /**
+     * Bypass the SeedProtocol contract and call EAS attest/multiAttest directly from the user's wallet.
+     * Default: false (uses contract multiPublish).
+     */
+    useDirectEas?: boolean;
+    /**
+     * Optional IModularCore module to ensure is installed on the connected account contract.
+     * When set, onConnect will check getInstalledModules and install if missing.
+     */
+    modularAccountModuleContract?: string;
+    /** Optional module install data (default "0x"). Used with modularAccountModuleContract. */
+    modularAccountModuleData?: string;
+    /**
+     * Use the modular executor for multiPublish.
+     * Default: false (uses the smart wallet executor).
+     */
+    useModularExecutor?: boolean;
+}
+export declare function initPublish(c: PublishConfig): void;
+export interface ResolvedPublishConfig extends PublishConfig {
+    thirdwebAccountFactoryAddress: string;
+    uploadApiBaseUrl: string;
+    easContractAddress: string;
+    useIntegerLocalIds: boolean;
+    useDirectEas: boolean;
+    modularAccountModuleData: string;
+    useModularExecutor: boolean;
+}
+export declare function getPublishConfig(): ResolvedPublishConfig;
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,aAAa;IAC5B,gBAAgB,EAAE,MAAM,CAAA;IACxB,kGAAkG;IAClG,gBAAgB,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;;OAGG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAA;IACrC,2FAA2F;IAC3F,wBAAwB,CAAC,EAAE,MAAM,CAAA;IACjC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B;AAwBD,wBAAgB,WAAW,CAAC,CAAC,EAAE,aAAa,GAAG,IAAI,CAElD;AAED,MAAM,WAAW,qBAAsB,SAAQ,aAAa;IAC1D,6BAA6B,EAAE,MAAM,CAAA;IACrC,gBAAgB,EAAE,MAAM,CAAA;IACxB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,kBAAkB,EAAE,OAAO,CAAA;IAC3B,YAAY,EAAE,OAAO,CAAA;IACrB,wBAAwB,EAAE,MAAM,CAAA;IAChC,kBAAkB,EAAE,OAAO,CAAA;CAC5B;AAED,wBAAgB,gBAAgB,IAAI,qBAAqB,CAgBxD"}

package/dist/helpers/blockchain.d.ts

@@ -0,0 +1,3 @@
+import Arweave from 'arweave';
+export declare const getArweave: () => Arweave;
+//# sourceMappingURL=blockchain.d.ts.map

package/dist/helpers/blockchain.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blockchain.d.ts","sourceRoot":"","sources":["../../src/helpers/blockchain.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAG7B,eAAO,MAAM,UAAU,QAAO,OAe7B,CAAA"}

package/dist/helpers/constants.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Constants for the publish package.
+ */
+/** EAS Schema Registry on Optimism Sepolia (chain 11155420) */
+export declare const SCHEMA_REGISTRY_ADDRESS: "0x4200000000000000000000000000000000000020";
+/** Schema #1 (Name a Schema) - universal UID for naming attestations */
+export declare const EAS_SCHEMA_NAME_ATTESTATION_UID: "0x44d562ac1d7cd77e232978687fea027ace48f719cf1d58c7888e509663bb87fc";
+/** Thirdweb ManagedAccount factory on Optimism Sepolia (chain 11155420) */
+export declare const THIRDWEB_ACCOUNT_FACTORY_ADDRESS: "0x76f47d88bfaf670f5208911181fcdc0e160cb16d";
+/** EAS contract address on Optimism Sepolia (chain 11155420) */
+export declare const EAS_CONTRACT_ADDRESS: "0x4200000000000000000000000000000000000021";
+export declare const PublishMachineStates: {
+    readonly SUCCESS: "success";
+    readonly FAILURE: "failure";
+};
+//# sourceMappingURL=constants.d.ts.map

package/dist/helpers/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/helpers/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,+DAA+D;AAC/D,eAAO,MAAM,uBAAuB,EAClC,4CAAqD,CAAA;AAEvD,wEAAwE;AACxE,eAAO,MAAM,+BAA+B,EAC1C,oEAA6E,CAAA;AAE/E,2EAA2E;AAC3E,eAAO,MAAM,gCAAgC,EAC3C,4CAAqD,CAAA;AAEvD,gEAAgE;AAChE,eAAO,MAAM,oBAAoB,EAC/B,4CAAqD,CAAA;AAEvD,eAAO,MAAM,oBAAoB;;;CAGvB,CAAA"}

package/dist/helpers/debugLog.d.ts

@@ -0,0 +1,7 @@
+export declare function debugLog(params: {
+    location: string;
+    message: string;
+    data?: Record<string, unknown>;
+    hypothesisId?: string;
+}): void;
+//# sourceMappingURL=debugLog.d.ts.map

package/dist/helpers/debugLog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debugLog.d.ts","sourceRoot":"","sources":["../../src/helpers/debugLog.ts"],"names":[],"mappings":"AAOA,wBAAgB,QAAQ,CAAC,MAAM,EAAE;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,QAkBA"}

package/dist/helpers/easDirect.d.ts

@@ -0,0 +1,91 @@
+import type { ThirdwebClient } from 'thirdweb';
+import type { Chain } from 'thirdweb/chains';
+declare const ZERO_ADDRESS: "0x0000000000000000000000000000000000000000";
+declare const ZERO_BYTES32: `0x${string}`;
+export type EasAttestParams = {
+    schema: `0x${string}`;
+    data: {
+        recipient?: `0x${string}`;
+        expirationTime?: bigint;
+        revocable?: boolean;
+        refUID: `0x${string}`;
+        data: `0x${string}`;
+        value?: bigint;
+    };
+};
+/**
+ * Prepares a single EAS attest call.
+ * Used for Seed and Version attestations in the direct-to-EAS publish path.
+ */
+export declare function prepareEasAttest(client: ThirdwebClient, chain: Chain, params: EasAttestParams): import("thirdweb").PreparedTransaction<[], {
+    readonly name: "attest";
+    readonly type: "function";
+    readonly stateMutability: "payable";
+    readonly inputs: readonly [{
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly type: "bytes32";
+            readonly name: "schema";
+        }, {
+            readonly type: "tuple";
+            readonly components: readonly [{
+                readonly type: "address";
+                readonly name: "recipient";
+            }, {
+                readonly type: "uint64";
+                readonly name: "expirationTime";
+            }, {
+                readonly type: "bool";
+                readonly name: "revocable";
+            }, {
+                readonly type: "bytes32";
+                readonly name: "refUID";
+            }, {
+                readonly type: "bytes";
+                readonly name: "data";
+            }, {
+                readonly type: "uint256";
+                readonly name: "value";
+            }];
+            readonly name: "data";
+        }];
+        readonly name: "request";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "bytes32";
+    }];
+}, import("thirdweb").PrepareTransactionOptions>;
+export type MultiAttestationRequest = {
+    schema: `0x${string}`;
+    data: Array<{
+        recipient: `0x${string}`;
+        expirationTime: bigint;
+        revocable: boolean;
+        refUID: `0x${string}`;
+        data: `0x${string}`;
+        value: bigint;
+    }>;
+};
+/**
+ * Prepares an EAS multiAttest call for batch attestations.
+ * Used for property attestations in the direct-to-EAS publish path.
+ */
+export declare function prepareEasMultiAttest(client: ThirdwebClient, chain: Chain, requests: MultiAttestationRequest[]): import("thirdweb").PreparedTransaction<import("abitype").Abi, import("abitype").AbiFunction, import("thirdweb").PrepareTransactionOptions>;
+/**
+ * Encodes a bytes32 value for Seed/Version attestation data.
+ * Equivalent to Solidity abi.encode(bytes32).
+ */
+export declare function encodeBytes32(value: `0x${string}`): `0x${string}`;
+/**
+ * Extracts the attestation UID from an EAS attest transaction receipt.
+ * Parses the Attested event from the receipt logs.
+ */
+export declare function getAttestationUidFromReceipt(receipt: {
+    logs?: Array<{
+        address?: string;
+        data?: string;
+        topics?: unknown[];
+    }>;
+}, easContractAddress: string): string | undefined;
+export { ZERO_ADDRESS, ZERO_BYTES32 };
+//# sourceMappingURL=easDirect.d.ts.map

package/dist/helpers/easDirect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"easDirect.d.ts","sourceRoot":"","sources":["../../src/helpers/easDirect.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AAU5C,QAAA,MAAM,YAAY,EAAG,4CAAqD,CAAA;AAC1E,QAAA,MAAM,YAAY,EAA8B,KAAK,MAAM,EAAE,CAAA;AAE7D,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,KAAK,MAAM,EAAE,CAAA;IACrB,IAAI,EAAE;QACJ,SAAS,CAAC,EAAE,KAAK,MAAM,EAAE,CAAA;QACzB,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,SAAS,CAAC,EAAE,OAAO,CAAA;QACnB,MAAM,EAAE,KAAK,MAAM,EAAE,CAAA;QACrB,IAAI,EAAE,KAAK,MAAM,EAAE,CAAA;QACnB,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;CACF,CAAA;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,cAAc,EACtB,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iDA2BxB;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,KAAK,MAAM,EAAE,CAAA;IACrB,IAAI,EAAE,KAAK,CAAC;QACV,SAAS,EAAE,KAAK,MAAM,EAAE,CAAA;QACxB,cAAc,EAAE,MAAM,CAAA;QACtB,SAAS,EAAE,OAAO,CAAA;QAClB,MAAM,EAAE,KAAK,MAAM,EAAE,CAAA;QACrB,IAAI,EAAE,KAAK,MAAM,EAAE,CAAA;QACnB,KAAK,EAAE,MAAM,CAAA;KACd,CAAC,CAAA;CACH,CAAA;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,cAAc,EACtB,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,uBAAuB,EAAE,8IAepC;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,KAAK,MAAM,EAAE,GAAG,KAAK,MAAM,EAAE,CAEjE;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAC1C,OAAO,EAAE;IAAE,IAAI,CAAC,EAAE,KAAK,CAAC;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAA;KAAE,CAAC,CAAA;CAAE,EAClF,kBAAkB,EAAE,MAAM,GACzB,MAAM,GAAG,SAAS,CAkBpB;AAED,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,CAAA"}