zklighter-perps 1.0.28 → 1.0.30

package/openapi.json

@@ -17,8 +17,8 @@
   "paths": {
     "/": {
       "get": {
-        "summary": "GetStatus",
-        "operationId": "GetStatus",
+        "summary": "status",
+        "operationId": "status",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -41,8 +41,8 @@
     },
     "/api/v1/account": {
       "get": {
-        "summary": "GetAccount",
-        "operationId": "GetAccount",
+        "summary": "account",
+        "operationId": "account",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -81,13 +81,13 @@
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "Get account by account's l1_address or index. Returns detailed account info"
+        "description": "Get account by account's index. <br>More details about account index: [Account Index](https://apidocs.lighter.xyz/docs/account-index)<hr>**Response Description:**<br><br>1) **Status:** 1 is active 0 is inactive.<br>2) **Collateral:** The amount of collateral in the account.<hr>**Position Details Description:**<br>1) **OOC:** Open order count in that market.<br>2) **Sign:** 1 for Long, -1 for Short.<br>3) **Position:** The amount of position in that market.<br>4) **Avg Entry Price:** The average entry price of the position.<br>5) **Position Value:** The value of the position.<br>6) **Unrealized PnL:** The unrealized profit and loss of the position.<br>7) **Realized PnL:** The realized profit and loss of the position."
       }
     },
     "/api/v1/accountActiveOrders": {
       "get": {
-        "summary": "GetAccountActiveOrders",
-        "operationId": "GetAccountActiveOrders",
+        "summary": "accountActiveOrders",
+        "operationId": "accountActiveOrders",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -129,8 +129,8 @@
     },
     "/api/v1/accountInactiveOrders": {
       "get": {
-        "summary": "GetAccountInactiveOrders",
-        "operationId": "GetAccountInactiveOrders",
+        "summary": "accountInactiveOrders",
+        "operationId": "accountInactiveOrders",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -197,8 +197,8 @@
     },
     "/api/v1/accountOrders": {
       "get": {
-        "summary": "GetAccountOrders",
-        "operationId": "GetAccountOrders",
+        "summary": "accountOrders",
+        "operationId": "accountOrders",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -255,8 +255,8 @@
     },
     "/api/v1/accountPendingTxs": {
       "get": {
-        "summary": "GetAccountPendingTxs",
-        "operationId": "GetAccountPendingTxs",
+        "summary": "accountPendingTxs",
+        "operationId": "accountPendingTxs",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -306,8 +306,8 @@
     },
     "/api/v1/accountTxs": {
       "get": {
-        "summary": "GetAccountTxs",
-        "operationId": "GetAccountTxs",
+        "summary": "accountTxs",
+        "operationId": "accountTxs",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -373,8 +373,8 @@
     },
     "/api/v1/accounts": {
       "get": {
-        "summary": "GetAccounts",
-        "operationId": "GetAccounts",
+        "summary": "accounts",
+        "operationId": "accounts",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -429,8 +429,8 @@
     },
     "/api/v1/accountsByL1Address": {
       "get": {
-        "summary": "GetAccountsByL1Address",
-        "operationId": "GetAccountsByL1Address",
+        "summary": "accountsByL1Address",
+        "operationId": "accountsByL1Address",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -464,8 +464,8 @@
     },
     "/api/v1/apikeys": {
       "get": {
-        "summary": "GetAccountApiKeys",
-        "operationId": "GetAccountApiKeys",
+        "summary": "apikeys",
+        "operationId": "apikeys",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -507,8 +507,8 @@
     },
     "/api/v1/block": {
       "get": {
-        "summary": "GetBlock",
-        "operationId": "GetBlock",
+        "summary": "block",
+        "operationId": "block",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -552,8 +552,8 @@
     },
     "/api/v1/blockTxs": {
       "get": {
-        "summary": "GetBlockTxs",
-        "operationId": "GetBlockTxs",
+        "summary": "blockTxs",
+        "operationId": "blockTxs",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -597,8 +597,8 @@
     },
     "/api/v1/blocks": {
       "get": {
-        "summary": "GetBlocks",
-        "operationId": "GetBlocks",
+        "summary": "blocks",
+        "operationId": "blocks",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -653,8 +653,8 @@
     },
     "/api/v1/candlesticks": {
       "get": {
-        "summary": "GetCandlesticks",
-        "operationId": "GetCandlesticks",
+        "summary": "candlesticks",
+        "operationId": "candlesticks",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -724,7 +724,8 @@
     },
     "/api/v1/currentHeight": {
       "get": {
-        "operationId": "GetCurrentHeight",
+        "summary": "currentHeight",
+        "operationId": "currentHeight",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -742,13 +743,13 @@
         "tags": [
           "block"
         ],
-        "summary": "GetCurrentHeight"
+        "description": "Get current height"
       }
     },
     "/api/v1/exchangeStats": {
       "get": {
-        "summary": "GetExchangeStats",
-        "operationId": "GetExchangeStats",
+        "summary": "exchangeStats",
+        "operationId": "exchangeStats",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -771,8 +772,8 @@
     },
     "/api/v1/faucet": {
       "get": {
-        "summary": "DoFaucet",
-        "operationId": "DoFaucet",
+        "summary": "faucet",
+        "operationId": "faucet",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -806,8 +807,8 @@
     },
     "/api/v1/fundings": {
       "get": {
-        "summary": "GetFundings",
-        "operationId": "GetFundings",
+        "summary": "fundings",
+        "operationId": "fundings",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -872,8 +873,8 @@
     },
     "/api/v1/l2Signature": {
       "post": {
-        "summary": "GetL2SignatureBody",
-        "operationId": "GetL2SignatureBody",
+        "summary": "l2Signature",
+        "operationId": "l2Signature",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -909,8 +910,8 @@
     },
     "/api/v1/layer1BasicInfo": {
       "get": {
-        "summary": "GetLayer1BasicInfo",
-        "operationId": "GetLayer1BasicInfo",
+        "summary": "layer1BasicInfo",
+        "operationId": "layer1BasicInfo",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -933,8 +934,8 @@
     },
     "/api/v1/layer2BasicInfo": {
       "get": {
-        "summary": "GetLayer2BasicInfo",
-        "operationId": "GetLayer2BasicInfo",
+        "summary": "layer2BasicInfo",
+        "operationId": "layer2BasicInfo",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -957,8 +958,8 @@
     },
     "/api/v1/markNotifRead": {
       "get": {
-        "summary": "MarkNotifRead",
-        "operationId": "MarkNotifRead",
+        "summary": "markNotifRead",
+        "operationId": "markNotifRead",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -1013,13 +1014,13 @@
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "Mark"
+        "description": "Mark liquidation notification as read"
       }
     },
     "/api/v1/nextNonce": {
       "get": {
-        "summary": "GetNextNonce",
-        "operationId": "GetNextNonce",
+        "summary": "nextNonce",
+        "operationId": "nextNonce",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -1061,8 +1062,8 @@
     },
     "/api/v1/orderBookDetails": {
       "get": {
-        "summary": "GetOrderBookDetails",
-        "operationId": "GetOrderBookDetails",
+        "summary": "orderBookDetails",
+        "operationId": "orderBookDetails",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -1107,8 +1108,8 @@
     },
     "/api/v1/orderBookOrders": {
       "get": {
-        "summary": "GetOrderBookOrders",
-        "operationId": "GetOrderBookOrders",
+        "summary": "orderBookOrders",
+        "operationId": "orderBookOrders",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -1152,8 +1153,8 @@
     },
     "/api/v1/orderBooks": {
       "get": {
-        "summary": "GetOrderBooks",
-        "operationId": "GetOrderBooks",
+        "summary": "orderBooks",
+        "operationId": "orderBooks",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -1193,13 +1194,13 @@
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "Get order books metadata"
+        "description": "Get order books metadata.<hr>**Response Description:**<br><br>1) **Taker and maker fees** are in percentage.<br>2) **Min base amount:** The amount of base token that can be traded in a single order.<br>3) **Min quote amount:** The amount of quote token that can be traded in a single order.<br>4) **Supported size decimals:** The number of decimal places that can be used for the size of the order.<br>5) **Supported price decimals:** The number of decimal places that can be used for the price of the order.<br>6) **Supported quote decimals:** Size Decimals + Quote Decimals."
       }
     },
     "/api/v1/pendingTxs": {
       "get": {
-        "summary": "GetPendingTxs",
-        "operationId": "GetPendingTxs",
+        "summary": "pendingTxs",
+        "operationId": "pendingTxs",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -1241,62 +1242,10 @@
         "description": "Get pending transactions"
       }
     },
-    "/api/v1/permission": {
-      "get": {
-        "summary": "GetPermission",
-        "operationId": "GetPermission",
-        "responses": {
-          "200": {
-            "description": "A successful response.",
-            "schema": {
-              "$ref": "#/definitions/Permission"
-            }
-          },
-          "400": {
-            "description": "Bad request",
-            "schema": {
-              "$ref": "#/definitions/ResultCode"
-            }
-          }
-        },
-        "parameters": [
-          {
-            "name": "by",
-            "in": "query",
-            "required": true,
-            "type": "string",
-            "enum": [
-              "index",
-              "l1_address"
-            ]
-          },
-          {
-            "name": "value",
-            "in": "query",
-            "required": true,
-            "type": "string"
-          },
-          {
-            "name": "tx_type",
-            "in": "query",
-            "required": true,
-            "type": "integer",
-            "format": "uint8"
-          }
-        ],
-        "tags": [
-          "account"
-        ],
-        "consumes": [
-          "multipart/form-data"
-        ],
-        "description": "Get permission by account's l1_address, index and tx_type"
-      }
-    },
     "/api/v1/pnl": {
       "get": {
-        "summary": "GetAccountPnl",
-        "operationId": "GetAccountPnl",
+        "summary": "pnl",
+        "operationId": "pnl",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -1374,8 +1323,8 @@
     },
     "/api/v1/recentTrades": {
       "get": {
-        "summary": "GetRecentTrades",
-        "operationId": "GetRecentTrades",
+        "summary": "recentTrades",
+        "operationId": "recentTrades",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -1419,8 +1368,8 @@
     },
     "/api/v1/rollbacks": {
       "get": {
-        "summary": "GetRollbacks",
-        "operationId": "GetRollbacks",
+        "summary": "rollbacks",
+        "operationId": "rollbacks",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -1473,8 +1422,8 @@
     },
     "/api/v1/search": {
       "get": {
-        "summary": "Search",
-        "operationId": "Search",
+        "summary": "search",
+        "operationId": "search",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -1508,8 +1457,8 @@
     },
     "/api/v1/sendTx": {
       "post": {
-        "summary": "SendTx",
-        "operationId": "SendTx",
+        "summary": "sendTx",
+        "operationId": "sendTx",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -1540,13 +1489,13 @@
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "Send raw transaction"
+        "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": {
       "post": {
-        "summary": "SendTxBatch",
-        "operationId": "SendTxBatch",
+        "summary": "sendTxBatch",
+        "operationId": "sendTxBatch",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -1577,13 +1526,13 @@
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "Send multiple raw transactions"
+        "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/trades": {
       "get": {
-        "summary": "GetTrades",
-        "operationId": "GetTrades",
+        "summary": "trades",
+        "operationId": "trades",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -1652,8 +1601,8 @@
     },
     "/api/v1/tx": {
       "get": {
-        "summary": "GetTx",
-        "operationId": "GetTx",
+        "summary": "tx",
+        "operationId": "tx",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -1697,8 +1646,8 @@
     },
     "/api/v1/txFromL1TxHash": {
       "get": {
-        "summary": "getTxFromL1TxHash",
-        "operationId": "getTxFromL1TxHash",
+        "summary": "txFromL1TxHash",
+        "operationId": "txFromL1TxHash",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -1732,8 +1681,8 @@
     },
     "/api/v1/txs": {
       "get": {
-        "summary": "GetTxs",
-        "operationId": "GetTxs",
+        "summary": "txs",
+        "operationId": "txs",
         "responses": {
           "200": {
             "description": "A successful response.",

package/package.json

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