@bluefin-exchange/pro-sdk 0.2.7 → 0.2.9

package/dist/types/src/api.d.ts

@@ -2488,6 +2488,25 @@ export declare const IntervalRewardsStatusEnum: {
     readonly Cooldown: "COOLDOWN";
 };
 export type IntervalRewardsStatusEnum = typeof IntervalRewardsStatusEnum[keyof typeof IntervalRewardsStatusEnum];
+/**
+ * Base64 encoded ISS details with index.
+ * @export
+ * @interface IssBase64Details
+ */
+export interface IssBase64Details {
+    /**
+     * Base64 encoded ISS details value.
+     * @type {string}
+     * @memberof IssBase64Details
+     */
+    'value': string;
+    /**
+     * Index modulo 4 for the ISS details.
+     * @type {number}
+     * @memberof IssBase64Details
+     */
+    'indexMod4': number;
+}
 /**
  *
  * @export
@@ -3774,6 +3793,31 @@ export declare const PositionSide: {
     readonly Unspecified: "UNSPECIFIED";
 };
 export type PositionSide = typeof PositionSide[keyof typeof PositionSide];
+/**
+ * The generated zero-knowledge proof points.
+ * @export
+ * @interface ProofPoints
+ */
+export interface ProofPoints {
+    /**
+     * Point A of the proof.
+     * @type {Array<string>}
+     * @memberof ProofPoints
+     */
+    'a': Array<string>;
+    /**
+     * Point B of the proof.
+     * @type {Array<Array<string>>}
+     * @memberof ProofPoints
+     */
+    'b': Array<Array<string>>;
+    /**
+     * Point C of the proof.
+     * @type {Array<string>}
+     * @memberof ProofPoints
+     */
+    'c': Array<string>;
+}
 /**
  *
  * @export
@@ -3931,6 +3975,49 @@ export interface SponsorTxResponse {
      */
     'expireAtTime': number;
 }
+/**
+ *
+ * @export
+ * @interface StatsAllTimeResponse
+ */
+export interface StatsAllTimeResponse {
+    /**
+     * Timestamp in milliseconds when the statistics period starts.
+     * @type {number}
+     * @memberof StatsAllTimeResponse
+     */
+    'startTimeAtMillis': number;
+    /**
+     * Total value locked in the legacy exchange in e9 format.
+     * @type {string}
+     * @memberof StatsAllTimeResponse
+     */
+    'legacyTvlE9': string;
+    /**
+     * Total value locked in the exchange in e9 format.
+     * @type {string}
+     * @memberof StatsAllTimeResponse
+     */
+    'tvlE9': string;
+    /**
+     * Total quote asset volume in the legacy exchange in e9 format.
+     * @type {string}
+     * @memberof StatsAllTimeResponse
+     */
+    'totalLegacyQuoteAssetVolumeE9': string;
+    /**
+     * Total quote asset volume in the exchange in e9 format.
+     * @type {string}
+     * @memberof StatsAllTimeResponse
+     */
+    'totalQuoteAssetVolumeE9': string;
+    /**
+     * Timestamp in milliseconds when the statistics period ends.
+     * @type {number}
+     * @memberof StatsAllTimeResponse
+     */
+    'endTimeAtMillis': number;
+}
 /**
  *
  * @export
@@ -4892,6 +4979,93 @@ export interface WithdrawRequestSignedFields {
      */
     'signedAtMillis': number;
 }
+/**
+ *
+ * @export
+ * @interface ZKLoginUserDetailsResponse
+ */
+export interface ZKLoginUserDetailsResponse {
+    /**
+     * The zkLogin user salt.
+     * @type {string}
+     * @memberof ZKLoginUserDetailsResponse
+     */
+    'salt': string;
+    /**
+     * The zkLogin user\'s address.
+     * @type {string}
+     * @memberof ZKLoginUserDetailsResponse
+     */
+    'address': string;
+    /**
+     * The zkLogin user\'s public key.
+     * @type {string}
+     * @memberof ZKLoginUserDetailsResponse
+     */
+    'publicKey': string;
+}
+/**
+ *
+ * @export
+ * @interface ZKLoginZKPRequest
+ */
+export interface ZKLoginZKPRequest {
+    /**
+     * The network to use (e.g., \"mainnet\", \"testnet\").
+     * @type {string}
+     * @memberof ZKLoginZKPRequest
+     */
+    'network'?: string;
+    /**
+     * The ephemeral public key for the ZK proof.
+     * @type {string}
+     * @memberof ZKLoginZKPRequest
+     */
+    'ephemeralPublicKey': string;
+    /**
+     * The maximum epoch for the ZK proof.
+     * @type {number}
+     * @memberof ZKLoginZKPRequest
+     */
+    'maxEpoch': number;
+    /**
+     * Randomness value for the ZK proof.
+     * @type {string}
+     * @memberof ZKLoginZKPRequest
+     */
+    'randomness': string;
+}
+/**
+ *
+ * @export
+ * @interface ZKLoginZKPResponse
+ */
+export interface ZKLoginZKPResponse {
+    /**
+     *
+     * @type {ProofPoints}
+     * @memberof ZKLoginZKPResponse
+     */
+    'proofPoints'?: ProofPoints;
+    /**
+     *
+     * @type {IssBase64Details}
+     * @memberof ZKLoginZKPResponse
+     */
+    'issBase64Details'?: IssBase64Details;
+    /**
+     * Base64 encoded header information.
+     * @type {string}
+     * @memberof ZKLoginZKPResponse
+     */
+    'headerBase64'?: string;
+    /**
+     * The address seed used in the proof.
+     * @type {string}
+     * @memberof ZKLoginZKPResponse
+     */
+    'addressSeed': string;
+}
 /**
  * AccountDataApi - axios parameter creator
  * @export
@@ -5256,7 +5430,7 @@ export declare const AuthApiAxiosParamCreator: (configuration?: Configuration) =
      */
     authTokenPost: (payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Retrieves a new auth token for an account. Expiry is set to 5 min
+     * Retrieves a new auth token for an account. Expiry is set to 5 min.
      * @param {RefreshTokenRequest} refreshTokenRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -5272,6 +5446,23 @@ export declare const AuthApiAxiosParamCreator: (configuration?: Configuration) =
      * @throws {RequiredError}
      */
     authV2TokenPost: (payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * ZK Login User Details
+     * @summary /auth/zklogin
+     * @param {string} zkloginJwt The JWT of the user signed in with zkLogin.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getZkLoginUserDetails: (zkloginJwt: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary /auth/zklogin/zkp
+     * @param {string} zkloginJwt The JWT of the user signed in with zkLogin.
+     * @param {ZKLoginZKPRequest} zKLoginZKPRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postZkLoginZkp: (zkloginJwt: string, zKLoginZKPRequest: ZKLoginZKPRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * AuthApi - functional programming interface
@@ -5297,7 +5488,7 @@ export declare const AuthApiFp: (configuration?: Configuration) => {
      */
     authTokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoginResponse>>;
     /**
-     * Retrieves a new auth token for an account. Expiry is set to 5 min
+     * Retrieves a new auth token for an account. Expiry is set to 5 min.
      * @param {RefreshTokenRequest} refreshTokenRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -5313,6 +5504,23 @@ export declare const AuthApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     authV2TokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoginResponse>>;
+    /**
+     * ZK Login User Details
+     * @summary /auth/zklogin
+     * @param {string} zkloginJwt The JWT of the user signed in with zkLogin.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getZkLoginUserDetails(zkloginJwt: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ZKLoginUserDetailsResponse>>;
+    /**
+     *
+     * @summary /auth/zklogin/zkp
+     * @param {string} zkloginJwt The JWT of the user signed in with zkLogin.
+     * @param {ZKLoginZKPRequest} zKLoginZKPRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postZkLoginZkp(zkloginJwt: string, zKLoginZKPRequest: ZKLoginZKPRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ZKLoginZKPResponse>>;
 };
 /**
  * AuthApi - factory interface
@@ -5338,7 +5546,7 @@ export declare const AuthApiFactory: (configuration?: Configuration, basePath?:
      */
     authTokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<LoginResponse>;
     /**
-     * Retrieves a new auth token for an account. Expiry is set to 5 min
+     * Retrieves a new auth token for an account. Expiry is set to 5 min.
      * @param {RefreshTokenRequest} refreshTokenRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -5354,6 +5562,23 @@ export declare const AuthApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     authV2TokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<LoginResponse>;
+    /**
+     * ZK Login User Details
+     * @summary /auth/zklogin
+     * @param {string} zkloginJwt The JWT of the user signed in with zkLogin.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getZkLoginUserDetails(zkloginJwt: string, options?: RawAxiosRequestConfig): AxiosPromise<ZKLoginUserDetailsResponse>;
+    /**
+     *
+     * @summary /auth/zklogin/zkp
+     * @param {string} zkloginJwt The JWT of the user signed in with zkLogin.
+     * @param {ZKLoginZKPRequest} zKLoginZKPRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postZkLoginZkp(zkloginJwt: string, zKLoginZKPRequest: ZKLoginZKPRequest, options?: RawAxiosRequestConfig): AxiosPromise<ZKLoginZKPResponse>;
 };
 /**
  * AuthApi - object-oriented interface
@@ -5383,7 +5608,7 @@ export declare class AuthApi extends BaseAPI {
      */
     authTokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LoginResponse, any>>;
     /**
-     * Retrieves a new auth token for an account. Expiry is set to 5 min
+     * Retrieves a new auth token for an account. Expiry is set to 5 min.
      * @param {RefreshTokenRequest} refreshTokenRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -5401,6 +5626,25 @@ export declare class AuthApi extends BaseAPI {
      * @memberof AuthApi
      */
     authV2TokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LoginResponse, any>>;
+    /**
+     * ZK Login User Details
+     * @summary /auth/zklogin
+     * @param {string} zkloginJwt The JWT of the user signed in with zkLogin.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthApi
+     */
+    getZkLoginUserDetails(zkloginJwt: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ZKLoginUserDetailsResponse, any>>;
+    /**
+     *
+     * @summary /auth/zklogin/zkp
+     * @param {string} zkloginJwt The JWT of the user signed in with zkLogin.
+     * @param {ZKLoginZKPRequest} zKLoginZKPRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthApi
+     */
+    postZkLoginZkp(zkloginJwt: string, zKLoginZKPRequest: ZKLoginZKPRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ZKLoginZKPResponse, any>>;
 }
 /**
  * ExchangeApi - axios parameter creator
@@ -5454,6 +5698,13 @@ export declare const ExchangeApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getExchangeStats: (interval?: StatsInterval, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves all time exchange statistics.
+     * @summary /v1/exchange/stats/allTime
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExchangeStatsAllTime: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieve the funding rate history for a specific market address.
      * @summary /exchange/fundingRateHistory
@@ -5549,6 +5800,13 @@ export declare const ExchangeApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getExchangeStats(interval?: StatsInterval, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StatsResponse>>;
+    /**
+     * Retrieves all time exchange statistics.
+     * @summary /v1/exchange/stats/allTime
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExchangeStatsAllTime(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StatsAllTimeResponse>>;
     /**
      * Retrieve the funding rate history for a specific market address.
      * @summary /exchange/fundingRateHistory
@@ -5644,6 +5902,13 @@ export declare const ExchangeApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getExchangeStats(interval?: StatsInterval, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): AxiosPromise<StatsResponse>;
+    /**
+     * Retrieves all time exchange statistics.
+     * @summary /v1/exchange/stats/allTime
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExchangeStatsAllTime(options?: RawAxiosRequestConfig): AxiosPromise<StatsAllTimeResponse>;
     /**
      * Retrieve the funding rate history for a specific market address.
      * @summary /exchange/fundingRateHistory
@@ -5746,6 +6011,14 @@ export declare class ExchangeApi extends BaseAPI {
      * @memberof ExchangeApi
      */
     getExchangeStats(interval?: StatsInterval, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StatsResponse, any>>;
+    /**
+     * Retrieves all time exchange statistics.
+     * @summary /v1/exchange/stats/allTime
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExchangeApi
+     */
+    getExchangeStatsAllTime(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StatsAllTimeResponse, any>>;
     /**
      * Retrieve the funding rate history for a specific market address.
      * @summary /exchange/fundingRateHistory