1 个不稳定版本
0.1.0 | 2023年6月16日 |
---|
#57 在 #atom
57KB
1K SLoC
CosmWasm 入门包
这是一个用于在所有启用它的链上运行智能合约的 Rust 模板。要更好地了解框架,请阅读 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 Actions 和 Circle CI 的模板配置,因此您可以立即开始使用持续集成。
需要注意的是,CI(持续集成)使用cargo
命令时都会加上--locked
参数,以确保它使用与你本地完全相同的版本。这也意味着你必须有一个最新的Cargo.lock
文件,这个文件不是自动生成的。当你第一次设置项目(或者在添加任何依赖后),你应该确保Cargo.lock
文件已更新,这样CI才能正确测试。这可以通过简单地运行cargo check
或cargo unit-test
来实现。
使用你的项目
一旦你有了自定义的仓库,你应该检出Developing以了解更多关于如何运行测试和开发代码的信息。或者通过在线教程来更好地了解开发过程。
Publishing包含有关如何将合约发布到世界的有用信息,一旦你准备好在运行的区块链上部署它。而Importing包含有关拉取已发布合约或crate的信息。
请用你特定项目的信息替换这个README文件。你可以保留Developing.md
和Publishing.md
文件作为有用的参考,但请在README中设置一些适当的描述。
依赖关系
~4–6MB
~126K SLoC