Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nervosnetwork/capsule
Capsule is an out-of-box development framework for creating smart contract on Nervos' CKB.
https://github.com/nervosnetwork/capsule
Last synced: 16 days ago
JSON representation
Capsule is an out-of-box development framework for creating smart contract on Nervos' CKB.
- Host: GitHub
- URL: https://github.com/nervosnetwork/capsule
- Owner: nervosnetwork
- License: mit
- Created: 2020-04-05T05:59:25.000Z (about 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-12T10:41:57.000Z (3 months ago)
- Last Synced: 2024-04-14T06:47:35.830Z (3 months ago)
- Language: Rust
- Homepage:
- Size: 1.63 MB
- Stars: 56
- Watchers: 10
- Forks: 32
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Lists
- awesome-nervos-ckb - Capsule: Framework for Developing CKB Contracts in Rust
README
# Capsule
![Github Actions][GH-action-badge] [![Rust crate][rust-crate-badge]](https://crates.io/crates/ckb-capsule)
[GH-action-badge]: https://img.shields.io/github/actions/workflow/status/nervosnetwork/capsule/rust.yml?branch=develop&style=flat
[rust-crate-badge]: https://img.shields.io/crates/v/ckb-capsule?style=flat
**Capsule is an out-of-box development framework for creating smart contract on Nervos' CKB.**
Capsule consists of:
- Capsule CLI - Scaffolding tool.
- [CKB-testtool](https://github.com/nervosnetwork/capsule/tree/develop/crates/testtool) - CKB scripts testing framework.
CKB supports several programming languages for writing scripts, and the language supporting libraries are maintained in the following repositories:
- [ckb-std](https://github.com/nervosnetwork/ckb-std) - Rust
- [ckb-c-stdlib](https://github.com/nervosnetwork/ckb-c-stdlib) - C
- [ckb-lua](https://github.com/nervosnetwork/ckb-lua) - Lua
## Installation
### Supported Environments
- Linux
- macOS
- Windows (WSL2)
### Prerequisites
The following must be installed and available to use Capsule.
- cargo and rust - Capsule uses `cargo` to generate Rust contracts and run tests. https://www.rust-lang.org/tools/install.
- docker - Capsule uses `docker` container to reproducible build contracts. It's also used by cross. https://docs.docker.com/get-docker/
- cross. Capsule uses `cross` to build rust contracts. Install with
```command
$ cargo install cross --git https://github.com/cross-rs/cross --rev=6982b6c
```
Note: All commands must be accessible in the `PATH` in order for them to be used by Capsule.
Note: The current user must have permission to manage Docker instances. [How to manage Docker as a non-root user.](https://docs.docker.com/engine/install/linux-postinstall/)
### Install binary
[Download the latest release](https://github.com/nervosnetwork/capsule/releases/latest)
### Cargo install
Install the latest version
``` sh
cargo install ckb-capsule
```
Install the develop branch
``` sh
cargo install ckb-capsule --git https://github.com/nervosnetwork/capsule.git --branch develop
```
## Usage
``` sh
capsule help
```
### Quick Start
``` sh
# check environment
capsule check
# create project
capsule new my-demo
cd my-demo
capsule build
capsule test
```
### Project Layout
* `capsule.toml` - Capsule manifest file.
* `contracts` - Contracts directory.
* `tests` - Contracts tests.
* `build` - Contracts binaries.
## Documentation
[Capsule Wiki on GitHub](https://github.com/nervosnetwork/capsule/wiki)
### Upgrading to Capsule 0.10
[Upgrade an existing project to capsule 0.10](https://github.com/nervosnetwork/capsule/wiki/Upgrade-an-existing-project-to-capsule-0.10)
## LICENSE
[MIT](https://github.com/nervosnetwork/capsule/blob/master/LICENSE)