@hfunlabs/hyperliquid 0.27.1-hfunlabs.1

package/CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# Contributing to @nktkas/hyperliquid
+
+Welcome, and thank you for taking time in contributing to SDK! You can contribute to SDK in different ways:
+
+- Submit new features
+- Report bugs
+- Review code
+
+## Dev Environment Setup
+
+If you want to read or modify the SDK code, set up your development environment as follows:
+
+1. Install [Deno](https://deno.com).
+2. Use [VSCode Deno LSP](https://marketplace.visualstudio.com/items?itemName=denoland.vscode-deno) or a
+   [similar extension](https://docs.deno.com/runtime/getting_started/setup_your_environment/) if you are using a
+   different editor.
+
+## Testing
+
+```bash
+deno test -A
+```
+
+Optional: Set `PRIVATE_KEY` env for complete tests. Required testnet balance: ~100 usdc-perps, ~3 usdc-spot, ~0.0000001
+hype-spot.
+
+## Coding Guidelines
+
+- **Style**: After making all changes, run: [`deno fmt`](https://docs.deno.com/runtime/reference/cli/fmt/) >
+  [`deno lint`](https://docs.deno.com/runtime/reference/cli/lint/) >
+  [`deno check`](https://docs.deno.com/runtime/reference/cli/check/)
+- **Dependencies**: Use small and easily auditable dependencies (e.g.
+  [@noble/hashes](https://www.npmjs.com/package/@noble/hashes) or [@std](https://jsr.io/@std)).
+- **Testing**: Write tests for any new functionality.
+- **Docs**: Update or add JSDoc comments where appropriate.
+
+## Common Tasks
+
+### Add a new API method
+
+1. Create a file with the method name in the appropriate directory:
+   `src/api/[exchange|info|subscription]/[methodName].ts`
+2. Implement the logic related to the new API (using ready-made patterns from other method files).
+3. Update the `~client.ts` file to include the new method.
+4. Add the raw function export to `~mod.ts`.
+5. Create a test (use patterns from other tests) and run the test.
+6. Update docs:
+   - Update the [`API Reference`](/README.md#api-reference) section in [`README.md`](/README.md)
+   - Update the helper message (function `printHelp`) in [`bin/cli.ts`](/bin/cli.ts).
+
+### Update API schemas/types
+
+1. Go to `src/api/[exchange|info|subscription]/[methodName].ts`
+2. Update the [valibot](https://valibot.dev/) schemas in the "Schemas" section (types are inferred from schemas).
+3. Run the test at `tests/api/[exchange|info|subscription]/[methodName].ts` to check the schemas against the actual API
+   response.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2025 nktkas
+
+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.