white-whale-defi-platform / white-whale-core Goto Github PK

If you want to report a security issue, please follow our security policy: https://github.com/White-Whale-Defi-Platform/migaloo-core/blob/main/SECURITY.md

Improvement description

Rust 1.64.0 has some juicy features we can use, for instance to handle dependencies from the workspace.

Read more at https://blog.rust-lang.org/2022/09/22/Rust-1.64.0.html

Additional context

Add any other context here, code snippets, json responses, screenshots and so on.

https://www.youtube.com/watch?v=CO5Xo76CVCk

The current migaloo core guides are not aligned with the ones used on the pool network repo as they are forked from terraswap. Fix that.

This is similar to what the pool factory has, a message that can trigger vault migrations.

[x] Make it recover from errors
[x] Make it possible to deploy specific contract
[x] Make it possible to create pools and vaults
[ ] Possible rewrite in another language? go, python

Use case

Create script to check artifacts size to make sure they can be uploaded to the blockchain, potentially integrate it with the github actions.

Proposal

Use case

Pools are added to the pool directory once they are created by the factory, but there is no way to delete them. Contracts will live forever on the blockchain, but if for some reason a pool is broken in any way, for example if they are instantiated wrong (wrong assets) it could be handy to be able to remove it from the directory to keep things clean.

Proposal

Create and implement ExecuteMsg::RemovePair { pair_address: String } on the terraswap_factory contract.

The fee collector contract has a state item called FACTORIES, which stores the factories in the Liquidity Hub. It was used to query stuff when collecting fees, but this is no longer the case. It can/should be removed, given that it's not used by the frontend.

Seems like tarpaulin action is broken or something, the action specifies to output an html file and yet the logs say a json file is generated.

Then the codecov action can't find the file in the right path.

Use case

Proposal

Make the token_code_id and vault_code_id able to modify when updating the config

Improvement description

Improve CI/CD runs time with caching additions to avoid redownloading deps all the time

Additional context

Right now we have some working CI/CD system which performs all sorts of checks against out contracts such as tests, coverage, schema updates as well as some linting variants. The bulk of the run time right now is in installing the dependancies for these builds, namely dylint as well as others. We should be able to, with a known steady version of Rust and dylint leverage the cache system to really bring these build times down.

For the version 1.63. clippy::derive_partial_eq_without_eq https://rust-lang.github.io/rust-clippy/rust-1.63.0/index.html#derive_partial_eq_without_eq is not passing the clippy command

cargo clippy -- -D warnings

error: you are deriving `PartialEq` and can implement `Eq`
 --> packages/white-whale/src/fee.rs:6:48
  |
6 | #[derive(Deserialize, Serialize, Clone, Debug, PartialEq, JsonSchema)]
  |                                                ^^^^^^^^^ help: consider deriving `Eq` as well: `PartialEq, Eq`
  |
  = note: `-D clippy::derive-partial-eq-without-eq` implied by `-D warnings`
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#derive_partial_eq_without_eq

error: could not compile `white-whale` due to previous error

Implement the ibc token matcher manually to decrease the wasm file size, the regex crate even with selected features was doubling the optimized wasm file size.

The current factory creates pairs and lp tokens with generic names, not possible to distinguish which is which easily just by looking at the contract label or token symbol.

https://crates.io/crates/bigint -> deprecated, replaced by -> https://crates.io/crates/uint

The following query is not working:

{
  "collect_fees":{
    "collect_fees_for":{
      "factory":{
        "factory_addr":"address",
        "factory_type":{
          "vault":{}
        }
      }
    }
  }
}

Error: Query failed with (18): failed to execute message; message index: 0: Generic error: Querier contract error: codespace: wasm, code: 9: execute wasm contract failed: invalid request

P.S.: You can still collect the fees for a vault by using CollectFeesFor::Contracts and providing the vault.

There are few items that need to be revised:

[ ] Documentation
[ ] include interim versions and not only releases
[ ] The release notes MUST identify every publicly known run-time vulnerability fixed in this release that already had a CVE assignment or similar when the release was created
[ ] Test policy
[ ] be maximally strict with warnings in the software produced by the project, where practical.
[ ] Use basic good cryptographic practices
[ ] Static/Dynamic code analysis

To improve our CI workflow.

If you want to report a security issue, please follow our security policy: https://github.com/White-Whale-Defi-Platform/migaloo-core/blob/main/SECURITY.md

Improvement description

Described during a meeting regarding deployment to certain networks
Currently we have two fees implemented, a Protocol Fee and a Swap Fee. This proposal describes adding a third fee structure to the current fee system called a Burn Fee. This Fee is optional per deployment meaning unless specified there is no Burn Fee for a network, only the original two fees. When specified, this Burn Fee will deduct N bps share as a fee similarly to the 2 earlier mentioned Fees but instead of being collected will be burned that is to say specific calling the Burn function on a given token or sending to a designated burn address.

Additional context

Add any other context here, code snippets, json responses, screenshots and so on.

The pool router enforces a spread limit for swap operations, which can potentially revert valid multi-hops swaps if this limit is reached.

Use case

Proposal

Make structs such as Config snake_case in the Vault Network so that you can query {"config": {}} instead of {"Config": {}}

The vault uses the following ticker symbol:

    let lp_symbol = format!(
        "uLP-{}",
        msg.asset_info
            .clone()
            .get_label(&deps.as_ref())?
            .chars()
            .take(8)
            .collect::<String>()
    );

which in case of an IBC token would like like uLP-ibc/1234...5678, which contains invalid characters for a token symbol. The easiest fix would be to make the token symbol generic as we did for the pools, while keeping the contract label custom.

Error when trying to create a vault with an IBC token:
Ticker symbol is not in expected format [a-zA-Z\-]{3,12}: instantiate wasm contract failed: invalid request.

The build_schemas.sh script generates additional schemas in folders where they are not needed on the fee_collector contract.

Steps to Reproduce

1. Execute scripts/build_schemas.sh

Expected results:
schema files being generated under /contract_name/schema/

Actual results:
schema files generated under
/contract_name/schema/schema
/contract_name/examples/schema
/contract_name/src/schema

Additional context

Add any other context about the problem here, code snippets, json responses and so on.

Similar to how dao dao does it.

Look at DA0-DA0/dao-contracts#475 and
https://github.com/DA0-DA0/dao-contracts/blob/main/.github/workflows/integration_tests.yml for reference

The Vault contains the query QueryMsg::Share { amount }, which returns the amount of underlying asset worth X amount of shares, i.e. LP tokens.

This can be beneficial to implement on the pools as well, to be adopted by UIs.

#23 (comment)

Add a template for general code improvements.

There are two important queries missing on the fee collector, namely "collected fees" i.e. fees sitting on the fee collector, those that have been collected already. Then another query to see the fees that have been accrued (but not collected) by the vaults/pools. The latter will probably need pagination.

Go through migaloo contracts and study if the iterator feature is needed for all the contracts.

At the moment, it is being imported everywhere as it is being inherited from the workspace. Removing it from where it isn't needed would decrease the wasm size.

Use case

Vaults are added to the vault directory once they are created by the factory, but there is no way to delete them. Contracts will live forever on the blockchain, but if for some reason a vault is broken in any way, for example if they are instantiated wrong (wrong assets) it could be handy to be able to remove it from the directory to keep things clean.

Proposal

Create and implement ExecuteMsg::RemoveVault { vault_address: String } on the vault_factory contract.

Every message on the vault factory can only be triggered by the owner. As of now we have the owner validation inside of each function triggered by the different ExecuteMsgs. We could move that validation before the match in the execute entry point to optimize the code and don't repeat ourselves.