@lidofinance/lsv-cli 1.0.0-alpha.15 → 1.0.0-alpha.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -152,25 +152,42 @@ lsv-cli hub -h
152
152
 
153
153
  #### API
154
154
 
155
- | Command | Description |
156
- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
157
- | constants | get vault hub constants |
158
- | add-codehash \<codehash> | add vault proxy codehash to allowed list |
159
- | v-count | get connected vaults number |
160
- | vi \<index> | get vault and vault socket by index |
161
- | va \<address> | get vault socket by address |
162
- | v-connect \<address> \<shareLimit> \<reserveRatio> \<reserveRatioThreshold> \<treasuryFeeBP> | connects a vault to the hub (vault master role needed) |
163
- | v-force-rebalance \<address> | force rebalance of the vault to have sufficient reserve ratio |
164
- | v-role-admin \<role> | returns the admin role that controls role |
165
- | v-role-member \<role> \<index> | returns one of the accounts that have role |
166
- | v-role-member-count \<role> | returns the number of accounts that have role |
167
- | v-role-has \<role> \<account> | returns true if account has been granted role |
168
- | v-update-share-limit \<address> \<shareLimit> | updates share limit for the vault |
169
- | v-disconnect \<address> | force disconnects a vault from the hub |
170
- | v-owner-disconnect \<address> | disconnects a vault from the hub, msg.sender should be vault's owner |
171
- | v-bbv-mint \<address> \<recipient> \<amountOfShares> | mint StETH shares backed by vault external balance to the receiver address |
172
- | v-bbv-burn \<address> \<amountOfShares> | burn steth shares from the balance of the VaultHub contract |
173
- | v-bbv-transfer \<address> \<amountOfShares> | separate burn function for EOA vault owners; requires vaultHub to be approved to transfer stETH |
155
+ | Command | Description |
156
+ | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
157
+ | constants | get vault hub constants |
158
+ | dar | get default admin role |
159
+ | lido | get lido address |
160
+ | ll | get lido locator address |
161
+ | pi | get pause infinitely |
162
+ | pr | get pause role |
163
+ | rr | get resume role |
164
+ | vm-role | get vault master role |
165
+ | vr-role | get vault registry role |
166
+ | calc-t-fee \<r-val> \<socket> \<pre-t-shares> \<pre-t-pe> \<post-i-shares> \<post-i-ether> \<s-mlc-fees> | get calculated vault treasury fees |
167
+ | calc-v-rebase \<v-vals> \<pre-t-shares> \<pre-t-pe> \<post-i-shares> \<post-i-ether> \<s-mlc-fees> | get calculated vaults rebase |
168
+ | getResumeSinceTimestamp | Calls the read-only function "getResumeSinceTimestamp" on the contract. |
169
+ | getRoleAdmin \<role> | Calls the read-only function "getRoleAdmin" on the contract. |
170
+ | getRoleMember \<role> \<index> | Calls the read-only function "getRoleMember" on the contract. |
171
+ | getRoleMemberCount \<role> | Calls the read-only function "getRoleMemberCount" on the contract. |
172
+ | getRoleMembers \<role> | Calls the read-only function "getRoleMembers" on the contract. |
173
+ | hasRole \<role> \<account> | Calls the read-only function "hasRole" on the contract. |
174
+ | is-paused | get is paused boolean |
175
+ | is-v-h \<\_vault> | get is vault healthy boolean |
176
+ | supportsInterface \<interfaceId> | Calls the read-only function "supportsInterface" on the contract. |
177
+ | vault \<\_index> | Calls the read-only function "vault" on the contract. |
178
+ | vaultSocket \<\_index> | Calls the read-only function "vaultSocket" on the contract. |
179
+ | vaultSocket_vault \<\_vault> | Calls the read-only function "vaultSocket" on the contract. |
180
+ | v-count | get connected vaults count |
181
+ | vi \<index> | get vault and vault socket by index |
182
+ | add-codehash \<codehash> | add vault proxy codehash to allowed list |
183
+ | v-connect \<address> \<shareLimit> \<reserveRatio> \<reserveRatioThreshold> \<treasuryFeeBP> | connects a vault to the hub (vault master role needed) |
184
+ | v-update-share-limit \<address> \<shareLimit> | updates share limit for the vault |
185
+ | v-disconnect \<address> | force disconnects a vault from the hub |
186
+ | v-owner-disconnect \<address> | disconnects a vault from the hub, msg.sender should be vault's owner |
187
+ | v-mint \<address> \<recipient> \<amountOfShares> | mint StETH shares backed by vault external balance to the receiver address |
188
+ | v-burn \<address> \<amountOfShares> | burn steth shares from the balance of the VaultHub contract |
189
+ | v-transfer-and-burn \<address> \<amountOfShares> | separate burn function for EOA vault owners; requires vaultHub to be approved to transfer stETH |
190
+ | v-force-rebalance \<address> | force rebalance of the vault to have sufficient reserve ratio |
174
191
 
175
192
  ### VaultFactory
176
193