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.

Sign up for GitHub

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

fix: updated docs errors and typos #463

Merged
merged 1 commit into from
Dec 3, 2024
Merged

fix: updated docs errors and typos #463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/pages/contracts/ERC721Drop.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ Once the contract is deployed, the address that is set as the owner will need to

## Upgrading the Contract
Once deployed it is possible to upgrade the NFT contract to have new functionality.
Note, that upgrade options are on the ones that are in the [Zora registry](https://github.com/ourzora/zora-drops-contracts/blob/main/src/FactoryUpgradeGate.sol).
Note, that upgrade options are only the ones that are in the [Zora registry](https://github.com/ourzora/zora-drops-contracts/blob/main/src/FactoryUpgradeGate.sol).
All upgrades are opt-in and can only be initiated by a default admin.

`upgradeTo` allows the NFT contract to upgrade to a new implementation contract to make delegate calls.
Expand Down
7 changes: 3 additions & 4 deletions docs/pages/contracts/ZoraTimedSaleStrategy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Zora Timed Sale Strategy

The Zora Sale Timed Sale Strategy introduces a new mint fee and [enables a secondary market that is powered by Uniswap V3](https://support.zora.co/en/categories/577345-secondary-market)
The Zora Sale Timed Sale Strategy introduces a new mint fee and [enables a secondary market that is powered by Uniswap V3](https://support.zora.co/en/categories/577345-secondary-market).
New tokens minted will have a mint fee of 0.000111 ETH (✧111).

Upon calling `setSale()` a sale will be created for the Zora 1155 NFT along with creating an ERC20z token and a Uniswap V3 Pool.
Expand All @@ -26,8 +26,7 @@ As soon as the secondary market is launched the mint fees earned by the market w
The ZoraTimedSaleStrategy contract is used to create a timed sale for a Zora 1155 token. When it is configured for an 1155 contract and token via the `setSale` function,
specifying the `saleStart` and `saleEnd` of the sale, it creates a new ERC20z token and corresponding Uniswap V3 pool for a WETH pair with the ERC20z with a 1% fee.

To mint an 1155 token, the `mint` function is called on the ZoraTimedSaleStrategy contract with the mint fee of 0.000111 eth x quantity to mint sent with the call. In the `mint` call, 0.0000111 eth x quantity is held in escrow to bootstrap liquidity for the Uniswap V3 pool, the rest is distributed as rewards.
via the [ProtocolRewards](./rewards) contract, and x quantity of 1155s is minted to the `recipient`.
To mint an 1155 token, the `mint` function is called on the ZoraTimedSaleStrategy contract with the mint fee of 0.000111 eth x quantity to mint sent with the call. In the `mint` call, 0.0000111 eth x quantity is held in escrow to bootstrap liquidity for the Uniswap V3 pool, the rest is distributed as rewards via the [ProtocolRewards](./rewards) contract, and x quantity of 1155s is minted to the `recipient`.

When the sale has ended, the `launchMarket` function can be called to launch the secondary market, which mints ERC20z tokens, wraps the escrowed ETH as WETH,
and deposits the WETH and a portion of the minted ERC20z to the Uniswap V3 pool to launch the secondary market.
Expand Down Expand Up @@ -139,7 +138,7 @@ The logic for launching the secondary market is designed with a few requirements

- The secondary market starting price should be 0.000111 eth per token
- There should be an equal amount of ERC20 to ERC1155 tokens minted/total supply
- Each owned ERC1155 should be backed and unwrappable by 1 ERC20, and visa versa.
- Each owned ERC1155 should be backed and unwrappable by 1 ERC20, and vice versa.

To achieve this, the following logic is used. For the sake of simplicity, one ERC20 represents 10^18 units:

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/protocol-sdk/creator/onchain.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ with the 1155 contract address and the token creation parameters.

## Setting a price per token

A price per token can be optionally set to earn eth additional on the primary sale when each token is minted, by setting `token.salesConfig.pricePerToken`.
A price per token can be optionally set to earn additional ETH on the primary sale when each token is minted, by setting `token.salesConfig.pricePerToken`.
If the `pricePerToken` is set to more than 0, there will be no `creatorReward` earned on the mint fee. If a pricePerToken is set to more than 0, then the token is setup with the [ZoraCreatorFixedPriceSaleStrategy](https://github.com/ourzora/zora-protocol/blob/main/packages/1155-contracts/src/minters/fixed-price/ZoraCreatorFixedPriceSaleStrategy.sol) as its minter.
This will also result in not being able to [leverage the onchain secondary market feature](https://support.zora.co/en/articles/2519873) for tokens minted using
this minter.
Expand Down