zklighter-perps 1.0.72 → 1.0.74

package/openapi.json

@@ -739,6 +739,43 @@
         "description": "Get candlesticks"
       }
     },
+    "/api/v1/createIntentAddress": {
+      "post": {
+        "summary": "createIntentAddress",
+        "operationId": "createIntentAddress",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/CreateIntentAddressResp"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/ReqCreateIntentAddress"
+            }
+          }
+        ],
+        "tags": [
+          "bridge"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Create a bridge intent address for CCTP bridge"
+      }
+    },
     "/api/v1/currentHeight": {
       "get": {
         "summary": "currentHeight",
@@ -763,6 +800,143 @@
         "description": "Get current height"
       }
     },
+    "/api/v1/deposit/cancel": {
+      "post": {
+        "summary": "deposit_cancel",
+        "operationId": "deposit_cancel",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/ReqCancelDeposit"
+            }
+          }
+        ],
+        "tags": [
+          "bridge"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Cancel bridge deposit"
+      }
+    },
+    "/api/v1/deposit/history": {
+      "get": {
+        "summary": "deposit_history",
+        "operationId": "deposit_history",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/DepositHistory"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "l1_address",
+            "in": "query",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "cursor",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "bridge"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get deposit history"
+      }
+    },
+    "/api/v1/deposit/latest": {
+      "get": {
+        "summary": "deposit_latest",
+        "operationId": "deposit_latest",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/Deposit"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "l1_address",
+            "in": "query",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "bridge"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get most recent deposit for given l1 address"
+      }
+    },
+    "/api/v1/deposit/networks": {
+      "get": {
+        "summary": "deposit_networks",
+        "operationId": "deposit_networks",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/BridgeSupportedNetworks"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "tags": [
+          "bridge"
+        ],
+        "description": "Get deposit supporting networks"
+      }
+    },
     "/api/v1/exchangeStats": {
       "get": {
         "summary": "exchangeStats",
@@ -1820,6 +1994,71 @@
         ],
         "description": "Get transactions which are already packed into blocks"
       }
+    },
+    "/api/v1/withdraw/history": {
+      "get": {
+        "summary": "withdraw_history",
+        "operationId": "withdraw_history",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/WithdrawHistory"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "l1_address",
+            "in": "query",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "cursor",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "bridge"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get withdraw history"
+      }
+    },
+    "/info": {
+      "get": {
+        "summary": "info",
+        "operationId": "info",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/ZkLighterInfo"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "tags": [
+          "root"
+        ],
+        "description": "Get info of zklighter"
+      }
     }
   },
   "definitions": {
@@ -2251,6 +2490,59 @@
         "blocks"
       ]
     },
+    "BridgeSupportedNetwork": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "example": "Arbitrum"
+        },
+        "chain_id": {
+          "type": "string",
+          "example": "4164"
+        },
+        "explorer": {
+          "type": "string",
+          "example": "https://arbiscan.io/"
+        },
+        "is_cex": {
+          "type": "boolean",
+          "format": "boolean",
+          "example": "false"
+        }
+      },
+      "title": "BridgeSupportedNetwork",
+      "required": [
+        "name",
+        "chain_id",
+        "explorer",
+        "is_cex"
+      ]
+    },
+    "BridgeSupportedNetworks": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "networks": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/BridgeSupportedNetwork"
+          }
+        }
+      },
+      "title": "BridgeSupportedNetworks",
+      "required": [
+        "code",
+        "networks"
+      ]
+    },
     "Candlestick": {
       "type": "object",
       "properties": {
@@ -2354,6 +2646,27 @@
         "address"
       ]
     },
+    "CreateIntentAddressResp": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "intent_address": {
+          "type": "string"
+        }
+      },
+      "title": "CreateIntentAddressResp",
+      "required": [
+        "code",
+        "intent_address"
+      ]
+    },
     "CurrentHeight": {
       "type": "object",
       "properties": {
@@ -2385,6 +2698,114 @@
       },
       "title": "Cursor"
     },
+    "Deposit": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "source": {
+          "type": "string",
+          "example": "Arbitrum"
+        },
+        "amount": {
+          "type": "string"
+        },
+        "intent_address": {
+          "type": "string"
+        },
+        "status": {
+          "type": "string"
+        },
+        "step": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "created_at": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "updated_at": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "is_external_deposit": {
+          "type": "boolean",
+          "format": "boolean"
+        }
+      },
+      "title": "Deposit",
+      "required": [
+        "code",
+        "source",
+        "amount",
+        "intent_address",
+        "status",
+        "step",
+        "description",
+        "created_at",
+        "updated_at",
+        "is_external_deposit"
+      ]
+    },
+    "DepositHistory": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "deposits": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/DepositHistoryItem"
+          }
+        },
+        "cursor": {
+          "type": "string"
+        }
+      },
+      "title": "DepositHistory",
+      "required": [
+        "code",
+        "deposits",
+        "cursor"
+      ]
+    },
+    "DepositHistoryItem": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "amount": {
+          "type": "string",
+          "example": "0.1"
+        },
+        "timestamp": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1640995200"
+        }
+      },
+      "title": "DepositHistoryItem",
+      "required": [
+        "id",
+        "amount",
+        "timestamp"
+      ]
+    },
     "DetailedAccount": {
       "type": "object",
       "properties": {
@@ -4028,6 +4449,46 @@
         "public_pools"
       ]
     },
+    "ReqCancelDeposit": {
+      "type": "object",
+      "properties": {
+        "from_addr": {
+          "type": "string"
+        },
+        "chain_id": {
+          "type": "string"
+        }
+      },
+      "title": "ReqCancelDeposit",
+      "required": [
+        "from_addr",
+        "chain_id"
+      ]
+    },
+    "ReqCreateIntentAddress": {
+      "type": "object",
+      "properties": {
+        "chain_id": {
+          "type": "string"
+        },
+        "from_addr": {
+          "type": "string"
+        },
+        "amount": {
+          "type": "string"
+        },
+        "is_external_deposit": {
+          "type": "boolean",
+          "format": "boolean"
+        }
+      },
+      "title": "ReqCreateIntentAddress",
+      "required": [
+        "chain_id",
+        "from_addr",
+        "amount"
+      ]
+    },
     "ReqDoFaucet": {
       "type": "object",
       "properties": {
@@ -4380,6 +4841,21 @@
         "count_back"
       ]
     },
+    "ReqGetDepositHistory": {
+      "type": "object",
+      "properties": {
+        "l1_address": {
+          "type": "string"
+        },
+        "cursor": {
+          "type": "string"
+        }
+      },
+      "title": "ReqGetDepositHistory",
+      "required": [
+        "l1_address"
+      ]
+    },
     "ReqGetExchangeStats": {
       "type": "object",
       "title": "ReqGetExchangeStats"
@@ -4444,6 +4920,18 @@
         "hash"
       ]
     },
+    "ReqGetLatestDeposit": {
+      "type": "object",
+      "properties": {
+        "l1_address": {
+          "type": "string"
+        }
+      },
+      "title": "ReqGetLatestDeposit",
+      "required": [
+        "l1_address"
+      ]
+    },
     "ReqGetLeaderboard": {
       "type": "object",
       "properties": {
@@ -4705,6 +5193,21 @@
         "value"
       ]
     },
+    "ReqGetWithdrawHistory": {
+      "type": "object",
+      "properties": {
+        "l1_address": {
+          "type": "string"
+        },
+        "cursor": {
+          "type": "string"
+        }
+      },
+      "title": "ReqGetWithdrawHistory",
+      "required": [
+        "l1_address"
+      ]
+    },
     "ReqIsWhitelisted": {
       "type": "object",
       "properties": {
@@ -5246,6 +5749,70 @@
         "address",
         "is_active"
       ]
+    },
+    "WithdrawHistory": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "withdraws": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/WithdrawHistoryItem"
+          }
+        },
+        "cursor": {
+          "type": "string"
+        }
+      },
+      "title": "WithdrawHistory",
+      "required": [
+        "code",
+        "withdraws",
+        "cursor"
+      ]
+    },
+    "WithdrawHistoryItem": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "amount": {
+          "type": "string",
+          "example": "0.1"
+        },
+        "timestamp": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1640995200"
+        }
+      },
+      "title": "WithdrawHistoryItem",
+      "required": [
+        "id",
+        "amount",
+        "timestamp"
+      ]
+    },
+    "ZkLighterInfo": {
+      "type": "object",
+      "properties": {
+        "contract_address": {
+          "type": "string",
+          "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
+        }
+      },
+      "title": "ZkLighterInfo",
+      "required": [
+        "contract_address"
+      ]
     }
   },
   "securityDefinitions": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zklighter-perps",
-  "version": "1.0.72",
+  "version": "1.0.74",
   "description": "zkLighter Perps SDK",
   "main": "index.ts",
   "directories": {