Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Elements-Studio/starswap-core
The swap project on Starcoin such as Uniswap a Sushiswap
https://github.com/Elements-Studio/starswap-core
Last synced: 3 months ago
JSON representation
The swap project on Starcoin such as Uniswap a Sushiswap
- Host: GitHub
- URL: https://github.com/Elements-Studio/starswap-core
- Owner: Elements-Studio
- License: apache-2.0
- Created: 2021-12-16T02:33:57.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-14T09:13:10.000Z (11 months ago)
- Last Synced: 2024-08-01T02:26:06.811Z (6 months ago)
- Language: Move
- Size: 1.17 MB
- Stars: 43
- Watchers: 3
- Forks: 17
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-move - Starswap - A Uniswap-style DEX. Deployed on Starcoin. (Code / DeFi)
- awesome-move - Starswap - A Uniswap-style DEX. Deployed on Starcoin. (Code / DeFi)
- awesome-move - Starswap - A Uniswap-style DEX. Deployed on Starcoin. (Code / DeFi)
README
# Starswap-core
Starswap is a general purpose DEX on Starcoin.
## Move Package Manager
### Compile Contract
```commandline
mpm package build
```
### Run Integration Tests
```commandline
mpm integration-test
```
### Run Unit Tests
```commandline
mpm package 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 starswap-core:
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.