Premint: updated documentation #199

oveddan · 2023-09-22T15:55:45Z

No description provided.

oveddan · 2023-09-22T15:56:07Z

Current dependencies on/for this PR:

main
- PR Fix published package to properly reference types #193
  - PR Prerelease workflow for versioning + publishing prerelease tags #184
    - PR Premint #161
      - PR refactor: only mint if specified quantity is greater than 0 #212
      - PR refactor: implement first minter reward on adminMint #207
        
        PR refactor: remove mint fee amount deploy param #208
      - PR refactor: add helper to read uups implementation #206
      - PR fix: redeem minter tests #203
      - PR move factory to a standalone contract #202
      - PR Move factory upgrade gate to seperate contract #200
      - PR Premint: updated documentation #199 👈
      - PR Add back mint fee getter #198
      - PR Premint - upgradeable premint, new deployment scripts, and premint proxy deployment #189
        
        PR Premint - expose preminter via js sdk #190
        
        PR Premint - factory proxy 777 deployments #191
        
        PR Premint prerelease #187
      - PR Premint - move delegated minter state to its own contract #188
      - PR Prerelease workflow for versioning + publishing prerelease tags #179
        
        PR Premint - proxy deployment and updated deployment scripts #171
        
        PR Update deployment instructions #183
        
        PR Prerelease ci task #178
        
        PR Expose preminter from package #175
        
        PR Premint: pre-release #173
        
        PR Premint: 1.5.0-gasless release #172
      - PR Premint - include erc1155 errors in premint executor abi, by extracting its errors into interface and importing it #170
      - PR Premint - premint executor is upgradeable #168
        
        PR Premint - wrap erc1155 errors in an error that can be decoded - Erc1155CallReverted(bytes errorRevertedData) #169
      - PR Premint - move attribution lib to contract consumed via interface #166
      - PR Premint: fix fork tests #164
      - PR Premint: add creator to creator attribution event #163
      - PR Premint: first minter rewards #162

This comment was auto-generated by Graphite.

iainnash · 2023-09-26T18:07:11Z

@oveddan this looks good to merge?

* * Check if key exists reading an address, as to not result in unexpected reverts * In premint tests, allow all forks to run the tests, but skip if there is no address for preminter * update storage layout

* Creator attribution - add creator to event * * Renamed creator attribution args from bytes32 to string to match the standard * Added test that verifies creator attribution event emitted

* refactor: remove legacy mint fee contracts * refactor: remove unusued import * chore: update tests * chore: lint * chore: update runs * chore: update storage layout * style: update natspec * chore: update tests * chore: remove unused var * chore: update tests * fix: move hardcoded fork vars to constants * added first minter changeset * * Added changeset that depreates redeem minters. * Remove Redeem minter from coverage. --------- Co-authored-by: Rohan Kulkarni <kulkarohan@gmail.com>

Moved some common factory setup logic to some library fixtures

…mint contract (#170)

…ersion. Will do updates via the standard changeset way

* Premint * Add back mint fee getter (#198) * add back mint fee getter * add mint fee to interface * * Updated script to deploy preminter to now deploy the proxy (#189) * Extracted common deployment tasks to reusable helper functions * Added script to upgrade preminter * Premint - move premint state to its own contract (#188) Renamed Premint folder to delegated mint * fix: redeem minter tests * fix: token transfer hook for single token transfers * feat: add unit tests * Seperate upgrade gate new contract (#204) * wip * wip * fix tests * chore: run lint & update natspec * update storage layout --------- Co-authored-by: Rohan Kulkarni <kulkarohan@gmail.com> * refactor: add helper to read uups implementation * fix: param name casing * refactor: use updated zora 1155 impl getter * refactor: add helper to read uups implementation * fix: zora 1155 impl var name * chore: run lint * chore: run lint * refactor: implement first minter reward on adminMint * chore: update runs * refactor: remove mint fee amount deploy param * chore: run lint * chore: run lint * chore: remove mint fee amount from chain configs * chore: update fork test * fix: use mint w rewards to gurantee mint fee amount * Premint: updated documentation (#199) Premint - update documentation * move upgrade gate to initializer pattern (#209) * move upgrade gate to initalizer pattern * formatting * refactor: only mint if specified quantity is greater than 0 (#212) * refactor: only mint if specified quantity is greater than 0 * fix tests --------- Co-authored-by: Dan Oved <stangogh@gmail.com> * Premint - factory proxy 777 deployments (#191) * Can mine for a determinstic address for the proxy shim in a script, and have a test that shows we can determinstically deploy proxy to that address with that salt and deployer account * wip on deploy via script. nneed to create web ui * cleanup * update test to work with new params :) * deployment works now!. lets genericize stuff :) * consolidated into one * end to end scripting works :) * renamed and refactored to be more usable * Determinstic deployer scripts are more generic and can deploy and verify :) * rename * another rename :) * Premint proxy deploy (#211) * made premint executor ugparde scripts. renamed executor to proxy * deploy preminter impl with script, and updated the config for that chain * Have premint proxy deploy scripts. can deploy both now * preminter proxy pushed * Refactor deterministic add upgrade gate (#210) * large refactor * update scripts * updates to test code * test naming updates * compiler run correctly * update with new deterministic configs * make node deps only for scripts * Premint deploy determinstic fix tests (#213) * fixed tests by just making it more dyanmic * fix stack too deep error for coverage * ignore deployment folder for coverage * properly filter out deployment --------- Co-authored-by: Iain Nash <iain@zora.co> * update deps * add back release command * fix version publish * fix contract version * move wagmi cli to proper version * more things in dev deps * move all into deps * update protocol rewards package (#226) * fix build * fix wagmi build * Clean Up Transfer Hook Mock (#229) * fix: remove unused param names * fix: linting --------- Co-authored-by: Rohan Kulkarni <kulkarohan@gmail.com> Co-authored-by: Rohan Kulkarni <rohan@ourzora.com> Co-authored-by: Isabella Smallcombe <isabella@ourzora.com> Co-authored-by: Iain Nash <iain@zora.co> Co-authored-by: Isabella Smallcombe <isabella.smallcombe@gmail.com>

* Premint * Add back mint fee getter (#198) * add back mint fee getter * add mint fee to interface * * Updated script to deploy preminter to now deploy the proxy (#189) * Extracted common deployment tasks to reusable helper functions * Added script to upgrade preminter * Premint - move premint state to its own contract (#188) Renamed Premint folder to delegated mint * fix: redeem minter tests * fix: token transfer hook for single token transfers * feat: add unit tests * Seperate upgrade gate new contract (#204) * wip * wip * fix tests * chore: run lint & update natspec * update storage layout --------- Co-authored-by: Rohan Kulkarni <kulkarohan@gmail.com> * refactor: add helper to read uups implementation * fix: param name casing * refactor: use updated zora 1155 impl getter * refactor: add helper to read uups implementation * fix: zora 1155 impl var name * chore: run lint * chore: run lint * refactor: implement first minter reward on adminMint * chore: update runs * refactor: remove mint fee amount deploy param * chore: run lint * chore: run lint * chore: remove mint fee amount from chain configs * chore: update fork test * fix: use mint w rewards to gurantee mint fee amount * Premint: updated documentation (#199) Premint - update documentation * move upgrade gate to initializer pattern (#209) * move upgrade gate to initalizer pattern * formatting * refactor: only mint if specified quantity is greater than 0 (#212) * refactor: only mint if specified quantity is greater than 0 * fix tests --------- Co-authored-by: Dan Oved <stangogh@gmail.com> * Premint - factory proxy 777 deployments (#191) * Can mine for a determinstic address for the proxy shim in a script, and have a test that shows we can determinstically deploy proxy to that address with that salt and deployer account * wip on deploy via script. nneed to create web ui * cleanup * update test to work with new params :) * deployment works now!. lets genericize stuff :) * consolidated into one * end to end scripting works :) * renamed and refactored to be more usable * Determinstic deployer scripts are more generic and can deploy and verify :) * rename * another rename :) * Premint proxy deploy (#211) * made premint executor ugparde scripts. renamed executor to proxy * deploy preminter impl with script, and updated the config for that chain * Have premint proxy deploy scripts. can deploy both now * preminter proxy pushed * Refactor deterministic add upgrade gate (#210) * large refactor * update scripts * updates to test code * test naming updates * compiler run correctly * update with new deterministic configs * make node deps only for scripts * Premint deploy determinstic fix tests (#213) * fixed tests by just making it more dyanmic * fix stack too deep error for coverage * ignore deployment folder for coverage * properly filter out deployment --------- Co-authored-by: Iain Nash <iain@zora.co> * update deps * add back release command * fix version publish * fix contract version * move wagmi cli to proper version * more things in dev deps * move all into deps * update protocol rewards package (#226) * fix build * fix wagmi build * make first minter on-chain gas sponsor * fix tests * prettier * add changeset * update changeset * fix build * first minter test fixes --------- Co-authored-by: Dan Oved <stangogh@gmail.com> Co-authored-by: Rohan Kulkarni <kulkarohan@gmail.com> Co-authored-by: Rohan Kulkarni <rohan@ourzora.com> Co-authored-by: Isabella Smallcombe <isabella@ourzora.com>

* Premint * Add back mint fee getter (#198) * add back mint fee getter * add mint fee to interface * * Updated script to deploy preminter to now deploy the proxy (#189) * Extracted common deployment tasks to reusable helper functions * Added script to upgrade preminter * Premint - move premint state to its own contract (#188) Renamed Premint folder to delegated mint * fix: redeem minter tests * fix: token transfer hook for single token transfers * feat: add unit tests * Seperate upgrade gate new contract (#204) * wip * wip * fix tests * chore: run lint & update natspec * update storage layout --------- Co-authored-by: Rohan Kulkarni <kulkarohan@gmail.com> * refactor: add helper to read uups implementation * fix: param name casing * refactor: use updated zora 1155 impl getter * refactor: add helper to read uups implementation * fix: zora 1155 impl var name * chore: run lint * chore: run lint * refactor: implement first minter reward on adminMint * chore: update runs * refactor: remove mint fee amount deploy param * chore: run lint * chore: run lint * chore: remove mint fee amount from chain configs * chore: update fork test * fix: use mint w rewards to gurantee mint fee amount * Premint: updated documentation (#199) Premint - update documentation * move upgrade gate to initializer pattern (#209) * move upgrade gate to initalizer pattern * formatting * refactor: only mint if specified quantity is greater than 0 (#212) * refactor: only mint if specified quantity is greater than 0 * fix tests --------- Co-authored-by: Dan Oved <stangogh@gmail.com> * Premint - factory proxy 777 deployments (#191) * Can mine for a determinstic address for the proxy shim in a script, and have a test that shows we can determinstically deploy proxy to that address with that salt and deployer account * wip on deploy via script. nneed to create web ui * cleanup * update test to work with new params :) * deployment works now!. lets genericize stuff :) * consolidated into one * end to end scripting works :) * renamed and refactored to be more usable * Determinstic deployer scripts are more generic and can deploy and verify :) * rename * another rename :) * Premint proxy deploy (#211) * made premint executor ugparde scripts. renamed executor to proxy * deploy preminter impl with script, and updated the config for that chain * Have premint proxy deploy scripts. can deploy both now * preminter proxy pushed * Refactor deterministic add upgrade gate (#210) * large refactor * update scripts * updates to test code * test naming updates * compiler run correctly * update with new deterministic configs * make node deps only for scripts * Premint deploy determinstic fix tests (#213) * fixed tests by just making it more dyanmic * fix stack too deep error for coverage * ignore deployment folder for coverage * properly filter out deployment --------- Co-authored-by: Iain Nash <iain@zora.co> * update deps * add back release command * fix version publish * fix contract version * move wagmi cli to proper version * more things in dev deps * move all into deps * update protocol rewards package (#226) * fix build * fix wagmi build * Clean Up Transfer Hook Mock (#229) * fix: remove unused param names * fix: linting --------- Co-authored-by: Rohan Kulkarni <kulkarohan@gmail.com> Co-authored-by: Rohan Kulkarni <rohan@ourzora.com> Co-authored-by: Isabella Smallcombe <isabella@ourzora.com> Co-authored-by: Iain Nash <iain@zora.co> Co-authored-by: Isabella Smallcombe <isabella.smallcombe@gmail.com>

* Premint * Add back mint fee getter (#198) * add back mint fee getter * add mint fee to interface * * Updated script to deploy preminter to now deploy the proxy (#189) * Extracted common deployment tasks to reusable helper functions * Added script to upgrade preminter * Premint - move premint state to its own contract (#188) Renamed Premint folder to delegated mint * fix: redeem minter tests * fix: token transfer hook for single token transfers * feat: add unit tests * Seperate upgrade gate new contract (#204) * wip * wip * fix tests * chore: run lint & update natspec * update storage layout --------- Co-authored-by: Rohan Kulkarni <kulkarohan@gmail.com> * refactor: add helper to read uups implementation * fix: param name casing * refactor: use updated zora 1155 impl getter * refactor: add helper to read uups implementation * fix: zora 1155 impl var name * chore: run lint * chore: run lint * refactor: implement first minter reward on adminMint * chore: update runs * refactor: remove mint fee amount deploy param * chore: run lint * chore: run lint * chore: remove mint fee amount from chain configs * chore: update fork test * fix: use mint w rewards to gurantee mint fee amount * Premint: updated documentation (#199) Premint - update documentation * move upgrade gate to initializer pattern (#209) * move upgrade gate to initalizer pattern * formatting * refactor: only mint if specified quantity is greater than 0 (#212) * refactor: only mint if specified quantity is greater than 0 * fix tests --------- Co-authored-by: Dan Oved <stangogh@gmail.com> * Premint - factory proxy 777 deployments (#191) * Can mine for a determinstic address for the proxy shim in a script, and have a test that shows we can determinstically deploy proxy to that address with that salt and deployer account * wip on deploy via script. nneed to create web ui * cleanup * update test to work with new params :) * deployment works now!. lets genericize stuff :) * consolidated into one * end to end scripting works :) * renamed and refactored to be more usable * Determinstic deployer scripts are more generic and can deploy and verify :) * rename * another rename :) * Premint proxy deploy (#211) * made premint executor ugparde scripts. renamed executor to proxy * deploy preminter impl with script, and updated the config for that chain * Have premint proxy deploy scripts. can deploy both now * preminter proxy pushed * Refactor deterministic add upgrade gate (#210) * large refactor * update scripts * updates to test code * test naming updates * compiler run correctly * update with new deterministic configs * make node deps only for scripts * Premint deploy determinstic fix tests (#213) * fixed tests by just making it more dyanmic * fix stack too deep error for coverage * ignore deployment folder for coverage * properly filter out deployment --------- Co-authored-by: Iain Nash <iain@zora.co> * update deps * add back release command * fix version publish * fix contract version * move wagmi cli to proper version * more things in dev deps * move all into deps * update protocol rewards package (#226) * fix build * fix wagmi build * make first minter on-chain gas sponsor * fix tests * prettier * add changeset * update changeset * fix build * first minter test fixes --------- Co-authored-by: Dan Oved <stangogh@gmail.com> Co-authored-by: Rohan Kulkarni <kulkarohan@gmail.com> Co-authored-by: Rohan Kulkarni <rohan@ourzora.com> Co-authored-by: Isabella Smallcombe <isabella@ourzora.com>

iainnash self-requested a review September 26, 2023 18:07

iainnash force-pushed the premint branch from 2c6b7d6 to 7b43696 Compare September 26, 2023 19:57

iainnash mentioned this pull request Sep 26, 2023

Move factory upgrade gate to seperate contract #200

Closed

oveddan force-pushed the premint branch from 7b43696 to 068989e Compare September 26, 2023 21:07

iainnash mentioned this pull request Sep 26, 2023

move factory to a standalone contract #202

Closed

kulkarohan and others added 14 commits September 27, 2023 16:52

refactor: store 1155 factory as immutable

4e1bfd2

chore: update tests

9aff1dc

chore: update tests

e970353

chore: lint

63b7a9b

Premint: fix fork tests (#164)

8919667

* * Check if key exists reading an address, as to not result in unexpected reverts * In premint tests, allow all forks to run the tests, but skip if there is no address for preminter * update storage layout

Premint: add creator to creator attribution event (#163)

1b9984b

* Creator attribution - add creator to event * * Renamed creator attribution args from bytes32 to string to match the standard * Added test that verifies creator attribution event emitted

fix coverage compilation issue

fdaa89d

Made premint executor upgradeable via a proxy. (#168)

82ee3ca

Moved some common factory setup logic to some library fixtures

Extracted erc1155 errors to an interface, and importing that into pre…

d347837

…mint contract (#170)

Reverted manual premint version update, and just pointing to origin v…

91dd712

…ersion. Will do updates via the standard changeset way

updated readme

6322adf

updating natspec

851d702

updated natspec readme

96304ae

iainnash force-pushed the premint-readme-update branch from 39738cd to 96304ae Compare September 27, 2023 20:57

iainnash added 3 commits September 27, 2023 17:02

remove unnecessary changes

22fe7ac

update uml diagrams

34794cf

fix build

71c2648

iainnash marked this pull request as ready for review September 27, 2023 21:16

iainnash requested a review from IsabellaSmallcombe September 27, 2023 21:16

IsabellaSmallcombe approved these changes Sep 27, 2023

View reviewed changes

oveddan added 2 commits September 28, 2023 07:59

Undo changes to changesets

85121f8

cleaned up readme, and removed some uml

7b14636

oveddan merged commit 3e58f0c into premint Sep 28, 2023
3 checks passed

oveddan deleted the premint-readme-update branch September 28, 2023 12:04

kulkarohan mentioned this pull request Sep 28, 2023

refactor: only mint if specified quantity is greater than 0 #212

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Premint: updated documentation #199

Premint: updated documentation #199

oveddan commented Sep 22, 2023

oveddan commented Sep 22, 2023 •

edited by kulkarohan

Loading

iainnash commented Sep 26, 2023

Premint: updated documentation #199

Premint: updated documentation #199

Conversation

oveddan commented Sep 22, 2023

oveddan commented Sep 22, 2023 • edited by kulkarohan Loading

iainnash commented Sep 26, 2023

oveddan commented Sep 22, 2023 •

edited by kulkarohan

Loading