@katanaperps/katana-perps-sdk 0.0.0-placeholder

package/dist/utils.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnreachableCaseError = exports.sanitizeSearchParams = exports.deriveBaseURL = exports.assertNonceIsValid = exports.INTERNAL_SYMBOL = exports.createDelegatedKeyWalletAndNonce = exports.createHmacRestRequestSignatureHeader = exports.isNode = void 0;
+const tslib_1 = require("tslib");
+const node_crypto_1 = require("node:crypto");
+const ethers_1 = require("ethers");
+const uuid_1 = require("uuid");
+const constants = tslib_1.__importStar(require("#constants"));
+const UUIDV1_REGEX = /^[0-9A-F]{8}-[0-9A-F]{4}-1[0-9A-F]{3}-[0-9A-F]{4}-[0-9A-F]{12}$/i;
+exports.isNode = typeof process !== 'undefined' &&
+    process.versions != null &&
+    process.versions.node != null;
+function createHmacRestRequestSignatureHeader(payload, secret) {
+    const hmacRestRequestSignature = (0, node_crypto_1.createHmac)('sha256', secret)
+        .update(payload)
+        .digest('hex');
+    return { [constants.REST_HMAC_SIGNATURE_HEADER]: hmacRestRequestSignature };
+}
+exports.createHmacRestRequestSignatureHeader = createHmacRestRequestSignatureHeader;
+/**
+ * Creates a random ethers wallet.
+ *
+ * @internal
+ */
+function generateRandomWallet() {
+    return ethers_1.ethers.Wallet.createRandom();
+}
+/**
+ * Creates a new wallet and nonce to use for delegated keys
+ *
+ * @internal
+ */
+function createDelegatedKeyWalletAndNonce() {
+    const wallet = generateRandomWallet();
+    const nonce = (0, uuid_1.v1)();
+    return [wallet, nonce];
+}
+exports.createDelegatedKeyWalletAndNonce = createDelegatedKeyWalletAndNonce;
+/**
+ * - For use internally at Katana Perps and may be removed or changed anywhere it is implemented without warning.
+ *
+ * @internal
+ */
+exports.INTERNAL_SYMBOL = Symbol.for('@katanaPerps/internal');
+/**
+ * Asserts that the provided nonce is a uuid v1 string.
+ *
+ * @internal
+ */
+function assertNonceIsValid(nonce) {
+    if (!nonce) {
+        throw new Error('A nonce must be provided with your request but none was provided.');
+    }
+    if (UUIDV1_REGEX.test(nonce) === false) {
+        throw new Error('The provided nonce is not a valid uuid v1 string. Please provide a valid uuid v1 string.');
+    }
+}
+exports.assertNonceIsValid = assertNonceIsValid;
+function deriveBaseURL(options) {
+    const { overrideBaseURL, sandbox, api = 'rest' } = options;
+    if (!overrideBaseURL &&
+        (options.baseRestApiURL || options.baseWebSocketURL)) {
+        switch (api) {
+            case 'rest': {
+                if (options.baseRestApiURL) {
+                    return options.baseRestApiURL;
+                }
+                if (options.baseWebSocketURL) {
+                    const wsUrl = new URL(options.baseWebSocketURL);
+                    return `https://${wsUrl.hostname.replace('websocket', 'api')}${wsUrl.pathname}`;
+                }
+                break;
+            }
+            case 'websocket': {
+                if (options.baseWebSocketURL) {
+                    return options.baseWebSocketURL;
+                }
+                if (options.baseRestApiURL) {
+                    const apiUrl = new URL(options.baseRestApiURL);
+                    return `wss://${apiUrl.hostname.replace('api', 'websocket')}${apiUrl.pathname}`;
+                }
+                break;
+            }
+            default:
+                break;
+        }
+    }
+    const baseURL = overrideBaseURL ??
+        constants.URLS[sandbox ? 'sandbox' : 'production'].v1[api];
+    if (!baseURL) {
+        throw new Error(`Invalid configuration, baseURL could not be derived (sandbox? ${String(options.sandbox)})`);
+    }
+    return baseURL;
+}
+exports.deriveBaseURL = deriveBaseURL;
+/**
+ * URLSearchParams encodes undefined and null as strings, we remove them as a
+ * precaution if this happens.
+ */
+function sanitizeSearchParams(searchParams = {}) {
+    const sanitizedSearchParams = new URLSearchParams(searchParams);
+    for (const [key, value] of sanitizedSearchParams) {
+        // if a user had a key in the obj they set to undefined
+        // url search params might serialize it to 'undefined'
+        if (value === 'undefined' || value === 'null') {
+            sanitizedSearchParams.delete(key, value);
+        }
+    }
+    return sanitizedSearchParams;
+}
+exports.sanitizeSearchParams = sanitizeSearchParams;
+/**
+ * By using this in default switch case, we can enforce exhaustive check of all case cases.
+ *
+ * @example
+ * ```typescript
+ *  switch (prop) {
+ *    // ...
+ *    default:
+ *      throw new UnreachableCaseError(prop);
+ *  }
+ * ```
+ *
+ * @internal
+ */
+class UnreachableCaseError extends Error {
+    /**
+     *
+     * @param value The value being switched that caused the default case to be reached.
+     * @param info Optionally the name of the fn or switch that caused the error for logging.
+     */
+    constructor(value, info = 'switch') {
+        super(`Unreachable Case: Must handle all cases in "${info}" but did not handle: ${value}`);
+    }
+}
+exports.UnreachableCaseError = UnreachableCaseError;

package/package.json

@@ -0,0 +1,200 @@
+{
+  "name": "@katanaperps/katana-perps-sdk",
+  "version": "0.0.0-placeholder",
+  "description": "Katana Perps SDK for Javascript in the browser and Node.js",
+  "repository": "git@github.com:katanaperps/katana-perps-sdk-js.git",
+  "license": "MIT",
+  "author": "Katana Perps <support@perps.katana.netowrk>",
+  "sideEffects": false,
+  "type": "commonjs",
+  "dep-notes": [
+    [
+      "chai v5",
+      "esm-only"
+    ],
+    [
+      "eslint v9",
+      "due to eslint-plugin-import not supporting flat config or ts path resolution"
+    ],
+    [
+      "ethers",
+      "keep in sync with other repos"
+    ]
+  ],
+  "imports": {
+    "#*": {
+      "types": [
+        "./src/*.ts",
+        "./dist/*.d.ts"
+      ],
+      "default": [
+        "./dist/*.js"
+      ]
+    }
+  },
+  "exports": {
+    ".": {
+      "types": [
+        "./src/index.ts",
+        "./dist/index.d.ts"
+      ],
+      "default": "./dist/index.js"
+    },
+    "./abis/*": {
+      "types": [
+        "./dist/abis/*.d.ts",
+        "./src/abis/*"
+      ],
+      "default": "./dist/abis/*"
+    },
+    "./clients": {
+      "types": [
+        "./dist/client/index.d.ts",
+        "./src/client/index.ts"
+      ],
+      "default": "./dist/client/index.js"
+    },
+    "./contracts": {
+      "types": [
+        "./dist/contracts.d.ts",
+        "./src/contracts.ts"
+      ],
+      "default": "./dist/contracts.js"
+    },
+    "./bridge": {
+      "types": [
+        "./dist/bridge/index.d.ts",
+        "./src/bridge/index.ts"
+      ],
+      "default": "./dist/bridge/index.js"
+    },
+    "./typechain": {
+      "types": [
+        "./dist/typechain-types/index.d.ts",
+        "./src/typechain-types/index.ts"
+      ],
+      "default": "./dist/typechain-types/index.js"
+    },
+    "./types": {
+      "types": [
+        "./dist/types/index.d.ts",
+        "./src/types/index.ts"
+      ],
+      "default": "./dist/types/index.js"
+    }
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    ".nvmrc",
+    "contracts",
+    "dist",
+    "package.json",
+    "yarn.lock",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "npm-run-all clean build:tsc build:abis",
+    "build:abis": "cp -rf abis dist/abis/",
+    "build:tsc": "yarn exec tsc",
+    "build:typechain": "typechain --target ethers-v6 --out-dir src/typechain-types 'abis/*.json'",
+    "clean": "rimraf dist",
+    "clean:docs": "rimraf docs",
+    "lint": "eslint --cache 'src/**/*.ts'",
+    "lint:fix": "eslint --cache 'src/**/*.ts' --fix",
+    "lint:fix:staged": "lint-staged",
+    "lint:fix:staged-and-modified": "eslint --cache --fix $(git diff --name-only HEAD | grep -E '\\.(ts|tsx)$' | xargs) && yarn lint:prettier:staged-and-modified",
+    "lint:prettier:staged-and-modified": "prettier --write $(git diff --name-only HEAD | grep -E '\\.(ts|tsx)$' | xargs)",
+    "lint:types": "yarn exec tsc --noEmit",
+    "on:commit": "npm-run-all build test --parallel lint:fix:staged lint:types --",
+    "orderbook:demo": "yarn node dist/orderbook/demo.js",
+    "postinstall": "git config --local core.hooksPath .githooks || echo 'Not a git repository, did not set up git hooks'",
+    "prettier:fix": "yarn exec prettier --cache --write 'src/**/*.ts'",
+    "prettier:fix:staged": "yarn exec pretty-quick --staged",
+    "start:path": "yarn exec tsx --tsconfig tsconfig.tsx.json --",
+    "start:path:watch": "yarn exec tsx watch --tsconfig tsconfig.tsx.json --clear-screen=false --",
+    "test": "mocha --unhandled-rejections=strict 'dist/tests/**/*.test.js'",
+    "typedoc:build": "npm-run-all --sequential clean:docs typedoc:build:run typedoc:build:assets",
+    "typedoc:build:assets": "cp assets/katana-perps-logo.png docs/assets/ && cp assets/CNAME docs/",
+    "typedoc:build:run": "yarn exec typedoc"
+  },
+  "lint-staged": {
+    "src/**/*.{ts,tsx}": [
+      "eslint --cache --fix",
+      "prettier --cache --write"
+    ]
+  },
+  "dependencies": {
+    "@layerzerolabs/lz-v2-utilities": "^3.0.83",
+    "axios": "1.6.8",
+    "bignumber.js": "^9.1.2",
+    "ethers": "6.13.5",
+    "isomorphic-ws": "^5.0.0",
+    "tslib": "^2.7.0",
+    "uuid": "^9.0.1",
+    "ws": "8.17.0"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^19.1.0",
+    "@commitlint/types": "^19.0.3",
+    "@eslint/eslintrc": "^3.0.2",
+    "@eslint/js": "^9.2.0",
+    "@qiwi/semantic-release-gh-pages-plugin": "^5.2.12",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^12.0.0",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^10.0.3",
+    "@semantic-release/npm": "^13.1.3",
+    "@semantic-release/release-notes-generator": "^13.0.0",
+    "@tsconfig/node20": "^20.1.4",
+    "@typechain/ethers-v6": "0.5.1",
+    "@types/chai": "^4.3.14",
+    "@types/crypto-js": "^4.2.2",
+    "@types/eslint": "^8.56.10",
+    "@types/eslint__js": "^8.42.3",
+    "@types/mocha": "^10.0.6",
+    "@types/node": "^20.12.12",
+    "@types/semantic-release": "^20.0.6",
+    "@types/uuid": "^9.0.8",
+    "@types/ws": "8.5.10",
+    "chai": "4.4.1",
+    "commitizen": "^4.3.0",
+    "commitlint": "^19.2.1",
+    "conventional-changelog-conventionalcommits": "^7.0.2",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^8.57.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import": "npm:eslint-plugin-i@latest",
+    "eslint-plugin-prettier": "^5.5.1",
+    "eslint-plugin-promise": "^6.1.1",
+    "globals": "^15.2.0",
+    "lint-staged": "^15.2.2",
+    "markdownlint-cli": "^0.39.0",
+    "mocha": "^10.4.0",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^3.2.5",
+    "prettier-plugin-package": "^1.4.0",
+    "pretty-quick": "^4.0.0",
+    "rimraf": "^5.0.7",
+    "semantic-release": "^25.0.2",
+    "semantic-release-slack-bot": "^4.0.2",
+    "slackify-markdown": "^4.4.0",
+    "tsx": "^4.10.2",
+    "typechain": "8.3.2",
+    "typedoc": "0.25.13",
+    "typedoc-plugin-extras": "^3.0.0",
+    "typedoc-plugin-mdn-links": "^3.1.25",
+    "typedoc-plugin-merge-modules": "^5.1.0",
+    "typedoc-plugin-missing-exports": "^2.2.0",
+    "typedoc-theme-category-nav": "^0.0.3",
+    "typescript": "5.4.5",
+    "typescript-eslint": "^7.9.0"
+  },
+  "optionalDependencies": {
+    "bufferutil": "^4.0.8"
+  },
+  "packageManager": "yarn@4.2.2"
+}