@northstake/northstakeapi 1.0.37 → 1.0.39

package/dist/api/{smartContractsApi.js → lidoRewardsApi.js}

@@ -1,7 +1,7 @@
 "use strict";
 /**
  * Northstake
- * Northstake api
+ * 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
  *
@@ -14,7 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SmartContractsApi = exports.SmartContractsApiApiKeys = void 0;
+exports.LidoRewardsApi = exports.LidoRewardsApiApiKeys = void 0;
 const request_1 = __importDefault(require("request"));
 const models_1 = require("../model/models");
 const models_2 = require("../model/models");
@@ -22,11 +22,11 @@ let defaultBasePath = 'https://api.northstake.dk/v1';
 // ===============================================
 // This file is autogenerated - Please do not edit
 // ===============================================
-var SmartContractsApiApiKeys;
-(function (SmartContractsApiApiKeys) {
-    SmartContractsApiApiKeys[SmartContractsApiApiKeys["ApiKeyAuth"] = 0] = "ApiKeyAuth";
-})(SmartContractsApiApiKeys || (exports.SmartContractsApiApiKeys = SmartContractsApiApiKeys = {}));
-class SmartContractsApi {
+var LidoRewardsApiApiKeys;
+(function (LidoRewardsApiApiKeys) {
+    LidoRewardsApiApiKeys[LidoRewardsApiApiKeys["ApiKeyAuth"] = 0] = "ApiKeyAuth";
+})(LidoRewardsApiApiKeys || (exports.LidoRewardsApiApiKeys = LidoRewardsApiApiKeys = {}));
+class LidoRewardsApi {
     constructor(basePathOrUsername, password, basePath) {
         this._basePath = defaultBasePath;
         this._defaultHeaders = {};
@@ -67,7 +67,7 @@ class SmartContractsApi {
         this.authentications.default = auth;
     }
     setApiKey(key, value) {
-        this.authentications[SmartContractsApiApiKeys[key]].apiKey = value;
+        this.authentications[LidoRewardsApiApiKeys[key]].apiKey = value;
     }
     set accessToken(accessToken) {
         this.authentications.bearerTokenAuth.accessToken = accessToken;
@@ -76,17 +76,17 @@ class SmartContractsApi {
         this.interceptors.push(interceptor);
     }
     /**
-     *
-     * @summary Get mined blocks related to a specific smart contract
-     * @param contractAddress The address of the smart contract
+     * Retrieves a paginated list of daily aggregated validator rewards for all staking vaults, aggregated by date, reward type, and staking vault. Optionally filter by a specific contractsId. Supports filtering by date range and reward type.
+     * @summary Get daily aggregated validator rewards for staking vaults
+     * @param contractsId Optional filter by the unique identifier of a specific Lido staking contracts set. If not provided, returns rewards for all staking vaults.
+     * @param startDate Start date for filtering rewards
+     * @param endDate End date for filtering rewards
      * @param page Page number for pagination
-     * @param limit Number of mined blocks per page
-     * @param startDate Start date for filtering mined blocks
-     * @param endDate End date for filtering mined blocks
+     * @param limit Number of daily reward records per page
+     * @param rewardType Filter by reward type
      */
-    async getSmartContractMinedBlocks(params, options = { headers: {} }) {
-        const localVarPath = this.basePath + '/smartContracts/{contractAddress}/minedBlocks'
-            .replace('{' + 'contractAddress' + '}', encodeURIComponent(String(params === null || params === void 0 ? void 0 : params.contractAddress)));
+    async getStakingVaultRewardsDaily(params, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/lidov3/rewards/daily';
         let localVarQueryParameters = {};
         let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
         const produces = ['application/json'];
@@ -97,9 +97,14 @@ class SmartContractsApi {
             localVarHeaderParams.Accept = produces.join(',');
         }
         let localVarFormParams = {};
-        // Verify required parameter 'contractAddress' is not null or undefined
-        if ((params === null || params === void 0 ? void 0 : params.contractAddress) === null || (params === null || params === void 0 ? void 0 : params.contractAddress) === undefined) {
-            throw new Error('Required parameter "contractAddress" was null or undefined when calling getSmartContractMinedBlocks.');
+        if ((params === null || params === void 0 ? void 0 : params.contractsId) !== undefined) {
+            localVarQueryParameters['contractsId'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.contractsId, "string");
+        }
+        if ((params === null || params === void 0 ? void 0 : params.startDate) !== undefined) {
+            localVarQueryParameters['start_date'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.startDate, "Date");
+        }
+        if ((params === null || params === void 0 ? void 0 : params.endDate) !== undefined) {
+            localVarQueryParameters['end_date'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.endDate, "Date");
         }
         if ((params === null || params === void 0 ? void 0 : params.page) !== undefined) {
             localVarQueryParameters['page'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.page, "number");
@@ -107,11 +112,8 @@ class SmartContractsApi {
         if ((params === null || params === void 0 ? void 0 : params.limit) !== undefined) {
             localVarQueryParameters['limit'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.limit, "number");
         }
-        if ((params === null || params === void 0 ? void 0 : params.startDate) !== undefined) {
-            localVarQueryParameters['start_date'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.startDate, "Date");
-        }
-        if ((params === null || params === void 0 ? void 0 : params.endDate) !== undefined) {
-            localVarQueryParameters['end_date'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.endDate, "Date");
+        if ((params === null || params === void 0 ? void 0 : params.rewardType) !== undefined) {
+            localVarQueryParameters['reward_type'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.rewardType, "'consensus' | 'block' | 'mev'");
         }
         Object.assign(localVarHeaderParams, options.headers);
         let localVarUseFormData = false;
@@ -146,7 +148,7 @@ class SmartContractsApi {
                     }
                     else {
                         if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
-                            body = models_1.ObjectSerializer.deserialize(body, "GetSmartContractMinedBlocks200Response");
+                            body = models_1.ObjectSerializer.deserialize(body, "ValidatorRewardsDailyResponse");
                             resolve({ body: body, status: response.statusCode });
                         }
                         else {
@@ -159,17 +161,17 @@ class SmartContractsApi {
         });
     }
     /**
-     *
-     * @summary Get transactions related to a specific smart contract
-     * @param contractAddress The address of the smart contract
-     * @param startDate Start date for filtering transactions
-     * @param endDate End date for filtering transactions
+     * Retrieves a paginated list of raw validator reward records for all staking vaults. Optionally filter by a specific contractsId. Supports filtering by date range and reward type.
+     * @summary Get raw validator rewards for staking vaults
+     * @param contractsId Optional filter by the unique identifier of a specific Lido staking contracts set. If not provided, returns rewards for all staking vaults.
+     * @param startDate Start date for filtering rewards
+     * @param endDate End date for filtering rewards
      * @param page Page number for pagination
-     * @param limit Number of transactions per page
+     * @param limit Number of reward records per page
+     * @param rewardType Filter by reward type
      */
-    async getSmartContractTransactions(params, options = { headers: {} }) {
-        const localVarPath = this.basePath + '/smartContracts/{contractAddress}/transactions'
-            .replace('{' + 'contractAddress' + '}', encodeURIComponent(String(params === null || params === void 0 ? void 0 : params.contractAddress)));
+    async getStakingVaultRewardsRaw(params, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/lidov3/rewards/raw';
         let localVarQueryParameters = {};
         let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
         const produces = ['application/json'];
@@ -180,9 +182,8 @@ class SmartContractsApi {
             localVarHeaderParams.Accept = produces.join(',');
         }
         let localVarFormParams = {};
-        // Verify required parameter 'contractAddress' is not null or undefined
-        if ((params === null || params === void 0 ? void 0 : params.contractAddress) === null || (params === null || params === void 0 ? void 0 : params.contractAddress) === undefined) {
-            throw new Error('Required parameter "contractAddress" was null or undefined when calling getSmartContractTransactions.');
+        if ((params === null || params === void 0 ? void 0 : params.contractsId) !== undefined) {
+            localVarQueryParameters['contractsId'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.contractsId, "string");
         }
         if ((params === null || params === void 0 ? void 0 : params.startDate) !== undefined) {
             localVarQueryParameters['start_date'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.startDate, "Date");
@@ -196,6 +197,9 @@ class SmartContractsApi {
         if ((params === null || params === void 0 ? void 0 : params.limit) !== undefined) {
             localVarQueryParameters['limit'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.limit, "number");
         }
+        if ((params === null || params === void 0 ? void 0 : params.rewardType) !== undefined) {
+            localVarQueryParameters['reward_type'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.rewardType, "'consensus' | 'block' | 'mev'");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         let localVarUseFormData = false;
         let localVarRequestOptions = {
@@ -229,7 +233,7 @@ class SmartContractsApi {
                     }
                     else {
                         if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
-                            body = models_1.ObjectSerializer.deserialize(body, "GetSmartContractTransactions200Response");
+                            body = models_1.ObjectSerializer.deserialize(body, "ValidatorRewardsRaw");
                             resolve({ body: body, status: response.statusCode });
                         }
                         else {
@@ -242,11 +246,15 @@ class SmartContractsApi {
         });
     }
     /**
-     *
-     * @summary Get list of all deployed smart contracts
+     * Creates an internal order document for CSV export of daily aggregated rewards. The backend janitor will process this order and send the CSV via email.
+     * @summary Request CSV export for daily rewards
+     * @param contractsId Optional filter by the unique identifier of a specific Lido staking contracts set. If not provided, exports rewards for all staking vaults.
+     * @param startDate Start date for filtering rewards
+     * @param endDate End date for filtering rewards
+     * @param rewardType Filter by reward type
      */
-    async getSmartContracts(options = { headers: {} }) {
-        const localVarPath = this.basePath + '/smartContracts';
+    async requestRewardsDailyCsvExport(params, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/lidov3/rewards/daily/csv-export';
         let localVarQueryParameters = {};
         let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
         const produces = ['application/json'];
@@ -257,10 +265,98 @@ class SmartContractsApi {
             localVarHeaderParams.Accept = produces.join(',');
         }
         let localVarFormParams = {};
+        if ((params === null || params === void 0 ? void 0 : params.contractsId) !== undefined) {
+            localVarQueryParameters['contractsId'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.contractsId, "string");
+        }
+        if ((params === null || params === void 0 ? void 0 : params.startDate) !== undefined) {
+            localVarQueryParameters['start_date'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.startDate, "Date");
+        }
+        if ((params === null || params === void 0 ? void 0 : params.endDate) !== undefined) {
+            localVarQueryParameters['end_date'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.endDate, "Date");
+        }
+        if ((params === null || params === void 0 ? void 0 : params.rewardType) !== undefined) {
+            localVarQueryParameters['reward_type'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.rewardType, "'consensus' | 'block' | 'mev'");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         let localVarUseFormData = false;
         let localVarRequestOptions = {
-            method: 'GET',
+            method: 'POST',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+        };
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+        let interceptorPromise = authenticationPromise;
+        for (const interceptor of this.interceptors) {
+            interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
+        }
+        return interceptorPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    localVarRequestOptions.formData = localVarFormParams;
+                }
+                else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise((resolve, reject) => {
+                (0, request_1.default)(localVarRequestOptions, (error, response, body) => {
+                    if (error) {
+                        console.error('API call error:', error);
+                        reject(error);
+                    }
+                    else {
+                        if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve({ body: body, status: response.statusCode });
+                        }
+                        else {
+                            console.error('API response error:', response.statusCode);
+                            resolve({ body: body, status: response.statusCode });
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Creates an internal order document for CSV export of raw validator rewards. The backend janitor will process this order and send the CSV via email.
+     * @summary Request CSV export for raw rewards
+     * @param contractsId Optional filter by the unique identifier of a specific Lido staking contracts set. If not provided, exports rewards for all staking vaults.
+     * @param startDate Start date for filtering rewards
+     * @param endDate End date for filtering rewards
+     * @param rewardType Filter by reward type
+     */
+    async requestRewardsRawCsvExport(params, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/lidov3/rewards/raw/csv-export';
+        let localVarQueryParameters = {};
+        let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
+        const produces = ['application/json'];
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        }
+        else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams = {};
+        if ((params === null || params === void 0 ? void 0 : params.contractsId) !== undefined) {
+            localVarQueryParameters['contractsId'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.contractsId, "string");
+        }
+        if ((params === null || params === void 0 ? void 0 : params.startDate) !== undefined) {
+            localVarQueryParameters['start_date'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.startDate, "Date");
+        }
+        if ((params === null || params === void 0 ? void 0 : params.endDate) !== undefined) {
+            localVarQueryParameters['end_date'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.endDate, "Date");
+        }
+        if ((params === null || params === void 0 ? void 0 : params.rewardType) !== undefined) {
+            localVarQueryParameters['reward_type'] = models_1.ObjectSerializer.serialize(params === null || params === void 0 ? void 0 : params.rewardType, "'consensus' | 'block' | 'mev'");
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        let localVarUseFormData = false;
+        let localVarRequestOptions = {
+            method: 'POST',
             qs: localVarQueryParameters,
             headers: localVarHeaderParams,
             uri: localVarPath,
@@ -290,7 +386,6 @@ class SmartContractsApi {
                     }
                     else {
                         if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
-                            body = models_1.ObjectSerializer.deserialize(body, "Array<SmartContractDetailed>");
                             resolve({ body: body, status: response.statusCode });
                         }
                         else {
@@ -303,4 +398,4 @@ class SmartContractsApi {
         });
     }
 }
-exports.SmartContractsApi = SmartContractsApi;
+exports.LidoRewardsApi = LidoRewardsApi;

package/dist/api/lidoStakingVaultsApi.d.ts

@@ -0,0 +1,108 @@
+/**
+ * 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 { CreateLidoStakingContractsRequest } from '../model/createLidoStakingContractsRequest';
+import { CreateVaultRequest } from '../model/createVaultRequest';
+import { LidoStakingContracts } from '../model/lidoStakingContracts';
+import { LidoStakingContractsWithData } from '../model/lidoStakingContractsWithData';
+import { RenameVaultRequest } from '../model/renameVaultRequest';
+import { VaultCreationStartResponse } from '../model/vaultCreationStartResponse';
+import { Authentication, Interceptor } from '../model/models';
+import { HttpBearerAuth, ApiKeyAuth } from '../model/models';
+export declare enum LidoStakingVaultsApiApiKeys {
+    ApiKeyAuth = 0
+}
+export declare class LidoStakingVaultsApi {
+    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: LidoStakingVaultsApiApiKeys, value: string): void;
+    set accessToken(accessToken: string | (() => string));
+    addInterceptor(interceptor: Interceptor): void;
+    /**
+     * Generates the transaction to deploy a new Lido staking vault.
+     * @summary Create a new Lido staking vault
+     * @param createVaultRequest
+     */
+    createLidoStakingVault(createVaultRequest: CreateVaultRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: VaultCreationStartResponse;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Get a specific Lido staking contract set
+     * @param contractsId The unique identifier of the Lido staking contracts
+     */
+    getLidoStakingContracts(contractsId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: LidoStakingContractsWithData;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary List all Lido staking contract sets
+     */
+    listLidoStakingContracts(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: Array<LidoStakingContracts>;
+        status: number;
+    }>;
+    /**
+     *
+     * @summary Register a new Lido staking vault contract set
+     * @param createLidoStakingContractsRequest
+     */
+    registerLidoStakingContracts(createLidoStakingContractsRequest: CreateLidoStakingContractsRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: LidoStakingContracts;
+        status: number;
+    }>;
+    /**
+     * Updates the name of an existing Lido staking vault contract set.
+     * @summary Rename a Lido staking vault
+     * @param contractsId The unique identifier of the Lido staking contracts
+     * @param renameVaultRequest
+     */
+    renameLidoStakingContracts(contractsId: string, renameVaultRequest: RenameVaultRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        body: LidoStakingContracts;
+        status: number;
+    }>;
+}