Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Protocol Initalization Handler Facet documentation #538

Merged
merged 12 commits into from
Jan 25, 2023

Conversation

zajck
Copy link
Member

@zajck zajck commented Jan 16, 2023

Since Protocol Initialization Handler Facet is a bit specific, it gets a dedicated page explaining how it works so it can be properly maintained in the future.

@zajck zajck self-assigned this Jan 16, 2023
@zajck zajck added the documentation Improvements or additions to documentation label Jan 16, 2023
Copy link
Contributor

@anajuliabit anajuliabit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well done here! Just small typos

docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
@zajck zajck requested a review from anajuliabit January 18, 2023 09:54
anajuliabit
anajuliabit previously approved these changes Jan 18, 2023
Copy link
Contributor

@anajuliabit anajuliabit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

mischat
mischat previously approved these changes Jan 20, 2023
Copy link
Member

@mischat mischat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, left some english changes.

docs/local-development.md Outdated Show resolved Hide resolved
docs/local-development.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
@zajck zajck dismissed stale reviews from mischat and anajuliabit via 2f46bdc January 20, 2023 17:35
Copy link
Member Author

@zajck zajck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for all corrections, @mischat .

Can you please next time in similar cases use github's "add a suggestion" feature?
It makes it much easier to understand what a proposed change is.

docs/local-development.md Outdated Show resolved Hide resolved
docs/local-development.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
docs/protocol-initialization-facet.md Outdated Show resolved Hide resolved
@zajck zajck requested review from mischat and anajuliabit January 20, 2023 17:38
Copy link
Contributor

@anajuliabit anajuliabit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a typo

docs/tasks.md Outdated Show resolved Hide resolved
mischat
mischat previously approved these changes Jan 25, 2023
@mischat
Copy link
Member

mischat commented Jan 25, 2023

Thanks for all corrections, @mischat .

Can you please next time in similar cases use github's "add a suggestion" feature? It makes it much easier to understand what a proposed change is.

I will, i didn't know about that feature. I will use it next time, apologies.

Co-authored-by: Ana Julia Bittencourt  <[email protected]>
Copy link
Member

@mischat mischat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@zajck zajck requested a review from anajuliabit January 25, 2023 14:27
Copy link
Contributor

@anajuliabit anajuliabit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@zajck zajck merged commit 6a4301a into main Jan 25, 2023
@zajck zajck deleted the documentation-initializer branch January 25, 2023 14:59
zajck added a commit that referenced this pull request Feb 3, 2023
* Initalizer Facet documentation

* Apply suggestions from code review

Co-authored-by: Ana Julia Bittencourt  <[email protected]>

* Expand initialization description

* Review fixes

* upgrade configs

* Update docs/tasks.md

Co-authored-by: Ana Julia Bittencourt  <[email protected]>

Co-authored-by: Ana Julia Bittencourt  <[email protected]>
zajck added a commit that referenced this pull request Nov 21, 2023
* 1st iteration

* buy order

* fulfilSellOrder

* releaseFundsToIntermediateSellers

* Bump eslint-config-prettier from 8.5.0 to 8.6.0 (#547)

Bumps [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) from 8.5.0 to 8.6.0.
- [Release notes](https://github.com/prettier/eslint-config-prettier/releases)
- [Changelog](https://github.com/prettier/eslint-config-prettier/blob/main/CHANGELOG.md)
- [Commits](prettier/eslint-config-prettier@v8.5.0...v8.6.0)

---
updated-dependencies:
- dependency-name: eslint-config-prettier
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Protocol Initalization Handler Facet documentation (#538)

* Initalizer Facet documentation

* Apply suggestions from code review

Co-authored-by: Ana Julia Bittencourt  <[email protected]>

* Expand initialization description

* Review fixes

* upgrade configs

* Update docs/tasks.md

Co-authored-by: Ana Julia Bittencourt  <[email protected]>

Co-authored-by: Ana Julia Bittencourt  <[email protected]>

* chore: add forwarder address in deploy suite script

* chore: add forwarder address in .env.example

* Rename operator to assistant (#556)

* operator->assistant

* remove console.log

* diagram update

* Revert assistant back to operator for ERC721/ERC1155

* PriceDIscovery domain test

* sequential commits test, first batch

* revert reasons

* escrow amount

* Return overpaid to buyer

* sell order

* releaseFunds - COMPLETED

* releaseFunds - REVOKED

* releaseFunds - CANCELED

* releaseFunds - RETRACTED

* releaseFunds - DISPUTED - RESOLVED

* releaseFunds - ESCALATED

* releaseFunds - REFUSED

* changing fee + royalties

* Refactor

* refactor into separate facet

* sequentialCommitToOffer tests

* verify incoming voucher

* Fix failing tests

* Protocol Diamond diagram

* review fixes

* additional tests

* remove RoyaltyRecipient + fix typos

* Fix typo SequentialCommitHandler.sol

* New chunks

* correctly toggle preprocessing

* SequentialCommitHandlerFacet constructor arg in deployment

* fix unit tests

* test isEligibleToCommit

* review fixes

* add events for encumbering/releasing funds

* add tests for events for encumbering/releasing funds

* use safeerc20 for approval

* extend test timeout

* Bump code coverage

* refactor + disable viaIR compilation

* Price discovery (#578)

* AMM integration tests (WIP)

* Make hardhat task work with submodules which uses foundry

* Update hardhat config

* Fix diamond deploy

* Renaming folders

* Continue AMM POC

* Add price type to offer struct and continue sudoswap poc

* Fix interface ids

* Moving lssvm submodule

* Make boson voucher compatible with price discovery offers

* Continue POC work

* Finalize AMM POC

* Finalize sudoswap POC

* Seaport: Create offer with criteria (WIP)

* Seaport: advance order with criteria

* Move test files

* Fix sudoswap tests

* Fix seaport tests

* Make commitToOffer and commitToPriceDiscoveryOffer a single method

* Price discovery POC: auction

* Implement new voucher transfer and protocol communication design (WIP)

* Removing logs

* Fixing compile

* Finish new voucher transfer and protocol communication design

* SneakAuction (WIP)

* Supports bid commits that requires pre-holding the NFT

* Token id is mandatory on bid commits

* Continue work on PD

* Fix submodules hardhat compilation

* Finish refactor

* Remove SneakyAuction test and add Zora test

* Offer can't be price discovery and be transfer externally at the sime time

* Add new validations to fulfilBidOrder

* Decoupling bid function

* Add natspec comments

* Fix set committed

* Split commitToOffer and commitToPreMintedOffer

* Review changes

* Apply more review changes

* Owner must be priceDiscoveryContract when caller is not voucher owner

* Add some others verifications

* Fix Zora integration test without wrapper

* Fix stack too deep issue by enabling Yul via iR

* Split commitToPriceDiscovery in a new PriceDiscoveryFacet

* Add weth to protocol protocol addresses storage

* Fix interface ids

* Creating SudoswapWrraper

* Update SudoswapWrapper contract to allow wrapping multiple tokens at once and modify integration test accordingly

* Update SudoswapWrapper contract to allow wrapping by sender

* Continue SudoswapWrapper

* Finalise sudoswap wrapper poc

* Adding missing natspec comments

* Upgrade hardhat config and minors changes

* Fix pre-minted voucher transfer to check for offer price type and transaction origin

* update integration tests

* update inegration test - sudoswap

* Extend priceDiscovery struct

* deprecate commitToPremintedOffer

* Fix fundsHandler tests

* Fix metaTransactionsHandler tests

* Fix Offer domain script

* Fix sequentialCommitHandler tests

* review fixes 1st iter

* Correct resellerId in initial exchangeCosts for price discovery

* review fixes 2nd iter

* More minore fixes in tests/contracts

* PriceDiscoveryHandler unit tests

* onPremintedVoucherTransferred test + other minor fixes

* Zora wrapper (#598)

* initial wrapper

* Zora auction PoC

* code cleanup, add comments

* additional auction tests

* Review fixes

* Remove ownable

* review fixes

* wrapper tests

* custom mock auction

* handling wrapper another type of "Side"

* Improve wrapper handling

---------

Co-authored-by: zajck <[email protected]>
Co-authored-by: Klemen <[email protected]>

* New chunks + bump line coverage

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Ana Julia Bittencourt <[email protected]>
Co-authored-by: Albert Folch <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants