Skip to content

Commit

Permalink
fix typos (#261)
Browse files Browse the repository at this point in the history
* fix typos

* fix typos

* fix typo

* fix typo

* fix typo

* fix typo

* fix typo

* fix typos
  • Loading branch information
omahs authored Oct 11, 2023
1 parent 2dbf40e commit 00108ed
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 14 deletions.
10 changes: 5 additions & 5 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Deploying to a new chain

1. Setup new `chainConfigs` file setting 1. fee recipient, and 2. owner for factory contracts
2. Generate signatures for deploying upgrade gate at a deterministic address and trasfering ownership to the factory owner:
2. Generate signatures for deploying upgrade gate at a deterministic address and transfering ownership to the factory owner:

npx tsx script/signDeploymentTransactions.ts

Expand All @@ -15,7 +15,7 @@

npx tsx script/copy-deployed-contracts.ts

5. Generate signatures to deploy proxy contracts at determinstic address:
5. Generate signatures to deploy proxy contracts at deterministic address:

npx tsx script/signDeploymentTransactions.ts

Expand Down Expand Up @@ -46,11 +46,11 @@ Publishing happens in the following steps:
* *If there are changes to the smart contracts that should be deployed*: the contract should be. Deploying the contract results in the addresses of the deployed contracts being updated in the corresponding `./addresses/{chainId}.json` file. This file should be committed and pushed to github.
* Running the command `npx changeset` will generate **a new changeset** in the `./changesets` directory. This changeset will be used to determine the next version of the bundled packages; this commit should then be pushed.
* The changeset and smart contract addresses are pushed to the branch.
* The pr is merged into main - any changesets in the PR are detected by a github action `release`, which will then **open a new PR** with proper the versions and readme updated in each each package. If more changesets are pushed to main before this branch is merged, the PR will continuously update the version of the packages according to the changeset specifiction.
* The pr is merged into main - any changesets in the PR are detected by a github action `release`, which will then **open a new PR** with proper versions and readme updated in each each package. If more changesets are pushed to main before this branch is merged, the PR will continuously update the version of the packages according to the changeset specification.

7. That version is merged into main along with the new versions.

8. The package is the published to npm with the command: `yarn publish-packages` and the package is published.
8. The package is then published to npm with the command: `yarn publish-packages` and the package is published.

In a future version, the when the version branch is merged into main, it can publish the new repos to github.

Expand All @@ -61,4 +61,4 @@ Some active questions:
Future ideas:

* Allow deployment to happen via github actions:
* Deployments can be added to changesets through some command. If a changeset is pushed to main and a deployment is detected in it, a deployment task is added to the PR that's created. When that PR is merged, the deployment happens, and a new package is built and publised to npm with the new versions.
* Deployments can be added to changesets through some command. If a changeset is pushed to main and a deployment is detected in it, a deployment task is added to the PR that's created. When that PR is merged, the deployment happens, and a new package is built and published to npm with the new versions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ZORA 1155 Contracts

The Zora Creator 1155 Contracts are the 1155 compliment to the Zora 721 Drops Contracts. While the 721 Drops Contracts enable creators to mint unique, non-fungible tokens (NFTs), the 1155 Contracts allow creators to mint semi-fungible tokens with a set of flexible properties.
The Zora Creator 1155 Contracts are the 1155 complement to the Zora 721 Drops Contracts. While the 721 Drops Contracts enable creators to mint unique, non-fungible tokens (NFTs), the 1155 Contracts allow creators to mint semi-fungible tokens with a set of flexible properties.

The main implementation of the Zora Creator 1155 Contracts includes the following modules:

Expand Down
2 changes: 1 addition & 1 deletion script/CalculateDeterministicParams.s.sol
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import {DeterministicDeployerScript, DeterministicParams} from "../src/deploymen
import {DeterministicProxyDeployer} from "../src/deployment/DeterministicProxyDeployer.sol";
import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";

/// @title Gets parameters for determinstically deploying a new 1155 factory proxy at an address starting with 0x777777, regardless of the chain.
/// @title Gets parameters for deterministically deploying a new 1155 factory proxy at an address starting with 0x777777, regardless of the chain.
/// @dev Example usage: DEPLOYER=0xf69fEc6d858c77e969509843852178bd24CAd2B6 forge script script/GetDeterminsticParam.s.sol --rpc-url https://testnet.rpc.zora.energy --ffi
/// @author doved
/// @notice Ensure to set env variable for DEPLOYER
Expand Down
2 changes: 1 addition & 1 deletion script/TestCreateDeterministic.sol
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ contract DeployScript is ZoraDeployerBase {

address factoryOwner = deployer;

// 1. create the proxy, pointing it to the factory implentation and setting the owner
// 1. create the proxy, pointing it to the factory implementation and setting the owner
ZoraCreator1155FactoryImpl proxy = ZoraCreator1155FactoryImpl(
payable(new Zora1155Factory(address(factory), abi.encodeWithSelector(ZoraCreator1155FactoryImpl.initialize.selector, factoryOwner)))
);
Expand Down
2 changes: 1 addition & 1 deletion script/ZoraDeployerBase.sol
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ abstract contract ZoraDeployerBase is ScriptDeploymentConfig, DeterministicDeplo
string constant DEMO_IPFS_METADATA_FILE = "ipfs://bafkreigu544g6wjvqcysurpzy5pcskbt45a5f33m6wgythpgb3rfqi3lzi";

/// @notice Get deployment configuration struct as JSON
/// @param deployment deploymet struct
/// @param deployment deployment struct
/// @return deploymentJson string JSON of the deployment info
function getDeploymentJSON(Deployment memory deployment) internal returns (string memory deploymentJson) {
string memory deploymentJsonKey = "deployment_json_file_key";
Expand Down
4 changes: 2 additions & 2 deletions src/delegation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A Preminter contract validates signatures and executes actions to 1. deploy cont
`Preminter`: Executes commands on the 1155 contract factory, and created 1155 contracts

Constraints:
* **Contract creation params must be unique** - the combination of creator + metadata uri + name must be unique. The Preminter can only create a single contract for each combination of creator, metadat uri, and name, as that combination is used to determinstically determine the contract address.
* **Contract creation params must be unique** - the combination of creator + metadata uri + name must be unique. The Preminter can only create a single contract for each combination of creator, metadata uri, and name, as that combination is used to deterministically determine the contract address.

Functions:
* `premint`: takes an [EIP712 signature](https://eips.ethereum.org/EIPS/eip-712) created by a creator, contract and token creation params, and creates a contract if the contract doesn’t exist and creates a new token, or creates a new token on an existing contract if it exists. It then mints a specified quantity of tokens to the executor as a reward. These parameters are the same both if a new contract is created or a token is created on an existing contract. The signature must have been previously created from a hash built from all of the input parameters; the hash can be generated using `premintHashData`. **Each signature can only be executed against once**; this is enforced through uniqueness of the contract creation params, the token creation params, and quantity to mint.
Expand Down Expand Up @@ -49,4 +49,4 @@ Collecting:
## Additional caveats

* The `Preminter` contract is granted the role `PERMISSION_BIT_MINTER` on the 1155 contract, allowing it to create new tokens.
* There are some issues where marketplaces show tx.origin of a transaction as the contract creator, which in this case would show the collector as the contract creator.
* There are some issues where marketplaces show tx.origin of a transaction as the contract creator, which in this case would show the collector as the contract creator.
2 changes: 1 addition & 1 deletion src/delegation/ZoraCreator1155Attribution.sol
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ library ZoraCreator1155Attribution {
}
}

/// @notice Utilitiy library to setup tokens created via premint. Functions exposed as external to not increase contract size in calling contract.
/// @notice Utility library to setup tokens created via premint. Functions exposed as external to not increase contract size in calling contract.
/// @author oveddan
library PremintTokenSetup {
uint256 constant PERMISSION_BIT_MINTER = 2 ** 2;
Expand Down
4 changes: 2 additions & 2 deletions src/delegation/ZoraCreator1155PremintExecutorImpl.sol
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ contract ZoraCreator1155PremintExecutorImpl is Ownable2StepUpgradeable, UUPSUpgr
isNewContract = contractAddress.code.length == 0;

if (isNewContract) {
// if address doesnt exist for hash, createi t
// if address doesn't exist for hash, create it
tokenContract = _createContract(contractConfig);
} else {
tokenContract = IZoraCreator1155(contractAddress);
Expand All @@ -126,7 +126,7 @@ contract ZoraCreator1155PremintExecutorImpl is Ownable2StepUpgradeable, UUPSUpgr
}

/// Gets the deterministic contract address for the given contract creation config.
/// Contract address is generated deterministically from a hash based onthe contract uri, contract name,
/// Contract address is generated deterministically from a hash based on the contract uri, contract name,
/// contract admin, and the msg.sender, which is this contract's address.
function getContractAddress(ContractCreationConfig calldata contractConfig) public view returns (address) {
return
Expand Down

0 comments on commit 00108ed

Please sign in to comment.