@zoralabs/protocol-sdk 0.7.5 → 0.8.0

package/dist/sdk.d.ts

@@ -8,7 +8,8 @@ export type CreatorClient = {
     createPremint: PremintClient["createPremint"];
     updatePremint: PremintClient["updatePremint"];
     deletePremint: PremintClient["deletePremint"];
-    create1155: Create1155Client["createNew1155Token"];
+    create1155: Create1155Client["createNew1155"];
+    create1155OnExistingContract: Create1155Client["createNew1155OnExistingContract"];
 };
 export type CollectorClient = {
     getPremint: PremintClient["getPremint"];

package/dist/sdk.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../src/sdk.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EAEd,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,WAAW,EAAoB,MAAM,8BAA8B,CAAC;AAE7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAElD,MAAM,MAAM,aAAa,GAAG;IAC1B,aAAa,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IAC9C,aAAa,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IAC9C,aAAa,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IAC9C,UAAU,EAAE,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;CACpD,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IACxC,gCAAgC,EAAE,aAAa,CAAC,2BAA2B,CAAC,CAAC;IAC7E,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IACzB,YAAY,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC;IACzC,QAAQ,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IAC5B,mBAAmB,EAAE,UAAU,CAAC,eAAe,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG;IAC/C,iFAAiF;IACjF,UAAU,CAAC,EAAE,WAAW,CAAC;CAC1B,CAAC;AAEF;;;;;KAKK;AACL,wBAAgB,mBAAmB,CACjC,YAAY,EAAE,mBAAmB,GAChC,aAAa,CAmBf;AAED,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG;IACjD,kEAAkE;IAClE,aAAa,CAAC,EAAE,WAAW,CAAC;IAC5B,4EAA4E;IAC5E,UAAU,CAAC,EAAE,kBAAkB,CAAC;CACjC,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,qBAAqB,GAC5B,eAAe,CAwBjB"}
+{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../src/sdk.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EAEd,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,WAAW,EAAoB,MAAM,8BAA8B,CAAC;AAE7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAElD,MAAM,MAAM,aAAa,GAAG;IAC1B,aAAa,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IAC9C,aAAa,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IAC9C,aAAa,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IAC9C,UAAU,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;IAC9C,4BAA4B,EAAE,gBAAgB,CAAC,iCAAiC,CAAC,CAAC;CACnF,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IACxC,gCAAgC,EAAE,aAAa,CAAC,2BAA2B,CAAC,CAAC;IAC7E,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IACzB,YAAY,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC;IACzC,QAAQ,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IAC5B,mBAAmB,EAAE,UAAU,CAAC,eAAe,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG;IAC/C,iFAAiF;IACjF,UAAU,CAAC,EAAE,WAAW,CAAC;CAC1B,CAAC;AAEF;;;;;KAKK;AACL,wBAAgB,mBAAmB,CACjC,YAAY,EAAE,mBAAmB,GAChC,aAAa,CAqBf;AAED,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG;IACjD,kEAAkE;IAClE,aAAa,CAAC,EAAE,WAAW,CAAC;IAC5B,4EAA4E;IAC5E,UAAU,CAAC,EAAE,kBAAkB,CAAC;CACjC,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,qBAAqB,GAC5B,eAAe,CAwBjB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zoralabs/protocol-sdk",
-  "version": "0.7.5",
+  "version": "0.8.0",
   "repository": "https://github.com/ourzora/zora-protocol",
   "license": "MIT",
   "type": "module",
@@ -17,13 +17,12 @@
   },
   "dependencies": {
     "abitype": "^1.0.2",
-    "@zoralabs/protocol-deployments": "^0.2.2"
+    "@zoralabs/protocol-deployments": "^0.3.0"
   },
   "peerDependencies": {
     "viem": "^2.13.2"
   },
   "devDependencies": {
-    "@fleekhq/fleek-storage-js": "^1.0.24",
     "@lavamoat/preinstall-always-fail": "2.0.0",
     "@reservoir0x/relay-sdk": "^0.3.8",
     "@reservoir0x/reservoir-sdk": "^2.0.11",

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

@@ -1,6 +1,8 @@
 import { describe, expect } from "vitest";
-import { getTokenIdFromCreateReceipt } from "./1155-create-helper";
-import { anvilTest } from "src/anvil";
+import {
+  getContractAddressFromReceipt,
+  getTokenIdFromCreateReceipt,
+} from "./1155-create-helper";
 import { createCreatorClient } from "src/sdk";
 import { zoraCreator1155ImplABI } from "@zoralabs/protocol-deployments";
 import { waitForSuccess } from "src/test-utils";
@@ -9,10 +11,18 @@ import {
   MintableParameters,
   makePrepareMint1155TokenParams,
 } from "src/mint/mint-transactions";
+import { forkUrls, makeAnvilTest } from "src/anvil";
+import { zora } from "viem/chains";
 
 const demoTokenMetadataURI = "ipfs://DUMMY/token.json";
 const demoContractMetadataURI = "ipfs://DUMMY/contract.json";
 
+const anvilTest = makeAnvilTest({
+  forkUrl: forkUrls.zoraMainnet,
+  forkBlockNumber: 18094820,
+  anvilChainId: zora.id,
+});
+
 describe("create-helper", () => {
   anvilTest(
     "creates a new 1155 contract and token",
@@ -24,24 +34,27 @@ describe("create-helper", () => {
         chainId: chain.id,
         publicClient: publicClient,
       });
-      const { parameters: request } = await creatorClient.create1155({
-        contract: {
-          name: "testContract",
-          uri: demoContractMetadataURI,
-        },
-        token: {
-          tokenMetadataURI: demoTokenMetadataURI,
-          mintToCreatorCount: 1,
-        },
-        account: creatorAddress,
-      });
-      const { request: simulationResponse } =
-        await publicClient.simulateContract(request);
-      const hash = await walletClient.writeContract(simulationResponse);
+      const { parameters, contractAddress: collectionAddress } =
+        await creatorClient.create1155({
+          contract: {
+            name: "testContract",
+            uri: demoContractMetadataURI,
+          },
+          token: {
+            tokenMetadataURI: demoTokenMetadataURI,
+            mintToCreatorCount: 1,
+          },
+          account: creatorAddress,
+        });
+      const { request } = await publicClient.simulateContract(parameters);
+      const hash = await walletClient.writeContract(request);
       const receipt = await publicClient.waitForTransactionReceipt({ hash });
       expect(receipt).not.toBeNull();
       expect(receipt.to).to.equal("0x777777c338d93e2c7adf08d102d45ca7cc4ed021");
       expect(getTokenIdFromCreateReceipt(receipt)).to.be.equal(1n);
+      expect(getContractAddressFromReceipt(receipt)).to.be.equal(
+        collectionAddress,
+      );
     },
     20 * 1000,
   );
@@ -56,25 +69,18 @@ describe("create-helper", () => {
         publicClient: publicClient,
       });
 
-      const {
-        parameters: request,
-        collectionAddress: contractAddress,
-        contractExists,
-      } = await creatorClient.create1155({
-        contract: {
-          name: "testContract2",
-          uri: demoContractMetadataURI,
-        },
-        token: {
-          tokenMetadataURI: demoTokenMetadataURI,
-          mintToCreatorCount: 3,
-        },
-        account: creatorAccount,
-      });
-      expect(contractAddress).to.be.equal(
-        "0xb1A8928dF830C21eD682949Aa8A83C1C215194d3",
-      );
-      expect(contractExists).to.be.false;
+      const { parameters: request, contractAddress: contractAddress } =
+        await creatorClient.create1155({
+          contract: {
+            name: "testContract2",
+            uri: demoContractMetadataURI,
+          },
+          token: {
+            tokenMetadataURI: demoTokenMetadataURI,
+            mintToCreatorCount: 3,
+          },
+          account: creatorAccount,
+        });
       const { request: simulateResponse } =
         await publicClient.simulateContract(request);
       const hash = await walletClient.writeContract(simulateResponse);
@@ -93,21 +99,15 @@ describe("create-helper", () => {
         }),
       ).toBe(3n);
 
-      const newTokenOnExistingContract = await creatorClient.create1155({
-        contract: {
-          name: "testContract2",
-          uri: demoContractMetadataURI,
-        },
-        token: {
-          tokenMetadataURI: demoTokenMetadataURI,
-          mintToCreatorCount: 2,
-        },
-        account: creatorAccount,
-      });
-      expect(newTokenOnExistingContract.collectionAddress).to.be.equal(
-        "0xb1A8928dF830C21eD682949Aa8A83C1C215194d3",
-      );
-      expect(newTokenOnExistingContract.contractExists).to.be.true;
+      const newTokenOnExistingContract =
+        await creatorClient.create1155OnExistingContract({
+          contractAddress: contractAddress,
+          token: {
+            tokenMetadataURI: demoTokenMetadataURI,
+            mintToCreatorCount: 2,
+          },
+          account: creatorAccount,
+        });
       const { request: simulateRequest } = await publicClient.simulateContract(
         newTokenOnExistingContract.parameters,
       );
@@ -132,7 +132,11 @@ describe("create-helper", () => {
         chainId: chain.id,
         publicClient: publicClient,
       });
-      const { parameters: request } = await creatorClient.create1155({
+      const {
+        parameters: request,
+        contractAddress: collectionAddress,
+        newTokenId,
+      } = await creatorClient.create1155({
         contract: {
           name: "testContract",
           uri: demoContractMetadataURI,
@@ -148,15 +152,15 @@ describe("create-helper", () => {
       const hash = await walletClient.writeContract(simulationResponse);
       const receipt = await publicClient.waitForTransactionReceipt({ hash });
       expect(receipt).not.toBeNull();
-      expect(receipt.to).to.equal("0xa72724cc3dcef210141a1b84c61824074151dc99");
-      expect(getTokenIdFromCreateReceipt(receipt)).to.be.equal(2n);
+      expect(receipt.to).to.equal("0x777777c338d93e2c7adf08d102d45ca7cc4ed021");
+      expect(getTokenIdFromCreateReceipt(receipt)).to.be.equal(newTokenId);
 
       expect(
         await publicClient.readContract({
           abi: zoraCreator1155ImplABI,
-          address: "0xa72724cc3dcef210141a1b84c61824074151dc99",
+          address: collectionAddress,
           functionName: "createReferrals",
-          args: [2n],
+          args: [newTokenId],
         }),
       ).to.be.equal(createReferral);
     },
@@ -177,10 +181,11 @@ describe("create-helper", () => {
       });
       const {
         parameters: request,
-        collectionAddress,
         newTokenId,
         newToken,
         minter,
+        contractAddress: collectionAddress,
+        contractVersion,
       } = await creatorClient.create1155({
         contract: {
           name: "testContract",
@@ -200,7 +205,7 @@ describe("create-helper", () => {
 
       const salesConfigAndTokenInfo: MintableParameters = {
         mintFeePerQuantity: parseEther("0.000777"),
-        contractVersion: "2.8.0",
+        contractVersion,
         salesConfig: {
           saleType: "fixedPrice",
           address: minter,
@@ -257,10 +262,11 @@ describe("create-helper", () => {
 
       const {
         parameters: request,
-        collectionAddress,
+        contractAddress: collectionAddress,
         newTokenId,
         newToken,
         minter,
+        contractVersion,
       } = await creatorClient.create1155({
         contract: {
           name: "testContract",
@@ -283,7 +289,7 @@ describe("create-helper", () => {
 
       const salesConfigAndTokenInfo: MintableParameters = {
         mintFeePerQuantity: parseEther("0.000777"),
-        contractVersion: "2.8.0",
+        contractVersion,
         salesConfig: {
           saleType: "fixedPrice",
           address: minter,

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

@@ -8,13 +8,23 @@ import type {
   Address,
   Hex,
   PublicClient,
-  SimulateContractParameters,
   TransactionReceipt,
 } from "viem";
 import { decodeEventLog } from "viem";
 import { makeContractParameters } from "src/utils";
-import { getContractInfo } from "./contract-setup";
-import { ContractType, CreateNew1155Params, New1155Token } from "./types";
+import {
+  getContractInfoExistingContract,
+  getDeterministicContractAddress,
+  new1155ContractVersion,
+} from "./contract-setup";
+import {
+  CreateNew1155ContractAndTokenReturn,
+  CreateNew1155ContractParams,
+  CreateNew1155ParamsBase,
+  CreateNew1155TokenParams,
+  CreateNew1155TokenReturn,
+  NewContractParams,
+} from "./types";
 import { constructCreate1155TokenCalls } from "./token-setup";
 
 // Default royalty bps
@@ -22,7 +32,7 @@ const ROYALTY_BPS_DEFAULT = 1000;
 
 export const getTokenIdFromCreateReceipt = (
   receipt: TransactionReceipt,
-): bigint | undefined => {
+): bigint => {
   for (const data of receipt.logs) {
     try {
       const decodedLog = decodeEventLog({
@@ -35,73 +45,84 @@ export const getTokenIdFromCreateReceipt = (
       }
     } catch (err: any) {}
   }
+
+  throw new Error(
+    "No event found in receipt that could be used to get tokenId",
+  );
+};
+
+export const getContractAddressFromReceipt = (
+  receipt: TransactionReceipt,
+): Address => {
+  for (const data of receipt.logs) {
+    try {
+      const decodedLog = decodeEventLog({
+        abi: zoraCreator1155FactoryImplABI,
+        eventName: "SetupNewContract",
+        ...data,
+      });
+      if (decodedLog && decodedLog.eventName === "SetupNewContract") {
+        return decodedLog.args.newContract;
+      }
+    } catch (err: any) {}
+  }
+
+  throw new Error(
+    "No event found in receipt that could be used to get contract address",
+  );
 };
 
-type CreateNew1155TokenReturn = {
-  parameters: SimulateContractParameters<
-    any,
-    any,
-    any,
-    any,
-    any,
-    Account | Address
-  >;
+type MakeContractParametersBase = {
+  account: Address | Account;
+
   tokenSetupActions: Hex[];
-  collectionAddress: Address;
-  newTokenId: bigint;
-  newToken: New1155Token;
-  minter: Address;
-  contractExists: boolean;
 };
 
-function makeCreateContractAndTokenCall({
-  contractExists,
-  contractAddress,
-  contract,
+export function makeCreateContractAndTokenCall({
   account,
+  contract,
   royaltyBPS,
-  tokenSetupActions,
   fundsRecipient,
+  tokenSetupActions,
+  chainId,
 }: {
-  contractExists: boolean;
-  contractAddress: Address;
-  contract: ContractType;
-  account: Address | Account;
+  chainId: number;
+  contract: NewContractParams;
   royaltyBPS?: number;
   fundsRecipient?: Address;
-  tokenSetupActions: Hex[];
-}) {
-  if (!contractAddress && typeof contract === "string") {
-    throw new Error("Invariant: contract cannot be missing and an address");
-  }
-
-  if (!contractExists) {
-    if (typeof contract === "string") {
-      throw new Error("Invariant: expected contract object");
-    }
-
-    const accountAddress =
-      typeof account === "string" ? account : account.address;
-    return makeContractParameters({
-      abi: zoraCreator1155FactoryImplABI,
-      functionName: "createContractDeterministic",
-      account,
-      address: zoraCreator1155FactoryImplAddress[999],
-      args: [
-        contract.uri,
-        contract.name,
-        {
-          // deprecated
-          royaltyMintSchedule: 0,
-          royaltyBPS: royaltyBPS || ROYALTY_BPS_DEFAULT,
-          royaltyRecipient: fundsRecipient || accountAddress,
-        },
-        contract.defaultAdmin || accountAddress,
-        tokenSetupActions,
+} & MakeContractParametersBase) {
+  const accountAddress =
+    typeof account === "string" ? account : account.address;
+  return makeContractParameters({
+    abi: zoraCreator1155FactoryImplABI,
+    functionName: "createContractDeterministic",
+    account,
+    address:
+      zoraCreator1155FactoryImplAddress[
+        chainId as keyof typeof zoraCreator1155FactoryImplAddress
       ],
-    });
-  }
+    args: [
+      contract.uri,
+      contract.name,
+      {
+        // deprecated
+        royaltyMintSchedule: 0,
+        royaltyBPS: royaltyBPS || ROYALTY_BPS_DEFAULT,
+        royaltyRecipient: fundsRecipient || accountAddress,
+      },
+      contract.defaultAdmin || accountAddress,
+      tokenSetupActions,
+    ],
+  });
+}
 
+function makeCreateTokenCall({
+  contractAddress,
+  account,
+  tokenSetupActions,
+}: {
+  contractAddress: Address;
+} & MakeContractParametersBase) {
   return makeContractParameters({
     abi: zoraCreator1155ImplABI,
     functionName: "multicall",
@@ -126,34 +147,146 @@ export class Create1155Client {
     this.publicClient = publicClient;
   }
 
-  async createNew1155Token(props: CreateNew1155Params) {
-    return createNew1155Token({
+  async createNew1155(
+    props: CreateNew1155ContractParams,
+  ): Promise<CreateNew1155ContractAndTokenReturn> {
+    return createNew1155ContractAndToken({
       ...props,
       publicClient: this.publicClient,
       chainId: this.chainId,
     });
   }
+
+  async createNew1155OnExistingContract({
+    contractAddress: contract,
+    account,
+    token,
+    getAdditionalSetupActions,
+  }: CreateNew1155TokenParams): Promise<CreateNew1155TokenReturn> {
+    return createNew1155Token({
+      contractAddress: contract,
+      account,
+      token,
+      getAdditionalSetupActions,
+      publicClient: this.publicClient,
+      chainId: this.chainId,
+    });
+  }
 }
 
-async function createNew1155Token({
+async function createNew1155ContractAndToken({
   contract,
   account,
+  chainId,
+  token,
+  publicClient,
+  getAdditionalSetupActions,
+}: CreateNew1155ContractParams & {
+  publicClient: Pick<PublicClient, "readContract">;
+  chainId: number;
+}): Promise<CreateNew1155ContractAndTokenReturn> {
+  const nextTokenId = 1n;
+  const contractVersion = new1155ContractVersion(chainId);
+
+  const {
+    minter,
+    newToken,
+    setupActions: tokenSetupActions,
+  } = prepareSetupActions({
+    chainId,
+    account,
+    contractVersion,
+    nextTokenId,
+    token,
+    getAdditionalSetupActions,
+  });
+
+  const request = makeCreateContractAndTokenCall({
+    contract,
+    account,
+    chainId,
+    tokenSetupActions,
+    fundsRecipient: token.payoutRecipient,
+    royaltyBPS: token.royaltyBPS,
+  });
+
+  const contractAddress = await getDeterministicContractAddress({
+    account,
+    publicClient,
+    setupActions: tokenSetupActions,
+    chainId,
+    contract,
+  });
+
+  return {
+    parameters: request,
+    tokenSetupActions,
+    newTokenId: nextTokenId,
+    newToken,
+    contractAddress: contractAddress,
+    contractVersion,
+    minter,
+  };
+}
+
+async function createNew1155Token({
+  contractAddress: contractAddress,
+  account,
   getAdditionalSetupActions,
-  token: tokenConfig,
+  token,
   publicClient,
   chainId,
-}: CreateNew1155Params & {
+}: CreateNew1155TokenParams & {
   publicClient: Pick<PublicClient, "readContract">;
   chainId: number;
 }): Promise<CreateNew1155TokenReturn> {
-  const { contractExists, contractAddress, nextTokenId, contractVersion } =
-    await getContractInfo({
+  const { nextTokenId, contractVersion } =
+    await getContractInfoExistingContract({
       publicClient,
-      chainId: chainId,
-      contract,
-      account,
+      contractAddress: contractAddress,
     });
 
+  const {
+    minter,
+    newToken,
+    setupActions: tokenSetupActions,
+  } = prepareSetupActions({
+    chainId,
+    account,
+    contractVersion,
+    nextTokenId,
+    token,
+    getAdditionalSetupActions,
+  });
+
+  const request = makeCreateTokenCall({
+    contractAddress,
+    account,
+    tokenSetupActions,
+  });
+
+  return {
+    parameters: request,
+    tokenSetupActions,
+    newTokenId: nextTokenId,
+    newToken,
+    contractVersion,
+    minter,
+  };
+}
+
+function prepareSetupActions({
+  chainId,
+  account,
+  contractVersion,
+  nextTokenId,
+  token,
+  getAdditionalSetupActions,
+}: {
+  chainId: number;
+  contractVersion: string;
+  nextTokenId: bigint;
+} & CreateNew1155ParamsBase) {
   const {
     minter,
     newToken,
@@ -163,36 +296,17 @@ async function createNew1155Token({
     ownerAddress: account,
     contractVersion,
     nextTokenId,
-    ...tokenConfig,
+    ...token,
   });
 
   const setupActions = getAdditionalSetupActions
     ? [
         ...getAdditionalSetupActions({
           tokenId: nextTokenId,
-          contractAddress,
         }),
         ...tokenSetupActions,
       ]
     : tokenSetupActions;
 
-  const request = makeCreateContractAndTokenCall({
-    contractExists,
-    contractAddress,
-    contract,
-    account,
-    tokenSetupActions: setupActions,
-    royaltyBPS: tokenConfig.royaltyBPS,
-    fundsRecipient: tokenConfig.payoutRecipient,
-  });
-
-  return {
-    parameters: request,
-    tokenSetupActions,
-    collectionAddress: contractAddress,
-    contractExists,
-    newTokenId: nextTokenId,
-    newToken,
-    minter,
-  };
+  return { minter, newToken, setupActions };
 }