feat: add create referral to token params

ourzora · Oct 24, 2023 · 4a78775 · 4a78775
1 parent f08f6c7
commit 4a78775
Show file tree

Hide file tree

Showing 13 changed files with 968 additions and 321 deletions.
diff --git a/packages/1155-contracts/package/preminter.test.ts b/packages/1155-contracts/package/preminter.test.ts
@@ -22,9 +22,10 @@ import {
 
 import {
   ContractCreationConfig,
-  PremintConfig,
-  TokenCreationConfig,
-  preminterTypedDataDefinition,
+  PremintConfigV2,
+  TokenCreationConfigV2,
+  encodeMintArguments,
+  preminterTypedDataDefinitionV2,
 } from "./preminter";
 
 const walletClient = createWalletClient({
@@ -51,8 +52,18 @@ const publicClient = createPublicClient({
 type Address = `0x${string}`;
 
 // JSON-RPC Account
-const [deployerAccount, creatorAccount, collectorAccount] =
-  (await walletClient.getAddresses()) as [Address, Address, Address, Address];
+const [
+  deployerAccount,
+  creatorAccount,
+  collectorAccount,
+  createReferralAccount,
+] = (await walletClient.getAddresses()) as [
+  Address,
+  Address,
+  Address,
+  Address,
+  Address
+];
 
 type TestContext = {
   preminterAddress: `0x${string}`;
@@ -75,20 +86,20 @@ const defaultContractConfig = ({
 
 const defaultTokenConfig = (
   fixedPriceMinterAddress: Address
-): TokenCreationConfig => ({
+): TokenCreationConfigV2 => ({
   tokenURI: "ipfs://tokenIpfsId0",
   maxSupply: 100n,
   maxTokensPerAddress: 10n,
   pricePerToken: 0n,
   mintStart: 0n,
   mintDuration: 100n,
-  royaltyMintSchedule: 30,
-  royaltyBPS: 200,
-  royaltyRecipient: creatorAccount,
   fixedPriceMinter: fixedPriceMinterAddress,
+  royaltyBPS: 10,
+  royaltyRecipient: creatorAccount,
+  createReferral: createReferralAccount,
 });
 
-const defaultPremintConfig = (fixedPriceMinter: Address): PremintConfig => ({
+const defaultPremintConfig = (fixedPriceMinter: Address): PremintConfigV2 => ({
   tokenConfig: defaultTokenConfig(fixedPriceMinter),
   deleted: false,
   uid: 105,
@@ -138,7 +149,7 @@ describe("ZoraCreator1155Preminter", () => {
       });
 
       const signedMessage = await walletClient.signTypedData({
-        ...preminterTypedDataDefinition({
+        ...preminterTypedDataDefinitionV2({
           verifyingContract: contractAddress,
           chainId: 999,
           premintConfig,
@@ -177,7 +188,7 @@ describe("ZoraCreator1155Preminter", () => {
 
       // sign message containing contract and token creation config and uid
       const signedMessage = await walletClient.signTypedData({
-        ...preminterTypedDataDefinition({
+        ...preminterTypedDataDefinitionV2({
           verifyingContract: contractAddress,
           // we need to sign here for the anvil chain, cause thats where it is run on
           chainId: anvilChainId,
@@ -187,11 +198,11 @@ describe("ZoraCreator1155Preminter", () => {
       });
 
       // recover and verify address is correct
-      const recoveredAddress = await publicClient.readContract({
+      const [, , recoveredAddress] = await publicClient.readContract({
         abi: preminterAbi,
         address: preminterAddress,
-        functionName: "recoverSigner",
-        args: [premintConfig, contractAddress, signedMessage],
+        functionName: "isValidSignature",
+        args: [contractConfig, premintConfig, signedMessage],
       });
 
       expect(recoveredAddress).to.equal(creatorAccount);
@@ -226,7 +237,7 @@ describe("ZoraCreator1155Preminter", () => {
       // have creator sign the message to create the contract
       // and the token
       const signedMessage = await walletClient.signTypedData({
-        ...preminterTypedDataDefinition({
+        ...preminterTypedDataDefinitionV2({
           verifyingContract: contractAddress,
           // we need to sign here for the anvil chain, cause thats where it is run on
           chainId: anvilChainId,
@@ -274,7 +285,7 @@ describe("ZoraCreator1155Preminter", () => {
           premintConfig,
           signedMessage,
           quantityToMint,
-          comment,
+          encodeMintArguments({ mintComment: comment }),
         ],
         value: valueToSend,
       });
@@ -319,7 +330,7 @@ describe("ZoraCreator1155Preminter", () => {
 
       // sign the message to create the second token
       const signedMessage2 = await walletClient.signTypedData({
-        ...preminterTypedDataDefinition({
+        ...preminterTypedDataDefinitionV2({
           verifyingContract: contractAddress,
           chainId: foundry.id,
           premintConfig: premintConfig2,
@@ -345,7 +356,7 @@ describe("ZoraCreator1155Preminter", () => {
           premintConfig2,
           signedMessage2,
           quantityToMint2,
-          comment,
+          encodeMintArguments({ mintComment: comment }),
         ],
         value: valueToSend2,
       });
@@ -403,7 +414,7 @@ describe("ZoraCreator1155Preminter", () => {
     // have creator sign the message to create the contract
     // and the token
     const signedMessage = await walletClient.signTypedData({
-      ...preminterTypedDataDefinition({
+      ...preminterTypedDataDefinitionV2({
         verifyingContract: contractAddress,
         // we need to sign here for the anvil chain, cause thats where it is run on
         chainId: anvilChainId,
@@ -439,7 +450,7 @@ describe("ZoraCreator1155Preminter", () => {
         premintConfig,
         signedMessage,
         quantityToMint,
-        comment,
+        encodeMintArguments({ mintComment: comment }),
       ],
       value: valueToSend,
     });

diff --git a/packages/1155-contracts/package/preminter.ts b/packages/1155-contracts/package/preminter.ts
@@ -1,7 +1,7 @@
 import { Address } from "abitype";
 import { ExtractAbiFunction, AbiParametersToPrimitiveTypes } from "abitype";
 import { zoraCreator1155PremintExecutorImplABI as preminterAbi } from "./wagmiGenerated";
-import { TypedDataDefinition } from "viem";
+import { TypedDataDefinition, encodeAbiParameters } from "viem";
 
 type PremintInputs = ExtractAbiFunction<
   typeof preminterAbi,
@@ -11,18 +11,90 @@ type PremintInputs = ExtractAbiFunction<
 type PreminterHashDataTypes = AbiParametersToPrimitiveTypes<PremintInputs>;
 
 export type ContractCreationConfig = PreminterHashDataTypes[0];
-export type PremintConfig = PreminterHashDataTypes[1];
-export type TokenCreationConfig = PremintConfig["tokenConfig"];
+export type PremintConfigs = PreminterHashDataTypes[1];
+
+export type TokenCreationConfigV1 = PremintConfigV2["tokenConfig"];
+export type PremintConfigV2 = Extract<
+  PremintConfigs,
+  {
+    tokenConfig: {
+      createReferral: string;
+    };
+  }
+>;
+export type PremintConfigV1 = Exclude<PremintConfigs, PremintConfigV2>;
+export type TokenCreationConfigV2 = PremintConfigV2["tokenConfig"];
+
+const premintV2Types = {
+  CreatorAttribution: [
+    { name: "tokenConfig", type: "TokenCreationConfig" },
+    // unique id scoped to the contract and token to create.
+    // ensure that a signature can be replaced, as long as the replacement
+    // has the same uid, and a newer version.
+    { name: "uid", type: "uint32" },
+    { name: "version", type: "uint32" },
+    // if this update should result in the signature being deleted.
+    { name: "deleted", type: "bool" },
+  ],
+  TokenCreationConfig: [
+    { name: "tokenURI", type: "string" },
+    { name: "maxSupply", type: "uint256" },
+    { name: "maxTokensPerAddress", type: "uint64" },
+    { name: "pricePerToken", type: "uint96" },
+    { name: "mintStart", type: "uint64" },
+    { name: "mintDuration", type: "uint64" },
+    { name: "royaltyBPS", type: "uint32" },
+    { name: "royaltyRecipient", type: "address" },
+    { name: "fixedPriceMinter", type: "address" },
+    { name: "createReferral", type: "address" },
+  ],
+};
+
+// Convenience method to create the structured typed data
+// needed to sign for a premint contract and token
+export const preminterTypedDataDefinitionV2 = ({
+  verifyingContract,
+  premintConfig,
+  chainId,
+}: {
+  verifyingContract: Address;
+  premintConfig: PremintConfigV2;
+  chainId: number;
+}) => {
+  const { tokenConfig, uid, version, deleted } = premintConfig;
+
+  const result: TypedDataDefinition<
+    typeof premintV2Types,
+    "CreatorAttribution"
+  > = {
+    domain: {
+      chainId,
+      name: "Preminter",
+      version: "2",
+      verifyingContract: verifyingContract,
+    },
+    types: premintV2Types,
+    message: {
+      tokenConfig,
+      uid,
+      version,
+      deleted,
+    },
+    primaryType: "CreatorAttribution",
+  };
+
+  return result;
+};
 
 // Convenience method to create the structured typed data
 // needed to sign for a premint contract and token
-export const preminterTypedDataDefinition = ({
+export const preminterTypedDataDefinitionV1 = ({
   verifyingContract,
   premintConfig,
   chainId,
 }: {
   verifyingContract: Address;
-  premintConfig: PremintConfig;
+  premintConfig: PremintConfigV1;
   chainId: number;
 }) => {
   const { tokenConfig, uid, version, deleted } = premintConfig;
@@ -68,7 +140,23 @@ export const preminterTypedDataDefinition = ({
     primaryType: "CreatorAttribution",
   };
 
-  // console.log({ result, deleted });
-
   return result;
 };
+
+const zeroAddress: Address = "0x0000000000000000000000000000000000000000";
+
+export const encodeMintArguments = ({
+  mintComment = "",
+  mintReferral = zeroAddress,
+}: {
+  mintComment?: string;
+  mintReferral?: Address;
+}) => {
+  return encodeAbiParameters(
+    [
+      { name: "mintReferral", type: "address" },
+      { name: "mintComment", type: "string" },
+    ],
+    [mintReferral, mintComment]
+  );
+};
diff --git a/packages/1155-contracts/script/DeployProxiesToNewChain.s.sol b/packages/1155-contracts/script/DeployProxiesToNewChain.s.sol
@@ -32,7 +32,7 @@ contract DeployProxiesToNewChain is ZoraDeployerBase, DeploymentTestingUtils {
 
         console2.log("testing premint");
 
-        signAndExecutePremint(deployment.preminterProxy);
+        signAndExecutePremint(deployment.preminterProxy, vm.envAddress("TEST_PREMINT_FUNDS_RECIPIENT"));
 
         vm.stopBroadcast();