From 661b5f61c2fac1ecffe4b16a1fa3d9c052ef1746 Mon Sep 17 00:00:00 2001 From: Alex Saltstein Date: Thu, 15 Feb 2024 17:27:05 +0000 Subject: [PATCH] add artblocks viewer info --- art-blocks-api/artblocks-viewer.md | 69 ++++++++++++++++++++++-------- 1 file changed, 50 insertions(+), 19 deletions(-) diff --git a/art-blocks-api/artblocks-viewer.md b/art-blocks-api/artblocks-viewer.md index 3944b5d29..bf14daf32 100644 --- a/art-blocks-api/artblocks-viewer.md +++ b/art-blocks-api/artblocks-viewer.md @@ -1,36 +1,65 @@ # Artblocks Viewer + An overview of [live.artblocks.io](https://live.artblocks.io/) ## Routes ->All routes are for the environment specified in .env file and act as such. i.e. Ropsten contracts will not work on mainnet and vice versa + +> All routes are for the environment specified in .env file and act as such. i.e. Ropsten contracts will not work on mainnet and vice versa **live.artblocks.io/** -Home page of the site which returns the latest *rendered* minted token from any of the Art Blocks contracts +Home page of the site which returns the latest _rendered_ minted token from any of the Art Blocks contracts + +**live.artblocks.io/`{CONTRACT_ADDRESS}`** enter any Art Blocks or Engine contract and you be presented with the latest _rendered_ mint. + +- _Example:_ [Latest Artblocks_VO mint](https://live.artblocks.io/0x059edd72cd353df5106d2b9cc5ab83a52287ac3a) + +**live.artblocks.io/`{CONTRACT_ADDRESS}`/`{PROJECT_INDEX}`** enter any Art Blocks or Engine contract followed by the index of the project and you be presented with the latest _rendered_ mint. + +- _Example:_ [Latest Chromie Squiggle mint](https://live.artblocks.io/0x059edd72cd353df5106d2b9cc5ab83a52287ac3a/0) + +**live.artblocks.io/token/`{TOKEN_ID}`** enter any Art Blocks or Engine token id and you are presented with that token. + +- _Example:_ [Chromie Squiggle mint #71](https://live.artblocks.io/token/0x059edd72cd353df5106d2b9cc5ab83a52287ac3a-71) + +**live.artblocks.io/random/`{CONTRACT_ADDRESS}`** enter any Art Blocks or Engine contract address and you are presented with a random active project + +- _Example:_ [Random Art Blocks v3 contract](https://live.artblocks.io/random/0x99a9b7c1116f9ceeb1652de04d5969cce509b069) -**live.artblocks.io/`{CONTRACT_ADDRESS}`** enter any Art Blocks or PBAB contract and you be presented with the latest *rendered* mint. -+ *Example:* [Latest Artblocks_VO mint](https://live.artblocks.io/0x059edd72cd353df5106d2b9cc5ab83a52287ac3a) +**live.artblocks.io/random/`{CONTRACT_ADDRESS}/{PROJECT_INDEX}`** enter any Art Blocks or Engine contract address and a project index you are presented with a random token from that project -**live.artblocks.io/`{CONTRACT_ADDRESS}`/`{PROJECT_INDEX}`** enter any Art Blocks or PBAB contract followed by the index of the project and you be presented with the latest *rendered* mint. -+ *Example:* [Latest Chromie Squiggle mint](https://live.artblocks.io/0x059edd72cd353df5106d2b9cc5ab83a52287ac3a/0) +- _Example:_ [Random Chromie Squiggles](https://live.artblocks.io/random/0x059edd72cd353df5106d2b9cc5ab83a52287ac3a/0) -**live.artblocks.io/token/`{TOKEN_ID}`** enter any Art Blocks or PBAB token id and you are presented with that token. -+ *Example:* [Chromie Squiggle mint #71](https://live.artblocks.io/token/0x059edd72cd353df5106d2b9cc5ab83a52287ac3a-71) +## Random Query Params + +You can add any query params from the customizable display listed below as well as two random specific query params. + +- **reloadClick**: this is to turn on click reloading where if you click the token it will give you a new token from that project. `default: false` +- **reloadDelay**: this is to turn on auto refreshing after the specified time in seconds to give you a new token from that project. `default: none` + +**Example URLs**: + +- [Click turned on](https://live.artblocks.io/random/0x059edd72cd353df5106d2b9cc5ab83a52287ac3a/0?reloadClick=true) +- [Delay of 30 seconds and click turned on](https://live.artblocks.io/random/0x059edd72cd353df5106d2b9cc5ab83a52287ac3a/0?reloadClick=true&reloadDelay=30) +- [Delay of 30 seconds with no click](https://live.artblocks.io/random/0x059edd72cd353df5106d2b9cc5ab83a52287ac3a/0?reloadDelay=30) ## Contracts -This is a running list of contract addresses for various Art Blocks and PBAB + +This is a running list of contract addresses for various Art Blocks and Engine **Mainnet**: -+ Artblocks_VO: 0x059edd72cd353df5106d2b9cc5ab83a52287ac3a -+ Artblocks_V1: 0xa7d8d9ef8d8ce8992df33d8b8cf4aebabd5bd270 -+ ARTCODE: 0xd10e3dee203579fcee90ed7d0bdd8086f7e53beb -+ Doodle Labs: 0x28f2d3805652fb5d359486dffb7d08320d403240 -+ CryptoCitizens: 0xbdde08bd57e5c9fd563ee7ac61618cb2ecdc0ce0 -+ Flutter: 0x13aae6f9599880edbb7d144bb13f1212cee99533 -+ MOMENT: 0x0a1bbd57033f57e7b6743621b79fcb9eb2ce3676 -+ Plottables: 0xa319c382a702682129fcbf55d514e61a16f97f9c -+ TBOA: 0x62e37f664b5945629b6549a87f8e10ed0b6d923b + +- Artblocks_VO: 0x059edd72cd353df5106d2b9cc5ab83a52287ac3a +- Artblocks_V1: 0xa7d8d9ef8d8ce8992df33d8b8cf4aebabd5bd270 +- ARTCODE: 0xd10e3dee203579fcee90ed7d0bdd8086f7e53beb +- Doodle Labs: 0x28f2d3805652fb5d359486dffb7d08320d403240 +- CryptoCitizens: 0xbdde08bd57e5c9fd563ee7ac61618cb2ecdc0ce0 +- Flutter: 0x13aae6f9599880edbb7d144bb13f1212cee99533 +- MOMENT: 0x0a1bbd57033f57e7b6743621b79fcb9eb2ce3676 +- Plottables: 0xa319c382a702682129fcbf55d514e61a16f97f9c +- TBOA: 0x62e37f664b5945629b6549a87f8e10ed0b6d923b ## Customizable Display + You can create a customizable display for any route on artblocks-viewer. This is done through query params added to the end of the url. In order to activate this ability you must first add `?useCustomViewParams=true` to the end of the whatever route you are using. [Here](https://live.artblocks.io/token/0x059edd72cd353df5106d2b9cc5ab83a52287ac3a-71?useCustomViewParams=true) is the most basic customized url of Chromie Squiggle mint #71 with just the squiggle centered in the middle of the page. All of the customization that can be done and the default values are as follows: @@ -46,7 +75,9 @@ All of the customization that can be done and the default values are as follows: - **textBottom**: this can be any valid html size and is the distance from the bottom of the screen of the text `default: 3em` **Example URLs**: + - [Latest Chimera](https://live.artblocks.io/0xa7d8d9ef8d8ce8992df33d8b8cf4aebabd5bd270/233?useCustomViewParams=true&backgroundColor=F8C8DC&showText=true) - [Latest Artblocks Mint](https://live.artblocks.io/0xa7d8d9ef8d8ce8992df33d8b8cf4aebabd5bd270/?useCustomViewParams=true&backgroundColor=a2beb1&showText=true&textBackground=000000&fontSize=30px&textColor=ffffff&textBottom=1em) - [Streamlines #414](https://live.artblocks.io/token/0xa319c382a702682129fcbf55d514e61a16f97f9c-414/?useCustomViewParams=true&backgroundColor=671108&showText=true&textColor=bfb3b2&textBottom=0.5em&width=425px&height=550px) - +- [Algobots (with text)](https://live.artblocks.io/random/0xa7d8d9ef8d8ce8992df33d8b8cf4aebabd5bd270/40?reloadClick=true&useCustomViewParams=true&showText=true&backgroundColor=ffffff&width=100vw&height=100vw&reloadDelay=10) +- [A Plottables project (full screen)](https://live.artblocks.io/random/0xa319c382a702682129fcbf55d514e61a16f97f9c/22?reloadClick=true&useCustomViewParams=true&showText=false&backgroundColor=000000&width=100vw&height=100vw&reloadDelay=10)