ourzora/zora-docs

 ________   ______   _______    ______         _______    ______    ______    ______  
/        | /      \ /       \  /      \       /       \  /      \  /      \  /      \ 
$$$$$$$$/ /$$$$$$  |$$$$$$$  |/$$$$$$  |      $$$$$$$  |/$$$$$$  |/$$$$$$  |/$$$$$$  |
    /$$/  $$ |  $$ |$$ |__$$ |$$ |__$$ |      $$ |  $$ |$$ |  $$ |$$ |  $$/ $$ \__$$/ 
   /$$/   $$ |  $$ |$$    $$< $$    $$ |      $$ |  $$ |$$ |  $$ |$$ |      $$      \ 
  /$$/    $$ |  $$ |$$$$$$$  |$$$$$$$$ |      $$ |  $$ |$$ |  $$ |$$ |   __  $$$$$$  |
 /$$/____ $$ \__$$ |$$ |  $$ |$$ |  $$ |      $$ |__$$ |$$ \__$$ |$$ \__/  |/  \__$$ |
/$$      |$$    $$/ $$ |  $$ |$$ |  $$ |      $$    $$/ $$    $$/ $$    $$/ $$    $$/ 
$$$$$$$$/  $$$$$$/  $$/   $$/ $$/   $$/       $$$$$$$/   $$$$$$/   $$$$$$/   $$$$$$/ 

Contribution Guidelines

Thanks for giving a little extra love to our docs site! Below are some basic guidelines to follow to get your PR merged :)

Live Docs Website

Creating a Pull Request

1. Fork the repository.
2. On your copy of the repo, create a new branch. Be sure that your branch contains the most recent changes from the main branch.
3. Make any necessary changes, then commit and push them to your fork.
4. Go to the main docs repo in your browser and open a new pull request.
5. Title the pull request to describe your contribution, and include a short summary of the changes. If an open issue is associated with your changes, tag the issue by referencing the issue number ( i.e., #123) in the pull request summary.
6. If there is a relevant tag like "typo", "bug", or "enhancement", include the tag in the PR.

A standard flow to set up a fork

Set up your fork with the following terminal commands, or an alteration of them to suit your environment:

git remote add upstream https://github.com/ourzora/zora-docs.git
git fetch upstream
git pull --rebase upstream main
git checkout -b "<your-name>/my-contribution"

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

First, create a .env file with these variables. For ease, you can copy the contents of .env.example into that file:

cp .env.example .env

Next, run this command:

yarn start

This starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

zora-docs's Issues

Zora nft related code

docs: update link in zora-docs/docs/guides /connect-wallet-react.mdx

zora-docs/docs/guides/connect-wallet-react.mdx

Line 19 in cd7b5e6

In order to submit a transaction, you must provide an [ethers signer](https://docs.ethers.io/v5/api/signer/).

Line 19, the data is outdated. A big update has been released. Here is a new link:
https://docs.ethers.org/v6/api/providers/#Signer
In the new version, the information is more complete and clear

For some reason I can't create a Pull Request and because of this I have to create Issue

Trouble building docs @ Node v18.12.0

I'm trying to pull down a fresh version of the docs, but having trouble getting them to build. I'm attaching a screenshot of the error but light googling is telling me this might having something to do with the version of Node that I'm running. I'm curious what version you guys are using locally.

@anader123

Guides: typo in Getting Collection Data

Summary

In the Guide for Getting Collection Data, Highest Sales is misspelled as "Higheset".

Minting event not sent in ZNFT example code

404 not found, update minting contract links with latest deployments

Flagged dead links: https://warpcast.com/cosmicblend/0x1bb40ce7 https://warpcast.com/cosmicblend/0x1bb40ce7

zora-docs/docs/smart-contracts/creator-tools/intro.mdx

Lines 18 to 19 in ccaa012

	- [1155 Contract Code](https://github.com/ourzora/zora-creator-contracts/tree/main/src)
	- [721 Contract Code](https://github.com/ourzora/zora-drops-contracts/tree/main/src)

zora-docs/docs/smart-contracts/creator-tools/intro.mdx

Lines 24 to 25 in ccaa012

	- [Mainnet](https://github.com/ourzora/zora-creator-contracts/blob/main/addresses/1.json)
	- [Goerli](https://github.com/ourzora/zora-creator-contracts/blob/main/addresses/5.json)

zora-docs/docs/smart-contracts/creator-tools/Deploy1155Contract.mdx

Lines 10 to 13 in ccaa012

	- [Factory Contract Code](https://github.com/ourzora/zora-creator-contracts/blob/main/src/factory/ZoraCreator1155FactoryImpl.sol)
	- [Mainnet Addresses](https://github.com/ourzora/zora-creator-contracts/blob/main/addresses/1.json)
	- [Goerli Addresses](https://github.com/ourzora/zora-creator-contracts/blob/main/addresses/5.json)

zora-docs/docs/smart-contracts/creator-tools/Selling1155.mdx

Lines 11 to 13 in ccaa012

	- [Minter Strategy Code](https://github.com/ourzora/zora-creator-contracts/tree/main/src/minters)
	- [Mainnet Addresses](https://github.com/ourzora/zora-creator-contracts/blob/main/addresses/1.json)
	- [Goerli Addresses](https://github.com/ourzora/zora-creator-contracts/blob/main/addresses/5.json)

zora-docs/docs/smart-contracts/creator-tools/Minting1155.mdx

Lines 40 to 43 in ccaa012

	- [Minters Code](https://github.com/ourzora/zora-creator-contracts/tree/main/src/minters)
	- [Mainnet Addresses](https://github.com/ourzora/zora-creator-contracts/blob/main/addresses/1.json)
	- [Goerli Addresses](https://github.com/ourzora/zora-creator-contracts/blob/main/addresses/5.json)

zora-docs/docs/smart-contracts/creator-tools/B2R1155.mdx

Line 20 in ccaa012

[Source Code](https://github.com/ourzora/zora-1155-contracts/tree/main/src/minters/redeem)

zora-docs/docs/smart-contracts/creator-tools/ZoraNFTCreator.mdx

Line 9 in ccaa012

View the contract code [here](https://github.com/ourzora/zora-drops-contracts/blob/main/src/ZoraNFTCreatorV1.sol) and the list of deployed addresses [here](https://github.com/ourzora/zora-drops-contracts/tree/main/deployments).

zora-docs/docs/smart-contracts/creator-tools/ERC721Drop.mdx

Line 14 in ccaa012

View the list of deployed contract addresses [here](https://github.com/ourzora/zora-drops-contracts/tree/main/deployments) and view the contract source code [here](https://github.com/ourzora/zora-drops-contracts/blob/main/src/ERC721Drop.sol)

zora-docs/docs/smart-contracts/creator-tools/EditionMetadataRenderer.mdx

Line 9 in ccaa012

View the source contract code [here](https://github.com/ourzora/zora-drops-contracts/blob/main/src/metadata/EditionMetadataRenderer.sol) and the list of deployed contract addresses [here](https://github.com/ourzora/zora-drops-contracts/tree/main/deployments).

zora-docs/docs/smart-contracts/creator-tools/DropMetadataRenderer.mdx

Line 9 in ccaa012

View the source contract code [here](https://github.com/ourzora/zora-drops-contracts/blob/main/src/metadata/DropMetadataRenderer.sol) and the list of deployed contract addresses [here](https://github.com/ourzora/zora-drops-contracts/tree/main/deployments).

Zora Opstack genesis and rollup json

Hi!

Our team currently operates https://nodies.org, and we support multiple RPC networks. Our goal is to ensure that L2's on OPStack are supported and we currently supported Optimism, Base, and Metis. We'd love to add Zora our fourth provider. Does zora have any documentation on building a node for their network? I cannot find the genesis or rollup.json for us to be able to support the network and provide RPC access to users.

A couple of minor typos in the Nouns Builder docs

I've been reading through the Nouns Builder docs - they're amazing. While reading I ran across a couple of super minor typos, thought I'd flag them for you!

https://github.com/ourzora/zora-docs/blob/main/docs/guides/builder-deployment.mdx

• "Obtain Geroli ETH" -> "Obtain Goerli ETH"

https://github.com/ourzora/zora-docs/blob/main/docs/smart-contracts/nouns-builder/auctions.mdx

• "hand over control of the auction house to the treasure" -> "hand over control of the auction house to the treasury"

re: dead link in rewards to deployments

update rewards dead links

https://github.com/ourzora/zora-docs/pull/120/files

We should correct all instances of "Github"

Summary

"GitHub" is the correct product name as defined in the GitHub Docs:

# https://github.com/github/docs/blob/d133e7c6bda57a810decc2e34519042669d964b6/data/variables/product.yml#L11-L12
## Use this variable when the output should always be GitHub, regardless of the product the user is using
prodname_dotcom: 'GitHub'

🔬 Using grep, there are 6 instances of "Github" in the docs/ directory:

$ grep -rn "Github" docs/
docs/smart-contracts/modules/Asks/asks_1.1.mdx:13:You can view all of the `Ask V1.1 Module` contract code in this [Github Repo](https://github.com/ourzora/v3/blob/main/contracts/modules/Asks/V1.1/AsksV1_1.sol).
docs/smart-contracts/modules/Asks/asks_1.0.mdx:20:You can view all of the `Ask V1.0 Module` contract code in this [Github Repo](https://github.com/ourzora/v3/blob/main/contracts/modules/Asks/V1/AsksV1.sol).
docs/smart-contracts/intro.mdx:46:Source code for all ZORA V3 contracts can be found in this [Github repository](https://github.com/ourzora/v3).
docs/smart-contracts/peripheral-contracts/zora-auction-house.mdx:21:The source code is available in this [Github repository](https://github.com/ourzora/auction-house).
docs/smart-contracts/peripheral-contracts/zora-contracts.mdx:30:The source code for both contracts can be found in this [Github repository](https://github.com/ourzora/core).
docs/guides/create-auction-house.mdx:14:ZORA has created a [Github Repo](https://github.com/ourzora/create-auction-house) that makes it easy for anyone to launch their own auction house.

Typo in docs

Minor issue but there's just a typo in the docs under this section

Assuming it should say:
can later be removed once the NFTs have become sufficiently decentralized.

White-paper Page Not Found

https://docs.zora.co/docs/smart-contracts/whitepaper

Uncaught ReferenceError: "process is not defined" thrown on fresh clone at 91f43f2b

Summary

👋 Hello, @ourzora! I hit this error when running a local instance of the site:

Uncaught ReferenceError: process is not defined

• Steps to reproduce 💁
• Why does this happen? 🕵️‍♂️
• Possible paths forward 💭

Steps to reproduce 💁

First, clone the repo, install the dependencies, and start it:

git clone https://github.com/ourzora/zora-docs
cd zora-docs
yarn install
yarn start

Next, open the developer console and observe the following errors:

Uncaught ReferenceError: process is not defined
    at eval (ShaderComponent.js?c1b7:9:1)
    at invokePassiveEffectCreate (react-dom.development.js?61bb:23487:1)
    at HTMLUnknownElement.callCallback (react-dom.development.js?61bb:3945:1)
    at Object.invokeGuardedCallbackDev (react-dom.development.js?61bb:3994:1)
    at invokeGuardedCallback (react-dom.development.js?61bb:4056:1)
    at flushPassiveEffectsImpl (react-dom.development.js?61bb:23574:1)
    at unstable_runWithPriority (scheduler.development.js?3069:468:1)
    at runWithPriority$1 (react-dom.development.js?61bb:11276:1)
    at flushPassiveEffects (react-dom.development.js?61bb:23447:1)
    at performSyncWorkOnRoot (react-dom.development.js?61bb:22269:1)
    at eval (react-dom.development.js?61bb:11327:1)
    at unstable_runWithPriority (scheduler.development.js?3069:468:1)
    at runWithPriority$1 (react-dom.development.js?61bb:11276:1)
    at flushSyncCallbackQueueImpl (react-dom.development.js?61bb:11322:1)
    at flushSyncCallbackQueue (react-dom.development.js?61bb:11309:1)
    at scheduleUpdateOnFiber (react-dom.development.js?61bb:21893:1)
    at updateContainer (react-dom.development.js?61bb:25482:1)
    at legacyRenderSubtreeIntoContainer (react-dom.development.js?61bb:26037:1)
    at render (react-dom.development.js?61bb:26103:1)
    at eval (VM940 clientEntry.js:19:216)

---

The above error occurred in the <ShaderComponent> component:

    at ShaderComponent (webpack-internal:///./src/components/ShaderComponent.js:10:257)
    at div
    at MobileSecondaryMenuProvider (webpack-internal:///./node_modules/@docusaurus/theme-common/lib/utils/mobileSecondaryMenu.js:13:217)
    at DocsPreferredVersionContextProviderUnsafe (webpack-internal:///./node_modules/@docusaurus/theme-common/lib/utils/docsPreferredVersion/DocsPreferredVersionProvider.js:26:877)
    at DocsPreferredVersionContextProvider (webpack-internal:///./node_modules/@docusaurus/theme-common/lib/utils/docsPreferredVersion/DocsPreferredVersionProvider.js:26:490)
    at UserPreferencesProvider (webpack-internal:///./node_modules/@docusaurus/theme-classic/lib-next/theme/UserPreferencesProvider/index.js:13:157)
    at AnnouncementBarProvider (webpack-internal:///./node_modules/@docusaurus/theme-common/lib/utils/announcementBarUtils.js:21:485)
    at ThemeProvider (webpack-internal:///./node_modules/@docusaurus/theme-classic/lib-next/theme/ThemeProvider/index.js:13:142)
    at LayoutProviders (webpack-internal:///./node_modules/@docusaurus/theme-classic/lib-next/theme/LayoutProviders/index.js:14:30)
    at Layout (webpack-internal:///./node_modules/@docusaurus/theme-classic/lib-next/theme/Layout/index.js:21:33)
    at Home
    at LoadableComponent (webpack-internal:///./node_modules/@docusaurus/react-loadable/lib/index.js:1:2843)
    at Route (webpack-internal:///./node_modules/react-router/esm/react-router.js:464:29)
    at Switch (webpack-internal:///./node_modules/react-router/esm/react-router.js:670:29)
    at Route (webpack-internal:///./node_modules/react-router/esm/react-router.js:464:29)
    at PendingNavigation (webpack-internal:///./node_modules/@docusaurus/core/lib/client/PendingNavigation.js:18:180)
    at C (webpack-internal:///./node_modules/react-router/esm/react-router.js:725:37)
    at Root (webpack-internal:///./node_modules/@docusaurus/core/lib/client/theme-fallback/Root/index.js:18:16)
    at App (webpack-internal:///./node_modules/@docusaurus/core/lib/client/App.js:23:94)
    at Router (webpack-internal:///./node_modules/react-router/esm/react-router.js:93:30)
    at BrowserRouter (webpack-internal:///./node_modules/react-router-dom/esm/react-router-dom.js:59:35)

---

Uncaught (in promise) ReferenceError: process is not defined
    at eval (ShaderComponent.js?c1b7:1:1)
    at invokePassiveEffectCreate (react-dom.development.js?61bb:23487:1)
    at HTMLUnknownElement.callCallback (react-dom.development.js?61bb:3945:1)
    at Object.invokeGuardedCallbackDev (react-dom.development.js?61bb:3994:1)
    at invokeGuardedCallback (react-dom.development.js?61bb:4056:1)
    at flushPassiveEffectsImpl (react-dom.development.js?61bb:23574:1)
    at unstable_runWithPriority (scheduler.development.js?3069:468:1)
    at runWithPriority$1 (react-dom.development.js?61bb:11276:1)
    at flushPassiveEffects (react-dom.development.js?61bb:23447:1)
    at performSyncWorkOnRoot (react-dom.development.js?61bb:22269:1)
    at eval (react-dom.development.js?61bb:11327:1)
    at unstable_runWithPriority (scheduler.development.js?3069:468:1)
    at runWithPriority$1 (react-dom.development.js?61bb:11276:1)
    at flushSyncCallbackQueueImpl (react-dom.development.js?61bb:11322:1)
    at flushSyncCallbackQueue (react-dom.development.js?61bb:11309:1)
    at unbatchedUpdates (react-dom.development.js?61bb:22438:1)
    at legacyRenderSubtreeIntoContainer (react-dom.development.js?61bb:26020:1)
    at render (react-dom.development.js?61bb:26103:1)
    at eval (clientEntry.js?12b7:21:1)

Why does this happen? 🕵️‍♂️

The aforementioned trace references ShaderComponent.js, responsible for rendering this beautiful motion graphic:

The specific line referenced in the trace is:

zora-docs/src/components/ShaderComponent.js

Line 14 in 91f43f2

const rpcProvider = new ethers.providers.JsonRpcProvider(process.env.RPC_ENDPOINT)

It expects process to be defined, but it isn't. Under the hood, the docusaurus2-dotenv package automatically imports the variables defined in .env via its config file:

zora-docs/docusaurus.config.js

Lines 97 to 110 in 91f43f2

	plugins: [
	[
	'docusaurus2-dotenv',
	{
	safe: false,
	systemvars: true,
	silent: false,
	expand: false,
	defaults: false,
	RPC_ENDPOINT: process.env.RPC_ENDPOINT,
	GTAG_ID: process.env.GTAG_ID,
	},
	],
	],

On a fresh clone, the project doesn't have a .env file. But, it does have a .env.example file. Working from other projects, we could copy the contents into a new .env file...

cp .env.example .env

... and restarting the server seems to do the trick:

But, a different error is output to the console:

Error: could not detect network (...)

geturl.js?21de:27 POST http://localhost:8545/ net::ERR_BLOCKED_BY_CLIENT
eval @ geturl.js?21de:27
eval @ geturl.js?21de:8
__awaiter @ geturl.js?21de:4
getUrl @ geturl.js?21de:13
eval @ index.js?baf7:143
eval @ index.js?baf7:8
__awaiter @ index.js?baf7:4
eval @ index.js?baf7:139
_fetchData @ index.js?baf7:233
fetchJson @ index.js?baf7:275
send @ json-rpc-provider.js?3e80:384
eval @ json-rpc-provider.js?3e80:333
rejected @ json-rpc-provider.js?3e80:6
Promise.then (async)
step @ json-rpc-provider.js?3e80:7
fulfilled @ json-rpc-provider.js?3e80:5
Promise.then (async)
step @ json-rpc-provider.js?3e80:7
eval @ json-rpc-provider.js?3e80:8
__awaiter @ json-rpc-provider.js?3e80:4
_uncachedDetectNetwork @ json-rpc-provider.js?3e80:325
detectNetwork @ json-rpc-provider.js?3e80:316
eval @ base-provider.js?bc79:419
rejected @ base-provider.js?bc79:6
Promise.then (async)
step @ base-provider.js?bc79:7
eval @ base-provider.js?bc79:8
__awaiter @ base-provider.js?bc79:4
_ready @ base-provider.js?bc79:408
BaseProvider @ base-provider.js?bc79:390
JsonRpcProvider @ json-rpc-provider.js?3e80:290
eval @ ShaderComponent.js?c1b7:1
invokePassiveEffectCreate @ react-dom.development.js?61bb:23487
callCallback @ react-dom.development.js?61bb:3945
invokeGuardedCallbackDev @ react-dom.development.js?61bb:3994
invokeGuardedCallback @ react-dom.development.js?61bb:4056
flushPassiveEffectsImpl @ react-dom.development.js?61bb:23574
unstable_runWithPriority @ scheduler.development.js?3069:468
runWithPriority$1 @ react-dom.development.js?61bb:11276
flushPassiveEffects @ react-dom.development.js?61bb:23447
performSyncWorkOnRoot @ react-dom.development.js?61bb:22269
eval @ react-dom.development.js?61bb:11327
unstable_runWithPriority @ scheduler.development.js?3069:468
runWithPriority$1 @ react-dom.development.js?61bb:11276
flushSyncCallbackQueueImpl @ react-dom.development.js?61bb:11322
flushSyncCallbackQueue @ react-dom.development.js?61bb:11309
unbatchedUpdates @ react-dom.development.js?61bb:22438
legacyRenderSubtreeIntoContainer @ react-dom.development.js?61bb:26020
render @ react-dom.development.js?61bb:26103
eval @ clientEntry.js?12b7:21
Promise.then (async)
eval @ clientEntry.js?12b7:21
./node_modules/@docusaurus/core/lib/client/clientEntry.js @ main.js:87
__webpack_require__ @ runtime~main.js:36
__webpack_exec__ @ main.js:772
(anonymous) @ main.js:773
__webpack_require__.O @ runtime~main.js:83
(anonymous) @ main.js:774
webpackJsonpCallback @ runtime~main.js:1314
(anonymous) @ main.js:9
index.js?ffb2:185 Uncaught (in promise) Error: could not detect network (event="noNetwork", code=NETWORK_ERROR, version=providers/5.4.5)
    at Logger.makeError (index.js?ffb2:185:1)
    at Logger.throwError (index.js?ffb2:194:1)
    at JsonRpcProvider.eval (json-rpc-provider.js?3e80:350:1)
    at Generator.throw (<anonymous>)
    at rejected (json-rpc-provider.js?3e80:6:1)

Possible paths forward 💭

• Code: Setting an explicit error boundary if .env isn't set and presenting a "friendly" error message would be the most impactful change. I'm also interested in the tradeoff cost of having this "just work" even if .env isn't explicitly defined.
• Docs: update the documentation with instructions for setting .env in development versus production.