@zoralabs/protocol-sdk 0.2.0

package/.turbo/turbo-build.log

@@ -0,0 +1,15 @@
+$ tsup
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v7.2.0
+CLI Using tsup config: /home/runner/work/zora-protocol/zora-protocol/packages/protocol-sdk/tsup.config.js
+CLI Target: es2021
+CLI Cleaning output folder
+CJS Build start
+ESM Build start
+CJS dist/index.cjs     31.18 KB
+CJS dist/index.cjs.map 56.54 KB
+CJS ⚡️ Build success in 21ms
+ESM dist/index.js     28.64 KB
+ESM dist/index.js.map 56.31 KB
+ESM ⚡️ Build success in 22ms

package/CHANGELOG.md

@@ -0,0 +1,47 @@
+# @zoralabs/premint-sdk
+
+## 0.1.1
+
+### Patch Changes
+
+- b62e471: created new package `protocol-deployments` that includes the deployed contract addresses.
+
+  - 1155-contracts js no longer exports deployed addresses, just the abis
+  - premint-sdk imports deployed addresses from `protocol-deployments
+
+- Updated dependencies [4d79b49]
+- Updated dependencies [b62e471]
+- Updated dependencies [7d1a4c1]
+  - @zoralabs/protocol-deployments@0.0.2
+
+## 0.1.0
+
+### Minor Changes
+
+- 4afa879: Added new premint api that abstracts out calls to the chain signature and submission logic around submitting a premint. This change also incorporates test helpers for premints and introduces docs and an api client for the zora api's premint module.
+
+### Patch Changes
+
+- Updated dependencies [4afa879]
+  - @zoralabs/zora-1155-contracts@2.3.0
+
+## 0.0.2-premint-api.2
+
+### Patch Changes
+
+- c29e080: Update retry and error reporting
+
+## 0.0.2-premint-api.1
+
+### Patch Changes
+
+- 6eaf7bb: add retries
+
+## 0.0.2-premint-api.0
+
+### Patch Changes
+
+- Updated dependencies [8395b8e]
+- Updated dependencies [aae756b]
+- Updated dependencies [cf184b3]
+  - @zoralabs/zora-1155-contracts@2.1.1-premint-api.0

package/README.md

@@ -0,0 +1,163 @@
+# Premint SDK
+
+Protocol SDK allows users to manage zora mints and collects.
+
+## Installing
+
+[viem](https://viem.sh/) is a peerDependency of protocol-sdk. If not already installed, it needs to be installed alongside the protocol sdk.
+
+- `npm install viem`
+- `npm install `
+
+### Creating a mint from an on-chain contract:
+
+```ts
+import { MintAPI } from "@zoralabs/protocol-sdk";
+import type { Address, WalletClient } from "viem";
+
+async function mintNFT(
+  walletClient: WalletClient,
+  address: Address,
+  tokenId: bigint,
+) {
+  const mintAPI = new MintAPI(walletClient.chain);
+  await mintAPI.mintNFT({
+    walletClient,
+    address,
+    tokenId,
+    mintArguments: {
+      quantityToMint: 23,
+      mintComment: "Helo",
+    },
+  });
+}
+```
+
+### Creating a premint:
+
+```ts
+import { PremintAPI } from "@zoralabs/protocol-sdk";
+import type { Address, WalletClient } from "viem";
+
+async function makePremint(walletClient: WalletClient) {
+  // Create premint API object passing in the current wallet chain (only zora and zora testnet are supported currently).
+  const premintAPI = new PremintAPI(walletClient.chain);
+
+  // Create premint
+  const premint = await premintAPI.createPremint({
+    // Extra step to check the signature on-chain before attempting to sign
+    checkSignature: true,
+    // Collection information that this premint NFT will exist in once minted.
+    collection: {
+      contractAdmin: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
+      contractName: "Testing Contract",
+      contractURI:
+        "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
+    },
+    // WalletClient doing the signature
+    walletClient,
+    // Token information, falls back to defaults set in DefaultMintArguments.
+    token: {
+      tokenURI:
+        "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
+    },
+  });
+
+  console.log(`created ZORA premint, link: ${premint.url}`);
+  return premint;
+}
+```
+
+### Updating a premint:
+
+```ts
+import { PremintAPI } from "@zoralabs/premint-sdk";
+import type { Address, WalletClient } from "viem";
+
+async function updatePremint(walletClient: WalletClient) {
+  // Create premint API object passing in the current wallet chain (only zora and zora testnet are supported currently).
+  const premintAPI = new PremintAPI(walletClient.chain);
+
+  // Create premint
+  const premint = await premintAPI.updatePremint({
+    // Extra step to check the signature on-chain before attempting to sign
+    collection: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
+    uid: 23,
+    // WalletClient doing the signature
+    walletClient,
+    // Token information, falls back to defaults set in DefaultMintArguments.
+    token: {
+      tokenURI:
+        "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
+    },
+  });
+
+  console.log(`updated ZORA premint, link: ${premint.url}`);
+  return premint;
+}
+```
+
+### Deleting a premint:
+
+```ts
+import { PremintAPI } from "@zoralabs/premint-sdk";
+import type { Address, WalletClient } from "viem";
+
+async function deletePremint(walletClient: WalletClient) {
+  // Create premint API object passing in the current wallet chain (only zora and zora testnet are supported currently).
+  const premintAPI = new PremintAPI(walletClient.chain);
+
+  // Create premint
+  const premint = await premintAPI.deletePremint({
+    // Extra step to check the signature on-chain before attempting to sign
+    collection: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
+    uid: 23,
+    // WalletClient doing the signature
+    walletClient,
+  });
+
+  console.log(`updated ZORA premint, link: ${premint.url}`);
+  return premint;
+}
+```
+
+### Executing a premint:
+
+```ts
+import { PremintAPI } from "@zoralabs/premint-sdk";
+import type { Address, WalletClient } from "viem";
+
+async function executePremint(
+  walletClient: WalletClient,
+  premintAddress: Address,
+  premintUID: number,
+) {
+  const premintAPI = new PremintAPI(walletClient.chain);
+
+  return await premintAPI.executePremintWithWallet({
+    data: premintAPI.getPremintData(premintAddress, premintUID),
+    walletClient,
+    mintArguments: {
+      quantityToMint: 1,
+    },
+  });
+}
+```
+
+### Deleting a premint:
+
+```js
+import {PremintAPI} from '@zoralabs/premint-sdk';
+import type {Address, WalletClient} from 'viem';
+
+async function deletePremint(walletClient: WalletClient, collection: Address, uid: number) {
+    const premintAPI = new PremintAPI(walletClient.chain);
+
+    return await premintAPI.deletePremint({
+        walletClient,
+        uid,
+        collection
+    });
+}
+
+```

package/dist/anvil.d.ts

@@ -0,0 +1,16 @@
+import { PublicClient, TestClient, WalletClient } from "viem";
+export interface AnvilViemClientsTest {
+    viemClients: {
+        walletClient: WalletClient;
+        publicClient: PublicClient;
+        testClient: TestClient;
+    };
+}
+export declare const anvilTest: import("@vitest/runner/dist/tasks-e594cd24").e<{
+    viemClients: {
+        walletClient: WalletClient;
+        publicClient: PublicClient;
+        testClient: TestClient;
+    };
+}>;
+//# sourceMappingURL=anvil.d.ts.map

package/dist/anvil.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"anvil.d.ts","sourceRoot":"","sources":["../src/anvil.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,YAAY,EACZ,UAAU,EACV,YAAY,EAKb,MAAM,MAAM,CAAC;AAGd,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE;QACX,YAAY,EAAE,YAAY,CAAC;QAC3B,YAAY,EAAE,YAAY,CAAC;QAC3B,UAAU,EAAE,UAAU,CAAC;KACxB,CAAC;CACH;AAUD,eAAO,MAAM,SAAS;;sBAdJ,YAAY;sBACZ,YAAY;oBACd,UAAU;;EAiExB,CAAC"}

package/dist/apis/chain-constants.d.ts

@@ -0,0 +1,21 @@
+import type { components } from "./generated/premint-api-types";
+export type NetworkConfig = {
+    chainId: number;
+    zoraPathChainName: string;
+    zoraBackendChainName: components["schemas"]["ChainName"];
+    isTestnet: boolean;
+    subgraphUrl: string;
+};
+export declare const REWARD_PER_TOKEN: bigint;
+export declare const BackendChainNamesLookup: {
+    readonly ZORA_MAINNET: "ZORA-MAINNET";
+    readonly ZORA_GOERLI: "ZORA-GOERLI";
+    readonly OPTIMISM_MAINNET: "OPTIMISM-MAINNET";
+    readonly OPTIMISM_GOERLI: "OPTIMISM-GOERLI";
+    readonly ETHEREUM_MAINNET: "ETHEREUM-MAINNET";
+    readonly ETHEREUM_GOERLI: "ETHEREUM-GOERLI";
+    readonly BASE_MAINNET: "BASE-MAINNET";
+    readonly BASE_GOERLI: "BASE-GOERLI";
+};
+export declare const networkConfigByChain: Record<number, NetworkConfig>;
+//# sourceMappingURL=chain-constants.d.ts.map

package/dist/apis/chain-constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chain-constants.d.ts","sourceRoot":"","sources":["../../src/apis/chain-constants.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAIhE,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,oBAAoB,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC;IACzD,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,eAAO,MAAM,gBAAgB,QAAyB,CAAC;AAEvD,eAAO,MAAM,uBAAuB;;;;;;;;;CAS1B,CAAC;AAEX,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAgE9D,CAAC"}

package/dist/apis/client-base.d.ts

@@ -0,0 +1,15 @@
+import { Chain, PublicClient } from "viem";
+import { NetworkConfig } from "./chain-constants";
+export declare abstract class ClientBase {
+    network: NetworkConfig;
+    chain: Chain;
+    constructor(chain: Chain);
+    /**
+     * Getter for public client that instantiates a publicClient as needed
+     *
+     * @param publicClient Optional viem public client
+     * @returns Existing public client or makes a new one for the given chain as needed.
+     */
+    protected getPublicClient(publicClient?: PublicClient): PublicClient;
+}
+//# sourceMappingURL=client-base.d.ts.map

package/dist/apis/client-base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-base.d.ts","sourceRoot":"","sources":["../../src/apis/client-base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,YAAY,EAA4B,MAAM,MAAM,CAAC;AACrE,OAAO,EAAE,aAAa,EAAwB,MAAM,mBAAmB,CAAC;AAExE,8BAAsB,UAAU;IAC9B,OAAO,EAAE,aAAa,CAAC;IACvB,KAAK,EAAE,KAAK,CAAC;gBAED,KAAK,EAAE,KAAK;IASxB;;;;;OAKG;IACH,SAAS,CAAC,eAAe,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,YAAY;CAMrE"}