Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/starcoinorg/starcoin-framework
The Starcoin Move framework
https://github.com/starcoinorg/starcoin-framework
Last synced: about 14 hours ago
JSON representation
The Starcoin Move framework
- Host: GitHub
- URL: https://github.com/starcoinorg/starcoin-framework
- Owner: starcoinorg
- License: apache-2.0
- Created: 2022-02-25T11:13:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-20T08:00:47.000Z (19 days ago)
- Last Synced: 2024-10-27T08:38:52.990Z (12 days ago)
- Language: Move
- Size: 6.5 MB
- Stars: 49
- Watchers: 17
- Forks: 27
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-move - Starcoin Framework
- awesome-move - Starcoin Framework
- awesome-move - Starcoin Framework
README
# Starcoin Move framework
## Network Deploy status
- halley: latest
- proxima: v11
- barnard: v11
- main: v11
## Documents
- [latest](./build/StarcoinFramework/docs)
- [v11](./release/v11/docs)
## Usage
Add `address` and `dependency` to the project's Move.toml
```
[addresses]
StarcoinFramework = "0x1"
[dependencies]
StarcoinFramework = {git = "https://github.com/starcoinorg/starcoin-framework.git", rev="cf1deda180af40a8b3e26c0c7b548c4c290cd7e7"}
```
* v11 git version: cf1deda180af40a8b3e26c0c7b548c4c290cd7e7
## Build and Test
Setup dev environment:
```bash
bash scripts/dev_setup.sh -t -y
```
Build:
```shell
mpm package build
```
Run unit test:
```shell
mpm package test
```
Run move prove
```shell
mpm package prove
```
Run integration test:
```shell
mpm integration-test
```
## Contributing
First off, thanks for taking the time to contribute! Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly appreciated**.
Contributions in the following are welcome:
1. Report a bug.
2. Submit a feature request.
3. Implement feature or fix bug.
### How to add new module to starcoin-framework:
1. Add New Move module to `sources` dir, such as `MyModule.move`.
2. Write Move code and add unit test in the module file.
3. Add an integration test to [integration-tests](./integration-tests) dir, such as: `test_my_module.move`.
4. Run the integration test `mpm integration-test test_my_module.move `.
5. Run script `./script/build.sh` for build and generate documents.
6. Commit the changes and create a pull request.
If you are not sure that the module belongs to starcoin-framework, please submit it to [move-funs](https://github.com/movefuns/movefuns) first.
You can view our [Code of Conduct](./CODE_OF_CONDUCT.md).