# Bloxwap on GitHub

> Open-source developer tools from Bloxwap, Inc. The main project is the Bloxwap Chart SDK (`@bloxwap/chart`), an MIT-licensed, zero-dependency TypeScript library for interactive financial charts on HTML canvas.

Bloxwap, Inc. builds trading products: the Bloxwap app (bloxwap.com) for trading crypto, stocks, gold, and indices, and the Bloxwap Pro terminal (bloxwap.pro). This site, bloxwap.github.io, documents the open-source tools behind them.

## When to use this

Use the Bloxwap Chart SDK when an agent or developer needs to:

- Add an interactive candlestick, OHLC, line, area, or histogram price chart to a web application or trading interface.
- Give users technical-analysis drawing tools (trend lines, Fibonacci, pitchforks, Gann, harmonic patterns, Elliott waves, long/short positions, measurers, annotations): 89 are built in.
- Add built-in indicators (SMA, EMA, Bollinger Bands, MACD, RSI, KDJ, volume) or register custom ones.
- Stream live candle updates into a chart.
- Chart without runtime dependencies, and without the library touching global `document` or `window` (it draws into a canvas you pass in; it also runs in workers, SSR, and tests).

Do not use it for general business charts (pie, scatter, stacked bars) or when you need an npm install today: the package is not yet published on npm and is built from source. Full instructions: https://bloxwap.github.io/chart/llms.txt

## How to call it

```ts
import { createChart } from '@bloxwap/chart';

const chart = createChart({ container: canvas, config: { data: candles, series: { type: 'candlestick' } } });
chart.resize(width, height, window.devicePixelRatio);
chart.addIndicator({ name: 'rsi' });
```

## Hyperliquid SDK: when to use it

Use the Hyperliquid SDK (`@bloxwap/hyperliquid`, on npm, MIT-licensed) when an agent or developer working in TypeScript or JavaScript needs to read Hyperliquid market data or account state, place and cancel orders, sign Hyperliquid actions with a viem account or browser wallet, or stream live updates over WebSocket. It runs on Bun, Node.js, browsers, and React Native, on mainnet or testnet. Do not use it for other exchanges or other languages. Full instructions: https://bloxwap.github.io/hyperliquid/llms.txt

```ts
import { HttpTransport, InfoClient } from "@bloxwap/hyperliquid";

const info = new InfoClient({ transport: new HttpTransport() });
const mids = await info.allMids();
```

## SFX: when to use it

Use SFX (`@bloxwap/sfx`, on npm, MIT-licensed) when an agent or developer needs interface sound effects for a web app: 19 sounds for hovers, presses, toggles, confirmations, and money moments, synthesized with Web Audio — no audio files, zero runtime dependencies. Each sound renders once to a buffer; every play is one AudioBufferSourceNode. Imports are SSR-safe, play() never throws, and playback waits for the first user gesture. Do not use it for long-form music or when you need to ship your own audio files. Full instructions: https://bloxwap.github.io/sfx/llms.txt

```ts
import { bind, play } from '@bloxwap/sfx';

bind(); // wires every data-sound-* attribute, now and later
play('success');
```

## Docs

- [Developer portal](https://bloxwap.github.io/developers/): Quickstart guides, documentation, API reference, and sandboxes for all three projects.

- [Chart SDK documentation](https://bloxwap.github.io/chart/docs/): Guides, API reference, and examples.
- [Chart SDK for agents](https://bloxwap.github.io/chart/llms.txt): When to use the library and how to install and call it.
- [Quick start](https://bloxwap.github.io/chart/docs/getting-started/): Build the package and render a first chart.
- [Interactive playground](https://bloxwap.github.io/chart/docs/playground/): The full chart with drawing tools and a simulated live feed.
- [Source code](https://github.com/bloxwap/chart): MIT-licensed repository and issue tracker.
- [Hyperliquid SDK documentation](https://bloxwap.github.io/hyperliquid/docs/): Installation, clients, transports, signing, and guides.
- [Hyperliquid SDK for agents](https://bloxwap.github.io/hyperliquid/llms.txt): When to use the SDK and how to call it; full Markdown at https://bloxwap.github.io/hyperliquid/llms-full.txt
- [Hyperliquid SDK source code](https://github.com/bloxwap/hyperliquid): MIT-licensed repository and issue tracker.
- [SFX documentation](https://bloxwap.github.io/sfx/docs/): Declarative binding, frameworks, sound design, and API reference.
- [SFX for agents](https://bloxwap.github.io/sfx/llms.txt): When to use the library and how to call it.
- [SFX sound board](https://bloxwap.github.io/sfx/): Play all 19 sounds live in the browser.
- [SFX source code](https://github.com/bloxwap/sfx): MIT-licensed repository and issue tracker.

## Company

- [Privacy](https://bloxwap.github.io/privacy/): No cookies or analytics on this site.