@zoralabs/protocol-sdk 0.8.0 → 0.9.0

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,IAAI,gBAAgB,EAAE,MAAM,MAAM,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,qCAAqC,EAAE,MAAM,SAAS,CAAC;AAEhE,eAAO,MAAM,sBAAsB,SAC3B,qCAAqC,0CACpC,CAAC;AAEV,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;AAElE,MAAM,MAAM,YAAY,GAAG;IACzB,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,4EAA4E;IAC5E,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,wBAAgB,WAAW,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,YAAY;;;EAKlE;AAED,wBAAgB,sBAAsB,CAAC,EACrC,aAAa,EACb,aAAa,GACd,EAAE;IACD,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,aAAa,EAAE,OAAO,GAAG,OAAO,CAAC;CAClC,GAAG,OAAO,CAKV;AAED,MAAM,MAAM,QAAQ,CAAC,IAAI,IAAI;KAC1B,QAAQ,IAAI,MAAM,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;CAC3C,CAAC;AAEF,wBAAsB,wBAAwB,CAAC,EAC7C,UAAU,EACV,WAAW,EACX,KAAK,EACL,SAAS,GACV,EAAE;IACD,UAAU,EAAE,WAAW,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,GAAG,CAAC;CAChB,gBAWA"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,IAAI,gBAAgB,EAAE,MAAM,MAAM,CAAC;AAC1E,OAAO,EAAE,qCAAqC,EAAE,MAAM,SAAS,CAAC;AAEhE,eAAO,MAAM,sBAAsB,SAC3B,qCAAqC,0CACpC,CAAC;AAEV,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,EAAE,cAAc,GAAG,UAAU,CAAC,CAAC;AAE/E,MAAM,MAAM,YAAY,GAAG;IACzB,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,4EAA4E;IAC5E,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,wBAAgB,WAAW,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,YAAY;;;EAKlE;AAED,wBAAgB,sBAAsB,CAAC,EACrC,aAAa,EACb,aAAa,GACd,EAAE;IACD,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,aAAa,EAAE,OAAO,GAAG,OAAO,CAAC;CAClC,GAAG,OAAO,CAKV;AAED,MAAM,MAAM,QAAQ,CAAC,IAAI,IAAI;KAC1B,QAAQ,IAAI,MAAM,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;CAC3C,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zoralabs/protocol-sdk",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "repository": "https://github.com/ourzora/zora-protocol",
   "license": "MIT",
   "type": "module",
@@ -36,7 +36,7 @@
     "tsup": "^7.2.0",
     "typescript": "^5.2.2",
     "vite": "^4.5.0",
-    "vitest": "^0.34.6",
+    "vitest": "^2.0.5",
     "@zoralabs/tsconfig": "^0.0.0"
   },
   "scripts": {

package/src/allow-list/allow-list-client.ts

@@ -0,0 +1,105 @@
+import {
+  IHttpClient,
+  httpClient as defaultHttpClient,
+} from "src/apis/http-api-base";
+import { paths } from "../apis/generated/allow-list-api-types";
+import { Hex } from "viem";
+import { AllowList } from "./types";
+
+type AllowListCreateType = paths["/allowlist"]["post"];
+type AllowListCreateParameters =
+  AllowListCreateType["requestBody"]["content"]["application/json"];
+type AllowListCreateResponse = {
+  existing?: {
+    entries: AllowListCreateParameters["entries"];
+    root: string;
+    added: string;
+  };
+  success: boolean;
+  root: string;
+  associated_id?: string;
+};
+
+const ALLOW_LIST_API_BASE = "http://allowlist.zora.co/";
+type AllowListAllowedResponse = {
+  maxCanMint: number;
+  price: string;
+  proof: string[];
+}[];
+
+export const createAllowList = async ({
+  allowList,
+  httpClient = defaultHttpClient,
+  baseUrl = ALLOW_LIST_API_BASE,
+}: {
+  allowList: AllowList;
+  httpClient?: IHttpClient;
+  baseUrl?: string;
+}) => {
+  const { post, retries } = httpClient;
+
+  const data: AllowListCreateParameters = {
+    entries: allowList.entries.map((entry) => ({
+      user: entry.user,
+      maxCanMint: entry.maxCanMint,
+      price: entry.price.toString(),
+    })),
+  };
+
+  return (
+    await retries(() =>
+      post<AllowListCreateResponse>(`${baseUrl}allowlist`, data),
+    )
+  ).root;
+};
+
+function padHex(value: string): Hex {
+  if (value.startsWith("0x")) return value as Hex;
+
+  return `0x${value}`;
+}
+
+export const getAllowListEntry = async ({
+  merkleRoot,
+  address,
+  httpClient = defaultHttpClient,
+  baseUrl = ALLOW_LIST_API_BASE,
+}: {
+  merkleRoot: string;
+  httpClient?: IHttpClient;
+  address: string;
+  baseUrl?: string;
+}) => {
+  const { retries, get } = httpClient;
+
+  const response = await retries(() =>
+    get<AllowListAllowedResponse>(
+      `${baseUrl}allowed?user=${address}&root=${merkleRoot}`,
+    ),
+  );
+
+  const entries = response?.map((x) => ({
+    maxCanMint: x.maxCanMint,
+    price: BigInt(x.price),
+    proof: x.proof.map(padHex),
+  }));
+
+  const entry = entries?.sort(
+    (a, b) => Number(a.price) - Number(b.price) || b.maxCanMint - a.maxCanMint,
+  )[0];
+
+  return {
+    accessAllowed: entry && entry?.proof?.length,
+    allowListEntry: entry,
+  };
+};
+
+export interface IAllowListClient {
+  createAllowList: typeof createAllowList;
+  getAllowListEntry: typeof getAllowListEntry;
+}
+
+export const defaultAllowListClient = (): IAllowListClient => ({
+  createAllowList,
+  getAllowListEntry,
+});

package/src/allow-list/types.ts

@@ -0,0 +1,15 @@
+import { Address, Hex } from "viem";
+
+export type AllowList = {
+  entries: {
+    user: Address;
+    price: bigint;
+    maxCanMint: number;
+  }[];
+};
+
+export type AllowListEntry = {
+  maxCanMint: number;
+  price: bigint;
+  proof: Hex[];
+};

package/src/apis/generated/allow-list-api-types.ts

@@ -0,0 +1,288 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+  "/_health": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** Health */
+    get: operations["health__health_get"];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/allowlist": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Add Allowlist
+     * @description This route adds a new allowlist
+     */
+    post: operations["add_allowlist_allowlist_post"];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/allowed": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** Allowed */
+    get: operations["allowed_allowed_get"];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/allowlist/{root}": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** Allowlist */
+    get: operations["allowlist_allowlist__root__get"];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/allowlist/{root}/count": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** Allowlist Count */
+    get: operations["allowlist_count_allowlist__root__count_get"];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+  schemas: {
+    /**
+     * AllowlistEntry
+     * @description Currently matches zora-nft-drops model
+     */
+    AllowlistEntry: {
+      /** User */
+      user: string;
+      /** Price */
+      price: string;
+      /** Maxcanmint */
+      maxCanMint: number;
+    };
+    /** AllowlistRequest */
+    AllowlistRequest: {
+      /** Entries */
+      entries: components["schemas"]["AllowlistEntry"][];
+      /** Contract */
+      contract?: string;
+    };
+    /** HTTPValidationError */
+    HTTPValidationError: {
+      /** Detail */
+      detail?: components["schemas"]["ValidationError"][];
+    };
+    /** 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 interface operations {
+  health__health_get: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Successful Response */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": unknown;
+        };
+      };
+    };
+  };
+  add_allowlist_allowlist_post: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody: {
+      content: {
+        "application/json": components["schemas"]["AllowlistRequest"];
+      };
+    };
+    responses: {
+      /** @description Successful Response */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": unknown;
+        };
+      };
+      /** @description Validation Error */
+      422: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": components["schemas"]["HTTPValidationError"];
+        };
+      };
+    };
+  };
+  allowed_allowed_get: {
+    parameters: {
+      query: {
+        user: string;
+        root: string;
+      };
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Successful Response */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": unknown;
+        };
+      };
+      /** @description Validation Error */
+      422: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": components["schemas"]["HTTPValidationError"];
+        };
+      };
+    };
+  };
+  allowlist_allowlist__root__get: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        root: string;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Successful Response */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": unknown;
+        };
+      };
+      /** @description Validation Error */
+      422: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": components["schemas"]["HTTPValidationError"];
+        };
+      };
+    };
+  };
+  allowlist_count_allowlist__root__count_get: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        root: string;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Successful Response */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": unknown;
+        };
+      };
+      /** @description Validation Error */
+      422: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": components["schemas"]["HTTPValidationError"];
+        };
+      };
+    };
+  };
+}

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

@@ -49,6 +49,15 @@ export const get = async <T>(url: string) => {
  * @throws Error when HTTP response fails
  */
 export const post = async <T>(url: string, data: any) => {
+  const controller = new AbortController();
+  const { signal } = controller;
+
+  // 30 minute timeout:
+  const timeout = 30 * 60 * 1000;
+
+  // Set a timeout to automatically abort the request
+  const timeoutId = setTimeout(() => controller.abort(), timeout);
+
   const response = await fetch(url, {
     method: "POST",
     headers: {
@@ -56,7 +65,10 @@ export const post = async <T>(url: string, data: any) => {
       accept: "application/json",
     },
     body: JSON.stringify(data),
+    signal,
   });
+
+  clearTimeout(timeoutId);
   if (response.status !== 200) {
     let json;
     try {

package/src/apis/subgraph-querier.ts

@@ -0,0 +1,38 @@
+import { IHttpClient } from "./http-api-base";
+
+export interface ISubgraphQuerier {
+  query: (params: {
+    subgraphUrl: string;
+    query: string;
+    variables?: Record<string, any>;
+  }) => Promise<object | undefined>;
+}
+
+export class SubgraphQuerier implements ISubgraphQuerier {
+  httpClient: IHttpClient;
+
+  constructor(httpClient: IHttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  async query({
+    subgraphUrl,
+    query,
+    variables,
+  }: {
+    subgraphUrl: string;
+    query: string;
+    variables?: Record<string, any>;
+  }) {
+    const { retries, post } = this.httpClient;
+
+    const result = await retries(async () => {
+      return await post<any>(subgraphUrl, {
+        query,
+        variables,
+      });
+    });
+
+    return result?.data;
+  }
+}