Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BlockchainCap/swaymigo
A library for common smart contract patterns in Sway on the FuelVM.
https://github.com/BlockchainCap/swaymigo
blockchain fuel fuelvm rust sway
Last synced: 3 months ago
JSON representation
A library for common smart contract patterns in Sway on the FuelVM.
- Host: GitHub
- URL: https://github.com/BlockchainCap/swaymigo
- Owner: BlockchainCap
- Created: 2022-05-27T18:27:18.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-04-13T17:04:09.000Z (about 1 year ago)
- Last Synced: 2024-01-22T01:10:23.037Z (5 months ago)
- Topics: blockchain, fuel, fuelvm, rust, sway
- Language: Rust
- Homepage:
- Size: 565 KB
- Stars: 29
- Watchers: 2
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Lists
- awesome-sway - Swaymigo - A library for common smart contract patterns in Sway on the FuelVM (Libraries)
README
# Swaymigo
Some common building blocks for Sway smart contracts in the FuelVM. While the fuel team maintains the sway standard library, there are some use cases that they have not implemented and may never implement. This library give the opportunity for the community to build more experimental and custom building blocks and still have the ability to share them across the ecosystem.
## Run the swaymigo test suite
Build the full library with the script under `test/`. Run:
``` sh
cd test
./build.sh
```
Run the tests after the library has been built successfuly:
``` sh
cargo test
```
## Repository Structure
``` bash
lib
└── src
├── auth
│ ├── get_sender.sw
│ └── get_zero_address.sw
├── auth.sw
├── lib.sw
├── token
│ ├── ledger_fungible_token.sw
│ ├── non_fungible_token.sw
│ ├── strict_token.sw
│ ├── vault.sw
│ ├── vote_token.sw
│ └── wrapped_asset.sw
├── token.sw
├── utils
│ ├── merkle_proof.sw
│ └── strings.sw
└── utils.sw
test
├── build.sh <-- the script to build all the test projects
└── test_projects
--> a bunch of example projects that use the swaymigo library
```
## Currently available
### Tokens
- [x] Fungible Token - A ledger based erc20 style token implementation. This does not take advantage of the FuelVM internal asset management system. This might be useful for scenario where the ledger state is an important part of the wrapper contract's implementation. For example, a vote token that needs the ability to lookup historical snapshots of the ledger state for each voter within the contract.
- [x] Non-fungible token - A simple library that implements the ERC721 standard
- [x] Vote token - A snapshotting token that allows for historical balance look ups based on block number. This is good for a governance use case.
- [x] Wrapper Token - A ledger based token wrapper for native assets. Good if you want to give snapshotting functionality to a native asset.
- [x] Vault token - Token that follows ERC4626 vault standard.
### Utils
- [ ] Merkle Proof verifier - not yet implemented because of limitations with dynamic collections in contract ABIs
- [ ] Strings - Not yet implemented. helpers for string manipulation
## Auth
- [x] Sender - helper to get the msg.sender or revert
- [x] Null Address - Constant getter for 0 address.
- [ ] Ownership - not yet implemented. Role based protection on contract functions.
## Known Issues
Sway is nascent. There are missing features and some lack of cleanliness. For now this contracts work around these issues to the best of our ability. Expect the contracts to evolve over time as the language itself evolves.
Workarounds/hacks include:
- Manual storage manipulation in libraries because `storage` keyword and `StorageMap` are not yet supported in libraries
- FuelVM native asset system not being utilized in fungible tokens.
- Delegation is not handled completely in vote token
- Test coverage is pretty weak
## Contribution Guide
`// TODO`
## Disclaimer
The current iteration of contracts written here are un-audited and are presented for demonstration purposes only. These contracts are not considered production ready. If you or your team is looking to build a Fuel application using the swaymigo library, reach out to [email protected].