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

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.
Files changed (143) hide show
  1. package/README.md +244 -120
  2. package/dist/abi/CLProofVerifier.js +279 -0
  3. package/dist/abi/CLProofVerifier.js.map +1 -0
  4. package/dist/abi/Dashboard.js +1060 -942
  5. package/dist/abi/Dashboard.js.map +1 -1
  6. package/dist/abi/Delegation.js +1260 -1129
  7. package/dist/abi/Delegation.js.map +1 -1
  8. package/dist/abi/LidoLocator.js +311 -270
  9. package/dist/abi/LidoLocator.js.map +1 -1
  10. package/dist/abi/PredepositGuarantee.js +1733 -0
  11. package/dist/abi/PredepositGuarantee.js.map +1 -0
  12. package/dist/abi/StakingVault.js +723 -528
  13. package/dist/abi/StakingVault.js.map +1 -1
  14. package/dist/abi/VaultFactory.js +164 -144
  15. package/dist/abi/VaultFactory.js.map +1 -1
  16. package/dist/abi/VaultHubViewer.js +297 -0
  17. package/dist/abi/VaultHubViewer.js.map +1 -0
  18. package/dist/abi/index.js +12 -9
  19. package/dist/abi/index.js.map +1 -1
  20. package/dist/configs/constants.js +2 -2
  21. package/dist/configs/constants.js.map +1 -1
  22. package/dist/contracts/clProofVerifier.js +29 -0
  23. package/dist/contracts/clProofVerifier.js.map +1 -0
  24. package/dist/contracts/dashboard.js.map +1 -1
  25. package/dist/contracts/index.js +12 -9
  26. package/dist/contracts/index.js.map +1 -1
  27. package/dist/contracts/locator.js +2 -2
  28. package/dist/contracts/locator.js.map +1 -1
  29. package/dist/contracts/pdg.js +17 -0
  30. package/dist/contracts/pdg.js.map +1 -0
  31. package/dist/contracts/vault-factory.js +5 -9
  32. package/dist/contracts/vault-factory.js.map +1 -1
  33. package/dist/contracts/vault-hub-viewer.js +14 -0
  34. package/dist/contracts/vault-hub-viewer.js.map +1 -0
  35. package/dist/features/dashboard-delegation.js +4 -1
  36. package/dist/features/dashboard-delegation.js.map +1 -1
  37. package/dist/features/vault-factory.js +6 -10
  38. package/dist/features/vault-factory.js.map +1 -1
  39. package/dist/features/voting.js +6 -14
  40. package/dist/features/voting.js.map +1 -1
  41. package/dist/index.js +6 -3
  42. package/dist/index.js.map +1 -1
  43. package/dist/programs/account.js +3 -1
  44. package/dist/programs/account.js.map +1 -1
  45. package/dist/programs/dashboard/config.js +65 -0
  46. package/dist/programs/dashboard/config.js.map +1 -0
  47. package/dist/programs/dashboard/index.js +4 -0
  48. package/dist/programs/dashboard/index.js.map +1 -0
  49. package/dist/programs/dashboard/main.js +12 -0
  50. package/dist/programs/dashboard/main.js.map +1 -0
  51. package/dist/programs/dashboard/read.js +25 -0
  52. package/dist/programs/dashboard/read.js.map +1 -0
  53. package/dist/programs/{dashboard.js → dashboard/write.js} +78 -136
  54. package/dist/programs/dashboard/write.js.map +1 -0
  55. package/dist/programs/delegation/config.js +33 -0
  56. package/dist/programs/delegation/config.js.map +1 -0
  57. package/dist/programs/delegation/index.js +4 -0
  58. package/dist/programs/delegation/index.js.map +1 -0
  59. package/dist/programs/delegation/main.js +12 -0
  60. package/dist/programs/delegation/main.js.map +1 -0
  61. package/dist/programs/delegation/read.js +98 -0
  62. package/dist/programs/delegation/read.js.map +1 -0
  63. package/dist/programs/delegation/write.js +327 -0
  64. package/dist/programs/delegation/write.js.map +1 -0
  65. package/dist/programs/index.js +7 -4
  66. package/dist/programs/index.js.map +1 -1
  67. package/dist/programs/pdg/config.js +2 -0
  68. package/dist/programs/pdg/config.js.map +1 -0
  69. package/dist/programs/pdg/index.js +4 -0
  70. package/dist/programs/pdg/index.js.map +1 -0
  71. package/dist/programs/pdg/main.js +12 -0
  72. package/dist/programs/pdg/main.js.map +1 -0
  73. package/dist/programs/pdg/read.js +7 -0
  74. package/dist/programs/pdg/read.js.map +1 -0
  75. package/dist/programs/pdg/write.js +64 -0
  76. package/dist/programs/pdg/write.js.map +1 -0
  77. package/dist/programs/pdg-helpers.js +73 -0
  78. package/dist/programs/pdg-helpers.js.map +1 -0
  79. package/dist/programs/vault/config.js +66 -0
  80. package/dist/programs/vault/config.js.map +1 -0
  81. package/dist/programs/vault/index.js +4 -0
  82. package/dist/programs/vault/index.js.map +1 -0
  83. package/dist/programs/vault/main.js +10 -0
  84. package/dist/programs/vault/main.js.map +1 -0
  85. package/dist/programs/vault/read.js +53 -0
  86. package/dist/programs/vault/read.js.map +1 -0
  87. package/dist/programs/vault/write.js +123 -0
  88. package/dist/programs/vault/write.js.map +1 -0
  89. package/dist/programs/vault-factory/config.js +2 -0
  90. package/dist/programs/vault-factory/config.js.map +1 -0
  91. package/dist/programs/vault-factory/index.js +4 -0
  92. package/dist/programs/vault-factory/index.js.map +1 -0
  93. package/dist/programs/vault-factory/main.js +12 -0
  94. package/dist/programs/vault-factory/main.js.map +1 -0
  95. package/dist/programs/vault-factory/read.js +26 -0
  96. package/dist/programs/vault-factory/read.js.map +1 -0
  97. package/dist/programs/{vault-factory.js → vault-factory/write.js} +22 -37
  98. package/dist/programs/vault-factory/write.js.map +1 -0
  99. package/dist/programs/vault-hub-viewer.js +52 -0
  100. package/dist/programs/vault-hub-viewer.js.map +1 -0
  101. package/dist/programs/vault-hub.js +20 -52
  102. package/dist/programs/vault-hub.js.map +1 -1
  103. package/dist/programs/voting.js +11 -33
  104. package/dist/programs/voting.js.map +1 -1
  105. package/dist/utils/contract.js +63 -2
  106. package/dist/utils/contract.js.map +1 -1
  107. package/dist/utils/get-commands.js +11 -0
  108. package/dist/utils/get-commands.js.map +1 -0
  109. package/dist/utils/index.js +5 -0
  110. package/dist/utils/index.js.map +1 -1
  111. package/dist/utils/prompts/default.js +17 -0
  112. package/dist/utils/prompts/default.js.map +1 -0
  113. package/dist/utils/prompts/delegation-dashboard.js +29 -0
  114. package/dist/utils/prompts/delegation-dashboard.js.map +1 -0
  115. package/dist/utils/prompts/index.js +4 -0
  116. package/dist/utils/prompts/index.js.map +1 -0
  117. package/dist/utils/prompts/predeposit-guarantee.js +25 -0
  118. package/dist/utils/prompts/predeposit-guarantee.js.map +1 -0
  119. package/dist/utils/proof/create-proof.js +62 -0
  120. package/dist/utils/proof/create-proof.js.map +1 -0
  121. package/dist/utils/proof/first-validator-gindex.js +26 -0
  122. package/dist/utils/proof/first-validator-gindex.js.map +1 -0
  123. package/dist/utils/proof/index.js +4 -0
  124. package/dist/utils/proof/index.js.map +1 -0
  125. package/dist/utils/proof/merkle-utils.js +131 -0
  126. package/dist/utils/proof/merkle-utils.js.map +1 -0
  127. package/dist/utils/proof/proofs.js +52 -0
  128. package/dist/utils/proof/proofs.js.map +1 -0
  129. package/dist/utils/read-programs-by-abi.js +83 -0
  130. package/dist/utils/read-programs-by-abi.js.map +1 -0
  131. package/dist/utils/spinner/index.js +2 -0
  132. package/dist/utils/spinner/index.js.map +1 -0
  133. package/dist/utils/spinner/spinners.js +16 -0
  134. package/dist/utils/spinner/spinners.js.map +1 -0
  135. package/dist/utils/spinner/spinners.json +119 -0
  136. package/dist/version/index.js +1 -1
  137. package/package.json +11 -4
  138. package/dist/programs/dashboard.js.map +0 -1
  139. package/dist/programs/delegation.js +0 -581
  140. package/dist/programs/delegation.js.map +0 -1
  141. package/dist/programs/vault-factory.js.map +0 -1
  142. package/dist/programs/vault.js +0 -375
  143. package/dist/programs/vault.js.map +0 -1
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
- # Liquid Staking Vault CLI
1
+ # Lido Staking Vault CLI
2
2
 
3
- A command-line interface (CLI) tool for managing liquid staking vaults. Simplify your staking operations with intuitive commands and streamlined workflows.
3
+ A command-line interface (CLI) tool for managing lido staking vaults. Simplify your staking operations with intuitive commands and streamlined workflows.
4
4
 
5
5
  ## Table of Contents
6
6
 
@@ -26,7 +26,7 @@ A command-line interface (CLI) tool for managing liquid staking vaults. Simplify
26
26
 
27
27
  ## Installation
28
28
 
29
- Install the Liquid Staking Vault CLI globally using npm:
29
+ Install the Lido Staking Vault CLI globally using npm:
30
30
 
31
31
  ```bash
32
32
  npm install -g @lidofinance/lsv-cli
@@ -72,6 +72,7 @@ Application supported a few ways to adding or combine different settings
72
72
  "chainId": 1, // or another number of chain id
73
73
  "lidoLocator": "LIDO locator address", // take LIDO locator address in paticular chainId
74
74
  "accounting": "LIDO accountind address" // take LIDO accounting address in paticular chainId
75
+ "clLink": "url" // CL url
75
76
  }
76
77
  ```
77
78
  If you plan to manage contracts the **privateKey** is required property for this type of operations.
@@ -187,9 +188,12 @@ lsv-cli factory -h
187
188
 
188
189
  #### API
189
190
 
190
- | Command | Description |
191
- | -------------------------------------------------------------------- | --------------------- |
192
- | create-vault \[-options] \<managerFee> \<performanceFee> \[quantity] | create vault contract |
191
+ | Command | Description |
192
+ | ------------------------------------------------------------- | --------------------------------------------------------------- |
193
+ | constants | get vault factory constants info |
194
+ | BEACON \<address> | Calls the read-only function "BEACON" on the contract. |
195
+ | DELEGATION_IMPL \<address> | Calls the read-only function "DELEGATION_IMPL" on the contract. |
196
+ | create-vault \<curatorFeeBP> \<nodeOperatorFeeBP> \<quantity> | create vault contract |
193
197
 
194
198
  Note: \[quantity] is optional argument, default 1
195
199
  **[options]**
@@ -226,27 +230,34 @@ lsv-cli vault -h
226
230
 
227
231
  #### API
228
232
 
229
- | Command | Description |
230
- | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- |
231
- | info \<address> | get vault base info |
232
- | l-report \<address> | get latest vault report |
233
- | is-balanced \<address> | returns whether vault is balanced, i.e. its valuation is greater than the locked amount |
234
- | node-operator \<address> | returns the address of the node operator |
235
- | valuation \<address> | get vault valuation |
236
- | unlocked \<address> | get vault unlocked |
237
- | locked \<address> | get vault locked |
238
- | withdrawal-c \<address> | get vault withdrawal credentials |
239
- | fund \<address> \<wei> | fund vault |
240
- | withdraw \<address> \<recipient> \<wei> | withdraw from vault |
241
- | rebalance \<address> \<amount> | rebalance vault |
242
- | no-deposit-beacon \<address> \<numberOfDeposits> \<pubkeys> \<signatures> | deposit to beacon chain |
243
- | no-val-exit \<address> \<validatorPublicKey> | request to exit validator |
244
- | delta \<address> | the net difference between deposits and withdrawals |
245
- | is-paused \<address> | Returns whether deposits are paused by the vault owner |
246
- | bc-resume \<address> | Resumes deposits to beacon chain |
247
- | bc-pause \<address> | Pauses deposits to beacon chain |
248
- | report \<address> \<valuation> \<inOutDelta> \<locked> | Submits a report containing valuation, inOutDelta, and locked amount |
249
- | compute-deposit \<address> \<pubkey> \<withdrawalCredentials> \<signature> \<amount> | Computes the deposit data root for a validator deposit |
233
+ | Command | Description |
234
+ | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
235
+ | deposit-contract \<address> | get vault deposit contract |
236
+ | PUBLIC_KEY_LENGTH \<address> | Calls the read-only function "PUBLIC_KEY_LENGTH" on the contract. |
237
+ | is-paused \<address> | get whether deposits are paused by the vault owner |
238
+ | validator-w-fee \<address> \<numberOfKeys> | get calculated withdrawal fee for a validator |
239
+ | depositor \<address> | Calls the read-only function "depositor" on the contract. |
240
+ | getInitializedVersion \<address> | Calls the read-only function "getInitializedVersion" on the contract. |
241
+ | delta \<address> | get the net difference between deposits and withdrawals |
242
+ | l-report \<address> | get latest vault report |
243
+ | locked \<address> | get vault locked |
244
+ | no \<address> | get vault node operator |
245
+ | owner \<address> | get vault owner |
246
+ | unlocked \<address> | get vault unlocked |
247
+ | valuation \<address> | get vault valuation |
248
+ | vault-hub \<address> | get vault hub |
249
+ | version \<address> | get vault version |
250
+ | wc \<address> | get vault withdrawal credentials |
251
+ | info \<address> | get vault base info |
252
+ | fund | fund vault |
253
+ | withdraw \<address> \<recipient> \<wei> | withdraw from vault |
254
+ | no-deposit-beacon \<address> \<amountOfDeposit> \<pubkey> \<signature> \<depositDataRoot> | deposit to beacon chain |
255
+ | no-val-exit \<address> \<validatorPublicKey> | request to exit validator |
256
+ | bc-resume \<address> | Resumes deposits to beacon chain |
257
+ | bc-pause \<address> | Pauses deposits to beacon chain |
258
+ | report \<address> \<valuation> \<inOutDelta> \<locked> | Submits a report containing valuation, inOutDelta, and locked amount |
259
+ | rebalance \<address> \<amount> | Rebalances the vault |
260
+ | trigger-v-w \<address> \<pubkeys> \<amounts> \<refundRecipient> | Trigger validator withdrawal |
250
261
 
251
262
  ### Dashboard
252
263
 
@@ -264,43 +275,75 @@ lsv-cli dashboard -h
264
275
 
265
276
  #### API
266
277
 
267
- | Command | Description |
268
- | ---------------------------------------------------------- | ---------------------------------------------------------------- |
269
- | info \<address> | Get dashboard base info |
270
- | committee \<address> | Voting committee info |
271
- | vault \<address> | Vault info |
272
- | s-limit \<address> | Shares limit |
273
- | s-minted \<address> | Shares minted |
274
- | reserve-ratio \<address> | Vault reserve ratio of the vault |
275
- | t-reserve-ratio \<address> | Threshold reserve ratio of the vault |
276
- | t-fee \<address> | Treasury fee basis points |
277
- | valuation \<address> | Valuation of the vault in ether |
278
- | t-shares \<address> | Total of shares that can be minted on the vault |
279
- | get-shares \<address> \<ether> | Maximum number of shares that can be minted with deposited ether |
280
- | withdrawable-eth \<address> | Amount of ether that can be withdrawn from the staking vault |
281
- | ownership \<address> \<newOwner> | Transfers ownership of the staking vault to a new owner |
282
- | disconnect \<address> | Disconnects the staking vault from the vault hub |
283
- | fund \<address> \<wei> | Funds the staking vault with ether |
284
- | fund-weth \<address> \<wethAmount> | Funds the staking vault with wrapped ether |
285
- | withdraw \<address> \<recipient> \<wei> | Withdraws ether from the staking vault to a recipient |
286
- | withdraw-weth \<address> \<recipient> \<ether> | Withdraws stETH tokens from the staking vault to wrapped ether |
287
- | exit \<address> \<validatorPubKey> | Requests the exit of a validator from the staking vault |
288
- | mint-shares \<address> \<recipient> \<amountOfShares> | Mints stETH tokens backed by the vault to a recipient |
289
- | mint-steth \<address> \<recipient> \<amountOfShares> | Mints stETH tokens backed by the vault to a recipient |
290
- | mint-wsteth \<address> \<recipient> \<tokens> | Mints wstETH tokens backed by the vault to a recipient |
291
- | burn-shares \<address> \<amountOfShares> | Burns stETH shares from sender (requires approved stETH) |
292
- | burn-steth \<address> \<amountOfShares> | Burns stETH shares from sender (requires approved stETH) |
293
- | burn-wsteth \<address> \<tokens> | Burn wstETH tokens from sender backed by vault |
294
- | burn-shares-permit \<address> \<tokens> \<permitJSON> | Burns stETH tokens using permit (value in stETH) |
295
- | burn-steth-permit \<address> \<tokens> \<permitJSON> | Burns stETH tokens using permit |
296
- | burn-wsteth-permit \<address> \<tokens> \<permitJSON> | Burn wstETH tokens using EIP-2612 Permit |
297
- | rebalance \<address> \<ether> | Rebalance the vault by transferring ether |
298
- | recover-erc20 \<address> \<token> \<recipient> \<amount> | Recovers ERC20 tokens or ether from dashboard contract |
299
- | recover-erc721 \<address> \<token> \<tokenId> \<recipient> | Transfers ERC721 NFT by token ID |
300
- | deposit-pause \<address> | Pauses beacon chain deposits on staking vault |
301
- | deposit-resume \<address> | Mass-grants multiple roles to multiple accounts |
302
- | role-grant \<address> \<roleAssignmentJSON> | Mass-revokes multiple roles from multiple accounts |
303
- | role-revoke \<address> \<roleAssignmentJSON> | Resumes beacon chain deposits on staking vault |
278
+ | Command | Description |
279
+ | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
280
+ | ASSET_RECOVERY_ROLE \<address> | Calls the read-only function "ASSET_RECOVERY_ROLE" on the contract. |
281
+ | BURN_ROLE \<address> | Calls the read-only function "BURN_ROLE" on the contract. |
282
+ | DEFAULT_ADMIN_ROLE \<address> | Calls the read-only function "DEFAULT_ADMIN_ROLE" on the contract. |
283
+ | ETH \<address> | Calls the read-only function "ETH" on the contract. |
284
+ | FUND_ROLE \<address> | Calls the read-only function "FUND_ROLE" on the contract. |
285
+ | MAX_CONFIRM_EXPIRY \<address> | Calls the read-only function "MAX_CONFIRM_EXPIRY" on the contract. |
286
+ | MINT_ROLE \<address> | Calls the read-only function "MINT_ROLE" on the contract. |
287
+ | MIN_CONFIRM_EXPIRY \<address> | Calls the read-only function "MIN_CONFIRM_EXPIRY" on the contract. |
288
+ | PAUSE_BEACON_CHAIN_DEPOSITS_ROLE \<address> | Calls the read-only function "PAUSE_BEACON_CHAIN_DEPOSITS_ROLE" on the contract. |
289
+ | PDG_WITHDRAWAL_ROLE \<address> | Calls the read-only function "PDG_WITHDRAWAL_ROLE" on the contract. |
290
+ | REBALANCE_ROLE \<address> | Calls the read-only function "REBALANCE_ROLE" on the contract. |
291
+ | REQUEST_VALIDATOR_EXIT_ROLE \<address> | Calls the read-only function "REQUEST_VALIDATOR_EXIT_ROLE" on the contract. |
292
+ | RESUME_BEACON_CHAIN_DEPOSITS_ROLE \<address> | Calls the read-only function "RESUME_BEACON_CHAIN_DEPOSITS_ROLE" on the contract. |
293
+ | STETH \<address> | Calls the read-only function "STETH" on the contract. |
294
+ | TRIGGER_VALIDATOR_WITHDRAWAL_ROLE \<address> | Calls the read-only function "TRIGGER_VALIDATOR_WITHDRAWAL_ROLE" on the contract. |
295
+ | VOLUNTARY_DISCONNECT_ROLE \<address> | Calls the read-only function "VOLUNTARY_DISCONNECT_ROLE" on the contract. |
296
+ | WETH \<address> | Calls the read-only function "WETH" on the contract. |
297
+ | WITHDRAW_ROLE \<address> | Calls the read-only function "WITHDRAW_ROLE" on the contract. |
298
+ | WSTETH \<address> | Calls the read-only function "WSTETH" on the contract. |
299
+ | confirmations \<address> \<callData> \<role> | Calls the read-only function "confirmations" on the contract. |
300
+ | confirmingRoles \<address> | Calls the read-only function "confirmingRoles" on the contract. |
301
+ | getConfirmExpiry \<address> | Calls the read-only function "getConfirmExpiry" on the contract. |
302
+ | getRoleAdmin \<address> \<role> | Calls the read-only function "getRoleAdmin" on the contract. |
303
+ | getRoleMember \<address> \<role> \<index> | Calls the read-only function "getRoleMember" on the contract. |
304
+ | getRoleMemberCount \<address> \<role> | Calls the read-only function "getRoleMemberCount" on the contract. |
305
+ | getRoleMembers \<address> \<role> | Calls the read-only function "getRoleMembers" on the contract. |
306
+ | has-role \<address> \<role> \<account> | get has role by role and account |
307
+ | initialized \<address> | Calls the read-only function "initialized" on the contract. |
308
+ | projected-new-mintable-shares \<address> \<etherToFund> | get projected new mintable shares |
309
+ | r-threshold \<address> | get rebalance threshold in basis points |
310
+ | reserve-ratio \<address> | get reserve ratio in basis points |
311
+ | s-limit \<address> | get share limit |
312
+ | s-minted \<address> | get shares minted |
313
+ | vault \<address> | get staking vault address |
314
+ | supports-interface \<address> \<interfaceId> | get supports interface by id |
315
+ | total-mintable-shares \<address> | get total of shares that can be minted on the vault |
316
+ | t-fee \<address> | get treasury fee in basis points |
317
+ | valuation \<address> | get vault valuation |
318
+ | hub \<address> | get vaultHub address |
319
+ | socket \<address> | get vault socket |
320
+ | w-ether \<address> | get amount of ether that can be withdrawn from the staking vault |
321
+ | info | get dashboard base info |
322
+ | ownership \<address> \<newOwner> | transfers ownership of the staking vault to a new owner |
323
+ | disconnect \<address> | disconnects the staking vault from the vault hub |
324
+ | fund | funds the staking vault with ether |
325
+ | fund-weth \<address> \<wethAmount> | funds the staking vault with wrapped ether |
326
+ | withdraw \<address> \<recipient> \<wei> | withdraws ether from the staking vault to a recipient |
327
+ | withdraw-weth \<address> \<recipient> \<ether> | withdraws stETH tokens from the staking vault to wrapped ether |
328
+ | exit \<address> \<validatorPubKey> | requests the exit of a validator from the staking vault |
329
+ | trigger-validator-withdrawal \<address> \<pubkeys> \<amounts> \<recipient> | triggers the withdrawal of a validator from the staking vault |
330
+ | mint-shares \<address> \<recipient> \<amountOfShares> | mints stETH tokens backed by the vault to a recipient |
331
+ | mint-steth \<address> \<recipient> \<amountOfShares> | mints stETH tokens backed by the vault to a recipient |
332
+ | mint-wsteth \<address> \<recipient> \<tokens> | mints wstETH tokens backed by the vault to a recipient |
333
+ | burn-shares \<address> \<amountOfShares> | Burns stETH shares from the sender backed by the vault. Expects corresponding amount of stETH approved to this contract |
334
+ | burn-steth \<address> \<amountOfShares> | Burns stETH shares from the sender backed by the vault. Expects stETH amount approved to this contract. |
335
+ | burn-wsteth \<address> \<tokens> | burn wstETH tokens from the sender backed by the vault |
336
+ | burn-shares-permit \<address> \<tokens> \<permitJSON> | Burns stETH tokens (in shares) backed by the vault from the sender using permit (with value in stETH). |
337
+ | burn-steth-permit \<address> \<tokens> \<permitJSON> | Burns stETH tokens backed by the vault from the sender using permit. |
338
+ | burn-wsteth-permit \<address> \<tokens> \<permitJSON> | burn wstETH tokens from the sender backed by the vault using EIP-2612 Permit |
339
+ | rebalance \<address> \<ether> | rebalance the vault by transferring ether |
340
+ | recover-erc20 \<address> \<token> \<recipient> \<amount> | recovers ERC20 tokens or ether from the dashboard contract to sender |
341
+ | recover-erc721 \<address> \<token> \<tokenId> \<recipient> | Transfers a given token_id of an ERC721-compatible NFT (defined by the token contract address) |
342
+ | deposit-pause \<address> | Pauses beacon chain deposits on the staking vault. |
343
+ | deposit-resume \<address> | Mass-grants multiple roles to multiple accounts. |
344
+ | role-grant \<address> \<roleAssignmentJSON> | Mass-revokes multiple roles from multiple accounts. |
345
+ | role-revoke \<address> \<roleAssignmentJSON> | Resumes beacon chain deposits on the staking vault. |
346
+ | compensate-disproven-predeposit \<address> \<pubkey> \<recipient> | Compensates a disproven predeposit from the Predeposit Guarantee contract. |
304
347
 
305
348
  **\<permitJSON>**
306
349
 
@@ -339,62 +382,143 @@ lsv-cli delegation -h
339
382
 
340
383
  #### API
341
384
 
342
- | Command | Description |
343
- | ---------------------------------------------------------- | --------------------------------------------------------------------------- |
344
- | roles \<address> | Get delegation contract roles info |
345
- | base-info \<address> | Get delegation base info |
346
- | voting-lifetime \<address> | Get committee's voting lifetime period |
347
- | is-healthy \<address> | Get vault healthy info |
348
- | voting-info \<address> \<callId> \<role> | Get committee votes |
349
- | cf \<address> | Curator fee in basis points |
350
- | cf-report \<address> | The last report for which curator fee was claimed. Updated on each claim |
351
- | cf-unclaimed \<address> | Returns accumulated unclaimed curator fee in ether (U = (R \* F) / T) |
352
- | cf-set \<address> \<newCuratorFee> | Sets the curator fee |
353
- | cf-claim \<address> \<recipient> | Claims the curator fee |
354
- | nof \<address> | Node operator fee in basis points |
355
- | nof-report \<address> | The last report for which node operator fee was claimed. Updated on claim |
356
- | nof-unclaimed \<address> | Returns accumulated unclaimed node operator fee in ether (U = (R \* F) / T) |
357
- | nof-set \<address> \<newNodeOperatorFeeBP> | Sets the node operator fee |
358
- | nof-claim \<address> \<recipient> | Claims the node operator fee |
359
- | unreserved \<address> | Returns the unreserved amount of ether |
360
- | vc \<address> | Returns the voting committee |
361
- | fund \<address> \<wei> | Funds the StakingVault with ether |
362
- | withdraw \<address> \<recipient> \<wei> | Withdraws ether from the StakingVault |
363
- | mint \<address> \<recipient> \<amountOfShares> | Mints shares for a given recipient |
364
- | burn \<address> \<amountOfShares> | Burns shares for a given recipient |
365
- | rebalance \<address> \<ether> | Rebalances the StakingVault with a given amount of ether |
366
- | set-vote-lt \<address> \<newVoteLifetime> | Sets the vote lifetime |
367
- | t-ownership \<address> \<newOwner> | Transfers the ownership of the StakingVault |
368
- | disconnect \<address> | Voluntarily disconnects a StakingVault from VaultHub |
369
- | deposit-pause \<address> | Pauses deposits to beacon chain from the StakingVault |
370
- | deposit-resume \<address> | Resumes deposits to beacon chain from the StakingVault |
371
- | vault \<address> | Vault info |
372
- | s-limit \<address> | Shares limit |
373
- | s-minted \<address> | Shares minted |
374
- | reserve-ratio \<address> | Vault reserve ratio of the vault |
375
- | t-reserve-ratio \<address> | Threshold reserve ratio of the vault |
376
- | t-fee \<address> | Treasury fee basis points |
377
- | valuation \<address> | Valuation of the vault in ether |
378
- | t-shares \<address> | Total of shares that can be minted on the vault |
379
- | get-shares \<address> \<ether> | Maximum number of shares that can be minted with deposited ether |
380
- | withdrawable-eth \<address> | Amount of ether that can be withdrawn from the staking vault |
381
- | ownership \<address> \<newOwner> | Transfers ownership of the staking vault to a new owner |
382
- | fund-weth \<address> \<wethAmount> | Funds the staking vault with wrapped ether |
383
- | withdraw-weth \<address> \<recipient> \<ether> | Withdraws stETH tokens from the staking vault to wrapped ether |
384
- | exit \<address> \<validatorPubKey> | Requests the exit of a validator from the staking vault |
385
- | mint-shares \<address> \<recipient> \<amountOfShares> | Mints stETH tokens backed by the vault to a recipient |
386
- | mint-steth \<address> \<recipient> \<amountOfShares> | Mints stETH tokens backed by the vault to a recipient |
387
- | mint-wsteth \<address> \<recipient> \<tokens> | Mints wstETH tokens backed by the vault to a recipient |
388
- | burn-shares \<address> \<amountOfShares> | Burns stETH shares (requires approved stETH amount) |
389
- | burn-steth \<address> \<amountOfShares> | Burns stETH shares (requires approved stETH amount) |
390
- | burn-wsteth \<address> \<tokens> | Burn wstETH tokens backed by the vault |
391
- | burn-shares-permit \<address> \<tokens> \<permitJSON> | Burns stETH tokens using permit (value in stETH) |
392
- | burn-steth-permit \<address> \<tokens> \<permitJSON> | Burns stETH tokens using permit |
393
- | burn-wsteth-permit \<address> \<tokens> \<permitJSON> | Burn wstETH tokens using EIP-2612 Permit |
394
- | recover-erc20 \<address> \<token> \<recipient> \<amount> | Recovers ERC20 tokens or ether from the delegation contract |
395
- | recover-erc721 \<address> \<token> \<tokenId> \<recipient> | Transfers ERC721 NFT by token ID |
396
- | role-grant \<address> \<roleAssignmentJSON> | Mass-revokes multiple roles from multiple accounts |
397
- | role-revoke \<address> \<roleAssignmentJSON> | Resumes beacon chain deposits on the staking vault |
385
+ | Command | Description |
386
+ | ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
387
+ | ASSET_RECOVERY_ROLE \<address> | Calls the read-only function "ASSET_RECOVERY_ROLE" on the contract. |
388
+ | BURN_ROLE \<address> | Calls the read-only function "BURN_ROLE" on the contract. |
389
+ | CURATOR_FEE_CLAIM_ROLE \<address> | Calls the read-only function "CURATOR_FEE_CLAIM_ROLE" on the contract. |
390
+ | CURATOR_FEE_SET_ROLE \<address> | Calls the read-only function "CURATOR_FEE_SET_ROLE" on the contract. |
391
+ | DEFAULT_ADMIN_ROLE \<address> | Calls the read-only function "DEFAULT_ADMIN_ROLE" on the contract. |
392
+ | ETH \<address> | Calls the read-only function "ETH" on the contract. |
393
+ | FUND_ROLE \<address> | Calls the read-only function "FUND_ROLE" on the contract. |
394
+ | MAX_CONFIRM_EXPIRY \<address> | Calls the read-only function "MAX_CONFIRM_EXPIRY" on the contract. |
395
+ | MINT_ROLE \<address> | Calls the read-only function "MINT_ROLE" on the contract. |
396
+ | MIN_CONFIRM_EXPIRY \<address> | Calls the read-only function "MIN_CONFIRM_EXPIRY" on the contract. |
397
+ | NODE_OPERATOR_FEE_CLAIM_ROLE \<address> | Calls the read-only function "NODE_OPERATOR_FEE_CLAIM_ROLE" on the contract. |
398
+ | NODE_OPERATOR_MANAGER_ROLE \<address> | Calls the read-only function "NODE_OPERATOR_MANAGER_ROLE" on the contract. |
399
+ | PAUSE_BEACON_CHAIN_DEPOSITS_ROLE \<address> | Calls the read-only function "PAUSE_BEACON_CHAIN_DEPOSITS_ROLE" on the contract. |
400
+ | PDG_WITHDRAWAL_ROLE \<address> | Calls the read-only function "PDG_WITHDRAWAL_ROLE" on the contract. |
401
+ | REBALANCE_ROLE \<address> | Calls the read-only function "REBALANCE_ROLE" on the contract. |
402
+ | REQUEST_VALIDATOR_EXIT_ROLE \<address> | Calls the read-only function "REQUEST_VALIDATOR_EXIT_ROLE" on the contract. |
403
+ | RESUME_BEACON_CHAIN_DEPOSITS_ROLE \<address> | Calls the read-only function "RESUME_BEACON_CHAIN_DEPOSITS_ROLE" on the contract. |
404
+ | STETH \<address> | Calls the read-only function "STETH" on the contract. |
405
+ | TRIGGER_VALIDATOR_WITHDRAWAL_ROLE \<address> | Calls the read-only function "TRIGGER_VALIDATOR_WITHDRAWAL_ROLE" on the contract. |
406
+ | VOLUNTARY_DISCONNECT_ROLE \<address> | Calls the read-only function "VOLUNTARY_DISCONNECT_ROLE" on the contract. |
407
+ | WETH \<address> | Calls the read-only function "WETH" on the contract. |
408
+ | WITHDRAW_ROLE \<address> | Calls the read-only function "WITHDRAW_ROLE" on the contract. |
409
+ | WSTETH \<address> | Calls the read-only function "WSTETH" on the contract. |
410
+ | confirmations \<address> \<callData> \<role> | Calls the read-only function "confirmations" on the contract. |
411
+ | confirmingRoles \<address> | Calls the read-only function "confirmingRoles" on the contract. |
412
+ | curatorFeeBP \<address> | Calls the read-only function "curatorFeeBP" on the contract. |
413
+ | curatorFeeClaimedReport \<address> | Calls the read-only function "curatorFeeClaimedReport" on the contract. |
414
+ | cf-unclaimed \<address> | Returns the accumulated unclaimed curator fee in ether |
415
+ | getConfirmExpiry \<address> | Calls the read-only function "getConfirmExpiry" on the contract. |
416
+ | getRoleAdmin \<address> \<role> | Calls the read-only function "getRoleAdmin" on the contract. |
417
+ | getRoleMember \<address> \<role> \<index> | Calls the read-only function "getRoleMember" on the contract. |
418
+ | getRoleMemberCount \<address> \<role> | Calls the read-only function "getRoleMemberCount" on the contract. |
419
+ | getRoleMembers \<address> \<role> | Calls the read-only function "getRoleMembers" on the contract. |
420
+ | has-role \<address> \<role> \<account> | get has role by role and account |
421
+ | initialized \<address> | Calls the read-only function "initialized" on the contract. |
422
+ | no-fee \<address> | get node operator fee in basis points |
423
+ | no-fee-report \<address> | get node operator fee claimed report |
424
+ | no-unclaimed-fee \<address> | Returns the accumulated unclaimed node operator fee in ether |
425
+ | projected-new-mintable-shares \<address> \<etherToFund> | get projected new mintable shares |
426
+ | r-threshold \<address> | get rebalance threshold in basis points |
427
+ | reserve-ratio \<address> | get reserve ratio in basis points |
428
+ | s-limit \<address> | get share limit |
429
+ | s-minted \<address> | get shares minted |
430
+ | vault \<address> | get staking vault address |
431
+ | supports-interface \<address> \<interfaceId> | get supports interface by id |
432
+ | total-mintable-shares \<address> | get total of shares that can be minted on the vault |
433
+ | t-fee \<address> | get treasury fee in basis points |
434
+ | unreserved \<address> | Calls the read-only function "unreserved" on the contract. |
435
+ | valuation \<address> | get vault valuation |
436
+ | hub \<address> | get vaultHub address |
437
+ | socket \<address> | get vault socket |
438
+ | w-ether \<address> | get amount of ether that can be withdrawn from the staking vault |
439
+ | roles \<address> | get delegation contract roles info |
440
+ | base-info \<address> | get delegation base info |
441
+ | is-healthy \<address> | get vault healthy info |
442
+ | cf-set \<address> \<newCuratorFee> | sets the curator fee |
443
+ | cf-claim \<address> \<recipient> | claims the curator fee |
444
+ | nof-set \<address> \<newNodeOperatorFeeBP> | sets the node operator fee |
445
+ | nof-claim \<address> \<recipient> | claims the node operator fee |
446
+ | fund \<address> \<wei> | funds the StakingVault with ether |
447
+ | withdraw \<address> \<recipient> \<wei> | withdraws ether from the StakingVault |
448
+ | rebalance \<address> \<ether> | rebalances the StakingVault with a given amount of ether |
449
+ | t-ownership \<address> \<newOwner> | transfers the ownership of the StakingVault |
450
+ | disconnect \<address> | voluntarily disconnects a StakingVault from VaultHub |
451
+ | deposit-pause \<address> | Pauses deposits to beacon chain from the StakingVault. |
452
+ | deposit-resume \<address> | Resumes deposits to beacon chain from the StakingVault. |
453
+ | fund-weth \<address> \<wethAmount> | funds the staking vault with wrapped ether |
454
+ | withdraw-weth \<address> \<recipient> \<ether> | withdraws stETH tokens from the staking vault to wrapped ether |
455
+ | exit \<address> \<validatorPubKey> | requests the exit of a validator from the staking vault |
456
+ | mint-shares \<address> \<recipient> \<amountOfShares> | mints stETH tokens backed by the vault to a recipient |
457
+ | mint-steth \<address> \<recipient> \<amountOfShares> | mints stETH tokens backed by the vault to a recipient |
458
+ | mint-wsteth \<address> \<recipient> \<tokens> | mints wstETH tokens backed by the vault to a recipient |
459
+ | burn-shares \<address> \<amountOfShares> | Burns stETH shares from the sender backed by the vault. Expects corresponding amount of stETH approved to this contract |
460
+ | burn-steth \<address> \<amountOfShares> | Burns stETH shares from the sender backed by the vault. Expects stETH amount approved to this contract. |
461
+ | burn-wsteth \<address> \<tokens> | burn wstETH tokens from the sender backed by the vault |
462
+ | burn-shares-permit \<address> \<tokens> \<permitJSON> | Burns stETH tokens (in shares) backed by the vault from the sender using permit (with value in stETH). |
463
+ | burn-steth-permit \<address> \<tokens> \<permitJSON> | Burns stETH tokens backed by the vault from the sender using permit. |
464
+ | burn-wsteth-permit \<address> \<tokens> \<permitJSON> | burn wstETH tokens from the sender backed by the vault using EIP-2612 Permit |
465
+ | recover-erc20 \<address> \<token> \<recipient> \<amount> | recovers ERC20 tokens or ether from the delegation contract to sender |
466
+ | recover-erc721 \<address> \<token> \<tokenId> \<recipient> | Transfers a given token_id of an ERC721-compatible NFT (defined by the token contract address) |
467
+ | role-grant \<address> \<roleAssignmentJSON> | Mass-revokes multiple roles from multiple accounts. |
468
+ | role-revoke \<address> \<roleAssignmentJSON> | Resumes beacon chain deposits on the staking vault. |
469
+ | set-confirm-expiry \<address> \<newConfirmExpiry> | set the confirmation expiry |
470
+
471
+ ### PredepositGuarantee
472
+
473
+ #### Command
474
+
475
+ ```bash
476
+ lsv-cli pdg [arguments] [-options]
477
+ ```
478
+
479
+ #### Delegation commands list
480
+
481
+ ```bash
482
+ lsv-cli pdg -h
483
+ ```
484
+
485
+ #### API
486
+
487
+ | Command | Description |
488
+ | -------------------------------------------- | ------------------------------------------------------------------------------- |
489
+ | BEACON_ROOTS | Calls the read-only function "BEACON_ROOTS" on the contract. |
490
+ | DEFAULT_ADMIN_ROLE | Calls the read-only function "DEFAULT_ADMIN_ROLE" on the contract. |
491
+ | GI_FIRST_VALIDATOR | Calls the read-only function "GI_FIRST_VALIDATOR" on the contract. |
492
+ | GI_FIRST_VALIDATOR_AFTER_CHANGE | Calls the read-only function "GI_FIRST_VALIDATOR_AFTER_CHANGE" on the contract. |
493
+ | GI_PUBKEY_WC_PARENT | Calls the read-only function "GI_PUBKEY_WC_PARENT" on the contract. |
494
+ | GI_STATE_ROOT | Calls the read-only function "GI_STATE_ROOT" on the contract. |
495
+ | MAX_SUPPORTED_WC_VERSION | Calls the read-only function "MAX_SUPPORTED_WC_VERSION" on the contract. |
496
+ | MIN_SUPPORTED_WC_VERSION | Calls the read-only function "MIN_SUPPORTED_WC_VERSION" on the contract. |
497
+ | PAUSE_INFINITELY | Calls the read-only function "PAUSE_INFINITELY" on the contract. |
498
+ | PAUSE_ROLE | Calls the read-only function "PAUSE_ROLE" on the contract. |
499
+ | PREDEPOSIT_AMOUNT | Calls the read-only function "PREDEPOSIT_AMOUNT" on the contract. |
500
+ | RESUME_ROLE | Calls the read-only function "RESUME_ROLE" on the contract. |
501
+ | SLOT_CHANGE_GI_FIRST_VALIDATOR | Calls the read-only function "SLOT_CHANGE_GI_FIRST_VALIDATOR" on the contract. |
502
+ | STATE_ROOT_DEPTH | Calls the read-only function "STATE_ROOT_DEPTH" on the contract. |
503
+ | STATE_ROOT_POSITION | Calls the read-only function "STATE_ROOT_POSITION" on the contract. |
504
+ | WC_PUBKEY_PARENT_DEPTH | Calls the read-only function "WC_PUBKEY_PARENT_DEPTH" on the contract. |
505
+ | WC_PUBKEY_PARENT_POSITION | Calls the read-only function "WC_PUBKEY_PARENT_POSITION" on the contract. |
506
+ | claimableRefund \<\_guarantor> | Calls the read-only function "claimableRefund" on the contract. |
507
+ | getResumeSinceTimestamp | Calls the read-only function "getResumeSinceTimestamp" on the contract. |
508
+ | getRoleAdmin \<role> | Calls the read-only function "getRoleAdmin" on the contract. |
509
+ | getRoleMember \<role> \<index> | Calls the read-only function "getRoleMember" on the contract. |
510
+ | getRoleMemberCount \<role> | Calls the read-only function "getRoleMemberCount" on the contract. |
511
+ | getRoleMembers \<role> | Calls the read-only function "getRoleMembers" on the contract. |
512
+ | hasRole \<role> \<account> | Calls the read-only function "hasRole" on the contract. |
513
+ | isPaused | Calls the read-only function "isPaused" on the contract. |
514
+ | nodeOperatorBalance \<\_nodeOperator> | Calls the read-only function "nodeOperatorBalance" on the contract. |
515
+ | nodeOperatorGuarantor \<\_nodeOperator> | Calls the read-only function "nodeOperatorGuarantor" on the contract. |
516
+ | supportsInterface \<interfaceId> | Calls the read-only function "supportsInterface" on the contract. |
517
+ | unlockedBalance \<\_nodeOperator> | Calls the read-only function "unlockedBalance" on the contract. |
518
+ | validatorStatus \<\_validatorPubkey> | Calls the read-only function "validatorStatus" on the contract. |
519
+ | predeposit \<vault> \<deposits> | predeposit |
520
+ | create-proof-and-prove \<index> | create proof and prove |
521
+ | deposit-to-beacon-chain \<vault> \<deposits> | deposit to beacon chain |
398
522
 
399
523
  ## License
400
524