@zoralabs/protocol-sdk 0.2.0

package/src/apis/generated/premint-api-types.ts

@@ -0,0 +1,363 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+
+export interface paths {
+  "/signature": {
+    /** Upsert Premint Signature */
+    post: operations["upsert_premint_signature_signature_post"];
+  };
+  "/signature/{chain_name}/{collection_address}": {
+    /** Get Premint Signatures For Collection */
+    get: operations["get_premint_signatures_for_collection_signature__chain_name___collection_address__get"];
+  };
+  "/signature/{chain_name}/{collection_address}/next_uid": {
+    /** Get Next Uid */
+    get: operations["get_next_uid_signature__chain_name___collection_address__next_uid_get"];
+  };
+  "/signature/{chain_name}/{collection_address}/{uid}": {
+    /** Get Premint Signature */
+    get: operations["get_premint_signature_signature__chain_name___collection_address___uid__get"];
+  };
+  "/created/{chain_name}/{signer}": {
+    /** Get Premint Signatures By Signer */
+    get: operations["get_premint_signatures_by_signer_created__chain_name___signer__get"];
+  };
+}
+
+export type webhooks = Record<string, never>;
+
+export interface components {
+  schemas: {
+    /**
+     * ChainName
+     * @description An enumeration.
+     * @enum {string}
+     */
+    ChainName: "ETHEREUM-MAINNET" | "ETHEREUM-ROPSTEN" | "ETHEREUM-RINKEBY" | "ETHEREUM-GOERLI" | "ETHEREUM-SEPOLIA" | "OPTIMISM-MAINNET" | "OPTIMISM-GOERLI" | "ZORA-GOERLI" | "ZORA-MAINNET" | "BASE-MAINNET" | "BASE-GOERLI" | "PGN-MAINNET";
+    /**
+     * CollectionCreationConfig
+     * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
+     * (store_as, override_name), as well as provides other convinience methods.
+     * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
+     * complex type we include on a stored entity.
+     *
+     * Example::
+     *     >>> class Foo(ObjectBase):
+     *     ...:     found_at_height: int = field(override_name="address", store_as=str)
+     *     ...:     other: str = "default"
+     */
+    CollectionCreationConfig: {
+      /** Contractadmin */
+      contractAdmin: string;
+      /** Contracturi */
+      contractURI: string;
+      /** Contractname */
+      contractName: string;
+    };
+    /** HTTPValidationError */
+    HTTPValidationError: {
+      /** Detail */
+      detail?: components["schemas"]["ValidationError"][];
+    };
+    /**
+     * PremintCollection
+     * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
+     * (store_as, override_name), as well as provides other convinience methods.
+     * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
+     * complex type we include on a stored entity.
+     *
+     * Example::
+     *     >>> class Foo(ObjectBase):
+     *     ...:     found_at_height: int = field(override_name="address", store_as=str)
+     *     ...:     other: str = "default"
+     */
+    PremintCollection: {
+      /** Contract Address */
+      contract_address: string;
+      /** Contract Admin */
+      contract_admin: string;
+      /** Contract Uri */
+      contract_uri: string;
+      /** Contract Name */
+      contract_name: string;
+      /** Premints */
+      premints: components["schemas"]["SignedPremintConfig"][];
+    };
+    /**
+     * PremintConfig
+     * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
+     * (store_as, override_name), as well as provides other convinience methods.
+     * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
+     * complex type we include on a stored entity.
+     *
+     * Example::
+     *     >>> class Foo(ObjectBase):
+     *     ...:     found_at_height: int = field(override_name="address", store_as=str)
+     *     ...:     other: str = "default"
+     */
+    PremintConfig: {
+      tokenConfig: components["schemas"]["TokenCreationConfig"];
+      /** Uid */
+      uid: number;
+      /** Version */
+      version: number;
+      /** Deleted */
+      deleted: boolean;
+    };
+    /**
+     * PremintNextUid
+     * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
+     * (store_as, override_name), as well as provides other convinience methods.
+     * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
+     * complex type we include on a stored entity.
+     *
+     * Example::
+     *     >>> class Foo(ObjectBase):
+     *     ...:     found_at_height: int = field(override_name="address", store_as=str)
+     *     ...:     other: str = "default"
+     */
+    PremintNextUid: {
+      /** Next Uid */
+      next_uid: number;
+    };
+    /**
+     * PremintRequest
+     * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
+     * (store_as, override_name), as well as provides other convinience methods.
+     * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
+     * complex type we include on a stored entity.
+     *
+     * Example::
+     *     >>> class Foo(ObjectBase):
+     *     ...:     found_at_height: int = field(override_name="address", store_as=str)
+     *     ...:     other: str = "default"
+     */
+    PremintRequest: {
+      collection: components["schemas"]["CollectionCreationConfig"];
+      premint: components["schemas"]["PremintConfig"];
+      chain_name: components["schemas"]["ChainName"];
+      /** Signature */
+      signature: string;
+    };
+    /**
+     * PremintSignature
+     * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
+     * (store_as, override_name), as well as provides other convinience methods.
+     * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
+     * complex type we include on a stored entity.
+     *
+     * Example::
+     *     >>> class Foo(ObjectBase):
+     *     ...:     found_at_height: int = field(override_name="address", store_as=str)
+     *     ...:     other: str = "default"
+     */
+    PremintSignature: {
+      collection: components["schemas"]["CollectionCreationConfig"];
+      premint: components["schemas"]["PremintConfig"];
+      chain_name: components["schemas"]["ChainName"];
+      /** Signature */
+      signature: string;
+      /** Collection Address */
+      collection_address: string;
+      /** Signer */
+      signer: string;
+    };
+    /**
+     * SignedPremintConfig
+     * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
+     * (store_as, override_name), as well as provides other convinience methods.
+     * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
+     * complex type we include on a stored entity.
+     *
+     * Example::
+     *     >>> class Foo(ObjectBase):
+     *     ...:     found_at_height: int = field(override_name="address", store_as=str)
+     *     ...:     other: str = "default"
+     */
+    SignedPremintConfig: {
+      tokenConfig: components["schemas"]["TokenCreationConfig"];
+      /** Uid */
+      uid: number;
+      /** Version */
+      version: number;
+      /** Deleted */
+      deleted: boolean;
+      /** Signature */
+      signature: string;
+    };
+    /**
+     * TokenCreationConfig
+     * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
+     * (store_as, override_name), as well as provides other convinience methods.
+     * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
+     * complex type we include on a stored entity.
+     *
+     * Example::
+     *     >>> class Foo(ObjectBase):
+     *     ...:     found_at_height: int = field(override_name="address", store_as=str)
+     *     ...:     other: str = "default"
+     */
+    TokenCreationConfig: {
+      /** Tokenuri */
+      tokenURI: string;
+      /** Maxsupply */
+      maxSupply: string;
+      /** Maxtokensperaddress */
+      maxTokensPerAddress: string;
+      /** Pricepertoken */
+      pricePerToken: string;
+      /** Mintstart */
+      mintStart: string;
+      /** Mintduration */
+      mintDuration: string;
+      /** Royaltymintschedule */
+      royaltyMintSchedule: number;
+      /** Royaltybps */
+      royaltyBPS: number;
+      /** Royaltyrecipient */
+      royaltyRecipient: string;
+      /** Fixedpriceminter */
+      fixedPriceMinter: string;
+    };
+    /** ValidationError */
+    ValidationError: {
+      /** Location */
+      loc: (string | number)[];
+      /** Message */
+      msg: string;
+      /** Error Type */
+      type: string;
+    };
+  };
+  responses: never;
+  parameters: never;
+  requestBodies: never;
+  headers: never;
+  pathItems: never;
+}
+
+export type $defs = Record<string, never>;
+
+export type external = Record<string, never>;
+
+export interface operations {
+
+  /** Upsert Premint Signature */
+  upsert_premint_signature_signature_post: {
+    requestBody: {
+      content: {
+        "application/json": components["schemas"]["PremintRequest"];
+      };
+    };
+    responses: {
+      /** @description Successful Response */
+      200: {
+        content: {
+          "application/json": components["schemas"]["PremintRequest"];
+        };
+      };
+      /** @description Validation Error */
+      422: {
+        content: {
+          "application/json": components["schemas"]["HTTPValidationError"];
+        };
+      };
+    };
+  };
+  /** Get Premint Signatures For Collection */
+  get_premint_signatures_for_collection_signature__chain_name___collection_address__get: {
+    parameters: {
+      path: {
+        chain_name: components["schemas"]["ChainName"];
+        collection_address: string;
+      };
+    };
+    responses: {
+      /** @description Successful Response */
+      200: {
+        content: {
+          "application/json": components["schemas"]["PremintCollection"];
+        };
+      };
+      /** @description Validation Error */
+      422: {
+        content: {
+          "application/json": components["schemas"]["HTTPValidationError"];
+        };
+      };
+    };
+  };
+  /** Get Next Uid */
+  get_next_uid_signature__chain_name___collection_address__next_uid_get: {
+    parameters: {
+      path: {
+        chain_name: components["schemas"]["ChainName"];
+        collection_address: string;
+      };
+    };
+    responses: {
+      /** @description Successful Response */
+      200: {
+        content: {
+          "application/json": components["schemas"]["PremintNextUid"];
+        };
+      };
+      /** @description Validation Error */
+      422: {
+        content: {
+          "application/json": components["schemas"]["HTTPValidationError"];
+        };
+      };
+    };
+  };
+  /** Get Premint Signature */
+  get_premint_signature_signature__chain_name___collection_address___uid__get: {
+    parameters: {
+      path: {
+        chain_name: components["schemas"]["ChainName"];
+        collection_address: string;
+        uid: number;
+      };
+    };
+    responses: {
+      /** @description Successful Response */
+      200: {
+        content: {
+          "application/json": components["schemas"]["PremintSignature"];
+        };
+      };
+      /** @description Validation Error */
+      422: {
+        content: {
+          "application/json": components["schemas"]["HTTPValidationError"];
+        };
+      };
+    };
+  };
+  /** Get Premint Signatures By Signer */
+  get_premint_signatures_by_signer_created__chain_name___signer__get: {
+    parameters: {
+      path: {
+        chain_name: components["schemas"]["ChainName"];
+        signer: string;
+      };
+    };
+    responses: {
+      /** @description Successful Response */
+      200: {
+        content: {
+          "application/json": components["schemas"]["PremintCollection"][];
+        };
+      };
+      /** @description Validation Error */
+      422: {
+        content: {
+          "application/json": components["schemas"]["HTTPValidationError"];
+        };
+      };
+    };
+  };
+}

package/src/apis/http-api-base.ts

@@ -0,0 +1,93 @@
+export class BadResponseError<T = any> extends Error {
+  status: number;
+  json: T;
+  constructor(message: string, status: number, json: any) {
+    super(message);
+    this.name = "BadResponseError";
+    this.status = status;
+    this.json = json;
+  }
+}
+
+async function wait(delayMs: number) {
+  return new Promise((resolve) => {
+    setTimeout(resolve, delayMs);
+  });
+}
+
+/**
+ * A simple fetch() wrapper for HTTP gets.
+ * Can be overridden as needed.
+ *
+ * @param path Path to run HTTP JSON get against
+ * @returns JSON object response
+ * @throws Error when HTTP response fails
+ */
+export const get = async <T>(url: string) => {
+  const response = await fetch(url, { method: "GET" });
+  if (response.status !== 200) {
+    let json;
+    try {
+      json = await response.json();
+    } catch (e: any) {}
+    throw new BadResponseError(
+      `Invalid response, status ${response.status}`,
+      response.status,
+      json,
+    );
+  }
+  return (await response.json()) as T;
+};
+
+/**
+ * A simple fetch() wrapper for HTTP post.
+ * Can be overridden as needed.
+ *
+ * @param path Path to run HTTP JSON POST against
+ * @param data Data to POST to the server, converted to JSON
+ * @returns JSON object response
+ * @throws Error when HTTP response fails
+ */
+export const post = async <T>(url: string, data: any) => {
+  const response = await fetch(url, {
+    method: "POST",
+    headers: {
+      "content-type": "application/json",
+      accept: "application/json",
+    },
+    body: JSON.stringify(data),
+  });
+  if (response.status !== 200) {
+    let json;
+    try {
+      json = await response.json();
+    } catch (e: any) {}
+    throw new BadResponseError(
+      `Bad response: ${response.status}`,
+      response.status,
+      json,
+    );
+  }
+  return (await response.json()) as T;
+};
+
+export const retries = async <T>(
+  tryFn: () => T,
+  maxTries: number = 3,
+  atTry: number = 1,
+  linearBackoffMS: number = 200,
+): Promise<T> => {
+  try {
+    return await tryFn();
+  } catch (err: any) {
+    if (err instanceof BadResponseError) {
+      if (err.status >= 500) {
+        if (atTry <= maxTries) {
+          await wait(atTry * linearBackoffMS);
+          return await retries(tryFn, maxTries, atTry + 1);
+        }
+      }
+    }
+    throw err;
+  }
+};

package/src/constants.ts

@@ -0,0 +1,10 @@
+export const ZORA_API_BASE = "https://api.zora.co/";
+export const OPEN_EDITION_MINT_SIZE = BigInt("18446744073709551615");
+
+// Subgraph base settings
+const SUBGRAPH_CONFIG_BASE =
+  "https://api.goldsky.com/api/public/project_clhk16b61ay9t49vm6ntn4mkz/subgraphs";
+
+export function getSubgraph(name: string, version: string): string {
+  return `${SUBGRAPH_CONFIG_BASE}/${name}/${version}/gn`;
+}

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

@@ -0,0 +1,90 @@
+import { parseEther } from "viem";
+import { describe, expect } from "vitest";
+import {
+  createNew1155Token,
+  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 new1155TokenRequest = await createNew1155Token({
+        publicClient,
+        contract: {
+          name: "testContract",
+          uri: demoContractMetadataURI,
+        },
+        tokenMetadataURI: demoTokenMetadataURI,
+        account: creatorAddress,
+        mintToCreatorCount: 1,
+      });
+      const hash = await new1155TokenRequest.send(walletClient);
+      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 new1155TokenRequest = await createNew1155Token({
+        publicClient,
+        contract: {
+          name: "testContract2",
+          uri: demoContractMetadataURI,
+        },
+        tokenMetadataURI: demoTokenMetadataURI,
+        account: creatorAccount,
+        mintToCreatorCount: 1,
+      });
+      expect(new1155TokenRequest.contractAddress).to.be.equal(
+        "0xb1A8928dF830C21eD682949Aa8A83C1C215194d3",
+      );
+      expect(new1155TokenRequest.contractExists).to.be.false;
+      const hash = await new1155TokenRequest.send(walletClient);
+      const receipt = await publicClient.waitForTransactionReceipt({ hash });
+      const firstTokenId = getTokenIdFromCreateReceipt(receipt);
+      expect(firstTokenId).to.be.equal(1n);
+      expect(receipt).not.toBeNull();
+
+      const newTokenOnExistingContract = await createNew1155Token({
+        publicClient,
+        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 newHash = await newTokenOnExistingContract.send(walletClient);
+      const newReceipt = await publicClient.waitForTransactionReceipt({
+        hash: newHash,
+      });
+      const tokenId = getTokenIdFromCreateReceipt(newReceipt);
+      expect(tokenId).to.be.equal(2n);
+      expect(newReceipt).not.toBeNull();
+    },
+    20 * 1000,
+  );
+});