1 个不稳定版本
0.1.0 | 2023年6月8日 |
---|
#78 在 #git-branch
23KB
275 行
CosmWasm 启动包
这是一个在所有启用它的链上的 Cosmos SDK 模块中运行 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 会使用带有 --locked
选项的 cargo
命令来确保它使用与您本地完全相同的版本。这也意味着您必须有一个最新的 Cargo.lock
文件,该文件不是自动生成的。在首次设置项目(或添加任何依赖后),您应该确保 Cargo.lock
文件已更新,以便 CI 可以正确地进行测试。这可以通过简单地运行 cargo check
或 cargo unit-test
来完成。
使用您的项目
一旦您有了自定义仓库,您应该检出 Developing 以了解如何运行测试和开发代码。或者通过 在线教程 来更好地了解开发过程。
发布 包含有关如何将合约发布到世界的有用信息,一旦您准备好在运行的区块链上部署它。而 导入 包含有关拉取已发布的其他合约或crate的信息。
请用您具体项目的相关信息替换此 README 文件。您可以保留 Developing.md
和 Publishing.md
文件作为有用的参考,但请在 README 中设置一些适当的描述。
依赖项
~4.5–6MB
~137K SLoC