Skip to content

Latest commit

 

History

History
85 lines (63 loc) · 3.42 KB

README.md

File metadata and controls

85 lines (63 loc) · 3.42 KB
Raw

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:

cd test
./build.sh

Run the tests after the library has been built successfuly:

cargo test

Repository Structure

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

  • 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.
  • Non-fungible token - A simple library that implements the ERC721 standard
  • Vote token - A snapshotting token that allows for historical balance look ups based on block number. This is good for a governance use case.
  • Wrapper Token - A ledger based token wrapper for native assets. Good if you want to give snapshotting functionality to a native asset.
  • 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

  • Sender - helper to get the msg.sender or revert
  • 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].