From 1701d95cb62d1231391e85c0ab89c0a4163cd6aa Mon Sep 17 00:00:00 2001 From: worryFree56 Date: Tue, 30 Aug 2022 14:43:43 +0800 Subject: [PATCH] del x/nft docs --- docs/cli-client/nft.md | 167 ---------------------------- docs/features/nft.md | 29 ----- docs/zh/cli-client/nft.md | 168 ----------------------------- docs/zh/features/nft-metadata.json | 22 ---- docs/zh/features/nft.md | 30 ------ 5 files changed, 416 deletions(-) delete mode 100644 docs/cli-client/nft.md delete mode 100644 docs/features/nft.md delete mode 100644 docs/zh/cli-client/nft.md delete mode 100644 docs/zh/features/nft-metadata.json delete mode 100644 docs/zh/features/nft.md diff --git a/docs/cli-client/nft.md b/docs/cli-client/nft.md deleted file mode 100644 index f63876d78..000000000 --- a/docs/cli-client/nft.md +++ /dev/null @@ -1,167 +0,0 @@ -# NFT - -`NFT` provides the ability to digitize assets. Through this module, each off-chain asset will be modeled as a unique on-chain asset. - -## Available commands - -| Name | Description | -| ---------------------------------------- | ----------- | -| [issue-class](#issue-class) | Create asset classification | -| [issue-nft](#issue-nft) | Issue additional assets | -| [edit-nft](#edit-nft) | Edit Assets | -| [transfer-class](#transfer-class) | Transfer asset classification | -| [transfer-nft](#transfer-nft) | Transfer specified nft assets | -| [burn-nft](#burn-nft) | Destroy Assets | -| [supply](#supply) | Query supply | -| [owner](#owner) | Query by owner | -| [nft](#nft) | Query specified nft | -| [nfts](#nfts) | Query nfts | -| [class](#class) | Query class | -| [classes](#classes) | Query classes | - -:::tip -The above commands can use the `-h` parameter to view the description of the function and the meaning of the parameters -::: - -:::warning -The above `issue-class`,`issue-nft`,`edit-nft`,`transfer-class`,`transfer-nft`,`burn-nft` commands all require parameters `--from`,`--chain -id`,`--fees` -::: - -**Logo:** - -| Name, shorthand | Optional value | Description | Required | -| ----------- | ---- | ------------------ | ---- | -| --from | | The address used to sign the transaction sent by the execution function | true | -| --chain-id | plugchain_520-1 | ID of the chain | true | -| --fees | 200uplugcn | Pay transaction fees | true | -| --home | ~/.plugchain | The directory where the chain data is located | Optional | - - -:::warning - -参数规则： -| 名称 | 类型 | 描述 | 规则 | -| ----------------- | ----------- | ---- | ---- | -| class-id | string | assets class-id | [a-zA-Z][a-zA-Z0-9/:-]{2,100} | -| class-name | string | assets class name | none | -| class-symbol | string | assets class symbol | none | -| mint-restricted | bool | MintRestricted is true means that only Class owners can issue NFTs under this category, false means anyone can | none | -| edit-restricted | bool | EditRestricted is true means that no one in this category can Edit the NFT, false means that only the owner of this NFT can Edit | none | -| nft-id | string | nft ID | [a-zA-Z][a-zA-Z0-9/:-]{2,100} | -| nft-name | string | nft name | none | -| nft-uri | string | The URI pointing to a JSON object that contains subsequent nftData information off-chain | The maximum length is 256 bytes, starting with `http://`,`https://` | -| nft-data | string | NFT specifications defined under this category | none | -| nft-recipient | string | owner address | none | - -::: - - - -## issue-class - -Issue assets - -```bash -plugchaind tx nft issue-class [class-id] [class-name] [class-symbol] [mint-restricted] [edit-restricted] [schema-content or path to schema.json] [flags] -``` - -## issue-nft - -Additional issuance (creation) of assets - -```bash -plugchaind tx nft issue-nft [class-id] [nft-id] [nft-name] [nft-uri] [nft-data] [nft-recipient] [flags] -``` - - -## edit-nft - -Edit assets - -```bash -plugchaind tx nft edit-nft [class-id] [nft-id] [flags] -``` - -**Logo:** - -| Name, shorthand | Default | Description | Required | -| ---------- | ---- | ------------------ | ---- | -| --nft-name | | The name of the nft asset | Optional | -| --nft-uri | | Where nft assets are located | Optional | -| --nft-data | |nft asset metadata | Optional | - -## transfer-class - -Transfer assets - -```bash -plugchaind tx nft transfer-class [flags] -``` - -## transfer-nft - -Transfer of designated nft assets - -```bash -plugchaind tx nft transfer-nft [flags] -``` - -## burn-nft - -Destroy assets - -```bash -plugchaind tx nft burn-nft [class-id] [nft-id] [flags] -``` - - -## supply - -Query the total amount of assets based on class-id; accept the optional --owner parameter. - - -```bash -plugchaind q nft supply [class-id] [flags] -plugchaind q nft supply [class-id] --owner= [flags] -``` - -## owner - -Query all assets owned by an account; you can specify the class-id parameter. - - -```bash -plugchaind query nft owner [address] [class-id] [flags] -``` -## nft - -Query specific assets based on class-id and ID. - -```bash -plugchaind q nft nft [class-id] [nft-id] [flags] -``` -## nfts - -Query all assets based on class-id.accept the optional --owner parameter. - - -```bash -plugchaind q nft nfts [class-id] [flags] -``` - -## class - -Query asset category information based on class-id. - - -```bash -plugchaind q nft class [class-id] [flags] -``` - -## classes - -Query all asset class information that has been issued. - -```bash -plugchaind q nft classes [flags] -``` \ No newline at end of file diff --git a/docs/features/nft.md b/docs/features/nft.md deleted file mode 100644 index 3e8eb6eca..000000000 --- a/docs/features/nft.md +++ /dev/null @@ -1,29 +0,0 @@ -# NFT - -## Introduction - -`NFT` provides the ability to digitize assets. Through this module, each off-chain asset will be modeled as a unique on-chain asset. - -Assets on the chain are identified by `ID`. With the help of the secure and non-tamperable features of the blockchain, the ownership of the assets will be clarified. The transaction process of assets among members will also be publicly recorded to facilitate traceability and dispute settlement. - -Asset metadata (`metadata`) can be stored directly on the chain, or it can be stored on the chain with the `URI` of its storage source outside the chain. Asset metadata is organized according to a specific [JSON Schema](https://JSON-Schema.org/). [Here](https://github.com/oracleNetworkProtocol/plugchain/tree/main/docs/zh/features/nft-metadata.json) is an example of metadata JSON Schema. - -Assets need to be issued before they are created to declare their abstract properties: - --_Class_: the globally unique asset class name - --_Class ID_: Class’s globally unique identifier - --_Metadata Specification_: The JSON Schema that asset metadata should follow - -Each specific asset is described by the following elements: - --_Class_: the category of the asset - --_ID_: the identifier of the asset, unique in this asset class - --_Metadata_: The structure that contains asset-specific data - --_Metadata URI_: When metadata is stored off-chain, this URI indicates its storage location - -## [Open functions and usage](../cli-client/nft.md) \ No newline at end of file diff --git a/docs/zh/cli-client/nft.md b/docs/zh/cli-client/nft.md deleted file mode 100644 index 9acac6163..000000000 --- a/docs/zh/cli-client/nft.md +++ /dev/null @@ -1,168 +0,0 @@ -# NFT - -`NFT`提供了将资产进行数字化的能力。通过该模块，每个链外资产将被建模为唯一的链上资产。 - -## 可用命令 - -| 名称 | 描述 | -| ------------------------------------ | ------------- | -| [issue-class](#issue-class) | 创建资产分类 | -| [issue-nft](#issue-nft) | 发行资产 | -| [edit-nft](#edit-nft) | 编辑资产 | -| [transfer-class](#transfer-class) | 转让资产分类 | -| [transfer-nft](#transfer-nft) | 转让指定nft资产 | -| [burn-nft](#burn-nft) | 销毁资产 | -| [supply](#supply) | 查询supply | -| [owner](#owner) | 通过owner查询 | -| [nft](#nft) | 查询指定nft | -| [nfts](#nfts) | 查询nfts | -| [class](#class) | 查询class | -| [classes](#classes) | 查询classes | - -:::tip -以上命令都可以使用 `-h` 参数，来查看功能的描述和参数的含义 -::: - -:::warning -以上`issue-class`,`issue-nft`,`edit-nft`,`transfer-class`,`transfer-nft`,`burn-nft` 命令都需要参数 `--from`,`--chain-id`,`--fees` -::: - -**标志：** - -| 名称，速记 | 可选值 | 描述 | 必须 | -| ----------- | ---- | ------------------ | ---- | -| --from | | 执行功能发交易用于签名的地址 | true | -| --chain-id | plugchain_520-1 | 链的ID | true | -| --fees | 200uplugcn | 支付交易的费用 | true | -| --home | ~/.plugchain | 链数据所在目录 | 可选 | - - -:::warning - -参数规则： -| 名称 | 类型 | 描述 | 规则 | -| ----------------- | ----------- | ---- | ---- | -| class-id | string | 资产类别序号 | [a-zA-Z][a-zA-Z0-9/:-]{2,100} | -| nft-id | string | 资产序号 | [a-zA-Z][a-zA-Z0-9/:-]{2,100} | -| class-name | string | 资产类别名称 | 无 | -| class-symbol | string | 资产类别缩写 | 无 | -| mint-restricted | bool | true 表示只有类别拥有者才可以在此类别下创建资产，false 表示任何人都可以| 无 | -| edit-restricted | bool | 为 true 表示此类别中没有人可以编辑 NFT，false 表示只有此 NFT 的所有者可以编辑 | 无 | - -| nft-name | string | 资产名称 | 无 | -| nft-uri | string | 资产链外信息的 JSON 对象的 URI | 最大长度256字节，以`http://`,`https://`开头 | -| nft-data | string | 资产元数据 | 无 | -| nft-recipient | string | 资产创建者 | 无 | - -::: - - -## issue-class - -发行资产 - -```bash -plugchaind tx nft issue-class [class-id] [class-name] [class-symbol] [mint-restricted] [edit-restricted] [schema-content or path to schema.json] [flags] -``` - -## issue-nft - -增发(创建)资产 - -```bash -plugchaind tx nft issue-nft [class-id] [nft-id] [nft-name] [nft-uri] [nft-data] [nft-recipient] [flags] -``` - - -## edit-nft - -编辑资产 - -```bash -plugchaind tx nft edit-nft [class-id] [nft-id] [flags] -``` - -**标志：** - -| 名称，速记 | 默认 | 描述 | 必须 | -| ---------- | ---- | ------------------ | ---- | -| --nft-name | | nft资产的名字 | 可选 | -| --nft-uri | | nft资产链外元数据地址 | 可选 | -| --nft-data | |nft资产的元数据 | 可选 | - -## transfer-class - -转让资产 - -```bash -plugchaind tx nft transfer-class [flags] -``` - -## transfer-nft - -转让指定nft资产 - -```bash -plugchaind tx nft transfer-nft [flags] -``` - -## burn-nft - -销毁资产 - -```bash -plugchaind tx nft burn-nft [class-id] [nft-id] [flags] -``` - - -## supply - -根据 class-id 查询资产总量；接受可选的 --owner 参数。 - - -```bash -plugchaind q nft supply [class-id] [flags] -plugchaind q nft supply [class-id] --owner= [flags] -``` - -## owner - -查询某一账户所拥有的全部资产；可以指定 class-id 参数。 - - -```bash -plugchaind query nft owner [address] [class-id] [flags] -``` - -## nft - -根据 class-id 以及 ID 查询具体资产。 - -```bash -plugchaind q nft nft [class-id] [nft-id] [flags] -``` - -## nfts - -根据 class-id 查询所有资产。接受可选的 --owner 参数。 - -```bash -plugchaind q nft nfts [class-id] [flags] -``` - -## class - -根据 class-id 查询资产类别信息。 - - -```bash -plugchaind q nft class [class-id] [flags] -``` - -## classes - -查询已发行的所有资产类别信息。 - -```bash -plugchaind q nft classes [flags] -``` diff --git a/docs/zh/features/nft-metadata.json b/docs/zh/features/nft-metadata.json deleted file mode 100644 index 0ed2df7b3..000000000 --- a/docs/zh/features/nft-metadata.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "title": "Asset Metadata", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Identifies the asset to which this NFT represents" - }, - "description": { - "type": "string", - "description": "Describes the asset to which this NFT represents" - }, - "image": { - "type": "string", - "description": "A URI pointing to a resource with mime type image/* representing the asset to which this NFT represents. Consider making any images at a width between 320 and 1080 pixels and aspect ratio between 1.91:1 and 4:5 inclusive." - }, - "meta": { - "type": "string", - "description": "A URI pointing to other attributes related to the asset to which this NFT represents" - } - } -} \ No newline at end of file diff --git a/docs/zh/features/nft.md b/docs/zh/features/nft.md deleted file mode 100644 index 1b3f8324e..000000000 --- a/docs/zh/features/nft.md +++ /dev/null @@ -1,30 +0,0 @@ -# NFT - -## 简介 - -`NFT`提供了将资产进行数字化的能力。通过该模块，每个链外资产将被建模为唯一的链上资产。 - -链上资产用 `ID` 进行标识，借助区块链安全、不可篡改的特性，资产的所有权将得到明确。资产在成员间的交易过程也将被公开地记录，以便于追溯以及争议处理。 - -资产的元数据（`metadata`）可以直接存储在链上，也可以将其在链外存储源的 `URI` 存储在链上。资产元数据按照特定的 [JSON Schema](https://JSON-Schema.org/) 进行组织。[这里](https://github.com/oracleNetworkProtocol/plugchain/tree/main/docs/zh/features/nft-metadata.json)是一个元数据 JSON Schema 示例。 - -资产在创建前需要发行，用以声明其抽象属性： - -- _Class_：即全局唯一的资产类别名 - -- _Class ID_：Demon的全局唯一标识符 - -- _元数据规范_：资产元数据应遵循的 JSON Schema - -每一个具体的资产由以下元素描述： - -- _Class_：该资产的类别 - -- _ID_：资产的标识符，在此资产类别中唯一 - -- _元数据_：包含资产具体数据的结构 - -- _元数据 URI_：当元数据存储在链外时，此 URI 表示其存储位置 - -## [开放功能和使用方式](../cli-client/nft.md) -