@zoralabs/protocol-sdk 0.5.4 → 0.5.6-exports.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @zoralabs/protocol-sdk
 
+## 0.5.6-exports.0
+
+### Patch Changes
+
+- b10b8d05: Publishing package in format that supports commonjs imports by specifying exports
+- Updated dependencies [b10b8d05]
+  - @zoralabs/protocol-deployments@0.1.2-exports.0
+
+## 0.5.5
+
+### Patch Changes
+
+- 8a87809: Undo changes to package export because it didn't properly bundle all files in `dist`
+
 ## 0.5.4
 
 ### Patch Changes

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@zoralabs/protocol-sdk",
-  "version": "0.5.4",
+  "version": "0.5.6-exports.0",
   "repository": "https://github.com/ourzora/zora-protocol",
   "license": "MIT",
+  "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "sideEffects": false,
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -13,7 +15,6 @@
       "default": "./dist/index.cjs"
     }
   },
-  "type": "module",
   "scripts": {
     "build": "tsup",
     "prepack": "yarn build",
@@ -24,7 +25,7 @@
     "lint": "prettier --check 'src/**/*.ts' 'test-integration/**/*.ts'"
   },
   "dependencies": {
-    "@zoralabs/protocol-deployments": "*",
+    "@zoralabs/protocol-deployments": "0.1.2-exports.0",
     "abitype": "^0.10.3",
     "vite": "4.5.0"
   },

package/.turbo/turbo-build.log

@@ -1,16 +0,0 @@
-warning package.json: "dependencies" has dependency "vite" with range "4.5.0" that collides with a dependency in "devDependencies" of the same name with version "^4.5.0"
-$ tsup
-CLI Building entry: src/index.ts
-CLI Using tsconfig: tsconfig.build.json
-CLI tsup v7.3.0
-CLI Using tsup config: /home/runner/work/zora-protocol-private/zora-protocol-private/packages/protocol-sdk/tsup.config.js
-CLI Target: es2021
-CLI Cleaning output folder
-CJS Build start
-ESM Build start
-CJS dist/index.cjs     50.17 KB
-CJS dist/index.cjs.map 97.10 KB
-CJS ⚡️ Build success in 67ms
-ESM dist/index.js     46.25 KB
-ESM dist/index.js.map 97.16 KB
-ESM ⚡️ Build success in 74ms

package/src/anvil.ts

@@ -1,111 +0,0 @@
-import { spawn } from "node:child_process";
-import { join } from "path";
-import { test } from "vitest";
-import {
-  Chain,
-  PublicClient,
-  TestClient,
-  WalletClient,
-  createPublicClient,
-  createTestClient,
-  createWalletClient,
-  http,
-} from "viem";
-import { foundry, zora } from "viem/chains";
-
-export interface AnvilViemClientsTest {
-  viemClients: {
-    walletClient: WalletClient;
-    publicClient: PublicClient;
-    testClient: TestClient;
-    chain: Chain;
-  };
-}
-
-async function waitForAnvilInit(anvil: any) {
-  return new Promise((resolve) => {
-    anvil.stdout.once("data", () => {
-      resolve(true);
-    });
-  });
-}
-
-export type AnvilTestForkSettings = {
-  forkUrl: string;
-  forkBlockNumber: number;
-  anvilChainId?: number;
-};
-
-export const makeAnvilTest = ({
-  forkUrl,
-  forkBlockNumber,
-  anvilChainId = 31337,
-}: AnvilTestForkSettings) =>
-  test.extend<AnvilViemClientsTest>({
-    viemClients: async ({ task }, use) => {
-      console.log("setting up clients for ", task.name);
-      const port = Math.floor(Math.random() * 2000) + 4000;
-      const anvil = spawn(
-        "anvil",
-        [
-          "--port",
-          `${port}`,
-          "--fork-url",
-          forkUrl,
-          "--fork-block-number",
-          `${forkBlockNumber}`,
-          "--chain-id",
-          anvilChainId.toString(),
-        ],
-        {
-          cwd: join(__dirname, ".."),
-          killSignal: "SIGINT",
-        },
-      );
-      const anvilHost = `http://0.0.0.0:${port}`;
-      await waitForAnvilInit(anvil);
-
-      const chain: Chain = {
-        ...foundry,
-        id: anvilChainId,
-      };
-
-      const walletClient = createWalletClient({
-        chain,
-        transport: http(anvilHost),
-      });
-
-      const testClient = createTestClient({
-        chain,
-        mode: "anvil",
-        transport: http(anvilHost),
-      });
-
-      const publicClient = createPublicClient({
-        chain,
-        transport: http(anvilHost),
-      });
-
-      await use({
-        publicClient,
-        walletClient,
-        testClient,
-        chain,
-      });
-
-      // clean up function, called once after all tests run
-      anvil.kill("SIGINT");
-    },
-  });
-
-export const forkUrls = {
-  zoraMainnet: "https://rpc.zora.co/",
-  zoraGoerli: "https://testnet.rpc.zora.co",
-  zoraSepolia: "https://sepolia.rpc.zora.energy",
-};
-
-export const anvilTest = makeAnvilTest({
-  forkUrl: forkUrls.zoraMainnet,
-  forkBlockNumber: 7866332,
-  anvilChainId: zora.id,
-});

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

@@ -1,104 +0,0 @@
-import { parseEther } from "viem";
-import { describe, expect } from "vitest";
-import {
-  create1155CreatorClient,
-  getTokenIdFromCreateReceipt,
-} from "./1155-create-helper";
-import { anvilTest } from "src/anvil";
-
-const demoTokenMetadataURI = "ipfs://DUMMY/token.json";
-const demoContractMetadataURI = "ipfs://DUMMY/contract.json";
-
-describe("create-helper", () => {
-  anvilTest(
-    "creates a new contract given arguments",
-    async ({ viemClients: { testClient, publicClient, walletClient } }) => {
-      const addresses = await walletClient.getAddresses();
-      const creatorAddress = addresses[0]!;
-      await testClient.setBalance({
-        address: creatorAddress,
-        value: parseEther("1"),
-      });
-      const creatorClient = create1155CreatorClient({
-        publicClient: publicClient,
-      });
-      const { request } = await creatorClient.createNew1155Token({
-        contract: {
-          name: "testContract",
-          uri: demoContractMetadataURI,
-        },
-        tokenMetadataURI: demoTokenMetadataURI,
-        account: creatorAddress,
-        mintToCreatorCount: 1,
-      });
-      const { request: simulationResponse } =
-        await publicClient.simulateContract(request);
-      const hash = await walletClient.writeContract(simulationResponse);
-      const receipt = await publicClient.waitForTransactionReceipt({ hash });
-      expect(receipt).not.toBeNull();
-      expect(receipt.to).to.equal("0x777777c338d93e2c7adf08d102d45ca7cc4ed021");
-      expect(getTokenIdFromCreateReceipt(receipt)).to.be.equal(1n);
-    },
-    20 * 1000,
-  );
-  anvilTest(
-    "creates a new contract, than creates a new token on this existing contract",
-    async ({ viemClients: { publicClient, walletClient } }) => {
-      const addresses = await walletClient.getAddresses();
-      const creatorAccount = addresses[0]!;
-
-      const creatorClient = create1155CreatorClient({
-        publicClient: publicClient,
-      });
-
-      const { request, contractAddress, contractExists } =
-        await creatorClient.createNew1155Token({
-          contract: {
-            name: "testContract2",
-            uri: demoContractMetadataURI,
-          },
-          tokenMetadataURI: demoTokenMetadataURI,
-          account: creatorAccount,
-          mintToCreatorCount: 1,
-        });
-      expect(contractAddress).to.be.equal(
-        "0xb1A8928dF830C21eD682949Aa8A83C1C215194d3",
-      );
-      expect(contractExists).to.be.false;
-      const { request: simulateResponse } =
-        await publicClient.simulateContract(request);
-      const hash = await walletClient.writeContract(simulateResponse);
-      const receipt = await publicClient.waitForTransactionReceipt({ hash });
-      const firstTokenId = getTokenIdFromCreateReceipt(receipt);
-      expect(firstTokenId).to.be.equal(1n);
-      expect(receipt).not.toBeNull();
-
-      const newTokenOnExistingContract = await creatorClient.createNew1155Token(
-        {
-          contract: {
-            name: "testContract2",
-            uri: demoContractMetadataURI,
-          },
-          tokenMetadataURI: demoTokenMetadataURI,
-          account: creatorAccount,
-          mintToCreatorCount: 1,
-        },
-      );
-      expect(newTokenOnExistingContract.contractAddress).to.be.equal(
-        "0xb1A8928dF830C21eD682949Aa8A83C1C215194d3",
-      );
-      expect(newTokenOnExistingContract.contractExists).to.be.true;
-      const { request: simulateRequest } = await publicClient.simulateContract(
-        newTokenOnExistingContract.request,
-      );
-      const newHash = await walletClient.writeContract(simulateRequest);
-      const newReceipt = await publicClient.waitForTransactionReceipt({
-        hash: newHash,
-      });
-      const tokenId = getTokenIdFromCreateReceipt(newReceipt);
-      expect(tokenId).to.be.equal(2n);
-      expect(newReceipt).not.toBeNull();
-    },
-    20 * 1000,
-  );
-});

package/src/mint/mint-client.test.ts

@@ -1,114 +0,0 @@
-import { Address, parseAbi, parseEther } from "viem";
-import { zora } from "viem/chains";
-import { describe, expect } from "vitest";
-import { createMintClient } from "./mint-client";
-import { zoraCreator1155ImplABI } from "@zoralabs/protocol-deployments";
-import { anvilTest, forkUrls, makeAnvilTest } from "src/anvil";
-
-const erc721ABI = parseAbi([
-  "function balanceOf(address owner) public view returns (uint256)",
-] as const);
-
-describe("mint-helper", () => {
-  anvilTest(
-    "mints a new 1155 token",
-    async ({ viemClients }) => {
-      const { testClient, walletClient, publicClient } = viemClients;
-      const creatorAccount = (await walletClient.getAddresses())[0]!;
-      await testClient.setBalance({
-        address: creatorAccount,
-        value: parseEther("2000"),
-      });
-      const targetContract: Address =
-        "0xa2fea3537915dc6c7c7a97a82d1236041e6feb2e";
-      const targetTokenId = 1n;
-      const minter = createMintClient({ chain: zora });
-
-      const params = await minter.makePrepareMintTokenParams({
-        minterAccount: creatorAccount,
-        tokenId: targetTokenId,
-        tokenAddress: targetContract,
-        mintArguments: {
-          mintToAddress: creatorAccount,
-          quantityToMint: 1,
-        },
-      });
-
-      const oldBalance = await publicClient.readContract({
-        abi: zoraCreator1155ImplABI,
-        address: targetContract,
-        functionName: "balanceOf",
-        args: [creatorAccount, targetTokenId],
-      });
-
-      const simulationResult = await publicClient.simulateContract(params);
-
-      const hash = await walletClient.writeContract(simulationResult.request);
-      const receipt = await publicClient.waitForTransactionReceipt({ hash });
-      const newBalance = await publicClient.readContract({
-        abi: zoraCreator1155ImplABI,
-        address: targetContract,
-        functionName: "balanceOf",
-        args: [creatorAccount, targetTokenId],
-      });
-      expect(receipt).to.not.be.null;
-      expect(oldBalance).to.be.equal(0n);
-      expect(newBalance).to.be.equal(1n);
-    },
-    12 * 1000,
-  );
-
-  makeAnvilTest({
-    forkUrl: forkUrls.zoraMainnet,
-    forkBlockNumber: 6133407,
-  })(
-    "mints a new 721 token",
-    async ({ viemClients }) => {
-      const { testClient, walletClient, publicClient } = viemClients;
-      const creatorAccount = (await walletClient.getAddresses())[0]!;
-      await testClient.setBalance({
-        address: creatorAccount,
-        value: parseEther("2000"),
-      });
-
-      const targetContract: Address =
-        "0x7aae7e67515A2CbB8585C707Ca6db37BDd3EA839";
-      const targetTokenId = undefined;
-      const minter = createMintClient({ chain: zora });
-
-      const params = await minter.makePrepareMintTokenParams({
-        tokenId: targetTokenId,
-        tokenAddress: targetContract,
-        minterAccount: creatorAccount,
-        mintArguments: {
-          mintToAddress: creatorAccount,
-          quantityToMint: 1,
-        },
-      });
-      const oldBalance = await publicClient.readContract({
-        abi: erc721ABI,
-        address: targetContract,
-        functionName: "balanceOf",
-        args: [creatorAccount],
-      });
-
-      const simulated = await publicClient.simulateContract(params);
-
-      const hash = await walletClient.writeContract(simulated.request);
-
-      const receipt = await publicClient.waitForTransactionReceipt({ hash });
-      expect(receipt).not.to.be.null;
-
-      const newBalance = await publicClient.readContract({
-        abi: erc721ABI,
-        address: targetContract,
-        functionName: "balanceOf",
-        args: [creatorAccount],
-      });
-
-      expect(oldBalance).to.be.equal(0n);
-      expect(newBalance).to.be.equal(1n);
-    },
-    12 * 1000,
-  );
-});

package/src/premint/premint-client.test.ts

@@ -1,239 +0,0 @@
-import { foundry } from "viem/chains";
-import { describe, expect, vi } from "vitest";
-
-import { createPremintClient } from "./premint-client";
-import { anvilTest } from "src/anvil";
-import { PremintConfigVersion } from "./contract-types";
-import { getDefaultFixedPriceMinterAddress } from "./preminter";
-
-describe("ZoraCreator1155Premint - v1 signatures", () => {
-  anvilTest(
-    "can sign by default v1 on the forked premint contract",
-    async ({ viemClients: { walletClient, publicClient, chain } }) => {
-      const [deployerAccount] = await walletClient.getAddresses();
-      const premintClient = createPremintClient({
-        chain,
-        publicClient,
-      });
-
-      premintClient.apiClient.getNextUID = vi
-        .fn<any, ReturnType<typeof premintClient.apiClient.getNextUID>>()
-        .mockResolvedValue(3);
-      premintClient.apiClient.postSignature = vi
-        .fn<Parameters<typeof premintClient.apiClient.postSignature>>()
-        .mockResolvedValue({ ok: true });
-
-      await premintClient.createPremint({
-        walletClient,
-        creatorAccount: deployerAccount!,
-        checkSignature: true,
-        collection: {
-          contractAdmin: deployerAccount!,
-          contractName: "Testing Contract",
-          contractURI:
-            "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
-        },
-        tokenCreationConfig: {
-          tokenURI:
-            "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
-        },
-      });
-
-      const expectedPostSignatureArgs: Parameters<
-        typeof premintClient.apiClient.postSignature
-      >[0] = {
-        collection: {
-          contractAdmin: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
-          contractName: "Testing Contract",
-          contractURI:
-            "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
-        },
-        premintConfig: {
-          deleted: false,
-          tokenConfig: {
-            fixedPriceMinter: getDefaultFixedPriceMinterAddress(chain.id),
-            maxSupply: 18446744073709551615n,
-            maxTokensPerAddress: 0n,
-            mintDuration: 604800n,
-            mintStart: 0n,
-            pricePerToken: 0n,
-            royaltyBPS: 1000,
-            royaltyMintSchedule: 0,
-            royaltyRecipient: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
-            tokenURI:
-              "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
-          },
-          uid: 3,
-          version: 0,
-        },
-        premintConfigVersion: PremintConfigVersion.V1,
-        signature:
-          "0x70fc1d6e862c42f2b0e4a062f4eb973cc8692df58a24b71b4fe91ae7baa5a26d2c99b1b8ab61f64ff431bf30b0897877b11b7405542c90b89b041808f1561a6c1c",
-      };
-
-      expect(premintClient.apiClient.postSignature).toHaveBeenCalledWith(
-        expectedPostSignatureArgs,
-      );
-    },
-    20 * 1000,
-  );
-
-  anvilTest(
-    "can execute premint on network",
-    async ({ viemClients: { walletClient, publicClient, chain } }) => {
-      const [deployerAccount] = await walletClient.getAddresses();
-      const premintClient = createPremintClient({
-        chain: foundry,
-        publicClient,
-      });
-
-      premintClient.apiClient.getSignature = vi
-        .fn<any, ReturnType<typeof premintClient.apiClient.getSignature>>()
-        .mockResolvedValue({
-          collection: {
-            contractAdmin: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
-            contractName: "Testing Contract",
-            contractURI:
-              "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
-          },
-          premintConfig: {
-            deleted: false,
-            tokenConfig: {
-              fixedPriceMinter: getDefaultFixedPriceMinterAddress(chain.id),
-              maxSupply: 18446744073709551615n,
-              maxTokensPerAddress: 0n,
-              mintDuration: 604800n,
-              mintStart: 0n,
-              pricePerToken: 0n,
-              royaltyBPS: 1000,
-              royaltyMintSchedule: 0,
-              royaltyRecipient: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
-              tokenURI:
-                "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
-            },
-            uid: 3,
-            version: 0,
-          },
-          premintConfigVersion: PremintConfigVersion.V1,
-          signature:
-            "0x70fc1d6e862c42f2b0e4a062f4eb973cc8692df58a24b71b4fe91ae7baa5a26d2c99b1b8ab61f64ff431bf30b0897877b11b7405542c90b89b041808f1561a6c1c",
-        });
-
-      premintClient.apiClient.postSignature = vi.fn();
-
-      const simulateContractParameters = await premintClient.makeMintParameters(
-        {
-          minterAccount: deployerAccount!,
-          tokenContract: "0xf8dA7f53c283d898818af7FB9d98103F559bDac2",
-          uid: 3,
-          mintArguments: {
-            quantityToMint: 1,
-            mintComment: "",
-          },
-        },
-      );
-      const { request: simulateRequest } = await publicClient.simulateContract(
-        simulateContractParameters,
-      );
-      const hash = await walletClient.writeContract(simulateRequest);
-      const receipt = await publicClient.waitForTransactionReceipt({ hash });
-      const { premintedLog, urls } =
-        premintClient.getDataFromPremintReceipt(receipt);
-
-      expect(urls).toEqual({
-        explorer:
-          "https://undefined/token/0xf8dA7f53c283d898818af7FB9d98103F559bDac2/instance/1",
-        zoraCollect:
-          "https://testnet.zora.co/collect/zgor:0xf8dA7f53c283d898818af7FB9d98103F559bDac2/1",
-        zoraManage:
-          "https://testnet.zora.co/collect/zgor:0xf8dA7f53c283d898818af7FB9d98103F559bDac2/1",
-      });
-
-      expect(premintedLog).toEqual({
-        contractAddress: "0xf8dA7f53c283d898818af7FB9d98103F559bDac2",
-        createdNewContract: expect.any(Boolean),
-        minter: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
-        quantityMinted: 1n,
-        tokenId: 1n,
-        uid: 3,
-      });
-    },
-    20 * 1000,
-  );
-});
-
-describe("ZoraCreator1155Premint - v2 signatures", () => {
-  anvilTest(
-    "can sign on the forked premint contract",
-    async ({ viemClients: { walletClient, publicClient, chain } }) => {
-      const [creatorAccount, createReferralAccount] =
-        await walletClient.getAddresses();
-      const premintClient = createPremintClient({
-        chain,
-        publicClient,
-      });
-
-      premintClient.apiClient.getNextUID = vi
-        .fn<any, ReturnType<typeof premintClient.apiClient.getNextUID>>()
-        .mockResolvedValue(3);
-      premintClient.apiClient.postSignature = vi
-        .fn<Parameters<typeof premintClient.apiClient.postSignature>>()
-        .mockResolvedValue({ ok: true });
-
-      await premintClient.createPremint({
-        walletClient,
-        creatorAccount: creatorAccount!,
-        checkSignature: true,
-        collection: {
-          contractAdmin: creatorAccount!,
-          contractName: "Testing Contract Premint V2",
-          contractURI:
-            "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
-        },
-        premintConfigVersion: PremintConfigVersion.V2,
-        tokenCreationConfig: {
-          tokenURI:
-            "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
-          createReferral: createReferralAccount,
-        },
-      });
-
-      const expectedPostSignatureArgs: Parameters<
-        typeof premintClient.apiClient.postSignature
-      >[0] = {
-        collection: {
-          contractAdmin: creatorAccount!,
-          contractName: "Testing Contract Premint V2",
-          contractURI:
-            "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
-        },
-        premintConfig: {
-          deleted: false,
-          tokenConfig: {
-            fixedPriceMinter: "0x04E2516A2c207E84a1839755675dfd8eF6302F0a",
-            maxSupply: 18446744073709551615n,
-            maxTokensPerAddress: 0n,
-            mintDuration: 604800n,
-            mintStart: 0n,
-            pricePerToken: 0n,
-            royaltyBPS: 1000,
-            payoutRecipient: creatorAccount!,
-            createReferral: createReferralAccount!,
-            tokenURI:
-              "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
-          },
-          uid: 3,
-          version: 0,
-        },
-        premintConfigVersion: PremintConfigVersion.V2,
-        signature:
-          "0x8be7932b0b31bdb7fc9269b756e0d0c9514519f083d86576e23b73c033d8ed8440ea363bc8bba0ec5c30eb6bbdf796163a324201bc7520965037102518fb5e991c",
-      };
-
-      expect(premintClient.apiClient.postSignature).toHaveBeenCalledWith(
-        expectedPostSignatureArgs,
-      );
-    },
-    20 * 1000,
-  );
-});