@zoralabs/protocol-sdk 0.9.2 → 0.9.4-PRE.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zoralabs/protocol-sdk",
-  "version": "0.9.2",
+  "version": "0.9.4-PRE.0",
   "repository": "https://github.com/ourzora/zora-protocol",
   "license": "MIT",
   "type": "module",
@@ -15,9 +15,18 @@
       "default": "./dist/index.cjs"
     }
   },
+  "scripts": {
+    "build": "pnpm tsup",
+    "prepack": "pnpm build",
+    "test:js": "vitest src",
+    "test:integration": "vitest test-integration",
+    "generate-types": "echo 'npx is used here because this is a rare operation' && npx openapi-typescript https://api.zora.co/premint/openapi.json -o src/apis/generated/premint-api-types.ts",
+    "prettier:write": "prettier --write 'src/**/*.ts' 'test-integration/**/*.ts'",
+    "lint": "prettier --check 'src/**/*.ts' 'test-integration/**/*.ts'"
+  },
   "dependencies": {
-    "abitype": "^1.0.2",
-    "@zoralabs/protocol-deployments": "^0.3.0"
+    "@zoralabs/protocol-deployments": "workspace:^",
+    "abitype": "^1.0.2"
   },
   "peerDependencies": {
     "viem": "^2.13.2"
@@ -28,6 +37,7 @@
     "@reservoir0x/reservoir-sdk": "^2.0.11",
     "@types/node": "^20.13.0",
     "@types/semver": "^7.5.8",
+    "@zoralabs/tsconfig": "workspace:^",
     "graphql-prettier": "^1.0.6",
     "multiformats": "^13.2.0",
     "prettier": "^3.0.3",
@@ -36,15 +46,6 @@
     "tsup": "^7.2.0",
     "typescript": "^5.2.2",
     "vite": "^4.5.0",
-    "vitest": "^2.0.5",
-    "@zoralabs/tsconfig": "^0.0.0"
-  },
-  "scripts": {
-    "build": "pnpm tsup",
-    "test:js": "vitest src",
-    "test:integration": "vitest test-integration",
-    "generate-types": "echo 'npx is used here because this is a rare operation' && npx openapi-typescript https://api.zora.co/premint/openapi.json -o src/apis/generated/premint-api-types.ts",
-    "prettier:write": "prettier --write 'src/**/*.ts' 'test-integration/**/*.ts'",
-    "lint": "prettier --check 'src/**/*.ts' 'test-integration/**/*.ts'"
+    "vitest": "^2.0.5"
   }
-}
+}

package/src/create/1155-create-helper.test.ts

@@ -6,10 +6,17 @@ import {
 import { createCreatorClient } from "src/sdk";
 import {
   zoraCreator1155ImplABI,
+  zoraTimedSaleStrategyABI,
   zoraTimedSaleStrategyAddress,
 } from "@zoralabs/protocol-deployments";
 import { waitForSuccess } from "src/test-utils";
-import { Address, parseEther, PublicClient, TransactionReceipt } from "viem";
+import {
+  Address,
+  erc20Abi,
+  parseEther,
+  PublicClient,
+  TransactionReceipt,
+} from "viem";
 import { makePrepareMint1155TokenParams } from "src/mint/mint-transactions";
 import { forkUrls, makeAnvilTest } from "src/anvil";
 import { zora } from "viem/chains";
@@ -67,6 +74,13 @@ function randomNewContract(): NewContractParams {
   };
 }
 
+const add24HoursToNowInSeconds = (): number => {
+  const currentTimeInSeconds = Math.floor(Date.now() / 1000);
+  const add24Hours = 24 * 60 * 60;
+
+  return currentTimeInSeconds + add24Hours;
+};
+
 describe("create-helper", () => {
   anvilTest(
     "when no sales config is provided, it creates a new 1155 contract and token using the timed sale strategy",
@@ -78,15 +92,24 @@ describe("create-helper", () => {
         chainId: chain.id,
         publicClient: publicClient,
       });
+
+      const saleStart = 5n;
+      const saleEnd = BigInt(add24HoursToNowInSeconds());
+      const contract = randomNewContract();
       const {
         parameters: parameters,
         contractAddress,
         newTokenId,
       } = await creatorClient.create1155({
-        contract: randomNewContract(),
+        contract,
         token: {
           tokenMetadataURI: demoTokenMetadataURI,
           mintToCreatorCount: 1,
+          salesConfig: {
+            saleStart,
+            saleEnd,
+            type: "timed",
+          },
         },
         account: creatorAddress,
       });
@@ -103,6 +126,27 @@ describe("create-helper", () => {
         contractAddress,
       );
 
+      const salesConfig = await publicClient.readContract({
+        abi: zoraTimedSaleStrategyABI,
+        address:
+          zoraTimedSaleStrategyAddress[
+            chain.id as keyof typeof zoraTimedSaleStrategyAddress
+          ],
+        functionName: "sale",
+        args: [contractAddress, newTokenId],
+      });
+
+      expect(salesConfig.saleEnd).toBe(saleEnd);
+      expect(salesConfig.saleStart).toBe(saleStart);
+
+      const erc20Name = await publicClient.readContract({
+        abi: erc20Abi,
+        address: salesConfig.erc20zAddress,
+        functionName: "name",
+      });
+
+      expect(erc20Name).toBe(contract.name);
+
       expect(
         await minterIsMinterOnToken({
           contractAddress,

package/src/create/1155-create-helper.ts

@@ -206,6 +206,7 @@ async function createNew1155ContractAndToken({
     nextTokenId,
     token,
     getAdditionalSetupActions,
+    contractName: contract.name,
   });
 
   const request = makeCreateContractAndTokenCall({
@@ -263,7 +264,7 @@ async function createNew1155Token({
   chainId: number;
   contractGetter: IContractGetter;
 }): Promise<CreateNew1155TokenReturn> {
-  const { nextTokenId, contractVersion, mintFee } =
+  const { nextTokenId, contractVersion, mintFee, name } =
     await contractGetter.getContractInfo({ contractAddress, retries: 5 });
 
   const {
@@ -277,6 +278,7 @@ async function createNew1155Token({
     nextTokenId,
     token,
     getAdditionalSetupActions,
+    contractName: name,
   });
 
   const request = makeCreateTokenCall({
@@ -311,11 +313,13 @@ async function prepareSetupActions({
   contractVersion,
   nextTokenId,
   token,
+  contractName,
   getAdditionalSetupActions,
 }: {
   chainId: number;
   contractVersion: string;
   nextTokenId: bigint;
+  contractName: string;
 } & CreateNew1155ParamsBase) {
   const {
     minter,
@@ -327,6 +331,7 @@ async function prepareSetupActions({
     contractVersion,
     nextTokenId,
     ...token,
+    contractName,
   });
 
   const setupActions = getAdditionalSetupActions

package/src/create/minter-defaults.ts

@@ -9,7 +9,6 @@ import {
   ConcreteSalesConfig,
   TimedSaleParamsType,
 } from "./types";
-import { fetchTokenMetadata } from "src/ipfs/token-metadata";
 
 // Sales end forever amount (uint64 max)
 export const SALE_END_FOREVER = 18446744073709551615n;
@@ -75,30 +74,19 @@ export const parseNameIntoSymbol = (name: string) => {
   return result;
 };
 
-async function fetchTokenNameFromMetadata(
-  tokenMetadataURI: string,
-): Promise<string> {
-  const tokenMetadata = await fetchTokenMetadata(tokenMetadataURI);
-
-  if (!tokenMetadata.name) {
-    throw new Error("No name found in token metadata");
-  }
-
-  return tokenMetadata.name;
-}
 const timedSaleSettingsWithDefaults = async (
   params: TimedSaleParamsType,
-  tokenMetadataURI: string,
+  contractName: string,
 ): Promise<Concrete<TimedSaleParamsType>> => {
   // If the name is not provided, try to fetch it from the metadata
-  const erc20Name =
-    params.erc20Name || (await fetchTokenNameFromMetadata(tokenMetadataURI));
+  const erc20Name = params.erc20Name || contractName;
   const symbol = params.erc20Symbol || parseNameIntoSymbol(erc20Name);
 
   return {
     type: "timed",
     ...DEFAULT_SALE_START_AND_END,
-    erc20Name,
+    ...params,
+    erc20Name: erc20Name,
     erc20Symbol: symbol,
   };
 };
@@ -112,14 +100,17 @@ const isErc20 = (
 const isFixedPrice = (
   salesConfig: SalesConfigParamsType,
 ): salesConfig is FixedPriceParamsType => {
-  return (salesConfig as FixedPriceParamsType).pricePerToken > 0n;
+  return (
+    salesConfig.type === "fixedPrice" ||
+    (salesConfig as FixedPriceParamsType).pricePerToken > 0n
+  );
 };
 
 export const getSalesConfigWithDefaults = async (
   salesConfig: SalesConfigParamsType | undefined,
-  tokenMetadataURI: string,
+  contractName: string,
 ): Promise<ConcreteSalesConfig> => {
-  if (!salesConfig) return timedSaleSettingsWithDefaults({}, tokenMetadataURI);
+  if (!salesConfig) return timedSaleSettingsWithDefaults({}, contractName);
   if (isAllowList(salesConfig)) {
     return allowListWithDefaults(salesConfig);
   }
@@ -130,5 +121,5 @@ export const getSalesConfigWithDefaults = async (
     return fixedPriceSettingsWithDefaults(salesConfig);
   }
 
-  return timedSaleSettingsWithDefaults(salesConfig, tokenMetadataURI);
+  return timedSaleSettingsWithDefaults(salesConfig, contractName);
 };

package/src/create/token-setup.ts

@@ -9,6 +9,7 @@ import { setupMinters } from "./minter-setup";
 async function applyNew1155Defaults(
   props: CreateNew1155TokenProps,
   ownerAddress: Address,
+  contractName: string,
 ): Promise<New1155Token> {
   const { payoutRecipient: fundsRecipient } = props;
   const fundsRecipientOrOwner =
@@ -26,7 +27,7 @@ async function applyNew1155Defaults(
     tokenMetadataURI: props.tokenMetadataURI,
     salesConfig: await getSalesConfigWithDefaults(
       props.salesConfig,
-      props.tokenMetadataURI,
+      contractName,
     ),
   };
 }
@@ -117,6 +118,8 @@ export async function constructCreate1155TokenCalls(
     ContractProps & {
       ownerAddress: Address;
       chainId: number;
+    } & {
+      contractName: string;
     },
 ): Promise<{
   setupActions: `0x${string}`[];
@@ -134,6 +137,7 @@ export async function constructCreate1155TokenCalls(
   const new1155TokenPropsWithDefaults = await applyNew1155Defaults(
     props,
     ownerAddress,
+    props.contractName,
   );
 
   const verifyTokenIdExpected = encodeFunctionData({

package/src/create/types.ts

@@ -29,7 +29,7 @@ export type FixedPriceParamsType = SaleStartAndEnd &
 
 export type TimedSaleParamsType = SaleStartAndEnd & {
   type?: "timed";
-  // Name of the erc20z token to create for the secondary sale.  If not provided, fetches the metadata from the tokenMetadataURI and uses the name from it.
+  // Name of the erc20z token to create for the secondary sale.  If not provided, uses the contract name
   erc20Name?: string;
   // Symbol of the erc20z token to create for the secondary sale.  If not provided, extracts it from the name.
   erc20Symbol?: string;