diff --git a/docs/pages/changelogs/1155-contracts.mdx b/docs/pages/changelogs/1155-contracts.mdx index acbfa6c72..749bddcde 100644 --- a/docs/pages/changelogs/1155-contracts.mdx +++ b/docs/pages/changelogs/1155-contracts.mdx @@ -54,7 +54,7 @@ - [898c84a7](https://github.com/ourzora/zora-protocol/commit/898c84a7): [chore] Update dependencies and runtime scripts - This ensures jobs do not match binary names to make runs less ambigious and also that all deps are accounted for. + This ensures jobs do not match binary names to make runs less ambiguous and also that all deps are accounted for. - [2677c896](https://github.com/ourzora/zora-protocol/commit/2677c896): Add reduceSupply interface check to 1155 @@ -178,11 +178,11 @@ } ``` -- [2475a4c9](https://github.com/ourzora/zora-protocol/commit/2475a4c9): Updates to Premint that enables preminting against contracts that were not created via premint, as well as adding collaborators to premint contracts by being able specify an array of additionalAdmins in a premint's contract creation config. +- [2475a4c9](https://github.com/ourzora/zora-protocol/commit/2475a4c9): Updates to Premint that enables preminting against contracts that were not created via premint, as well as adding collaborators to premint contracts by being able to specify an array of additionalAdmins in a premint's contract creation config. #### No breaking changes - These updates are fully backwards compatible; the old functions on the contracts are still intact and will work. Additionally, these updates dont require a new premint config version to be signed; the only thing that could be affected is the deterministic address to be signed against, in the case there are additional contract admins. + These updates are fully backwards compatible; the old functions on the contracts are still intact and will work. Additionally, these updates don't require a new premint config version to be signed; the only thing that could be affected is the deterministic address to be signed against, in the case there are additional contract admins. #### Ability to add contract-wide additional admins with premint @@ -570,7 +570,7 @@ Prior to 2.9.0, rewards were distributed based on a fixed value in ETH per token - 885ffa4: Premint executor can still execute premint mints that were created with V1 signatures for `delegateSetupNewToken` - ffb5cb7: Premint - added method getSupportedPremintSignatureVersions(contractAddress) that returns an array of the premint signature versions an 1155 contract supports. If the contract hasn't been created yet, assumes that when it will be created it will support the latest versions of the signatures, so the function returns all versions. -- ffb5cb7: Added method `IZoraCreator1155PremintExecutor.supportedPremintSignatureVersions(contractAddress)` that tells what version of the premint signature the contract supports, and added corresponding method `ZoraCreator1155Impl.supportedPremintSignatureVersions()` to fetch supported version. If premint not supported, returns an empty array. +- ffb5cb7: Added method `IZoraCreator1155PremintExecutor.supportedPremintSignatureVersions(contractAddress)` that tells what version of the premint signature the contract supports, and added corresponding method `ZoraCreator1155Impl.supportedPremintSignatureVersions()` to fetch supported version. If premint is not supported, returns an empty array. - cacb543: Added impl getter to premint executor ## 2.4.1 diff --git a/docs/pages/contracts/events.mdx b/docs/pages/contracts/events.mdx index d672aff91..db7b6beac 100644 --- a/docs/pages/contracts/events.mdx +++ b/docs/pages/contracts/events.mdx @@ -14,7 +14,7 @@ Now that we have both gasless and on-chain minting the token creation event argu Creating new tokens can happen with a call to either [`setupNewToken()`](https://github.com/ourzora/zora-protocol/blob/HEAD/packages/1155-contracts/src/nft/ZoraCreator1155Impl.sol#L260) or [`delegateSetupNewToken()`](https://github.com/ourzora/zora-protocol/blob/f58ee955e6b50c13e90b4cfd72ab4b68dce86fad/packages/1155-contracts/src/nft/ZoraCreator1155Impl.sol#L765) (used by the gasless creation mint flow). -Be aware that often creating a new token and minting often occur in the _same_ transaction. +Be aware that often creating a new token and minting often occurs in the _same_ transaction. It is also possible to setup a new token without a mint event. diff --git a/docs/pages/protocol-sdk/creator/premint.mdx b/docs/pages/protocol-sdk/creator/premint.mdx index 78f438eb4..6411e3788 100644 --- a/docs/pages/protocol-sdk/creator/premint.mdx +++ b/docs/pages/protocol-sdk/creator/premint.mdx @@ -70,7 +70,7 @@ One of the items returned from `create` is `signAndSubmit` which must be called ::: -### Signing and Submitting Premint a Premint using Wagmi +### Signing and Submitting Premint using Wagmi Sometimes it may be desirable to sign a premint with another library, and not using the sdk's `signAndSubmit` method. For this case, the `createPremint`, `updatePremint`, and `deletePremint` functions return a `typedDataDefinition` which is the typed data definition for the premint and must be signed. @@ -141,7 +141,7 @@ This signature and deleted premint is then submitted to the Zora Premint API and ::: -### Earning Create Referral Referral Rewards +### Earning Create Referral Rewards To earn a create referral reward, pass in the `createReferral` argument when creating a Premint: diff --git a/docs/pages/protocol-sdk/introduction.mdx b/docs/pages/protocol-sdk/introduction.mdx index c31c3a9e8..567c32139 100644 --- a/docs/pages/protocol-sdk/introduction.mdx +++ b/docs/pages/protocol-sdk/introduction.mdx @@ -1,6 +1,6 @@ --- title: Protocol SDK Introduction -description: Zora Protocol SDKs are a suite of typescript libraries and utilites that simplify interacting with the Zora protocol +description: Zora Protocol SDKs are a suite of typescript libraries and utilities that simplify interacting with the Zora protocol --- # Zora Protocol SDKs diff --git a/packages/1155-contracts/src/permissions/CreatorPermissionControl.sol b/packages/1155-contracts/src/permissions/CreatorPermissionControl.sol index 0f35946d3..56ed06e24 100644 --- a/packages/1155-contracts/src/permissions/CreatorPermissionControl.sol +++ b/packages/1155-contracts/src/permissions/CreatorPermissionControl.sol @@ -11,7 +11,7 @@ contract CreatorPermissionControl is CreatorPermissionStorageV1, ICreatorPermiss /// @dev if multiple permissions are passed in this checks for any one of those permissions /// @return true or false if any of the passed in permissions apply function _hasAnyPermission(uint256 tokenId, address user, uint256 permissionBits) internal view returns (bool) { - // Does a bitwise and and checks if any of those permissions match + // Does a bitwise and checks if any of those permissions match return permissions[tokenId][user] & permissionBits > 0; } @@ -19,7 +19,7 @@ contract CreatorPermissionControl is CreatorPermissionStorageV1, ICreatorPermiss /// @dev if multiple permissions are passed in this checks for any one of those permissions /// @return true or false if any of the passed in permissions apply function _hasAllPermissions(uint256 tokenId, address user, uint256 permissionBits) internal view returns (bool) { - // Does a bitwise and and checks if all of those permissions match + // Does a bitwise and checks if all of those permissions match return permissions[tokenId][user] & permissionBits == permissionBits; } diff --git a/packages/1155-contracts/test/nft/ZoraCreator1155.t.sol b/packages/1155-contracts/test/nft/ZoraCreator1155.t.sol index bb8b41009..ffee520a3 100644 --- a/packages/1155-contracts/test/nft/ZoraCreator1155.t.sol +++ b/packages/1155-contracts/test/nft/ZoraCreator1155.t.sol @@ -1659,7 +1659,7 @@ contract ZoraCreator1155Test is Test { assertEq(protocolRewards.balanceOf(zora), firstMintZoraBalance); assertEq(protocolRewards.balanceOf(mintReferral), firstMintMintReferralBalance); - // update quanity to be fuzzy value - 1 + // update quantity to be fuzzy value - 1 quantity = quantity - 1; totalReward = target.computeTotalReward(target.mintFee(), quantity); diff --git a/packages/1155-contracts/test/premint/ZoraCreator1155PremintExecutor.t.sol b/packages/1155-contracts/test/premint/ZoraCreator1155PremintExecutor.t.sol index f172a3a85..fee784543 100644 --- a/packages/1155-contracts/test/premint/ZoraCreator1155PremintExecutor.t.sol +++ b/packages/1155-contracts/test/premint/ZoraCreator1155PremintExecutor.t.sol @@ -122,7 +122,7 @@ contract ZoraCreator1155PreminterTest is Test { uint256 chainId = block.chainid; // get contract hash, which is unique per contract creation config, and can be used - // retreive the address created for a contract + // retrieve the address created for a contract address contractAddress = preminter.getContractAddress(contractConfig); // 2. Call smart contract to get digest to sign for creation params. @@ -168,7 +168,7 @@ contract ZoraCreator1155PreminterTest is Test { uint256 chainId = block.chainid; // get contract hash, which is unique per contract creation config, and can be used - // retreive the address created for a contract + // retrieve the address created for a contract address contractAddress = preminter.getContractAddress(contractConfig); // 2. Call smart contract to get digest to sign for creation params. @@ -208,7 +208,7 @@ contract ZoraCreator1155PreminterTest is Test { vm.prank(premintExecutor); tokenId = preminter.premintV2{value: mintCost}(contractConfig, premintConfig, signature, quantityToMint, defaultMintArguments).tokenId; - // a new token shoudl have been created, with x tokens minted to the executor, on the same contract address + // a new token should have been created, with x tokens minted to the executor, on the same contract address // as before since the contract config didnt change assertEq(created1155Contract.balanceOf(premintExecutor, tokenId), quantityToMint); } @@ -224,7 +224,7 @@ contract ZoraCreator1155PreminterTest is Test { uint256 chainId = block.chainid; // get contract hash, which is unique per contract creation config, and can be used - // retreive the address created for a contract + // retrieve the address created for a contract address contractAddress = preminter.getContractAddress(contractConfig); // 2. Call smart contract to get digest to sign for creation params. diff --git a/packages/1155-deployments/CHANGELOG.md b/packages/1155-deployments/CHANGELOG.md index 87f4fca6f..0b0e70a0f 100644 --- a/packages/1155-deployments/CHANGELOG.md +++ b/packages/1155-deployments/CHANGELOG.md @@ -18,7 +18,7 @@ ### Patch Changes -- c2a0a2b: Moved dev depenencies to devDependencies since they are not needed by external users of the package, they are only used for codegen +- c2a0a2b: Moved dev dependencies to devDependencies since they are not needed by external users of the package, they are only used for codegen ## 0.0.3 diff --git a/packages/1155-deployments/script/UpgradePreminter.s.sol b/packages/1155-deployments/script/UpgradePreminter.s.sol index e1de152f8..96e1dbbbc 100644 --- a/packages/1155-deployments/script/UpgradePreminter.s.sol +++ b/packages/1155-deployments/script/UpgradePreminter.s.sol @@ -25,7 +25,7 @@ contract UpgradePreminter is ZoraDeployerBase { upgradeTarget = deployment.preminterImpl; - console2.log("Upgrade PremintExecutor target and implementatin:", upgradeTarget, preminterImplementation); + console2.log("Upgrade PremintExecutor target and implementation:", upgradeTarget, preminterImplementation); console2.log("To upgrade, use this calldata:"); console2.logBytes(upgradeCalldata); diff --git a/packages/1155-deployments/script/copy-deployed-contracts.ts b/packages/1155-deployments/script/copy-deployed-contracts.ts index db8d60c71..ef0ebe0e6 100644 --- a/packages/1155-deployments/script/copy-deployed-contracts.ts +++ b/packages/1155-deployments/script/copy-deployed-contracts.ts @@ -23,8 +23,8 @@ async function copyEnvironmentRunFiles() { // a recent version of forge added a bug where the returns value with some sort of url based encoding. // the below code is a hack to fix this. It should be removed once forge is fixed. - // use string regex replace all to remove all instances of \\ from returns (this appeared in a wierd version of forge) - // also opening and closing quotes that incorrecly appear before opening bracket: + // use string regex replace all to remove all instances of \\ from returns (this appeared in a weird version of forge) + // also opening and closing quotes that incorrectly appear before opening bracket: const filtered = returns .replace(/\\/g, "") .replace('"{', "{") diff --git a/packages/1155-deployments/script/getPendingUpgrades.ts b/packages/1155-deployments/script/getPendingUpgrades.ts index 8254040c6..ba5b52ed1 100644 --- a/packages/1155-deployments/script/getPendingUpgrades.ts +++ b/packages/1155-deployments/script/getPendingUpgrades.ts @@ -235,7 +235,7 @@ async function getVersions({ let contractImpl: Address | null = null; - // try to get contract fro rpc + // try to get contract for rpc try { contractImpl = await publicClient.readContract({ address: factoryImpl as Address, diff --git a/packages/1155-deployments/src/DeterministicDeployerScript.sol b/packages/1155-deployments/src/DeterministicDeployerScript.sol index 48f408ca6..e9ac43e4b 100644 --- a/packages/1155-deployments/src/DeterministicDeployerScript.sol +++ b/packages/1155-deployments/src/DeterministicDeployerScript.sol @@ -149,7 +149,7 @@ contract DeterministicDeployerScript is Script { bytes memory proxyCreationCode, uint256 proxyShimSaltSuffix ) internal returns (DeterministicParams memory) { - // 1. Get salt with first bytes that match address, and resulting determinisitic factory proxy deployer address + // 1. Get salt with first bytes that match address, and resulting deterministic factory proxy deployer address (bytes32 proxyDeployerSalt, bytes memory proxyDeployerCreationCode, address proxyDeployerAddress) = getProxyDeployerParams(); // replace first 20 characters of salt with deployer address, so that the salt can be used with // ImmutableCreate2Factory.safeCreate2 when called by this deployer's account: diff --git a/packages/1155-deployments/test/NewFactoryProxyDeployer.t.sol b/packages/1155-deployments/test/NewFactoryProxyDeployer.t.sol index 2c0cf4453..6393fac71 100644 --- a/packages/1155-deployments/test/NewFactoryProxyDeployer.t.sol +++ b/packages/1155-deployments/test/NewFactoryProxyDeployer.t.sol @@ -103,7 +103,7 @@ contract DeterministicProxyDeployerTest is DeterministicDeployerScript, Test { (address deployerAddress, uint256 deployerPrivateKey) = makeAddrAndKey("deployer"); vm.assume(nonce > vm.getNonce(deployerAddress)); - // we set the nonce to a random value, to prove this doesn't affect the deterministic addrss + // we set the nonce to a random value, to prove this doesn't affect the deterministic address vm.setNonce(deployerAddress, nonce); DeterministicProxyDeployer factoryProxyDeployer = _deployKnownZoraFactoryProxy(bytes32(0)); diff --git a/packages/1155-deployments/test/ZoraCreator1155FactoryBase.sol b/packages/1155-deployments/test/ZoraCreator1155FactoryBase.sol index 80b557bda..156e79694 100644 --- a/packages/1155-deployments/test/ZoraCreator1155FactoryBase.sol +++ b/packages/1155-deployments/test/ZoraCreator1155FactoryBase.sol @@ -57,7 +57,7 @@ contract ZoraCreator1155FactoryBase is ForkDeploymentConfig, Test, DeploymentCon } function _createErc1155Contract(IZoraCreator1155Factory factory) private returns (IZoraCreator1155 target) { - // create the contract, with no toekns + // create the contract, with no tokens bytes[] memory initSetup = new bytes[](0); address admin = creator;