如需获取详细的 forge-python-sdk 参考手册,请访问此处

Python SDK 的源代码可在Github获取。如果有任何疑问,请联系我们。

安装

推荐您通过pip安装

此 sdk 支持>=3.6的 python 版本。

使用

第 0 步

首先,通过Forge CLI在本地运行 Forge。

第 1 步

创建一个Forge连接(Forge Connection)来连接您的 Forge 端口(如果您是通过 forge-cli来运行您的 Forge,初始端口为 127.0.0.1:28210)。

每一个教程都从这一步开始。

教程

1 级:转移金钱

场景:Alice想给迈克转移 10TBA。

TBA是 Forge 链上的默认货币。1 TBA 有 16 个数位,所以,显示为10000000000000000

第 1 步:为Alice和迈克创建钱包

moniker是 Forge 上该钱包的昵称。passphrase是通过 Forge 将钱包加密为一个 keystore 文件。如需了解钱包声明规则的更多信息,请点击此处

我们看看Alice的钱包和账户详情

第 2 步:帮助Alice发出签到交易以获得一些钱

现在,您已为Alice和迈克创建了钱包,但是他们的账户里没有钱。让我们发出一次签到交易,帮助Alice得到一些钱。

收到哈希意味着交易被转移到 Forge,但不意味着交易成功。为了确认交易成功发出,让我们深入了解交易详情。

如果is_tx_ok返回True,则意味着交易成功执行。现在,Alice的账户中应该有 25 TBA。

现在,我们查看一下Alice的账户余额。应该有 25 TBA。

签到:每个账户可每天发出一次签到交易以获得 25 TBA。 哈希:通过已签署交易计算的哈希。每笔交易应有其独特的哈希

第 3 步:从Alice向迈克转移钱

现在Alice的账户中有 25 个 TBA,迈克的账户中什么也没有。我们可以发出转移交易,帮助Alice将 10 TBA 转给迈克。

现在我们可以看到,Alice刚刚成功地将 10 TBA 转到了迈克的账户!

🎉 祝贺您!您已完成 1 级教程!现在,您应该对 Forge 的工作原理有了基本的了解。如果您想迎接更多挑战,请查看 2 级教程。

2 级:出售二手笔记本电脑

场景:迈克想向Alice出售一台二手笔记本电脑。

第 1 步:为Alice和迈克创建账户

在帮助Alice和迈克创建账户后,我们帮助Alice获得一些购买迈克笔记本所需的钱

第 2 步:为迈克创建笔记本资产

在现实世界,迈克可以简单地向Alice出售他的笔记本。通过 Forge SDK,任何物理项目都能以资产形式存在。

我们试试帮迈克通过CreateAssetTx创建笔记本资产。用户可在data字段输入项目相关的信息,type_url代表如何解码序列化的value字段。在本教程中,为了简便,我们只填写笔记本的名称。

然后我们可以看看这个资产到底是什么样的。

最后一个字段是data字段,我们可以看到Laptop from Mike。您也可以在其中加入更为复杂的信息,如序列化的 protobuf 消息。

第 3 步:用钱交换资产

现在,Alice的账户里有 25 TBA,迈克有一个笔记本资产。如果迈克想以 10 TBA 的价格出售笔记本,应该怎么做?他可以发起ExchangeTx

因为迈克将是发出者,我们将笔记本asset_address作为他将交换的对象。相似的,Alice将交换 10 TBA。

prepare_exchange,我们让卖家迈克验证交易;在finalize_exchange,我们让买家Alice验证交易。在双方验证后,我们可直接发出交易。

现在,如果我们查看笔记本的所有者,应为Alice的地址。

在购买笔记本后,Alice 的账户中应只有 15 TBA。

🎉 🎉 祝贺您!您已完成 2 级教程!现在,您应该对如何通过 Forge SDK 创建资产和交换资产 Forge 的工作原理有了一定的了解。不妨试试创建更多复杂资产!

就是这样了。现在您已经准备就绪了。如果您有任何问题或建议,请在GitHub上与我们分享。