@northstake/northstakeapi 1.0.38 → 1.0.40

package/dist/api/lidoWriteApi.d.ts

@@ -0,0 +1,469 @@
+/**
+ * Northstake
+ * Northstake api  Operation-level extensions used by the API: - x-roleRequired (array of strings): roles required to call the operation. - x-mfaApiScope (array of strings): MFA API scopes required when the user has MFA enrolled. - x-isProSvmFeature (boolean): when true, the operation is restricted to users whose Cosmos user document has is_pro_svm_user set to true.
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+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';
+import { FundVault } from '../model/fundVault';
+import { GetLazyOracleReportCallData200Response } from '../model/getLazyOracleReportCallData200Response';
+import { GrantRole } from '../model/grantRole';
+import { MintShares } from '../model/mintShares';
+import { MintStETH } from '../model/mintStETH';
+import { MintWstETH } from '../model/mintWstETH';
+import { PartialTransaction } from '../model/partialTransaction';
+import { RebalanceVaultWithEther } from '../model/rebalanceVaultWithEther';
+import { RebalanceVaultWithShares } from '../model/rebalanceVaultWithShares';
+import { RecoverERC20 } from '../model/recoverERC20';
+import { RevokeRole } from '../model/revokeRole';
+import { StakeEthRequest } from '../model/stakeEthRequest';
+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';
+import { Authentication, Interceptor } from '../model/models';
+import { HttpBearerAuth, ApiKeyAuth } from '../model/models';
+export declare enum LidoWriteApiApiKeys {
+    ApiKeyAuth = 0
+}
+export declare class LidoWriteApi {
+    protected _basePath: string;
+    protected _defaultHeaders: any;
+    protected _useQuerystring: boolean;
+    protected authentications: {
+        default: Authentication;
+        bearerTokenAuth: HttpBearerAuth;
+        ApiKeyAuth: ApiKeyAuth;
+    };
+    protected interceptors: Interceptor[];
+    constructor(basePath?: string);
+    set useQuerystring(value: boolean);
+    set basePath(basePath: string);
+    set defaultHeaders(defaultHeaders: any);
+    get defaultHeaders(): any;
+    get basePath(): string;
+    setDefaultAuthentication(auth: Authentication): void;
+    setApiKey(key: LidoWriteApiApiKeys, value: string): void;
+    set accessToken(accessToken: string | (() => string));
+    addInterceptor(interceptor: Interceptor): void;
+    /**
+     *
+     * @summary Encode approval to burn stETH
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param approveStETH
+     */
+    approveBurnStETH(contractsId: string, approveStETH: ApproveStETH, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Encode approval to burn wstETH
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param approveWstETH
+     */
+    approveBurnWstETH(contractsId: string, approveWstETH: ApproveWstETH, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Approve wrapping stETH to wstETH
+     * @param approveStETH
+     */
+    approveWrapStETH(approveStETH: ApproveStETH, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Encode burn shares transaction
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param burnShares
+     */
+    burnShares(contractsId: string, burnShares: BurnShares, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Encode burn stETH transaction
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param burnStETH
+     */
+    burnStETH(contractsId: string, burnStETH: BurnStETH, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Encode burn wstETH transaction
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param burnWstETH
+     */
+    burnWstETH(contractsId: string, burnWstETH: BurnWstETH, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @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
+     */
+    collectERC20FromVault(contractsId: string, collectERC20FromVault: CollectERC20FromVault, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Create EIP-7251 consolidation requests for validators
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param consolidateValidators
+     */
+    consolidateValidators(contractsId: string, consolidateValidators: ConsolidateValidators, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: ConsolidateValidatorsResponse;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Fund vault with ETH
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param fundVault
+     */
+    fundVault(contractsId: string, fundVault: FundVault, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     * 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, simulateAddress?: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: GetLazyOracleReportCallData200Response;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Get details for a specific staking request
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param stakingRequestId The staking request ID
+     */
+    getStakingRequest(contractsId: string, stakingRequestId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: StakingRequest;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Grant vault role
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param grantRole
+     */
+    grantRole(contractsId: string, grantRole: GrantRole, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary List staking request IDs for a vault
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param status
+     */
+    listStakingRequests(contractsId: string, status?: 'pending' | 'completed' | 'failed', options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: Array<string>;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Encode mint shares transaction
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param mintShares
+     */
+    mintShares(contractsId: string, mintShares: MintShares, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Encode mint stETH transaction
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param mintStETH
+     */
+    mintStETH(contractsId: string, mintStETH: MintStETH, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Encode mint wstETH transaction
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param mintWstETH
+     */
+    mintWstETH(contractsId: string, mintWstETH: MintWstETH, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Rebalance vault with ETH
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param rebalanceVaultWithEther
+     */
+    rebalanceVaultWithEther(contractsId: string, rebalanceVaultWithEther: RebalanceVaultWithEther, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Rebalance vault with shares
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param rebalanceVaultWithShares
+     */
+    rebalanceVaultWithShares(contractsId: string, rebalanceVaultWithShares: RebalanceVaultWithShares, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Recover ERC20 from vault
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param recoverERC20
+     */
+    recoverERC20(contractsId: string, recoverERC20: RecoverERC20, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Revoke vault role
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param revokeRole
+     */
+    revokeRole(contractsId: string, revokeRole: RevokeRole, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     * 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
+     */
+    stakeEthWithLidoContracts(contractsId: string, stakeEthRequest: StakeEthRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: StakeEthResponse;
+        status: number;
+    }>;
+    /**
+     *
+     * @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;
+    }>;
+    /**
+     *
+     * @summary Trigger validator withdrawals
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param triggerValidatorWithdrawals
+     */
+    triggerValidatorWithdrawals(contractsId: string, triggerValidatorWithdrawals: TriggerValidatorWithdrawals, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Unwrap wstETH to stETH
+     * @param unwrapWstETH
+     */
+    unwrapWstETH(unwrapWstETH: UnwrapWstETH, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @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
+     */
+    validateConsolidationRequests(contractsId: string, consolidateValidators: ConsolidateValidators, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: ValidateConsolidationRequestsResponse;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Withdraw from vault
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param withdrawFromVault
+     */
+    withdrawFromVault(contractsId: string, withdrawFromVault: WithdrawFromVault, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Wrap stETH to wstETH
+     * @param wrapStETH
+     */
+    wrapStETH(wrapStETH: WrapStETH, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: PartialTransaction;
+        status: number;
+    }>;
+}