zklighter-perps 1.0.340 → 1.0.342

package/openapi.json

@@ -1355,6 +1355,92 @@
         "description": "Platform-wide competitions (not guild-scoped), newest first; competition_id narrows to one (any scope)"
       }
     },
+    "/api/v1/connectX": {
+      "post": {
+        "summary": "connectX",
+        "operationId": "connectX",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/RespConnectX"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/ReqConnectX"
+            }
+          }
+        ],
+        "tags": [
+          "account"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Start connecting an X account to the wallet: returns the X OAuth authorize URL (PKCE). redirect_uri must be allowlisted."
+      }
+    },
+    "/api/v1/connectXCallback": {
+      "post": {
+        "summary": "connectXCallback",
+        "operationId": "connectXCallback",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/RespConnectXCallback"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/ReqConnectXCallback"
+            }
+          }
+        ],
+        "tags": [
+          "account"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Finish connecting an X account with the code and state X returned to redirect_uri"
+      }
+    },
     "/api/v1/createIntentAddress": {
       "post": {
         "summary": "createIntentAddress",
@@ -1548,6 +1634,49 @@
         "description": "Get deposit supporting networks"
       }
     },
+    "/api/v1/disconnectX": {
+      "post": {
+        "summary": "disconnectX",
+        "operationId": "disconnectX",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/ReqDisconnectX"
+            }
+          }
+        ],
+        "tags": [
+          "account"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Disconnect the wallet's X account"
+      }
+    },
     "/api/v1/event/create": {
       "post": {
         "summary": "event_create",
@@ -5601,6 +5730,42 @@
         "description": "Get public pools metadata"
       }
     },
+    "/api/v1/publicProfiles": {
+      "get": {
+        "summary": "publicProfiles",
+        "operationId": "publicProfiles",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/RespGetPublicProfiles"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "l1_addresses",
+            "description": " comma-separated, max 100",
+            "in": "query",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "account"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get public profiles (display name source, username, verified X handle) for up to 100 L1 addresses. No auth."
+      }
+    },
     "/api/v1/pushnotif/register": {
       "post": {
         "summary": "pushnotif_register",
@@ -8489,6 +8654,10 @@
         "instance": {
           "type": "string",
           "description": " non-core instance the l1 address belongs to, e.g. \"us\""
+        },
+        "profile": {
+          "$ref": "#/definitions/PublicProfile",
+          "description": " wallet-level public identity, set on the master account only"
         }
       },
       "title": "AccountMetadata",
@@ -8503,7 +8672,8 @@
         "agent_enabled",
         "created_at",
         "metadata",
-        "instance"
+        "instance",
+        "profile"
       ]
     },
     "AccountMetadatas": {
@@ -10586,6 +10756,10 @@
           "type": "string",
           "description": " non-core instance the l1 address belongs to, e.g. \"us\""
         },
+        "profile": {
+          "$ref": "#/definitions/PublicProfile",
+          "description": " wallet-level public identity, set on the master account only"
+        },
         "positions": {
           "type": "array",
           "items": {
@@ -10667,6 +10841,7 @@
         "created_at",
         "metadata",
         "instance",
+        "profile",
         "positions",
         "assets",
         "total_asset_value",
@@ -11847,6 +12022,9 @@
         "volume": {
           "type": "integer",
           "format": "int64"
+        },
+        "profile": {
+          "$ref": "#/definitions/PublicProfile"
         }
       },
       "title": "GuildDuelMemberScore",
@@ -11856,7 +12034,8 @@
         "pnl",
         "capital",
         "roi",
-        "volume"
+        "volume",
+        "profile"
       ]
     },
     "GuildDuelOffer": {
@@ -12047,13 +12226,17 @@
         },
         "selected_by_l1": {
           "type": "string"
+        },
+        "profile": {
+          "$ref": "#/definitions/PublicProfile"
         }
       },
       "title": "GuildDuelRosterMember",
       "required": [
         "l1_address",
         "guild_id",
-        "selected_by_l1"
+        "selected_by_l1",
+        "profile"
       ]
     },
     "GuildDuelScore": {
@@ -12108,6 +12291,9 @@
         },
         "stake_tx_hash": {
           "type": "string"
+        },
+        "leader_profile": {
+          "$ref": "#/definitions/PublicProfile"
         }
       },
       "title": "GuildDuelSide",
@@ -12118,7 +12304,8 @@
         "roster_size",
         "roster_locked_at",
         "stake_status",
-        "stake_tx_hash"
+        "stake_tx_hash",
+        "leader_profile"
       ]
     },
     "GuildDuelStakeInfo": {
@@ -12229,6 +12416,9 @@
         },
         "redeemed_by_l1": {
           "type": "string"
+        },
+        "bound_profile": {
+          "$ref": "#/definitions/PublicProfile"
         }
       },
       "title": "GuildInviteCode",
@@ -12239,7 +12429,8 @@
         "created_by_l1",
         "status",
         "created_at",
-        "expires_at"
+        "expires_at",
+        "bound_profile"
       ]
     },
     "GuildJoinRequest": {
@@ -12272,6 +12463,9 @@
         "expires_at": {
           "type": "integer",
           "format": "int64"
+        },
+        "profile": {
+          "$ref": "#/definitions/PublicProfile"
         }
       },
       "title": "GuildJoinRequest",
@@ -12283,7 +12477,8 @@
         "status",
         "source",
         "created_at",
-        "expires_at"
+        "expires_at",
+        "profile"
       ]
     },
     "GuildLeaderboardEntry": {
@@ -12385,6 +12580,9 @@
         "duel_opt_in": {
           "type": "boolean",
           "format": "boolean"
+        },
+        "profile": {
+          "$ref": "#/definitions/PublicProfile"
         }
       },
       "title": "GuildMember",
@@ -12392,7 +12590,8 @@
         "l1_address",
         "role",
         "joined_at",
-        "duel_opt_in"
+        "duel_opt_in",
+        "profile"
       ]
     },
     "GuildPnlStats": {
@@ -15714,6 +15913,43 @@
         "entry_timestamp"
       ]
     },
+    "PublicProfile": {
+      "type": "object",
+      "properties": {
+        "l1_address": {
+          "type": "string"
+        },
+        "username": {
+          "type": "string"
+        },
+        "display_name_source": {
+          "type": "string",
+          "enum": [
+            "address",
+            "username",
+            "ens",
+            "x"
+          ],
+          "description": " ens is resolved by the client from l1_address on chain 1"
+        },
+        "x_user_id": {
+          "type": "string",
+          "description": " verified through X OAuth; link by id, the handle can change hands after a rename"
+        },
+        "x_handle": {
+          "type": "string",
+          "description": " as of connecting"
+        }
+      },
+      "title": "PublicProfile",
+      "required": [
+        "l1_address",
+        "username",
+        "display_name_source",
+        "x_user_id",
+        "x_handle"
+      ]
+    },
     "PushNotifDeliveryResult": {
       "type": "object",
       "properties": {
@@ -16223,6 +16459,50 @@
         "new_tier"
       ]
     },
+    "ReqConnectX": {
+      "type": "object",
+      "properties": {
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "redirect_uri": {
+          "type": "string"
+        },
+        "auth": {
+          "type": "string"
+        }
+      },
+      "title": "ReqConnectX",
+      "required": [
+        "account_index",
+        "redirect_uri"
+      ]
+    },
+    "ReqConnectXCallback": {
+      "type": "object",
+      "properties": {
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "code": {
+          "type": "string"
+        },
+        "state": {
+          "type": "string"
+        },
+        "auth": {
+          "type": "string"
+        }
+      },
+      "title": "ReqConnectXCallback",
+      "required": [
+        "account_index",
+        "code",
+        "state"
+      ]
+    },
     "ReqCreateAirdropAllocations": {
       "type": "object",
       "properties": {
@@ -16489,6 +16769,22 @@
         "id"
       ]
     },
+    "ReqDisconnectX": {
+      "type": "object",
+      "properties": {
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "auth": {
+          "type": "string"
+        }
+      },
+      "title": "ReqDisconnectX",
+      "required": [
+        "account_index"
+      ]
+    },
     "ReqDoFaucet": {
       "type": "object",
       "properties": {
@@ -18248,6 +18544,19 @@
         "limit"
       ]
     },
+    "ReqGetPublicProfiles": {
+      "type": "object",
+      "properties": {
+        "l1_addresses": {
+          "type": "string",
+          "description": " comma-separated, max 100"
+        }
+      },
+      "title": "ReqGetPublicProfiles",
+      "required": [
+        "l1_addresses"
+      ]
+    },
     "ReqGetPushNotifSettings": {
       "type": "object",
       "properties": {
@@ -19856,6 +20165,52 @@
         "code"
       ]
     },
+    "RespConnectX": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "authorize_url": {
+          "type": "string"
+        }
+      },
+      "title": "RespConnectX",
+      "required": [
+        "code",
+        "authorize_url"
+      ]
+    },
+    "RespConnectXCallback": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "x_user_id": {
+          "type": "string"
+        },
+        "x_handle": {
+          "type": "string"
+        }
+      },
+      "title": "RespConnectXCallback",
+      "required": [
+        "code",
+        "x_user_id",
+        "x_handle"
+      ]
+    },
     "RespCreateEvent": {
       "type": "object",
       "properties": {
@@ -20564,6 +20919,31 @@
         "metrics"
       ]
     },
+    "RespGetPublicProfiles": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "profiles": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PublicProfile"
+          },
+          "description": " only wallets with a profile set"
+        }
+      },
+      "title": "RespGetPublicProfiles",
+      "required": [
+        "code",
+        "profiles"
+      ]
+    },
     "RespGetPushNotifSettings": {
       "type": "object",
       "properties": {
@@ -24331,6 +24711,26 @@
           "type": "integer",
           "format": "int64",
           "example": "0"
+        },
+        "twap_fee_ticks": {
+          "type": "integer",
+          "format": "int32",
+          "example": "0"
+        },
+        "taker_latency_ms": {
+          "type": "integer",
+          "format": "int32",
+          "example": "140"
+        },
+        "send_tx_rate_limit": {
+          "type": "integer",
+          "format": "int64",
+          "example": "4000"
+        },
+        "max_sub_accounts": {
+          "type": "integer",
+          "format": "int32",
+          "example": "64"
         }
       },
       "title": "UserFeeTier",
@@ -24340,7 +24740,11 @@
         "maker_fee_ticks",
         "taker_fee_ticks",
         "required_lit_stakes",
-        "required_volume"
+        "required_volume",
+        "twap_fee_ticks",
+        "taker_latency_ms",
+        "send_tx_rate_limit",
+        "max_sub_accounts"
       ]
     },
     "UserReferrals": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zklighter-perps",
-  "version": "1.0.340",
+  "version": "1.0.342",
   "description": "Lighter Perps SDK",
   "main": "index.ts",
   "directories": {