VaultHub

Command

yarn start contracts hub [arguments] [-options]

VaultHub commands list

yarn start contracts hub -h

API

Command	Description
read (r)	read commands
write (w)	write commands

Read

Command	Description
info	get vault hub info
roles	get vault hub roles
BAD_DEBT_MASTER_ROLE	Calls the read-only function "BAD_DEBT_MASTER_ROLE" on the contract.
CONNECT_DEPOSIT	Calls the read-only function "CONNECT_DEPOSIT" on the contract.
CONSENSUS_CONTRACT	Calls the read-only function "CONSENSUS_CONTRACT" on the contract.
DEFAULT_ADMIN_ROLE	Calls the read-only function "DEFAULT_ADMIN_ROLE" on the contract.
LIDO	Calls the read-only function "LIDO" on the contract.
LIDO_LOCATOR	Calls the read-only function "LIDO_LOCATOR" on the contract.
MAX_RELATIVE_SHARE_LIMIT_BP	Calls the read-only function "MAX_RELATIVE_SHARE_LIMIT_BP" on the contract.
PAUSE_INFINITELY	Calls the read-only function "PAUSE_INFINITELY" on the contract.
PAUSE_ROLE	Calls the read-only function "PAUSE_ROLE" on the contract.
REDEMPTION_MASTER_ROLE	Calls the read-only function "REDEMPTION_MASTER_ROLE" on the contract.
REPORT_FRESHNESS_DELTA	Calls the read-only function "REPORT_FRESHNESS_DELTA" on the contract.
RESUME_ROLE	Calls the read-only function "RESUME_ROLE" on the contract.
VALIDATOR_EXIT_ROLE	Calls the read-only function "VALIDATOR_EXIT_ROLE" on the contract.
VAULT_CODEHASH_SET_ROLE	Calls the read-only function "VAULT_CODEHASH_SET_ROLE" on the contract.
VAULT_MASTER_ROLE	Calls the read-only function "VAULT_MASTER_ROLE" on the contract.
bad-debt	get the amount of bad debt to be internalized to become the protocol loss
getResumeSinceTimestamp	Calls the read-only function "getResumeSinceTimestamp" on the contract.
getRoleAdmin <role>	Calls the read-only function "getRoleAdmin" on the contract.
getRoleMember <role> <index>	Calls the read-only function "getRoleMember" on the contract.
getRoleMemberCount <role>	Calls the read-only function "getRoleMemberCount" on the contract.
getRoleMembers <role>	Calls the read-only function "getRoleMembers" on the contract.
hasRole <role> <account>	Calls the read-only function "hasRole" on the contract.
in-out-delta <vault>	get the inOutDelta of the vault as of the last refSlot
is-paused	get is paused boolean
is-report-fresh <vault>	check if if the report for the vault is fresh, false otherwise
is-v-connected <vault>	check if the vault is connected to the hub
is-v-h <vault>	get is vault healthy boolean
latest-report-data <vault>	get latest report for the vault
liability-shares <vault>	get liability shares of the vault
locked <vault>	get llocked amount of ether for the vault
max-lockable-value <vault>	get the amount of ether that can be locked in the vault given the current total value
rebalance-shortfall <vault>	get amount to rebalance or UINT256_MAX if it`s impossible to make the vault healthy using rebalance
supportsInterface <interfaceId>	Calls the read-only function "supportsInterface" on the contract.
total-value <vault>	get total value of the vault (as of the latest report received)
v-by-index <index>	get the vault address by its index
v-connection <vault>	get connection parameters struct for the given vault
v-obligations <vault>	get the obligations struct for the given vault
v-record <vault>	get the accounting record struct for the given vault
v-count	get the number of vaults connected to the hub
w-ether <vault>	get the amount of ether that can be instantly withdrawn from the staking vault
vault-info-by-index vi<index>	get vault and vault connection parameters by index

Write

Command	Description
set-allowed-codehash <codehash> <allowed>	Set if a vault proxy codehash is allowed to be connected to the hub
v-connect <address>	connects a vault to the hub (vault master role needed)
v-update-share-limit <address> <shareLimit>	updates share limit for the vault
v-disconnect <address>	disconnect a vault from the hub. msg.sender must have VAULT_MASTER_ROLE. vault`s "liabilityShares" should be zero
v-owner-disconnect <address>	disconnects a vault from the hub, msg.sender should be vault's owner
v-mint <address> <recipient> <amountOfShares>	mint StETH shares backed by vault external balance to the receiver address
v-burn <address> <amountOfShares>	burn steth shares from the balance of the VaultHub contract
v-transfer-and-burn <address> <amountOfShares>	separate burn function for EOA vault owners; requires vaultHub to be approved to transfer stETH
v-force-rebalance <address>	force rebalance of the vault to have sufficient reserve ratio
v-rebalance <vaultAddress> <amount>	rebalances StakingVault by withdrawing ether to VaultHub. msg.sender should be vault`s owner
v-force-validator-exit <vaultAddress> <validatorPubkey> <refundRecipient>	force validator exit
update-vault-fees <vaultAddress> <infraFeeBP> <liquidityFeeBP> <reservationFeeBP>	updates fees for the vault. msg.sender must have VAULT_MASTER_ROLE
transfer-vault-ownership <vaultAddress> <newOwner>	transfer the ownership of the vault to a new owner
fund-vault <vaultAddress> <amount>	funds the vault passing ether as msg.value
withdraw-vault <vaultAddress> <amount> <recipient>	withdraws ether from the vault to the recipient address
pause-beacon-chain-deposits <vaultAddress>	pauses beacon chain deposits for the vault
resume-beacon-chain-deposits <vaultAddress>	resumes beacon chain deposits for the vault
request-validator-exit <vaultAddress> <validatorPubkeys>	emits a request event for the node operator to perform validator exit
trigger-validator-withdrawals <vaultAddress> <validatorPubkeys> <withdrawalAmounts> <recipient>	triggers validator withdrawals for the vault using EIP-7002
prove-unknown-validator-to-pdg <vaultAddress> <validatorIndex>	proves that validators unknown to PDG have correct WC to participate in the vault
compensate-disproven-predeposit-from-pdg <vaultAddress> <validatorPubkey> <recipient>	compensates disproven predeposit from PDG to the recipient
socialize-bad-debt <badDebtVault> <acceptorVault> <maxSharesToSocialize>	transfer the bad debt from the donor vault to the acceptor vault. msg.sender must have BAD_DEBT_MASTER_ROLE
internalize-bad-debt <badDebtVault> <maxSharesToInternalize>	internalize the bad debt to the protocol. msg.sender must have BAD_DEBT_MASTER_ROLE
settle-vault-obligations <vaultAddress>	allows permissionless full or partial settlement of unsettled obligations on the vault