Skip to content

ceramicnetwork/ceramic-sdk

Repository files navigation

Ceramic SDK

TypeScript client and utilities for Ceramic One interactions

Packages

Name Description Version
events Events encoding, signing and other utilities npm version
flight-sql-client Flight SQL client for ceramic one using WASM npm version
http-client HTTP client for Ceramic One npm version
identifiers Ceramic streams and commits identifiers npm version
model-protocol Model streams protocol npm version
model-client Model streams client npm version
model-instance-protocol ModelInstanceDocument streams protocol npm version
model-instance-client ModelInstanceDocument streams client npm version

Other packages present in the packages folder are for internal use and may not be published to the npm registry.

Development

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 tests

CI

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.

License

Dual licensed under MIT and Apache 2