InstrumentalFi · fgregoribattista · Jan 17, 2024 · Jan 17, 2024 · Jan 18, 2024 · Jan 19, 2024
diff --git a/.prettierrc b/.prettierrc
@@ -1,6 +1,9 @@
 {
   "printWidth": 80,
   "proseWrap": "always",
+  "singleQuote": true,
+  "semi": true,
+  "trailingComma": "all",
   "overrides": [
     {
       "files": "*.yml",
@@ -10,4 +13,4 @@
       }
     }
   ]
-}
+}
diff --git a/README.md b/README.md
@@ -5,42 +5,61 @@
 [![Coverage](https://github.com/InstrumentalFi/instrumental-contracts/actions/workflows/coverage.yml/badge.svg)](https://github.com/InstrumentalFi/instrumental-contracts/actions/workflows/coverage.yml)
 [![codecov](https://codecov.io/github/InstrumentalFi/instrumental-contracts/branch/main/graph/badge.svg?token=dH6ikLs46M)](https://codecov.io/github/InstrumentalFi/instrumental-contracts/
 
-This repository contains the source code for the Pablo Vault and Fee Distribution Contracts.
+This repository contains the source code for the Pablo Vault and Fee
+Distribution Contracts.
 
 ## Behaviour
 
-This section elaborates on the functionalities and interactions of CosmWasm contracts used for staking and fee distribution within the Cosmos network.
+This section elaborates on the functionalities and interactions of CosmWasm
+contracts used for staking and fee distribution within the Cosmos network.
 
 ### 1. Distributor Contract
+
 - **Functionality**: Receives and allocates tokens based on predefined rules.
-- **Features**: 
-  - Supports various Cosmos denominations (denoms), accounts, and percentage-based distributions.
-  - Enables the transfer of tokens to multiple contracts or addresses, ensuring versatile distribution.
-  - Suitable for various applications including staking and the Osmosis adapter pool (note: no integration with the pool).
+- **Features**:
+  - Supports various Cosmos denominations (denoms), accounts, and
+    percentage-based distributions.
+  - Enables the transfer of tokens to multiple contracts or addresses, ensuring
+    versatile distribution.
+  - Suitable for various applications including staking and the Osmosis adapter
+    pool (note: no integration with the pool).
 
 ### 2. Fee Collector Contract
-- **Functionality**: Serves as a recipient for tokens from the Distributor contract, acting as a secure storage.
-- **Characteristics**: 
+
+- **Functionality**: Serves as a recipient for tokens from the Distributor
+  contract, acting as a secure storage.
+- **Characteristics**:
   - Receives a specific portion of tokens from the Distributor contract.
-  - Implements checks and permissions to ensure secure and authorized withdrawals of tokens.
+  - Implements checks and permissions to ensure secure and authorized
+    withdrawals of tokens.
   - Allows the Staking contract to withdraw tokens.
 
 ### 3. Staking Contract
-- **Functionality**: Manages the staking of tokens and facilitates the distribution of rewards.
+
+- **Functionality**: Manages the staking of tokens and facilitates the
+  distribution of rewards.
 - **Features**:
-  - "Tokens per interval" parameter sets a maximum limit for distribution within a specified timeframe.
-  - Distributes the lesser of total tokens in the collector or "time x tokens per interval."
+  - "Tokens per interval" parameter sets a maximum limit for distribution within
+    a specified timeframe.
+  - Distributes the lesser of total tokens in the collector or "time x tokens
+    per interval."
   - Issues stTokens to users in representation of their stake.
-  - stTokens are value-accruing, allowing holders to collect a portion of fees proportional to their stToken holdings.
-- **Distribution**: 
-  - Occurs at predefined intervals with immediate accrual of user shares upon staking.
-  - Adopts a pro-rata distribution model, ensuring fee distribution is proportional to each user’s stToken holdings.
-  - Utilizes a precise user share tracking mechanism akin to other reward systems.
+  - stTokens are value-accruing, allowing holders to collect a portion of fees
+    proportional to their stToken holdings.
+- **Distribution**:
+  - Occurs at predefined intervals with immediate accrual of user shares upon
+    staking.
+  - Adopts a pro-rata distribution model, ensuring fee distribution is
+    proportional to each user’s stToken holdings.
+  - Utilizes a precise user share tracking mechanism akin to other reward
+    systems.
 
 ### Special Considerations
 
-- **Passive Stakers**: Further investigation is necessary to ensure that passive stakers are adequately protected and fairly treated compared to those who stake at the last minute. The case of one chain accumulates and sends transfers peridocally is important.
-
+- **Passive Stakers**: Further investigation is necessary to ensure that passive
+  stakers are adequately protected and fairly treated compared to those who
+  stake at the last minute. The case of one chain accumulates and sends
+  transfers peridocally is important.
 
 ## Environment set up
 
@@ -72,9 +91,12 @@ cargo make rust-optimizer
 wget -P ./artifacts/ https://github.com/CosmWasm/cw-plus/releases/download/v1.1.0/cw20_base.wasm
 ```
 
-This compiles and optimizes all contracts, storing them in `/artifacts` directory along with `checksum.txt` which contains sha256 hashes of each of the `.wasm` files (The script just uses CosmWasm's [rust-optimizer][9]).
+This compiles and optimizes all contracts, storing them in `/artifacts`
+directory along with `checksum.txt` which contains sha256 hashes of each of the
+`.wasm` files (The script just uses CosmWasm's [rust-optimizer][9]).
 
-**Note:** Intel/Amd 64-bit processor is required. While there is experimental ARM support for CosmWasm/rust-optimizer, it's discouraged to use in production.
+**Note:** Intel/Amd 64-bit processor is required. While there is experimental
+ARM support for CosmWasm/rust-optimizer, it's discouraged to use in production.
 
 **NOTE:** on Apple devices an architecture suffix may be required.
 
@@ -88,7 +110,8 @@ See deployment [scripts](./scripts/README.md).
 cargo make --makefile Makefile.toml generate-all-schemas
 ```
 
-Creates JSON schema files for relevant contract calls, queries and query responses (See: [cosmwams-schema][10]).
+Creates JSON schema files for relevant contract calls, queries and query
+responses (See: [cosmwams-schema][10]).
 
 ## Linting
 
@@ -106,7 +129,8 @@ cargo make clippy
 
 ## Testing
 
-Integration tests (task `integration-test` or `test`) use `.wasm` files. They have to be generated with `cargo make build`.
+Integration tests (task `integration-test` or `test`) use `.wasm` files. They
+have to be generated with `cargo make build`.
 
 Run unit tests:
 
@@ -122,17 +146,29 @@ cargo make test
 
 ## Deployments
 
+### Code ids
+
 | chain   | contract    | code id | git commit                               | store tx                                                                                                                                                                         |
-|---------|-------------|---------|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ------- | ----------- | ------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | osmosis | liquidator  | 398     | 27aad556a2c6ac6dbb3a4c078fc523982c2b02dc | [9734C67B5E046BA7AE57D566BFB8FCD7611C842A1D4063CA03D81D4636670C12](https://celatone.osmosis.zone/osmosis-1/txs/9734C67B5E046BA7AE57D566BFB8FCD7611C842A1D4063CA03D81D4636670C12) |
 | neutron | collector   | 603     | 27aad556a2c6ac6dbb3a4c078fc523982c2b02dc | [D2CDBB27AC03976D239852E01ED43CEB5100574AA4192677E64AC1E4248515A8](https://neutron.celat.one/neutron-1/txs/D2CDBB27AC03976D239852E01ED43CEB5100574AA4192677E64AC1E4248515A8)     |
 | neutron | staking     | 604     | 27aad556a2c6ac6dbb3a4c078fc523982c2b02dc | [6DA9CAC7377E8D9EBD567E2372A79D8AAD2354D31871586E6AC2927F4E238B95](https://neutron.celat.one/neutron-1/txs/6DA9CAC7377E8D9EBD567E2372A79D8AAD2354D31871586E6AC2927F4E238B95)     |
 | neutron | distributor | 605     | 27aad556a2c6ac6dbb3a4c078fc523982c2b02dc | [FD8A8BA705181B0FFD351B27AEE8DA405D844F972EF67535C5BD7595205D3051](https://neutron.celat.one/neutron-1/txs/FD8A8BA705181B0FFD351B27AEE8DA405D844F972EF67535C5BD7595205D3051)     |
+| neutron | cw20        | 640     | 27aad556a2c6ac6dbb3a4c078fc523982c2b02dc | [29136027A18998DBE7919040C5D79CA5B6F4D66FBD2D5C877E36C8DFEADA7DF9](https://neutron.celat.one/neutron-1/txs/29136027A18998DBE7919040C5D79CA5B6F4D66FBD2D5C877E36C8DFEADA7DF9)     |
+
+### Instances
 
+| chain   | code id | contract label                       | contract address                                                   | instantiate tx                                                                                                                                                                   |
+| ------- | ------- | ------------------------------------ | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| neutron | 603     | Instrumental Collector Test v0.1.0   | neutron1rj7qq3gdy9vlj2lcetcljfqkl0we4wyy0v39008j46dgkntcy08sd6973f | [CDA0E3D8804F568C6C62A57C50D72DB472C83CCCC97C533BAF098D764134344C](https://neutron.celat.one/neutron-1/txs/CDA0E3D8804F568C6C62A57C50D72DB472C83CCCC97C533BAF098D764134344C)     |
+| neutron | 604     | Instrumental Staking Test v0.1.2     | neutron1r8f6teg5j4w3k8fda5hcfaalhp2ny0g2dje9c5syewwlhe6n8wlsyeh3zy | [FC978990550CEFE2F7C8FE78A58A8BC5418E60D084A15E21A952C4D23308DA77](https://neutron.celat.one/neutron-1/txs/FC978990550CEFE2F7C8FE78A58A8BC5418E60D084A15E21A952C4D23308DA77)     |
+| neutron | 605     | Instrumental Distributor Test v0.1.0 | neutron1q780umshmr5jnwngyulfnyds6tymdwxpxhadl4w2nugk3826n70sd4res8 | [F90C7BC588703759FDC5990114AFB672A4ED5DDC9EC58F2C56ADBFD77C78F356](https://neutron.celat.one/neutron-1/txs/F90C7BC588703759FDC5990114AFB672A4ED5DDC9EC58F2C56ADBFD77C78F356)     |
+| osmosis | 398     | Instrumental Liquidator Test v0.1.0  | osmo1p5q3n023cky2ftmdrwzyxmsmvrvh7twj7lc9vr30xrg6agpksl2qqphkdg    | [067DE48605184A001985041AACAC22266A2190FEAF841A64AA3C48C54EA78E46](https://celatone.osmosis.zone/osmosis-1/txs/067DE48605184A001985041AACAC22266A2190FEAF841A64AA3C48C54EA78E46) |
 
 ## License
 
-Contents of this repository are open source under [GNU General Public License v3](./LICENSE) or later.
+Contents of this repository are open source under
+[GNU General Public License v3](./LICENSE) or later.
 
 [4]: https://rustup.rs/
 [5]: https://github.com/sagiegurari/cargo-make