@northstake/northstakeapi 1.0.39 → 1.0.41

package/dist/api/lidoWriteApi.d.ts

@@ -9,11 +9,13 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { AbandonDashboardRequest } from '../model/abandonDashboardRequest';
 import { ApproveStETH } from '../model/approveStETH';
 import { ApproveWstETH } from '../model/approveWstETH';
 import { BurnShares } from '../model/burnShares';
 import { BurnStETH } from '../model/burnStETH';
 import { BurnWstETH } from '../model/burnWstETH';
+import { ChangeTier } from '../model/changeTier';
 import { CollectERC20FromVault } from '../model/collectERC20FromVault';
 import { ConsolidateValidators } from '../model/consolidateValidators';
 import { ConsolidateValidatorsResponse } from '../model/consolidateValidatorsResponse';
@@ -33,6 +35,7 @@ import { StakeEthResponse } from '../model/stakeEthResponse';
 import { StakingRequest } from '../model/stakingRequest';
 import { TriggerValidatorWithdrawals } from '../model/triggerValidatorWithdrawals';
 import { UnwrapWstETH } from '../model/unwrapWstETH';
+import { UpdateShareLimit } from '../model/updateShareLimit';
 import { ValidateConsolidationRequestsResponse } from '../model/validateConsolidationRequestsResponse';
 import { WithdrawFromVault } from '../model/withdrawFromVault';
 import { WrapStETH } from '../model/wrapStETH';
@@ -61,8 +64,38 @@ export declare class LidoWriteApi {
     setApiKey(key: LidoWriteApiApiKeys, value: string): void;
     set accessToken(accessToken: string | (() => string));
     addInterceptor(interceptor: Interceptor): void;
+    /**
+     * Returns a partial transaction to call Dashboard.abandonDashboard(newOwner). Only allowed when the vault is fully disconnected from the vault hub (after disconnect has completed). Step 3 of the stVault disconnect guide (with Dashboard).
+     * @summary Abandon dashboard and transfer vault ownership (disconnect Step 3)
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param abandonDashboardRequest
+     * @param simulateAddress Optional Ethereum address to simulate the transaction from.
+     */
+    abandonDashboard(contractsId: string, abandonDashboardRequest: AbandonDashboardRequest, simulateAddress?: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     * Returns a partial transaction to call StakingVault.acceptOwnership(). Only allowed when the vault is fully disconnected from the vault hub. Step 4 of the stVault disconnect guide (with Dashboard), or Step 3 without Dashboard.
+     * @summary Accept staking vault ownership (disconnect Step 4)
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param simulateAddress Optional Ethereum address to simulate the transaction from.
+     */
+    acceptStakingVaultOwnership(contractsId: string, simulateAddress?: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
     /**
      *
+     * @summary Encode approval to burn stETH
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param approveStETH
      */
@@ -76,6 +109,7 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Encode approval to burn wstETH
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param approveWstETH
      */
@@ -89,6 +123,7 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Approve wrapping stETH to wstETH
      * @param approveStETH
      */
     approveWrapStETH(approveStETH: ApproveStETH, options?: {
@@ -101,6 +136,7 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Encode burn shares transaction
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param burnShares
      */
@@ -114,6 +150,7 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Encode burn stETH transaction
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param burnStETH
      */
@@ -127,6 +164,7 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Encode burn wstETH transaction
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param burnWstETH
      */
@@ -140,6 +178,21 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Encode change tier transaction
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param changeTier
+     */
+    changeTier(contractsId: string, changeTier: ChangeTier, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Collect ERC20 from vault
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param collectERC20FromVault
      */
@@ -151,6 +204,20 @@ export declare class LidoWriteApi {
         body: PartialTransaction;
         status: number;
     }>;
+    /**
+     * Returns a partial transaction to connect the vault to the vault hub (payable with 1 ETH). Only allowed when the vault is not already connected; returns 400 if already connected.
+     * @summary Connect to vault hub
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param simulateAddress Optional Ethereum address to simulate the transaction from.
+     */
+    connectToVaultHub(contractsId: string, simulateAddress?: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
     /**
      *
      * @summary Create EIP-7251 consolidation requests for validators
@@ -167,6 +234,7 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Fund vault with ETH
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param fundVault
      */
@@ -179,11 +247,12 @@ export declare class LidoWriteApi {
         status: number;
     }>;
     /**
-     *
-     * @summary Update the lazy oracle report for a specific Lido staking contract set, returns the calldata needed to submit the updateVaultData transaction to the lazy oracle contract.
+     * Returns the calldata needed to submit the updateVaultData transaction to the lazy oracle contract for a specific Lido staking contract set.
+     * @summary Update lazy oracle report
      * @param contractsId The unique identifier of the Lido staking contracts
+     * @param simulateAddress Optional Ethereum address to simulate the transaction from. If provided, the transaction will be simulated and any revert errors will be returned.
      */
-    getLazyOracleReportCallData(contractsId: string, options?: {
+    getLazyOracleReportCallData(contractsId: string, simulateAddress?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -207,6 +276,7 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Grant vault role
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param grantRole
      */
@@ -220,7 +290,7 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
-     * @summary List staking request IDs for a specific Lido staking contract set
+     * @summary List staking request IDs for a vault
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param status
      */
@@ -234,6 +304,7 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Encode mint shares transaction
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param mintShares
      */
@@ -247,6 +318,7 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Encode mint stETH transaction
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param mintStETH
      */
@@ -260,6 +332,7 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Encode mint wstETH transaction
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param mintWstETH
      */
@@ -273,6 +346,7 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Rebalance vault with ETH
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param rebalanceVaultWithEther
      */
@@ -286,6 +360,7 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Rebalance vault with shares
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param rebalanceVaultWithShares
      */
@@ -299,6 +374,7 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Recover ERC20 from vault
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param recoverERC20
      */
@@ -312,6 +388,7 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Revoke vault role
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param revokeRole
      */
@@ -324,8 +401,8 @@ export declare class LidoWriteApi {
         status: number;
     }>;
     /**
-     *
-     * @summary Stake ETH using a specific Lido staking contract set. Returns the call data needed to submit the unguaranteed deposit transaction to the dashboard contract.
+     * Returns the call data needed to submit the unguaranteed deposit transaction to the dashboard contract.
+     * @summary Stake ETH with a Lido staking vault
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param stakeEthRequest
      */
@@ -339,6 +416,21 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Encode sync tier transaction
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param simulateAddress Optional Ethereum address to simulate the transaction from. If provided, the transaction will be simulated and any revert errors will be returned.
+     */
+    syncTier(contractsId: string, simulateAddress?: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     * Returns a partial transaction to trigger EIP-7002 validator withdrawals. When the vault is connected, uses Dashboard. When the vault is disconnected (e.g. after the disconnect wizard), uses StakingVault.triggerValidatorWithdrawals.
+     * @summary Trigger validator withdrawals
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param triggerValidatorWithdrawals
      */
@@ -352,6 +444,7 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Unwrap wstETH to stETH
      * @param unwrapWstETH
      */
     unwrapWstETH(unwrapWstETH: UnwrapWstETH, options?: {
@@ -364,7 +457,21 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
-     * @summary Validate consolidation requests and return validator balances and signing wallet information
+     * @summary Encode update share limit transaction
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param updateShareLimit
+     */
+    updateShareLimit(contractsId: string, updateShareLimit: UpdateShareLimit, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     * Returns validator balances and signing wallet information for the given consolidation requests.
+     * @summary Validate consolidation requests
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param consolidateValidators
      */
@@ -377,7 +484,22 @@ export declare class LidoWriteApi {
         status: number;
     }>;
     /**
-     *
+     * Returns a partial transaction to voluntarily disconnect the vault from the vault hub. This is the only write operation allowed when the vault is already disconnected.
+     * @summary Voluntary disconnect from vault hub
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param simulateAddress Optional Ethereum address to simulate the transaction from.
+     */
+    voluntaryDisconnectFromVaultHub(contractsId: string, simulateAddress?: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     * Returns a partial transaction to withdraw ETH. When the vault is connected, uses Dashboard.withdraw. When the vault is disconnected (e.g. after the disconnect wizard), uses StakingVault.withdraw(recipient, amount).
+     * @summary Withdraw from vault
      * @param contractsId The unique identifier of the Lido staking contracts
      * @param withdrawFromVault
      */
@@ -391,6 +513,7 @@ export declare class LidoWriteApi {
     }>;
     /**
      *
+     * @summary Wrap stETH to wstETH
      * @param wrapStETH
      */
     wrapStETH(wrapStETH: WrapStETH, options?: {