kingchencandGitHub
91f6f67257
The first language stecker on the C ABI hub: a .NET binding exposing all 514 indicators as idiomatic `IDisposable` classes, generated from `wickra.h`. ## What's here - **`bindings/csharp/`** — the `Wickra` .NET 8 package. `[LibraryImport]` source-generated P/Invoke (`NativeMethods.g.cs`) plus idiomatic wrappers (`Indicators.g.cs`), both generated from the committed `bindings/c/include/wickra.h`. The binding owns no indicator maths — it only marshals types across the C ABI. - **Marshalling, verified end-to-end against the native library.** Opaque handles cross as `nint` kept alive per call via a `SafeHandle`; `bool` as `[MarshalAs(U1)]` (Rust `bool` is one byte); a self-correcting `DllImportResolver` validates the loaded library actually exports the Wickra ABI. Tests cover one representative per FFI archetype (scalar, candle, pairwise, multi-output, bars, profile, values-profile, order-book / array-input) plus exact Sma reference values. - **NuGet packaging** — `dotnet pack` produces `Wickra.<version>.nupkg`; the release pipeline stages prebuilt native libraries under `runtimes/<rid>/native/` for six target triples (win/linux/osx × x64/arm64). - **`examples/csharp/`** — nine examples mirroring `examples/c/`: streaming, backtest, multi_timeframe, parallel_assets, three strategies, and fetch_btcusdt + live_binance. - **CI** — a `csharp` job on the three OSes builds the C ABI, tests the binding, and runs the offline examples. **Release** — a gated `csharp-publish` job packs and pushes to NuGet (gated on `NUGET_API_KEY`, independent of the GitHub-release job so a C# hiccup never blocks the C/C++ asset release). - **Docs consistency wave** — README, CONTRIBUTING, CHANGELOG, examples/README, the issue / PR templates, `sync-about.yml`, and `.gitattributes`. The native Python / Node / WASM bindings and the C ABI are untouched; this is additive. Publishing to NuGet stays gated behind the release tag and the secret.
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# 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.
|