@katanaperps/katana-perps-sdk 0.0.0-placeholder

package/.nvmrc

@@ -0,0 +1 @@
+v20.12.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 - present Aurora Labs, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,90 @@
+<!-- markdownlint-disable md033 -->
+# <img src="assets/katana-perps-logo.png" alt="katana perps" height="32px" valign="top"> typescript/javascript sdk
+
+the official typescript/javascript sdk for <a href="https://perps.katana.network">katana perps v1</a> rest and websocket apis.
+
+![discord](https://img.shields.io/discord/455246457465733130?label=discord&style=flat-square)
+![github](https://img.shields.io/github/license/katanaperps/katana-perps-sdk-js?style=flat-square)
+![npm](https://img.shields.io/npm/v/@katanaperps/katana-perps-sdk?style=flat-square)
+![GitHub issues](https://img.shields.io/github/issues/katanaperps/katana-perps-sdk-js?style=flat-square)
+![Twitter Follow](https://img.shields.io/twitter/follow/KatanaPerps?style=social)
+
+---
+
+## Summary
+
+- 🔥 **Built with TypeScript** - Provides a TypeScript/JavaScript SDK for the [Katana Perps v1 REST and WebSocket APIs](https://api-docs-v1-perps.katana.network).
+- ⭐ **Powerful Documentation** - Provides complete inline IDE documentation and matching 📖 [typedoc-generated reference documentation](https://sdk-js-docs-v1-perps.katana.network).
+- 🦺 **End-to-End type safety** - The SDK types are used by Katana Perps servers and clients so enumerations and types are always up-to-date and accurate.
+- 🌐 **Universal Compatibility** - Optimized to work in both Node.js and browser environments for maximum compatibility.
+
+## Links & Resource
+
+- 🏠 [Katana Perps Homepage](https://perps.katana.network)
+- 📈 [Katana Perps v1 Exchange Sandbox](https://perps-sandbox.katana.network)
+- 📖 [Katana Perps v1 Typescript SDK Reference Documentation](https://sdk-js-docs-v1-perps.katana.network)
+- 📖 [Katana Perps v1 API Documentation](https://api-docs-v1-perps.katana.network)
+- 🔗 [Katana Perps v1 SDK GitHub](https://github.com/katanaperps/katana-perps-sdk-js)
+
+## Installation
+
+```bash
+npm install @katanaperps/katana-perps-sdk@beta
+```
+
+## Getting Started
+
+```typescript
+import * as katanaPerps from '@katanaperps/katana-perps-sdk';
+
+// const publicClient = new katanaPerps.RestPublicClient();
+// or, for sandbox API:
+const publicClient = new katanaPerps.RestPublicClient({
+  // no params required for production api client
+  sandbox: true,
+});
+
+const authenticatedClient = new katanaPerps.RestAuthenticatedClient({
+  sandbox: false,
+
+  // fill these in with your own walletPrivateKey/apiKey/apiSecret
+  walletPrivateKey: '0x...',
+  apiKey: '1e7c4f52-4af7-4e1b-aa94-94fac8d931aa',
+  apiSecret: 'ufuh3ywgg854aq7m73oy6gnnpj5ar9a67szuw5lclbz77zqu0j',
+});
+
+const markets = await publicClient.getMarkets();
+
+const wallets = await authenticatedClient.getWallets();
+```
+
+- Start with **sandbox** testing by getting [Katana Perps v1 sandbox API keys](https://api-docs-v1-perps.katana.network/#sandbox).
+
+## Node Versions
+
+Minimum supported version is Node v16 with support for import/export map resolution.
+
+> The sdk should work with any JavaScript environment that supports [import maps](https://nodejs.org/dist/latest-v20.x/docs/api/packages.html#imports) & [export maps](https://nodejs.org/dist/latest-v20.x/docs/api/packages.html#exports).
+
+## Typescript Support
+
+Your tsconfig/jsconfig must be setup to ensure TypeScript handles import/export map resolution. This is generally done by setting `module` and `moduleResolution` to `Node16` or `NodeNext`.
+
+> See [resolvePackageJsonExports](https://www.typescriptlang.org/tsconfig#resolvePackageJsonExports) and [resolvePacakageJsonImports](https://www.typescriptlang.org/tsconfig#resolvePackageJsonImports) configuration reference for additional details.
+
+## JavaScript
+
+JavaScript is fully supported, however, it is recommended to add `// @ts-check` at the top of your files so your IDE will inform you of any type-related errors in your code!
+
+## Typechain
+
+Typechain types and factories for contracts are available by importing them from `/typechain` export directly, they are not
+exported from the main export.
+
+```typescript
+import * as typechain from '@katanaperps/katana-perps-sdk/typechain';
+```
+
+## License
+
+The Katana Perps JavaScript SDK is released under the [MIT License](https://opensource.org/licenses/MIT).

package/dist/abis/ERC20.json

@@ -0,0 +1,288 @@
+[
+  {
+    "inputs": [
+      {
+        "internalType": "string",
+        "name": "name_",
+        "type": "string"
+      },
+      {
+        "internalType": "string",
+        "name": "symbol_",
+        "type": "string"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "constructor"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "spender",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "value",
+        "type": "uint256"
+      }
+    ],
+    "name": "Approval",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "from",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "value",
+        "type": "uint256"
+      }
+    ],
+    "name": "Transfer",
+    "type": "event"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "spender",
+        "type": "address"
+      }
+    ],
+    "name": "allowance",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "spender",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "approve",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "account",
+        "type": "address"
+      }
+    ],
+    "name": "balanceOf",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "decimals",
+    "outputs": [
+      {
+        "internalType": "uint8",
+        "name": "",
+        "type": "uint8"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "spender",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "subtractedValue",
+        "type": "uint256"
+      }
+    ],
+    "name": "decreaseAllowance",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "spender",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "addedValue",
+        "type": "uint256"
+      }
+    ],
+    "name": "increaseAllowance",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "name",
+    "outputs": [
+      {
+        "internalType": "string",
+        "name": "",
+        "type": "string"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "symbol",
+    "outputs": [
+      {
+        "internalType": "string",
+        "name": "",
+        "type": "string"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "totalSupply",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "transfer",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "from",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "transferFrom",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  }
+]