TypeScript client and utilities for Ceramic One interactions
| Name | Description | Version |
|---|---|---|
| events | Events encoding, signing and other utilities |  |
| flight-sql-client | Flight SQL client for ceramic one using WASM |  |
| http-client | HTTP client for Ceramic One |  |
| identifiers | Ceramic streams and commits identifiers |  |
| model-protocol | Model streams protocol |  |
| model-client | Model streams client |  |
| model-instance-protocol | ModelInstanceDocument streams protocol |  |
| model-instance-client | ModelInstanceDocument streams client |  |
| stream-client | Generic streams client |  |
Other packages present in the packages folder are for internal use and may not be published to the npm registry.
Getting started:
pnpm i
pnpm build
pnpm test # run all tests (unit and integration, requires docker to be running)
pnpm test:ci # run only unit testsThe flight-sql-client is written in Rust and has the ability to log to the console. However the jest framework will often overwrite the logs output by the Rust code. To avoid this use:
CI=true RUST_LOG=debug pnpm testThe RUST_LOG env var can be set to change the Rust log level.
In order to specify targets for WASM builds on CI, the build script is split into pnpm build:rust which allows passing --target TARGET_TRIPLE and pnpm build:js.
Dual licensed under MIT and Apache 2