Rename payout address to payout recipient

ourzora · Nov 6, 2023 · 5acd82b · 5acd82b
1 parent 1c2f8d3
commit 5acd82b
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 15 deletions.
diff --git a/.changeset/violet-starfishes-visit.md b/.changeset/violet-starfishes-visit.md
@@ -39,8 +39,8 @@ struct TokenCreationConfigV2 {
     uint64 mintDuration;
     // RoyaltyBPS for created tokens. The royalty amount in basis points for secondary sales.
     uint32 royaltyBPS;
-    // The address that will receive creatorRewards, secondary royalties, and paid mint funds.
-    address payoutAddress;
+    // The address that will receive creatorRewards, secondary royalties, and paid mint funds.  This is the address that will be set on the `royaltyRecipient` for the created token on the 1155 contract, which is the address that receives creator rewards and secondary royalties for the token, and on the `fundsRecipient` on the ZoraCreatorFixedPriceSaleStrategy contract for the token, which is the address that receives paid mint funds for the token.
+    address payoutRecipient;
     // Fixed price minter address
     address fixedPriceMinter;
     // create referral

diff --git a/packages/1155-contracts/src/delegation/ZoraCreator1155Attribution.sol b/packages/1155-contracts/src/delegation/ZoraCreator1155Attribution.sol
@@ -79,8 +79,11 @@ struct TokenCreationConfigV2 {
     uint64 mintDuration;
     // RoyaltyBPS for created tokens. The royalty amount in basis points for secondary sales.
     uint32 royaltyBPS;
-    // The address that will receive creatorRewards, secondary royalties, and paid mint funds.
-    address payoutAddress;
+    // This is the address that will be set on the `royaltyRecipient` for the created token on the 1155 contract,
+    // which is the address that receives creator rewards and secondary royalties for the token,
+    // and on the `fundsRecipient` on the ZoraCreatorFixedPriceSaleStrategy contract for the token,
+    // which is the address that receives paid mint funds for the token.
+    address payoutRecipient;
     // Fixed price minter address
     address fixedPriceMinter;
     // create referral
@@ -195,7 +198,7 @@ library ZoraCreator1155Attribution {
 
     bytes32 constant TOKEN_DOMAIN_V2 =
         keccak256(
-            "TokenCreationConfig(string tokenURI,uint256 maxSupply,uint64 maxTokensPerAddress,uint96 pricePerToken,uint64 mintStart,uint64 mintDuration,uint32 royaltyBPS,address payoutAddress,address fixedPriceMinter,address createReferral)"
+            "TokenCreationConfig(string tokenURI,uint256 maxSupply,uint64 maxTokensPerAddress,uint96 pricePerToken,uint64 mintStart,uint64 mintDuration,uint32 royaltyBPS,address payoutRecipient,address fixedPriceMinter,address createReferral)"
         );
 
     function _hashToken(TokenCreationConfigV2 memory tokenConfig) private pure returns (bytes32) {
@@ -210,7 +213,7 @@ library ZoraCreator1155Attribution {
                     tokenConfig.mintStart,
                     tokenConfig.mintDuration,
                     tokenConfig.royaltyBPS,
-                    tokenConfig.payoutAddress,
+                    tokenConfig.payoutRecipient,
                     tokenConfig.fixedPriceMinter,
                     tokenConfig.createReferral
                 )
@@ -266,7 +269,7 @@ library PremintTokenSetup {
                 maxTokensPerAddress: tokenConfig.maxTokensPerAddress,
                 mintDuration: tokenConfig.mintDuration,
                 royaltyBPS: tokenConfig.royaltyBPS,
-                payoutAddress: tokenConfig.payoutAddress
+                payoutRecipient: tokenConfig.payoutRecipient
             });
     }
 
@@ -280,7 +283,7 @@ library PremintTokenSetup {
                 maxTokensPerAddress: tokenConfig.maxTokensPerAddress,
                 mintDuration: tokenConfig.mintDuration,
                 royaltyBPS: tokenConfig.royaltyBPS,
-                payoutAddress: tokenConfig.royaltyRecipient
+                payoutRecipient: tokenConfig.royaltyRecipient
             });
     }
 
@@ -291,7 +294,7 @@ library PremintTokenSetup {
         uint64 maxTokensPerAddress,
         uint64 mintDuration,
         uint32 royaltyBPS,
-        address payoutAddress
+        address payoutRecipient
     ) private view returns (bytes[] memory calls) {
         calls = new bytes[](3);
 
@@ -318,7 +321,7 @@ library PremintTokenSetup {
         calls[2] = abi.encodeWithSelector(
             IZoraCreator1155.updateRoyaltiesForToken.selector,
             newTokenId,
-            ICreatorRoyaltiesControl.RoyaltyConfiguration({royaltyBPS: royaltyBPS, royaltyRecipient: payoutAddress, royaltyMintSchedule: 0})
+            ICreatorRoyaltiesControl.RoyaltyConfiguration({royaltyBPS: royaltyBPS, royaltyRecipient: payoutRecipient, royaltyMintSchedule: 0})
         );
     }
 

diff --git a/packages/1155-contracts/test/fixtures/Zora1155PremintFixtures.sol b/packages/1155-contracts/test/fixtures/Zora1155PremintFixtures.sol
@@ -26,7 +26,7 @@ library Zora1155PremintFixtures {
                 mintStart: 0,
                 mintDuration: 0,
                 fixedPriceMinter: address(fixedPriceMinter),
-                payoutAddress: royaltyRecipient,
+                payoutRecipient: royaltyRecipient,
                 royaltyBPS: 0,
                 createReferral: address(0)
             });
@@ -46,7 +46,7 @@ library Zora1155PremintFixtures {
                 mintStart: 0,
                 mintDuration: 0,
                 fixedPriceMinter: address(fixedPriceMinter),
-                payoutAddress: royaltyRecipient,
+                payoutRecipient: royaltyRecipient,
                 royaltyBPS: 10,
                 createReferral: createReferral
             });

diff --git a/packages/1155-contracts/test/nft/ZoraCreator1155.t.sol b/packages/1155-contracts/test/nft/ZoraCreator1155.t.sol
@@ -1063,7 +1063,7 @@ contract ZoraCreator1155Test is Test {
                 mintStart: 0,
                 // The duration of the mint, starting from the first mint of this token. 0 for infinite
                 mintDuration: type(uint64).max - 1,
-                payoutAddress: admin,
+                payoutRecipient: admin,
                 royaltyBPS: 0,
                 // Fixed price minter address
                 fixedPriceMinter: address(fixedPriceMinter),

diff --git a/packages/premint-sdk/src/preminter.test.ts b/packages/premint-sdk/src/preminter.test.ts
@@ -95,7 +95,7 @@ const defaultTokenConfig = (
   mintDuration: 100n,
   fixedPriceMinter: fixedPriceMinterAddress,
   royaltyBPS: 10,
-  royaltyRecipient: creatorAccount,
+  payoutRecipient: creatorAccount,
   createReferral: createReferralAccount,
 });
 

diff --git a/packages/premint-sdk/src/preminter.ts b/packages/premint-sdk/src/preminter.ts
@@ -42,7 +42,7 @@ const premintV2Types = {
     { name: "mintStart", type: "uint64" },
     { name: "mintDuration", type: "uint64" },
     { name: "royaltyBPS", type: "uint32" },
-    { name: "royaltyRecipient", type: "address" },
+    { name: "payoutRecipient", type: "address" },
     { name: "fixedPriceMinter", type: "address" },
     { name: "createReferral", type: "address" },
   ],