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.

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

docs: doc for creating a new NFT in Chinese and English #157

Merged
merged 1 commit into from
Jul 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/03-move/98-move-examples/01-create-a-new-token.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Create a new Token

In this chapter, we will focus on how to create a custom non-fungible token on the Starcoin blockchain. Let's get started.
In this chapter, we will focus on how to create a custom token on the Starcoin blockchain. Let's get started.

## Required

Expand Down Expand Up @@ -52,7 +52,7 @@ starcoin% account import -i 0x05c9d09cd06a49e99efd0308c64bfdfb57409e10bc9e2a57cb
Get some STC coin from `dev` net, and it will send `1000000000` STC to the account by default. Notice that, this command can only be used in dev net.

```bash
dev get-coin 0xb19b07b76f00a8df445368a91c0547cc
starcoin% dev get-coin 0xb19b07b76f00a8df445368a91c0547cc
```

## Deploy module
Expand Down
151 changes: 149 additions & 2 deletions docs/03-move/98-move-examples/02-create-a-new-nft.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,152 @@
# Create a new NFT

TODO
In this chapter, we will focus on how to create a custom non-fungible token on the Starcoin blockchain. Let's get started.

1. package & release & deploy
## Required

First, start a dev network described in [How to set up a local dev network](../../02-getting-started/02-setup/03-dev-network.md) and get some coins, say `1000000000`.

In this document, I will use `0xb19b07b76f00a8df445368a91c0547cc`, the default account address of my dev network, to represent the person who issues and send the new token.

The source file can be found at [simple-nft](https://github.com/starcoinorg/starcoin-cookbook/tree/main/examples/simple-nft).

## Compile the module

Clone the code from github and enter the `simple-nft` folder:

```bash
git clone https://github.com/starcoinorg/starcoin-cookbook.git
cd starcoin-cookbook/examples/simple-nft
```

Replace the SNFT address with your default address in the `Move.toml` file.

```toml
[addresses]
StarcoinFramework = "0x1"
SNFT = "0xb19b07b76f00a8df445368a91c0547cc"
```

Run mpm release in another shell console for release package:

```bash
$ mpm release

Packaging Modules:
0xb19b07b76f00a8df445368a91c0547cc::SimpleNFT
0xb19b07b76f00a8df445368a91c0547cc::SimpleNFTScripts
Release done: release/simple-nft.v0.0.1.blob, package hash: 0x39bf53490461a9ccf07804312561280e7dafa4ba8ea102913c022de5c9a80555
```

It will compile the module, and then you will get the binary package `simple-nft.v0.0.1.blob` in `release` folder. We will use it then.

We will need to import `0xb19b07b76f00a8df445368a91c0547cc` account to deploy the module.

```bash
starcoin% account import -i 0x05c9d09cd06a49e99efd0308c64bfdfb57409e10bc9e2a57cb4330cd946b4e83 -p <MY-PASSWORD>

{
"ok": {
"address": "0xb19b07b76f00a8df445368a91c0547cc",
"is_default": false,
"is_readonly": false,
"public_key": "0x7932502fa3f8c9bc9c9bb994f718b9bd90e58a6cdb145e24769560d3c96254d2",
"receipt_identifier": "stc1pkxds0dm0qz5d73zndz53cp28esyfj4ue"
}
}
```

## Get devnet test coins

Get some STC coin from `dev` net, and it will send `1000000000` STC to the account by default.

```bash
starcoin% dev get-coin 0xb19b07b76f00a8df445368a91c0547cc
```

## Deploy module

Then, unlock the account and deploy `SimpleNFT` module and `SimpleNFTScripts` module.

```bash
starcoin% account unlock 0xb19b07b76f00a8df445368a91c0547cc -p <MY-PASSWORD>
```

```bash
starcoin% dev deploy /path/to/simple-nft/release/simple-nft.v0.0.1.blob -s 0xb19b07b76f00a8df445368a91c0547cc -b

txn 0x60e31b4e4fe974f66b80c3e69c659a573b4022754430bf030576292e1358d7b0 submitted.
{
"ok": {
"dry_run_output": {
"events": [],
"explained_status": "Executed",
"gas_used": "37536",
"status": "Executed",
"write_set": [
{
"access_path": "0x00000000000000000000000000000001/1/0x00000000000000000000000000000001::TransactionFee::TransactionFee<0x00000000000000000000000000000001::STC::STC>",
"action": "Value",
"value": {
"Resource": {
"json": {
"fee": {
"value": 322067
}
},
"raw": "0x13ea0400000000000000000000000000"
}
}
},
.....
....
}
```

You can see that the transation is submitted and the result status is `Executed`. That means the module has been deployed.

## Execute script function

First,execute the initialize transaction in starcoin console:

```bash
starcoin% account execute-function --function 0xb19b07b76f00a8df445368a91c0547cc::SimpleNFTScripts::initialize -b
```

Then, mint a test nft:

```bash
starcoin% account execute-function --function 0xb19b07b76f00a8df445368a91c0547cc::SimpleNFTScripts::test_mint_with_image_data -b
```

Last, run `account nft list` to check the NFT in the account:

```bash
starcoin% account nft list
{
"ok": {
"list": [
{
"base_meta": {
"description": "test description",
"image": "",
"image_data": "<省略 image_data>",
"name": "test nft"
},
"body": {
"dummy_field": false
},
"creator": "0xb19b07b76f00a8df445368a91c0547cc",
"id": 1,
"nft_type": "0xb19b07b76f00a8df445368a91c0547cc::SimpleNFT::SimpleNFT/0xb19b07b76f00a8df445368a91c0547cc::SimpleNFT::SimpleNFTBody",
"type_meta": {
"dummy_field": false
},
"uuid": "0xb19b07b76f00a8df445368a91c0547cc::SimpleNFT::SimpleNFT/0xb19b07b76f00a8df445368a91c0547cc::SimpleNFT::SimpleNFTBody/1"
}
]
}
}
```

We can now see a NFT witd `id` 1 in your account.
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ starcoin% account import -i 0x05c9d09cd06a49e99efd0308c64bfdfb57409e10bc9e2a57cb
获得 `dev` 网络的 STC 代币,这个命令将默认发送 `1000000000` STC 到账户中。注意,这个命令只能用于开发网络。

```bash
dev get-coin 0xb19b07b76f00a8df445368a91c0547cc
starcoin% dev get-coin 0xb19b07b76f00a8df445368a91c0547cc
```

## 部署模块
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
# 创建一种新的 NFT

这一章节主要介绍用户如何在 Starcoin 区块链上自定义一种 NFT(Non-Fungible Token)。

## 前提

首先,按照[如何设置本地开发网络](../../02-getting-started/02-setup/03-dev-network.md)中的描述启动一个开发网络,并获得一些 STC 代币用于创建NFT,比如 `1000000000 STC`。

在本文档中,我将使用我的开发网络的默认帐户地址 `0xb19b07b76f00a8df445368a91c0547cc` 来代表**发行**和**铸造**新 NFT 的人。

创建自定义 NFT 的代码源文件位于 [simple-nft](https://github.com/starcoinorg/starcoin-cookbook/tree/main/examples/simple-nft)。

## 编译模块

下载代码并进入 `simple-nft` 目录:

```bash
git clone https://github.com/starcoinorg/starcoin-cookbook.git
cd starcoin-cookbook/examples/simple-nft
```

修改 `Move.toml` 文件中 `SNFT` 地址为默认账户地址:

```toml
[addresses]
StarcoinFramework = "0x1"
SNFT = "0xb19b07b76f00a8df445368a91c0547cc"
```

在 shell 控制台中运行 `mpm release` 以获取发布模块:

```bash
$ mpm release

Packaging Modules:
0xb19b07b76f00a8df445368a91c0547cc::SimpleNFT
0xb19b07b76f00a8df445368a91c0547cc::SimpleNFTScripts
Release done: release/simple-nft.v0.0.1.blob, package hash: 0x39bf53490461a9ccf07804312561280e7dafa4ba8ea102913c022de5c9a80555
```

它将编译自定义 NFT 的合约代码,在项目的 `release` 目录下生成二进制文件 `simple-nft.v0.0.1.blob`,此二进制文件将用于之后的部署。

## 导入账户

我们需要先导入 `0xb19b07b76f00a8df445368a91c0547cc` 账号。

```bash
starcoin% account import -i 0x05c9d09cd06a49e99efd0308c64bfdfb57409e10bc9e2a57cb4330cd946b4e83 -p <MY-PASSWORD>

{
"ok": {
"address": "0xb19b07b76f00a8df445368a91c0547cc",
"is_default": false,
"is_readonly": false,
"public_key": "0x7932502fa3f8c9bc9c9bb994f718b9bd90e58a6cdb145e24769560d3c96254d2",
"receipt_identifier": "stc1pkxds0dm0qz5d73zndz53cp28esyfj4ue"
}
}
```

## 获取代币

获得 `dev` 网络的 STC 代币用户支付合约部署过程中的花费,这个命令将默认发送 `1000000000` STC 到账户中。

```bash
starcoin% dev get-coin 0xb19b07b76f00a8df445368a91c0547cc
```

## 部署模块

解锁帐户并部署 SimpleNFT 模块和 SimpleNFTScripts 模块。

```bash
starcoin% account unlock 0xb19b07b76f00a8df445368a91c0547cc -p <MY-PASSWORD>
```

```bash
starcoin% dev deploy /path/to/simple-nft/release/simple-nft.v0.0.1.blob -s 0xb19b07b76f00a8df445368a91c0547cc -b

txn 0x60e31b4e4fe974f66b80c3e69c659a573b4022754430bf030576292e1358d7b0 submitted.
{
"ok": {
"dry_run_output": {
"events": [],
"explained_status": "Executed",
"gas_used": "37536",
"status": "Executed",
"write_set": [
{
"access_path": "0x00000000000000000000000000000001/1/0x00000000000000000000000000000001::TransactionFee::TransactionFee<0x00000000000000000000000000000001::STC::STC>",
"action": "Value",
"value": {
"Resource": {
"json": {
"fee": {
"value": 322067
}
},
"raw": "0x13ea0400000000000000000000000000"
}
}
},
.....
....
}
```

可以看到交易已经提交,结果状态为 `Executed`。这意味着该模块已部署。

## 执行脚本功能

首先,在 starcoin 控制台执行初始化交易:

```bash
starcoin% account execute-function --function 0xb19b07b76f00a8df445368a91c0547cc::SimpleNFTScripts::initialize -b
```

然后,铸造一个测试 NFT:

```bash
starcoin% account execute-function --function 0xb19b07b76f00a8df445368a91c0547cc::SimpleNFTScripts::test_mint_with_image_data -b
```

最后,通过 `account nft list` 命令可以查看已经铸造的 NFT:

```bash
starcoin% account nft list
{
"ok": {
"list": [
{
"base_meta": {
"description": "test description",
"image": "",
"image_data": "<省略 image_data>",
"name": "test nft"
},
"body": {
"dummy_field": false
},
"creator": "0xb19b07b76f00a8df445368a91c0547cc",
"id": 1,
"nft_type": "0xb19b07b76f00a8df445368a91c0547cc::SimpleNFT::SimpleNFT/0xb19b07b76f00a8df445368a91c0547cc::SimpleNFT::SimpleNFTBody",
"type_meta": {
"dummy_field": false
},
"uuid": "0xb19b07b76f00a8df445368a91c0547cc::SimpleNFT::SimpleNFT/0xb19b07b76f00a8df445368a91c0547cc::SimpleNFT::SimpleNFTBody/1"
}
]
}
}
```

我们可以看到我们的账户中已经有了 `id` 为 1 的一个 NFT。