zklighter-perps 1.0.72 → 1.0.74

package/.openapi-generator/FILES

@@ -1,5 +1,6 @@
 apis/AccountApi.ts
 apis/BlockApi.ts
+apis/BridgeApi.ts
 apis/CandlestickApi.ts
 apis/InfoApi.ts
 apis/LiquidationApi.ts
@@ -19,11 +20,17 @@ models/Accounts.ts
 models/ApiKey.ts
 models/Block.ts
 models/Blocks.ts
+models/BridgeSupportedNetwork.ts
+models/BridgeSupportedNetworks.ts
 models/Candlestick.ts
 models/Candlesticks.ts
 models/ContractAddress.ts
+models/CreateIntentAddressResp.ts
 models/CurrentHeight.ts
 models/Cursor.ts
+models/Deposit.ts
+models/DepositHistory.ts
+models/DepositHistoryItem.ts
 models/DetailedAccount.ts
 models/DetailedAccounts.ts
 models/DetailedCandlestick.ts
@@ -71,9 +78,11 @@ models/ReqGetBlock.ts
 models/ReqGetBlockTxs.ts
 models/ReqGetByAccount.ts
 models/ReqGetCandlesticks.ts
+models/ReqGetDepositHistory.ts
 models/ReqGetFeeBucket.ts
 models/ReqGetFundings.ts
 models/ReqGetL1Tx.ts
+models/ReqGetLatestDeposit.ts
 models/ReqGetLeaderboard.ts
 models/ReqGetNextNonce.ts
 models/ReqGetOrderBookDetails.ts
@@ -86,6 +95,7 @@ models/ReqGetRangeWithIndexSortable.ts
 models/ReqGetRecentTrades.ts
 models/ReqGetTrades.ts
 models/ReqGetTx.ts
+models/ReqGetWithdrawHistory.ts
 models/ReqIsWhitelisted.ts
 models/ResultCode.ts
 models/SimpleOrder.ts
@@ -99,5 +109,8 @@ models/TxHash.ts
 models/TxHashes.ts
 models/Txs.ts
 models/ValidatorInfo.ts
+models/WithdrawHistory.ts
+models/WithdrawHistoryItem.ts
+models/ZkLighterInfo.ts
 models/index.ts
 runtime.ts

package/apis/BridgeApi.ts

@@ -0,0 +1,369 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  BridgeSupportedNetworks,
+  CreateIntentAddressResp,
+  Deposit,
+  DepositHistory,
+  ResultCode,
+  WithdrawHistory,
+} from '../models/index';
+import {
+    BridgeSupportedNetworksFromJSON,
+    BridgeSupportedNetworksToJSON,
+    CreateIntentAddressRespFromJSON,
+    CreateIntentAddressRespToJSON,
+    DepositFromJSON,
+    DepositToJSON,
+    DepositHistoryFromJSON,
+    DepositHistoryToJSON,
+    ResultCodeFromJSON,
+    ResultCodeToJSON,
+    WithdrawHistoryFromJSON,
+    WithdrawHistoryToJSON,
+} from '../models/index';
+
+export interface CreateIntentAddressRequest {
+    chain_id: string;
+    from_addr: string;
+    amount: string;
+    is_external_deposit?: boolean;
+}
+
+export interface DepositCancelRequest {
+    from_addr: string;
+    chain_id: string;
+}
+
+export interface DepositHistoryRequest {
+    l1_address: string;
+    cursor?: string;
+}
+
+export interface DepositLatestRequest {
+    l1_address: string;
+}
+
+export interface WithdrawHistoryRequest {
+    l1_address: string;
+    cursor?: string;
+}
+
+/**
+ * 
+ */
+export class BridgeApi extends runtime.BaseAPI {
+
+    /**
+     * Create a bridge intent address for CCTP bridge
+     * createIntentAddress
+     */
+    async createIntentAddressRaw(requestParameters: CreateIntentAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateIntentAddressResp>> {
+        if (requestParameters['chain_id'] == null) {
+            throw new runtime.RequiredError(
+                'chain_id',
+                'Required parameter "chain_id" was null or undefined when calling createIntentAddress().'
+            );
+        }
+
+        if (requestParameters['from_addr'] == null) {
+            throw new runtime.RequiredError(
+                'from_addr',
+                'Required parameter "from_addr" was null or undefined when calling createIntentAddress().'
+            );
+        }
+
+        if (requestParameters['amount'] == null) {
+            throw new runtime.RequiredError(
+                'amount',
+                'Required parameter "amount" was null or undefined when calling createIntentAddress().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['chain_id'] != null) {
+            formParams.append('chain_id', requestParameters['chain_id'] as any);
+        }
+
+        if (requestParameters['from_addr'] != null) {
+            formParams.append('from_addr', requestParameters['from_addr'] as any);
+        }
+
+        if (requestParameters['amount'] != null) {
+            formParams.append('amount', requestParameters['amount'] as any);
+        }
+
+        if (requestParameters['is_external_deposit'] != null) {
+            formParams.append('is_external_deposit', requestParameters['is_external_deposit'] as any);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/createIntentAddress`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateIntentAddressRespFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a bridge intent address for CCTP bridge
+     * createIntentAddress
+     */
+    async createIntentAddress(requestParameters: CreateIntentAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateIntentAddressResp> {
+        const response = await this.createIntentAddressRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Cancel bridge deposit
+     * deposit_cancel
+     */
+    async depositCancelRaw(requestParameters: DepositCancelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResultCode>> {
+        if (requestParameters['from_addr'] == null) {
+            throw new runtime.RequiredError(
+                'from_addr',
+                'Required parameter "from_addr" was null or undefined when calling depositCancel().'
+            );
+        }
+
+        if (requestParameters['chain_id'] == null) {
+            throw new runtime.RequiredError(
+                'chain_id',
+                'Required parameter "chain_id" was null or undefined when calling depositCancel().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['from_addr'] != null) {
+            formParams.append('from_addr', requestParameters['from_addr'] as any);
+        }
+
+        if (requestParameters['chain_id'] != null) {
+            formParams.append('chain_id', requestParameters['chain_id'] as any);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/deposit/cancel`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ResultCodeFromJSON(jsonValue));
+    }
+
+    /**
+     * Cancel bridge deposit
+     * deposit_cancel
+     */
+    async depositCancel(requestParameters: DepositCancelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResultCode> {
+        const response = await this.depositCancelRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get deposit history
+     * deposit_history
+     */
+    async depositHistoryRaw(requestParameters: DepositHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DepositHistory>> {
+        if (requestParameters['l1_address'] == null) {
+            throw new runtime.RequiredError(
+                'l1_address',
+                'Required parameter "l1_address" was null or undefined when calling depositHistory().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['l1_address'] != null) {
+            queryParameters['l1_address'] = requestParameters['l1_address'];
+        }
+
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/deposit/history`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DepositHistoryFromJSON(jsonValue));
+    }
+
+    /**
+     * Get deposit history
+     * deposit_history
+     */
+    async depositHistory(requestParameters: DepositHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DepositHistory> {
+        const response = await this.depositHistoryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get most recent deposit for given l1 address
+     * deposit_latest
+     */
+    async depositLatestRaw(requestParameters: DepositLatestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Deposit>> {
+        if (requestParameters['l1_address'] == null) {
+            throw new runtime.RequiredError(
+                'l1_address',
+                'Required parameter "l1_address" was null or undefined when calling depositLatest().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['l1_address'] != null) {
+            queryParameters['l1_address'] = requestParameters['l1_address'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/deposit/latest`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DepositFromJSON(jsonValue));
+    }
+
+    /**
+     * Get most recent deposit for given l1 address
+     * deposit_latest
+     */
+    async depositLatest(requestParameters: DepositLatestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Deposit> {
+        const response = await this.depositLatestRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get deposit supporting networks
+     * deposit_networks
+     */
+    async depositNetworksRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BridgeSupportedNetworks>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/deposit/networks`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => BridgeSupportedNetworksFromJSON(jsonValue));
+    }
+
+    /**
+     * Get deposit supporting networks
+     * deposit_networks
+     */
+    async depositNetworks(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BridgeSupportedNetworks> {
+        const response = await this.depositNetworksRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get withdraw history
+     * withdraw_history
+     */
+    async withdrawHistoryRaw(requestParameters: WithdrawHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WithdrawHistory>> {
+        if (requestParameters['l1_address'] == null) {
+            throw new runtime.RequiredError(
+                'l1_address',
+                'Required parameter "l1_address" was null or undefined when calling withdrawHistory().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['l1_address'] != null) {
+            queryParameters['l1_address'] = requestParameters['l1_address'];
+        }
+
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/withdraw/history`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => WithdrawHistoryFromJSON(jsonValue));
+    }
+
+    /**
+     * Get withdraw history
+     * withdraw_history
+     */
+    async withdrawHistory(requestParameters: WithdrawHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WithdrawHistory> {
+        const response = await this.withdrawHistoryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/apis/RootApi.ts

@@ -17,12 +17,15 @@ import * as runtime from '../runtime';
 import type {
   ResultCode,
   Status,
+  ZkLighterInfo,
 } from '../models/index';
 import {
     ResultCodeFromJSON,
     ResultCodeToJSON,
     StatusFromJSON,
     StatusToJSON,
+    ZkLighterInfoFromJSON,
+    ZkLighterInfoToJSON,
 } from '../models/index';
 
 /**
@@ -30,6 +33,34 @@ import {
  */
 export class RootApi extends runtime.BaseAPI {
 
+    /**
+     * Get info of zklighter
+     * info
+     */
+    async infoRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZkLighterInfo>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/info`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ZkLighterInfoFromJSON(jsonValue));
+    }
+
+    /**
+     * Get info of zklighter
+     * info
+     */
+    async info(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZkLighterInfo> {
+        const response = await this.infoRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get status of zklighter
      * status

package/apis/index.ts

@@ -2,6 +2,7 @@
 /* eslint-disable */
 export * from './AccountApi';
 export * from './BlockApi';
+export * from './BridgeApi';
 export * from './CandlestickApi';
 export * from './InfoApi';
 export * from './LiquidationApi';

package/models/BridgeSupportedNetwork.ts

@@ -0,0 +1,88 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface BridgeSupportedNetwork
+ */
+export interface BridgeSupportedNetwork {
+    /**
+     * 
+     * @type {string}
+     * @memberof BridgeSupportedNetwork
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof BridgeSupportedNetwork
+     */
+    chain_id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof BridgeSupportedNetwork
+     */
+    explorer: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof BridgeSupportedNetwork
+     */
+    is_cex: boolean;
+}
+
+/**
+ * Check if a given object implements the BridgeSupportedNetwork interface.
+ */
+export function instanceOfBridgeSupportedNetwork(value: object): value is BridgeSupportedNetwork {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('chain_id' in value) || value['chain_id'] === undefined) return false;
+    if (!('explorer' in value) || value['explorer'] === undefined) return false;
+    if (!('is_cex' in value) || value['is_cex'] === undefined) return false;
+    return true;
+}
+
+export function BridgeSupportedNetworkFromJSON(json: any): BridgeSupportedNetwork {
+    return BridgeSupportedNetworkFromJSONTyped(json, false);
+}
+
+export function BridgeSupportedNetworkFromJSONTyped(json: any, ignoreDiscriminator: boolean): BridgeSupportedNetwork {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'chain_id': json['chain_id'],
+        'explorer': json['explorer'],
+        'is_cex': json['is_cex'],
+    };
+}
+
+export function BridgeSupportedNetworkToJSON(value?: BridgeSupportedNetwork | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'name': value['name'],
+        'chain_id': value['chain_id'],
+        'explorer': value['explorer'],
+        'is_cex': value['is_cex'],
+    };
+}
+

package/models/BridgeSupportedNetworks.ts

@@ -0,0 +1,85 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { BridgeSupportedNetwork } from './BridgeSupportedNetwork';
+import {
+    BridgeSupportedNetworkFromJSON,
+    BridgeSupportedNetworkFromJSONTyped,
+    BridgeSupportedNetworkToJSON,
+} from './BridgeSupportedNetwork';
+
+/**
+ * 
+ * @export
+ * @interface BridgeSupportedNetworks
+ */
+export interface BridgeSupportedNetworks {
+    /**
+     * 
+     * @type {number}
+     * @memberof BridgeSupportedNetworks
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof BridgeSupportedNetworks
+     */
+    message?: string;
+    /**
+     * 
+     * @type {Array<BridgeSupportedNetwork>}
+     * @memberof BridgeSupportedNetworks
+     */
+    networks: Array<BridgeSupportedNetwork>;
+}
+
+/**
+ * Check if a given object implements the BridgeSupportedNetworks interface.
+ */
+export function instanceOfBridgeSupportedNetworks(value: object): value is BridgeSupportedNetworks {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('networks' in value) || value['networks'] === undefined) return false;
+    return true;
+}
+
+export function BridgeSupportedNetworksFromJSON(json: any): BridgeSupportedNetworks {
+    return BridgeSupportedNetworksFromJSONTyped(json, false);
+}
+
+export function BridgeSupportedNetworksFromJSONTyped(json: any, ignoreDiscriminator: boolean): BridgeSupportedNetworks {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'networks': ((json['networks'] as Array<any>).map(BridgeSupportedNetworkFromJSON)),
+    };
+}
+
+export function BridgeSupportedNetworksToJSON(value?: BridgeSupportedNetworks | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'networks': ((value['networks'] as Array<any>).map(BridgeSupportedNetworkToJSON)),
+    };
+}
+