zklighter-perps 1.0.32 → 1.0.34

package/openapi.json

@@ -871,43 +871,6 @@
         "description": "Get fundings"
       }
     },
-    "/api/v1/l2Signature": {
-      "post": {
-        "summary": "l2Signature",
-        "operationId": "l2Signature",
-        "responses": {
-          "200": {
-            "description": "A successful response.",
-            "schema": {
-              "$ref": "#/definitions/SignBody"
-            }
-          },
-          "400": {
-            "description": "Bad request",
-            "schema": {
-              "$ref": "#/definitions/ResultCode"
-            }
-          }
-        },
-        "parameters": [
-          {
-            "name": "body",
-            "in": "body",
-            "required": true,
-            "schema": {
-              "$ref": "#/definitions/ReqSendTx"
-            }
-          }
-        ],
-        "tags": [
-          "transaction"
-        ],
-        "consumes": [
-          "multipart/form-data"
-        ],
-        "description": "Get transaction signature body"
-      }
-    },
     "/api/v1/layer1BasicInfo": {
       "get": {
         "summary": "layer1BasicInfo",
@@ -1321,6 +1284,51 @@
         "description": "Get account PnL chart"
       }
     },
+    "/api/v1/publicPools": {
+      "get": {
+        "summary": "publicPools",
+        "operationId": "publicPools",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/PublicPools"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "index",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int64"
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int64",
+            "minimum": 1,
+            "maximum": 100
+          }
+        ],
+        "tags": [
+          "account"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get public pools"
+      }
+    },
     "/api/v1/recentTrades": {
       "get": {
         "summary": "recentTrades",
@@ -1420,15 +1428,15 @@
         "description": "Get rollbacks"
       }
     },
-    "/api/v1/search": {
-      "get": {
-        "summary": "search",
-        "operationId": "search",
+    "/api/v1/sendTx": {
+      "post": {
+        "summary": "sendTx",
+        "operationId": "sendTx",
         "responses": {
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/Search"
+              "$ref": "#/definitions/TxHash"
             }
           },
           "400": {
@@ -1440,30 +1448,32 @@
         },
         "parameters": [
           {
-            "name": "keyword",
-            "in": "query",
+            "name": "body",
+            "in": "body",
             "required": true,
-            "type": "string"
+            "schema": {
+              "$ref": "#/definitions/ReqSendTx"
+            }
           }
         ],
         "tags": [
-          "info"
+          "transaction"
         ],
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "Search with a specific keyword"
+        "description": "You need to sign the transaction body before sending it to the server. More details can be found in the Get Started docs: [Get Started For Programmers](https://apidocs.lighter.xyz/docs/get-started-for-programmers)"
       }
     },
-    "/api/v1/sendTx": {
+    "/api/v1/sendTxBatch": {
       "post": {
-        "summary": "sendTx",
-        "operationId": "sendTx",
+        "summary": "sendTxBatch",
+        "operationId": "sendTxBatch",
         "responses": {
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/TxHash"
+              "$ref": "#/definitions/TxHashes"
             }
           },
           "400": {
@@ -1479,7 +1489,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "$ref": "#/definitions/ReqSendTx"
+              "$ref": "#/definitions/ReqSendTxBatch"
             }
           }
         ],
@@ -1492,15 +1502,15 @@
         "description": "You need to sign the transaction body before sending it to the server. More details can be found in the Get Started docs: [Get Started For Programmers](https://apidocs.lighter.xyz/docs/get-started-for-programmers)"
       }
     },
-    "/api/v1/sendTxBatch": {
+    "/api/v1/setAccountMetadata": {
       "post": {
-        "summary": "sendTxBatch",
-        "operationId": "sendTxBatch",
+        "summary": "setAccountMetadata",
+        "operationId": "setAccountMetadata",
         "responses": {
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/TxHashes"
+              "$ref": "#/definitions/ResultCode"
             }
           },
           "400": {
@@ -1516,7 +1526,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "$ref": "#/definitions/ReqSendTxBatch"
+              "$ref": "#/definitions/ReqSetAccountMetadata"
             }
           }
         ],
@@ -1526,7 +1536,7 @@
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "You need to sign the transaction body before sending it to the server. More details can be found in the Get Started docs: [Get Started For Programmers](https://apidocs.lighter.xyz/docs/get-started-for-programmers)"
+        "description": "Set account metadata"
       }
     },
     "/api/v1/trades": {
@@ -1851,6 +1861,22 @@
         "open_position_quote"
       ]
     },
+    "AccountMetadata": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        }
+      },
+      "title": "AccountMetadata",
+      "required": [
+        "name",
+        "description"
+      ]
+    },
     "AccountPnL": {
       "type": "object",
       "properties": {
@@ -2300,6 +2326,12 @@
           "type": "string",
           "example": "46342"
         },
+        "name": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
         "positions": {
           "type": "array",
           "items": {
@@ -2316,6 +2348,9 @@
             "$ref": "#/definitions/AccountMarketStats"
           }
         },
+        "pool_info": {
+          "$ref": "#/definitions/PublicPoolInfo"
+        },
         "shares": {
           "type": "array",
           "items": {
@@ -2333,9 +2368,12 @@
         "open_order_count",
         "status",
         "collateral",
+        "name",
+        "description",
         "positions",
         "total_asset_value",
         "market_stats",
+        "pool_info",
         "shares"
       ]
     },
@@ -3468,6 +3506,113 @@
         "size"
       ]
     },
+    "PublicPool": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "100"
+        },
+        "message": {
+          "type": "string"
+        },
+        "account_type": {
+          "type": "integer",
+          "format": "uint8",
+          "example": "1"
+        },
+        "index": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1"
+        },
+        "l1_address": {
+          "type": "string",
+          "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
+        },
+        "cancel_all_time": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1640995200"
+        },
+        "open_order_count": {
+          "type": "integer",
+          "format": "int64",
+          "example": "100"
+        },
+        "status": {
+          "type": "integer",
+          "format": "int32",
+          "example": "1"
+        },
+        "collateral": {
+          "type": "string",
+          "example": "46342"
+        },
+        "name": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "pool_info": {
+          "$ref": "#/definitions/PublicPoolInfo"
+        }
+      },
+      "title": "PublicPool",
+      "required": [
+        "code",
+        "account_type",
+        "index",
+        "l1_address",
+        "cancel_all_time",
+        "open_order_count",
+        "status",
+        "collateral",
+        "name",
+        "description",
+        "pool_info"
+      ]
+    },
+    "PublicPoolInfo": {
+      "type": "object",
+      "properties": {
+        "ppi_s": {
+          "type": "integer",
+          "format": "uint8",
+          "example": "0"
+        },
+        "ppi_of": {
+          "type": "integer",
+          "format": "int64",
+          "example": "100"
+        },
+        "ppi_mosr": {
+          "type": "integer",
+          "format": "int64",
+          "example": "200"
+        },
+        "ppi_tsa": {
+          "type": "integer",
+          "format": "int64",
+          "example": "100000"
+        },
+        "ppi_os": {
+          "type": "integer",
+          "format": "int64",
+          "example": "20000"
+        }
+      },
+      "title": "PublicPoolInfo",
+      "required": [
+        "ppi_s",
+        "ppi_of",
+        "ppi_mosr",
+        "ppi_tsa",
+        "ppi_os"
+      ]
+    },
     "PublicPoolShare": {
       "type": "object",
       "properties": {
@@ -3493,6 +3638,30 @@
         "entry_usdc"
       ]
     },
+    "PublicPools": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "100"
+        },
+        "message": {
+          "type": "string"
+        },
+        "public_pools": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PublicPool"
+          }
+        }
+      },
+      "title": "PublicPools",
+      "required": [
+        "code",
+        "public_pools"
+      ]
+    },
     "ReqDoFaucet": {
       "type": "object",
       "properties": {
@@ -3989,6 +4158,26 @@
         "tx_type"
       ]
     },
+    "ReqGetPublicPools": {
+      "type": "object",
+      "properties": {
+        "index": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "limit": {
+          "type": "integer",
+          "format": "int64",
+          "maximum": 100,
+          "minimum": 1
+        }
+      },
+      "title": "ReqGetPublicPools",
+      "required": [
+        "index",
+        "limit"
+      ]
+    },
     "ReqGetRangeWithCursor": {
       "type": "object",
       "properties": {
@@ -4184,18 +4373,6 @@
         "signature"
       ]
     },
-    "ReqSearch": {
-      "type": "object",
-      "properties": {
-        "keyword": {
-          "type": "string"
-        }
-      },
-      "title": "ReqSearch",
-      "required": [
-        "keyword"
-      ]
-    },
     "ReqSendTx": {
       "type": "object",
       "properties": {
@@ -4229,6 +4406,32 @@
         "tx_infos"
       ]
     },
+    "ReqSetAccountMetadata": {
+      "type": "object",
+      "properties": {
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "api_key_index": {
+          "type": "integer",
+          "format": "uint8"
+        },
+        "metadata": {
+          "type": "string"
+        },
+        "signature": {
+          "type": "string"
+        }
+      },
+      "title": "ReqSetAccountMetadata",
+      "required": [
+        "account_index",
+        "api_key_index",
+        "metadata",
+        "signature"
+      ]
+    },
     "ResultCode": {
       "type": "object",
       "properties": {
@@ -4308,51 +4511,6 @@
         "rollbacks"
       ]
     },
-    "Search": {
-      "type": "object",
-      "properties": {
-        "code": {
-          "type": "integer",
-          "format": "int32",
-          "example": "100"
-        },
-        "message": {
-          "type": "string"
-        },
-        "data_type": {
-          "type": "integer",
-          "format": "int32",
-          "example": "1"
-        }
-      },
-      "title": "Search",
-      "required": [
-        "code",
-        "data_type"
-      ]
-    },
-    "SignBody": {
-      "type": "object",
-      "properties": {
-        "code": {
-          "type": "integer",
-          "format": "int32",
-          "example": "100"
-        },
-        "message": {
-          "type": "string"
-        },
-        "sign_body": {
-          "type": "string",
-          "example": "success"
-        }
-      },
-      "title": "SignBody",
-      "required": [
-        "code",
-        "sign_body"
-      ]
-    },
     "SimpleOrder": {
       "type": "object",
       "properties": {

package/package.json

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