kingchencandGitHub
23d636fd97
Adds a Go binding (`bindings/go`) over the C ABI hub — the second language stecker after C#. ## What's here - **`bindings/go`** — a cgo binding exposing all 514 indicators as idiomatic Go types with `New<Indicator>` constructors and `Update`/`Batch`/`Reset`/`Close` methods. The wrappers in `indicators_gen.go` are generated from `bindings/c/include/wickra.h` (same archetype taxonomy as the C# generator: scalar/batch, multi-output, bars, profile, profile-values, array-input). Opaque handles are freed by `Close()` with a `runtime.SetFinalizer` backstop; pointer arguments are caller-owned, panics never cross the boundary. - **`examples/go`** — the full example suite mirroring C/C#: streaming, backtest, multi_timeframe, parallel_assets (goroutine fan-out), three strategies, and `fetch_btcusdt`/`live_binance`. - **CI** — a `go` job builds the C ABI library, stages it, and runs `gofmt`/`go vet`/`go test` plus the offline examples on Linux, macOS and Windows. - **Docs** — Go added to the README languages table, project layout, building/testing, CONTRIBUTING binding table + regenerate note, ARCHITECTURE, examples index, issue/PR templates, the About-description template, and the other binding READMEs. ## Linking / distribution The binding links the prebuilt C ABI library via cgo (`libwickra.so`/`.dylib`/`wickra.dll` staged under `bindings/go/lib`, gitignored). The native libraries are already shipped per target triple by the existing `c-abi-build` release job; distribution is via the subdirectory module tag `bindings/go/vX.Y.Z` (gated), so `release.yml` needs no new publish job. No Rust crate or `Cargo.toml` change — the Go module is standalone and additive. Not for merge yet (gated, per request).
73 lines
3.0 KiB
Markdown
73 lines
3.0 KiB
Markdown
# Wickra — WebAssembly
|
|
|
|
[](https://github.com/wickra-lib/wickra/actions/workflows/ci.yml)
|
|
[](https://codecov.io/gh/wickra-lib/wickra)
|
|
[](https://www.npmjs.com/package/wickra-wasm)
|
|
[](https://github.com/wickra-lib/wickra#license)
|
|
|
|
**Streaming-first technical indicators in the browser. `npm install
|
|
wickra-wasm` — pure WebAssembly, runs anywhere a modern JS engine does.**
|
|
|
|
Wickra is a multi-language technical-analysis library with a Rust core and
|
|
bindings for Python, Node.js and WebAssembly, plus a C ABI for C/C++, C#, Go and any
|
|
other C-capable language. Every indicator is an O(1)
|
|
streaming state machine, so live trading dashboards and historical backtests
|
|
share the exact same implementation. This package is the WebAssembly binding
|
|
(wasm-bindgen, built for the `web` target); it exposes 200+ streaming-first
|
|
indicators across sixteen families.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
npm install wickra-wasm
|
|
```
|
|
|
|
## Quick start
|
|
|
|
The module ships a default `init` export that loads the `.wasm` payload; await
|
|
it once before constructing indicators.
|
|
|
|
```js
|
|
import init, { RSI } from 'wickra-wasm';
|
|
|
|
await init(); // load the WebAssembly module once
|
|
|
|
// Streaming: feed prices tick by tick in O(1).
|
|
const rsi = new RSI(14);
|
|
for (const price of liveFeed) {
|
|
const value = rsi.update(price); // null during warmup
|
|
if (value !== null && value > 70) {
|
|
console.log('overbought');
|
|
}
|
|
}
|
|
```
|
|
|
|
Constructors mirror the other bindings (`new SMA(20)`, `new MACD(12, 26, 9)`,
|
|
`new BollingerBands(20, 2.0)`, …); `update()` returns the latest value or
|
|
`null` while the indicator is still warming up.
|
|
|
|
## Documentation
|
|
|
|
The full indicator catalogue, guides, quickstarts, and API reference live in
|
|
the main repository and documentation site:
|
|
|
|
- **Repository & full indicator list:** <https://github.com/wickra-lib/wickra>
|
|
- **Docs** (quickstarts, cookbook, TA-Lib migration): <https://docs.wickra.org>
|
|
- **Runnable browser examples:** [`examples/wasm/`](https://github.com/wickra-lib/wickra/tree/main/examples/wasm)
|
|
|
|
Wickra ships native bindings for Python, Node.js, WebAssembly and Rust, plus a
|
|
C ABI hub that any C-capable language (C, C++, Go, C#, Java, R) links against —
|
|
all exposing the same indicators from the shared, `unsafe`-forbidden Rust core.
|
|
|
|
## Disclaimer
|
|
|
|
Wickra is an indicator toolkit, not a trading system. The values it computes
|
|
are deterministic transforms of the input data — they are not financial advice
|
|
and do not predict the market. Any use in a live trading context is at your own
|
|
risk. The library is provided **as is**, without warranty of any kind.
|
|
|
|
## License
|
|
|
|
Licensed under either of [Apache-2.0](https://github.com/wickra-lib/wickra/blob/main/LICENSE-APACHE)
|
|
or [MIT](https://github.com/wickra-lib/wickra/blob/main/LICENSE-MIT) at your option.
|