From b463d0a07656c6ac579e1bb2ac2e635ef2c8a52d Mon Sep 17 00:00:00 2001 From: Matej Lubej Date: Thu, 30 May 2024 08:06:03 +0200 Subject: [PATCH] Add NFTs doc --- .changelog/1436.internal.md | 1 + .markdownlint.yml | 2 ++ README.md | 29 +++++++++++++++- docs/NFTs.md | 69 +++++++++++++++++++++++++++++++++++++ 4 files changed, 100 insertions(+), 1 deletion(-) create mode 100644 .changelog/1436.internal.md create mode 100644 docs/NFTs.md diff --git a/.changelog/1436.internal.md b/.changelog/1436.internal.md new file mode 100644 index 000000000..413d90722 --- /dev/null +++ b/.changelog/1436.internal.md @@ -0,0 +1 @@ +Add NFTs documentation diff --git a/.markdownlint.yml b/.markdownlint.yml index 531422391..6cb792fe4 100644 --- a/.markdownlint.yml +++ b/.markdownlint.yml @@ -14,6 +14,8 @@ line-length: line_length: 80 # Allow longer lines for code blocks. code_block_line_length: 100 + # Ignore on tables + tables: false # Do not always require language specifiers with fenced code blocks since they # are not part of the Markdown spec. diff --git a/README.md b/README.md index 96e60cf8c..86ed4533f 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,33 @@ The official deployment of Oasis Explorer lives at . Development deploy is available at . +## Features + +- **Transaction History**: Allows you to view the complete transaction history + of a specific blockchain* address. +- **Block Contents**: Enables you to examine the contents of individual blocks. + This includes information like the transactions in the block, the total block + size, and the block's hash data. +- **Transaction Verification**: Lets you verify the status of a transaction. You + can confirm whether a transaction has been validated by the network and + included in a block. +- **Blockchain Statistics**: Provides overall statistics regarding the + blockchain* such as the total number of transactions, and the number of blocks + already created. +- **Address Balance**: Enables you to see the balance of any blockchain* + address. +- **Network Nodes**: Provides information about the nodes in the blockchain* + network. +- **Search engine**: Enables you to lookup tokens, addresses, names, blocks and + transactions; +- **Non-Fungible Tokens (NFTs)**: Provides information about NFT ownership, + metadata, transactions history and minting information. ( + See [more...](./docs/NFTs.md)) +- **Contract Reading and Writing** *(upcoming)*: Can read contract details and + record new contract interactions. + +*blockchain: ParaTime layer/s or Consensus + ## Getting started ### Installing and running Oasis Explorer @@ -58,7 +85,7 @@ A quick summary: - Use the present tense ("Add feature" not "Added feature"). - Use the imperative mood ("Move component to..." not "Moves component to..."). - Wrap the body at 80 characters. -- Use the body to explain _what_ and _why_ vs. _how_. +- Use the body to explain *what* and *why* vs. *how*. A detailed post on Git commit messages: [How To Write a Git Commit Message]. diff --git a/docs/NFTs.md b/docs/NFTs.md new file mode 100644 index 000000000..92b60f74c --- /dev/null +++ b/docs/NFTs.md @@ -0,0 +1,69 @@ +# Non-Fungible Tokens (NFTs) + +## Features + +- **NFT Ownership**: Indicates which address currently owns a particular NFT. +- **NFT Metadata**: Displays metadata associated with the NFT, such as name, + description, image defined in the token's contract. +- **Transaction History**: Shows the transaction history of the NFT, allowing + you to see past owners and sales prices. +- **Minting Information**: The time and block of when NFT was minted. + +## NFT Metadata support + +As of the time this documentation was written, our Explorer is designed to +support only the +official [ERC-721](https://github.com/ethereum/ERCs/blob/master/ERCS/erc-721.md) +metadata standard, as per Ethereum's +specifications. + +At present, our system primarily supports the display of image type assets with +a preview feature. These image types can +reside on a variety of hosting platforms, including `https`, `ipfs` or +they can even be Base64 encoded (data: +image/*). + +However, it's important to note that this does not imply a lack of support for +other types of assets. We do accommodate +a wide range of asset types, but instead of a preview, a link to the asset will +be provided. If a user clicks on this +link, they will be redirected to a new tab where the asset will be displayed. +For instance, if the asset is a video, it +will be played in the new tab, and if the native browser supports it, an +accurate preview of an asset will be shown. + +### Properties support + +The table herein outlines the properties that are specifically parsed/rendered +in our Explorer. You have the ability to +view the complete metadata JSON in our dedicated metadata preview section. + +| Property | Description | +|----------|---------------------------------------------------| +| _image_ | URL to the image, it can be any type of an image. | +| _name_ | Name of the asset. | + +## Upcoming + +Here is the proposed upcoming metadata structure. We kindly request that you +adhere to these guidelines to ensure that +your metadata is correctly interpreted and displayed within our explorer. + +| Property | Description | +|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| _image_ | URL to the image, it can be any type of an image. In the context of video content, this refers to a thumbnail representation of the respective video. | +| _name_ | Name of the asset. | +| _description_ | Description of the asset. | +| _attributes_ | Attributes of an asset. | +| _animation_url_ | URL to multi media asset. Our initial development plan includes support for video content. The incorporation of other media types is also under consideration and may be introduced at a future date, depending on the level of demand and usage requirements. | + +Inspiration from +[source](https://docs.opensea.io/docs/metadata-standards#metadata-structure) + +### Planned action items + +- Add support for video assets +- Add support + for [ERC-1155](https://github.com/ethereum/ERCs/blob/master/ERCS/erc-1155.md) +- Add attribute support +- Add support for different kind of assets(audio, documents,...)