Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (36 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

51 lines (36 loc) · 1.86 KB

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.
  2. Use VSCode Deno LSP or a similar extension if you are using a different editor.

Testing

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 task check
  • Dependencies: Use small and easily auditable dependencies (e.g. @noble/hashes or @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.

Update API schemas/types

  1. Go to src/api/[exchange|info|subscription]/[methodName].ts
  2. Update the valibot 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.