From 91cbaa71686a88cb614cefcf064e5700e2d5a899 Mon Sep 17 00:00:00 2001 From: qiwihui Date: Sat, 30 Jul 2022 10:39:50 +0800 Subject: [PATCH 1/2] docs: English for create-a-new-token --- .../98-move-examples/01-create-a-new-token.md | 139 +++++++++++++++++- 1 file changed, 132 insertions(+), 7 deletions(-) diff --git a/docs/03-move/98-move-examples/01-create-a-new-token.md b/docs/03-move/98-move-examples/01-create-a-new-token.md index 9f1bb2a76..039da2440 100644 --- a/docs/03-move/98-move-examples/01-create-a-new-token.md +++ b/docs/03-move/98-move-examples/01-create-a-new-token.md @@ -1,16 +1,141 @@ # 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. -:::note +## Required -TODO +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. And I also created another account `0x831d51f0087596e6aa4e7b3b9c85f945` and transfer some STC to it. The account will be used to receive the token. -1. package & release & deploy +The source file can be found at [my-token](https://github.com/starcoinorg/starcoin-cookbook/tree/main/examples/my-token). -Migrate +## Compile the module -* https://starcoin.org/en/developer/tutorials/user_defined_token/ -* https://starcoin.org/zh/developer/tutorials/user_defined_token/ +Change the address of the module: + +- edit `Move.toml` +- change `MyToken = "0xABCDE"` to `MyToken = "0xb19b07b76f00a8df445368a91c0547cc"` + +Then open a console and run the following command: + +```bash +$ mpm release + +Packaging Modules: + 0xb19b07b76f00a8df445368a91c0547cc::MyToken +Release done: release/my_token.v0.0.1.blob, package hash: 0xc3b9cf32499f4bdf0a38d57f7c7c66a6f4df69881a8980bcda2106782dce88ba +``` + +It will compile the module, and then you will get the binary package `my_token.v0.0.1.blob` in `release` folder. We will use it then. + +## Import account + +We will need to import `0xb19b07b76f00a8df445368a91c0547cc` account to deploy the module. + +```bash +starcoin% account import -i 0x05c9d09cd06a49e99efd0308c64bfdfb57409e10bc9e2a57cb4330cd946b4e83 -p + +{ + "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. This command can only be used in dev net. + +```bash +dev get-coin 0xb19b07b76f00a8df445368a91c0547cc +``` + +## Deploy module + +Then, unlock the account and deploy `MyToken` module. + +```bash +starcoin% account unlock 0xb19b07b76f00a8df445368a91c0547cc -p +``` + +```bash +starcoin% dev deploy /path/to/my-token/release/my_token.v0.0.1.blob -s 0xb19b07b76f00a8df445368a91c0547cc -b + +txn 0x686964d6a4212f1e32e8626132e14dabffb034d6f3aec921e80a2e54726391b1 submitted. +{ + "ok": { + "dry_run_output": { + "events": [], + "explained_status": "Executed", + "gas_used": "7800", + "status": "Executed", + "write_set": [ + { + "access_path": "0x00000000000000000000000000000001/1/0x00000000000000000000000000000001::TransactionFee::TransactionFee<0x00000000000000000000000000000001::STC::STC>", + "action": "Value", + "value": { + "Resource": { + "json": { + "fee": { + "value": 25031 + } + }, + "raw": "0xc7610000000000000000000000000000" + } + } + }, + ..... + .... +} +``` + +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，use the account `0xb19b07b76f00a8df445368a91c0547cc` to initial module via `init` function. + +```bash +starcoin% account execute-function --function 0xb19b07b76f00a8df445368a91c0547cc::MyToken::init -s 0xb19b07b76f00a8df445368a91c0547cc --blocking +``` + +Second, use the account `0xb19b07b76f00a8df445368a91c0547cc` to mint some MyToken. + +```bash +starcoin% account execute-function --function 0xb19b07b76f00a8df445368a91c0547cc::MyToken::mint --blocking --arg 1000000u128 -s 0xb19b07b76f00a8df445368a91c0547cc +``` + +Third, use the account `0xb19b07b76f00a8df445368a91c0547cc` to transfer 1000 MyToken to another user `0x831d51f0087596e6aa4e7b3b9c85f945`. + +```bash +starcoin% account execute-function --function 0x1::TransferScripts::peer_to_peer_v2 -t 0xb19b07b76f00a8df445368a91c0547cc::MyToken::MyToken --arg 0x831d51f0087596e6aa4e7b3b9c85f945 --arg 10000u128 -s 0xb19b07b76f00a8df445368a91c0547cc +``` + +Last, show balances of the second user. + +```bash +starcoin% account show 0x831d51f0087596e6aa4e7b3b9c85f945 +{ + "ok": { + "account": { + "address": "0x831d51f0087596e6aa4e7b3b9c85f945", + "is_default": true, + "is_readonly": false, + "public_key": "0x29894dafe73616f807ed48aef1978974122d790a62be767d115f396b422cbb75", + "receipt_identifier": "stc1psvw4ruqgwktwd2jw0vaeep0eg5eac86k" + }, + "auth_key": "0xedf8fad3eb73ab981793ca5b29b9f660831d51f0087596e6aa4e7b3b9c85f945", + "balances": { + "0x00000000000000000000000000000001::STC::STC": 100000533341, + "0xb19b07b76f00a8df445368a91c0547cc::MyToken::MyToken": 10000 <- Note that MyToken has been successfully received + }, + "sequence_number": 3 + } +} +``` -::: \ No newline at end of file From 43c22eaf93ce34da83d7d78e36cee9233ec57f67 Mon Sep 17 00:00:00 2001 From: qiwihui Date: Sat, 30 Jul 2022 16:24:55 +0800 Subject: [PATCH 2/2] fix: adjust Chinese doc for create-a-new-token --- .../98-move-examples/01-create-a-new-token.md | 2 +- .../98-move-examples/01-create-a-new-token.md | 18 +++++++++--------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/03-move/98-move-examples/01-create-a-new-token.md b/docs/03-move/98-move-examples/01-create-a-new-token.md index 039da2440..05a90a323 100644 --- a/docs/03-move/98-move-examples/01-create-a-new-token.md +++ b/docs/03-move/98-move-examples/01-create-a-new-token.md @@ -49,7 +49,7 @@ starcoin% account import -i 0x05c9d09cd06a49e99efd0308c64bfdfb57409e10bc9e2a57cb ## Get devnet test coins -Get some STC coin from `dev` net. This command can only be used in dev net. +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 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/03-move/98-move-examples/01-create-a-new-token.md b/i18n/zh/docusaurus-plugin-content-docs/current/03-move/98-move-examples/01-create-a-new-token.md index dfd2efcf1..893fe1793 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/03-move/98-move-examples/01-create-a-new-token.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/03-move/98-move-examples/01-create-a-new-token.md @@ -1,8 +1,6 @@ # 创建一种新的代币 -这一章节主要介绍用户如何自定义一种代币（Token）。 - -接下来将演示如何在 Starcoin 区块链上定义用户自定义代币。 +在这一章节中，我们将介绍如何在 Starcoin 区块链上创建自定义代币（Token）。让我们开始吧。 ## 前提 @@ -17,8 +15,8 @@ 修改模块地址： -- 编辑`Move.toml` -- MyToken = "0xABCDE" 改为 MyToken = "0xb19b07b76f00a8df445368a91c0547cc" +- 编辑 `Move.toml` +- 把 `MyToken = "0xABCDE"` 改为 `MyToken = "0xb19b07b76f00a8df445368a91c0547cc"` 在命令行中运行： @@ -30,11 +28,11 @@ Packaging Modules: Release done: release/my_token.v0.0.1.blob, package hash: 0xc3b9cf32499f4bdf0a38d57f7c7c66a6f4df69881a8980bcda2106782dce88ba ``` -它将编译自定义代币的合约代码，在项目的 `release` 目录下生成二进制文件。 +它将编译自定义代币的合约代码，在项目的 `release` 目录下生成二进制文件 `my_token.v0.0.1.blob`，我们之后部署将用到这个文件。 ## 导入账户 -导入 `0xb19b07b76f00a8df445368a91c0547cc` 账号. +我们需要先导入 `0xb19b07b76f00a8df445368a91c0547cc` 账号。 ```bash starcoin% account import -i 0x05c9d09cd06a49e99efd0308c64bfdfb57409e10bc9e2a57cb4330cd946b4e83 -p @@ -52,7 +50,7 @@ starcoin% account import -i 0x05c9d09cd06a49e99efd0308c64bfdfb57409e10bc9e2a57cb ## 获取代币 -获得 `dev` 网络的 STC 代币 +获得 `dev` 网络的 STC 代币，这个命令将默认发送 `1000000000` STC 到账户中。注意，这个命令只能用于开发网络。 ```bash dev get-coin 0xb19b07b76f00a8df445368a91c0547cc @@ -97,6 +95,8 @@ txn 0x686964d6a4212f1e32e8626132e14dabffb034d6f3aec921e80a2e54726391b1 submitted } ``` +可以看到交易已经提交，结果状态为 `Executed`。这意味着该模块已部署。 + ## 执行脚本功能 首先，使用 `0xb19b07b76f00a8df445368a91c0547cc` 账户初始化模块。 @@ -111,7 +111,7 @@ starcoin% account execute-function --function 0xb19b07b76f00a8df445368a91c0547cc starcoin% account execute-function --function 0xb19b07b76f00a8df445368a91c0547cc::MyToken::mint --blocking --arg 1000000u128 -s 0xb19b07b76f00a8df445368a91c0547cc ``` -然后，`0xb19b07b76f00a8df445368a91c0547cc` 账户转账1000个 MyToken 给默认账户 `0x831d51f0087596e6aa4e7b3b9c85f945`。 +然后，使用 `0xb19b07b76f00a8df445368a91c0547cc` 账户转账1000个 MyToken 给默认账户 `0x831d51f0087596e6aa4e7b3b9c85f945`。 ```bash starcoin% account execute-function --function 0x1::TransferScripts::peer_to_peer_v2 -t 0xb19b07b76f00a8df445368a91c0547cc::MyToken::MyToken --arg 0x831d51f0087596e6aa4e7b3b9c85f945 --arg 10000u128 -s 0xb19b07b76f00a8df445368a91c0547cc