chore(): update package dependencies and add example for fetching futures contract size

Author: JJ-Cro

package-lock.json

@@ -43,15 +43,15 @@
   },
   "dependencies": {
     "@siebly/kraken-api": "^1.0.4",
-    "binance": "^3.3.1",
-    "bitget-api": "^3.1.3",
-    "bitmart-api": "^2.3.2",
-    "bybit-api": "^4.5.2",
-    "coinbase-api": "^1.1.10",
-    "gateio-api": "^1.4.1",
+    "binance": "^3.3.3",
+    "bitget-api": "^3.1.4",
+    "bitmart-api": "^2.3.3",
+    "bybit-api": "^4.5.3",
+    "coinbase-api": "^1.1.11",
+    "gateio-api": "^1.4.2",
     "https-proxy-agent": "latest",
-    "kucoin-api": "^2.4.1",
-    "okx-api": "^3.1.1",
+    "kucoin-api": "^2.5.0",
+    "okx-api": "^3.1.2",
     "socks-proxy-agent": "^8.0.5"
   }
 }

package.json

@@ -1103,6 +1103,13 @@
                   "code": "import { RestClient } from 'gateio-api';\n\n// Define the account object with API key and secret\nconst account = {\n  key: process.env.API_KEY || 'yourApiHere', // Replace 'yourApiHere' with your actual API key\n  secret: process.env.API_SECRET || 'yourSecretHere', // Replace 'yourSecretHere' with your actual API secret\n};\n\n// Initialize the RestClient with the API credentials\nconst gateRestClient = new RestClient({\n  apiKey: account.key,\n  apiSecret: account.secret,\n});\n\nasync function getFuturesBalances() {\n  try {\n    console.log('Using API keys:', account);\n\n    // Fetch the futures account balance for USDT settlement\n    const result = await gateRestClient.getFuturesAccount({ settle: 'usdt' });\n\n    console.log('Response: ', result); // Log the response to the console\n  } catch (e) {\n    console.error('Error in execution: ', e); // Log any errors that occur\n  }\n}\n\n// Execute the function to get futures balances\ngetFuturesBalances();\n",
                   "metadata": {}
                 },
+                {
+                  "type": "file",
+                  "name": "getContractSize.ts",
+                  "path": "examples/Gate/Rest/futures/getContractSize.ts",
+                  "code": "/**\n * Example: Get futures contract size (quanto_multiplier) and convert between\n * notional (e.g. USDT) and order size in contracts.\n *\n * Gate.io futures orders use `size` = number of CONTRACTS, not currency amount.\n * The contract details endpoint returns `quanto_multiplier`: the amount of\n * underlying (e.g. BTC) that 1 contract represents. So:\n *   notional_in_settle = size * quanto_multiplier * price\n *   size = notional_in_settle / (quanto_multiplier * price)\n *\n * This example:\n * 1) Fetches contract with getFuturesContract\n * 2) Reads quanto_multiplier and derives \"contract size\" in quote currency\n * 3) Converts a desired notional (e.g. 1000 USDT) to order size in contracts\n */\n\nimport { RestClient } from 'gateio-api';\n\nconst client = new RestClient({\n  apiKey: process.env.API_KEY || 'your_api_key',\n  apiSecret: process.env.API_SECRET || 'your_api_secret',\n});\n\nconst SETTLE = 'usdt';\nconst CONTRACT = 'BTC_USDT';\n\nasync function getContractSizeExample() {\n  // 1) Get single contract (public, no auth required)\n  const contract = await client.getFuturesContract({\n    settle: SETTLE,\n    contract: CONTRACT,\n  });\n\n  const quantoMult = contract.quanto_multiplier;\n  const markPrice = contract.mark_price;\n  const orderSizeMin = Number(contract.order_size_min ?? 1);\n  const orderSizeMax =\n    contract.order_size_max != null ? Number(contract.order_size_max) : null;\n  const enableDecimal = contract.enable_decimal ?? false;\n\n  if (!quantoMult || !markPrice) {\n    throw new Error('Contract missing quanto_multiplier or mark_price');\n  }\n\n  const q = Number(quantoMult);\n  const p = Number(markPrice);\n\n  // 2) Contract size in quote (settle) currency: 1 contract = q * p\n  const notionalPerContract = q * p;\n  console.log('Contract:', CONTRACT);\n  console.log('quanto_multiplier (underlying per 1 contract):', quantoMult);\n  console.log('mark_price:', markPrice);\n  console.log('Notional per 1 contract (quote):', notionalPerContract);\n  console.log(\n    'order_size_min:',\n    orderSizeMin,\n    'order_size_max:',\n    orderSizeMax,\n    'enable_decimal:',\n    enableDecimal,\n  );\n\n  // 3) Convert desired notional (e.g. 1000 USDT) to size in contracts\n  const desiredNotionalUsdt = 1000;\n  let size = desiredNotionalUsdt / notionalPerContract;\n\n  if (!enableDecimal) {\n    size = Math.floor(size);\n  }\n  size = Math.max(orderSizeMin, size);\n  if (orderSizeMax != null) {\n    size = Math.min(orderSizeMax, size);\n  }\n\n  console.log('\\nDesired notional (USDT):', desiredNotionalUsdt);\n  console.log('Computed size (contracts):', size);\n  console.log(\n    'Actual notional (size * quanto_multiplier * mark_price):',\n    size * q * p,\n  );\n\n  // Example: you would pass this size to submitFuturesOrder\n  // await client.submitFuturesOrder({\n  //   settle: SETTLE,\n  //   contract: CONTRACT,\n  //   size: size,  // in contracts; positive = long, negative = short\n  //   price: markPrice,\n  //   tif: 'gtc',\n  // });\n}\n\ngetContractSizeExample().catch(console.error);\n",
+                  "metadata": {}
+                },
                 {
                   "type": "file",
                   "name": "getOrders.ts",

public/examples-index.json

@@ -28,26 +28,29 @@ async function buildFileTree(basePath: string): Promise<ExampleFolder> {
   const files: string[] = glob.sync(`${basePath}/**/*.ts`);
   const tree: ExampleFolder = {
     type: 'folder',
-    name: basePath,
-    path: basePath,
+    name: 'examples',
+    path: 'examples',
     children: [],
   };
 
   for (const filePath of files) {
-    const parts = filePath.split('/');
+    // Get relative path from basePath (examples directory)
+    const relativePath = path.relative(basePath, filePath);
+    const parts = relativePath.split(path.sep);
     let current = tree;
 
     // Create folder structure
-    for (let i = 1; i < parts.length - 1; i++) {
+    for (let i = 0; i < parts.length - 1; i++) {
       let folder = current.children.find(
         (child) => child.type === 'folder' && child.name === parts[i],
       ) as ExampleFolder;
 
       if (!folder) {
+        const folderPath = path.join('examples', ...parts.slice(0, i + 1));
         folder = {
           type: 'folder',
           name: parts[i],
-          path: parts.slice(0, i + 1).join('/'),
+          path: folderPath.replace(/\\/g, '/'), // Normalize to forward slashes
           children: [],
         };
         current.children.push(folder);
@@ -67,10 +70,11 @@ async function buildFileTree(basePath: string): Promise<ExampleFolder> {
         {},
       ) || {};
 
+    const fileRelativePath = path.join('examples', relativePath);
     current.children.push({
       type: 'file',
       name: parts[parts.length - 1],
-      path: filePath,
+      path: fileRelativePath.replace(/\\/g, '/'), // Normalize to forward slashes
       code: content,
       metadata: {
         title: metadata.title,