2个版本

0.1.1 2023年8月14日
0.1.0 2023年8月13日

#23 in #cw20

Apache-2.0

30KB
548

CosmWasm入门包

这是一个模板,用于在Rust中构建智能合约,以便在所有启用它的链上的Cosmos SDK模块中运行。为了更好地理解框架,请阅读cosmwasm仓库中的概述,并深入了解cosmwasm文档。这假设你理解了理论,只想开始编码。

从模板创建新仓库

假设你已经安装了最新的Rust和Cargo(通过rustup),然后以下命令将为你创建一个新的仓库以开始编写合约

安装cargo-generate和cargo-run-script。除非你已经这样做过,否则现在运行这条命令

cargo install cargo-generate --features vendored-openssl
cargo install cargo-run-script

现在,使用它来创建你的新合约。转到你想要放置它的文件夹,并运行

最新版本

cargo generate --git https://github.com/CosmWasm/cw-template.git --name PROJECT_NAME

用于克隆最小代码仓库

cargo generate --git https://github.com/CosmWasm/cw-template.git --name PROJECT_NAME -d minimal=true

旧版本

使用版本作为分支标志

cargo generate --git https://github.com/CosmWasm/cw-template.git --branch <version> --name PROJECT_NAME

示例

cargo generate --git https://github.com/CosmWasm/cw-template.git --branch 0.16 --name PROJECT_NAME

你现在将有一个名为PROJECT_NAME的新文件夹(我希望你已经将其更改为其他名称),其中包含一个简单的可工作合约和构建系统,你可以自定义它。

创建仓库

生成后,你将有一个初始化的本地git仓库,但没有提交,也没有远程仓库。转到服务器(例如github)并创建一个新的上游仓库(如下面的YOUR-GIT-URL)。然后运行以下命令

# this is needed to create a valid Cargo.lock file (see below)
cargo check
git branch -M main
git add .
git commit -m 'Initial Commit'
git remote add origin YOUR-GIT-URL
git push -u origin main

持续集成支持

在生成的项目中,我们提供了GitHub ActionsCircle CI的模板配置,因此你可以立即开始使用持续集成。

请注意,CI在执行所有cargo命令时使用--locked,以确保它使用与您本地相同的版本。这也意味着您必须有一个最新的Cargo.lock文件,该文件不是自动生成的。第一次设置项目(或添加任何依赖后),您应确保Cargo.lock文件已更新,以便CI可以正确测试。这可以通过简单地运行cargo checkcargo unit-test来完成。

使用您的项目

一旦您拥有自定义仓库,您应该检出开发以了解如何运行测试和开发代码。或者通过在线教程来更好地了解如何开发。

发布包含有关如何将合约发布到世界的信息,一旦您准备好在运行的区块链上部署它。而导入包含有关引入其他已发布的合约或crate的信息。

请将此README文件替换为有关您特定项目的信息。您可以将Developing.mdPublishing.md文件作为有用的参考,但请在README中设置一些适当的描述。

依赖项

~4–6MB
~124K SLoC