Premint api helper

.changeset/soft-dots-live.md

@@ -0,0 +1,5 @@
+---
+"@zoralabs/premint-sdk": minor
+---
+
+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.

.gitignore

@@ -35,6 +35,7 @@ dist/
 .env
 .env.*
 !.env.example
+!.env.anvil
 
 package/wagmiGenerated.ts
 package/chainConfigs.ts

packages/1155-contracts/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@zoralabs/zora-1155-contracts",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "repository": "[email protected]:ourzora/zora-protocol.git",
   "author": "Iain <[email protected]>",
   "license": "MIT",
-  "main": "./dist/index.cjs",
+  "main": "./dist/index.js",
   "types": "./dist/package/index.d.ts",
   "type": "module",
   "scripts": {
@@ -45,29 +45,25 @@
   ],
   "dependencies": {
     "@openzeppelin/contracts": "4.9.2",
-    "@wagmi/cli": "^1.0.1",
     "@zoralabs/openzeppelin-contracts-upgradeable": "4.8.4",
     "@zoralabs/protocol-rewards": "*",
-    "abitype": "^0.8.7",
     "ds-test": "https://github.com/dapphub/ds-test#cd98eff28324bfac652e63a239a60632a761790b",
-    "es-main": "^1.2.0",
     "forge-std": "https://github.com/foundry-rs/forge-std#705263c95892a906d7af65f0f73ce8a4a0c80b80",
-    "glob": "^10.2.2",
-    "prettier": "^2.8.8",
-    "prettier-plugin-solidity": "^1.1.3",
     "solady": "^0.0.123",
-    "solmate": "^6.1.0",
-    "tsup": "^7.2.0",
-    "tsx": "^3.13.0",
-    "typescript": "^5.0.4",
-    "viem": "^1.16.2",
-    "vite": "^4.1.4",
-    "vitest": "~0.30.1"
+    "solmate": "^6.1.0"
   },
   "devDependencies": {
+    "@wagmi/cli": "^1.0.1",
+    "tsx": "^3.13.0",
+    "glob": "^10.2.2",
+    "prettier": "^2.8.8",
+    "es-main": "^1.2.0",
     "@turnkey/api-key-stamper": "^0.1.1",
+    "prettier-plugin-solidity": "^1.1.3",
     "@turnkey/http": "^1.2.0",
     "@turnkey/viem": "^0.2.4",
-    "@types/node": "^20.1.2"
+    "@types/node": "^20.1.2",
+    "tsup": "^7.2.0",
+    "typescript": "^5.0.4"
   }
 }

packages/1155-contracts/src/version/ContractVersionBase.sol

@@ -1,5 +1,5 @@
 // This file is automatically generated by code; do not manually update
-// Last updated on 2023-10-18T17:43:11.859Z
+// Last updated on 2023-10-30T19:58:54.830Z
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.17;
 
@@ -10,6 +10,6 @@ import {IVersionedContract} from "../interfaces/IVersionedContract.sol";
 contract ContractVersionBase is IVersionedContract {
     /// @notice The version of the contract
     function contractVersion() external pure override returns (string memory) {
-        return "2.1.0";
+        return "2.2.0";
     }
 }

packages/1155-contracts/tsconfig.json

@@ -21,8 +21,5 @@
     "outDir": "dist"
   },
   "exclude": ["node_modules/**", "dist/**"],
-  "include": [
-    "package/**/*.ts",
-    "script/*.ts"
-  ],
-}
+  "include": ["package/**/*.ts", "script/*.ts"]
+}

packages/1155-contracts/tsup.config.ts

@@ -5,6 +5,6 @@ export default defineConfig({
   sourcemap: true,
   clean: true,
   dts: false,
-  format: ['cjs'],
+  format: ['cjs', 'esm'],
   onSuccess: 'tsc --emitDeclarationOnly --declaration --declarationMap'
 })

packages/premint-sdk/CHANGELOG.md

@@ -0,0 +1,22 @@
+# @zoralabs/premint-sdk
+
+## 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/[email protected]

packages/premint-sdk/README.md

@@ -0,0 +1,131 @@
+# Premint SDK
+
+Premint SDK allows users to manage zora premints
+
+### Creating a premint:
+
+```js
+import {PremintAPI} from '@zoralabs/premint-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:
+
+```js
+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:
+
+```js
+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:
+
+```js
+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
+    });
+}
+
+```

packages/premint-sdk/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@zoralabs/premint-sdk",
+  "version": "0.0.2-premint-api.2",
+  "repository": "https://github.com/ourzora/zora-protocol",
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsup",
+    "prepack": "yarn build",
+    "test": "vitest src",
+    "generate-types": "npx openapi-typescript https://api.zora.co/premint/openapi.json -o src/generated/premint-api-types.ts && npx openapi-typescript https://api.zora.co/discover/openapi.json -o src/generated/discover-api-types.ts",
+    "anvil": "source .env.anvil && anvil --fork-url $FORK_RPC_URL --fork-block-number $FORK_BLOCK_NUMBER --chain-id 31337"
+  },
+  "dependencies": {
+    "@zoralabs/zora-1155-contracts": "*",
+    "abitype": "^0.8.7",
+    "vite": "4.5.0",
+    "vitest": "0.34.6"
+  },
+  "peerDependencies": {
+    "viem": "^1.16.6"
+  },
+  "devDependencies": {
+    "typescript": "^5.2.2",
+    "vite": "4.5.0",
+    "vitest": "0.34.6"
+  }
+}