# @cambrianprotocol/core

> Typescript implementation of the Ceramic protocol

Latest version **2.37.0** (published 2023-03-08) · (Apache-2.0 OR MIT) license · 0 weekly downloads

## Install

```sh
npm install @cambrianprotocol/core
pnpm add @cambrianprotocol/core
yarn add @cambrianprotocol/core
bun add @cambrianprotocol/core
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.37.0 |
| Published | 2023-03-08 |
| First published | 2023-03-08 |
| Weekly downloads | 0 |
| License | (Apache-2.0 OR MIT) |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 41 |
| Unpacked size | 579.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 424 |
| Author | Joel Torstensson |
| Maintainers | zktruth |
| Keywords | Ceramic, DID, identity, Data, routing |

## Links

- npm: https://www.npmjs.com/package/@cambrianprotocol/core
- Repository: https://github.com/ceramicnetwork/js-ceramic
- Homepage: https://github.com/ceramicnetwork/js-ceramic#readme
- Issues: https://github.com/ceramicnetwork/js-ceramic/issues
- npm.io page: https://npm.io/package/@cambrianprotocol/core

## Dependencies (41)

- [pg](https://npm.io/package/pg.md) ^8.7.3
- [ajv](https://npm.io/package/ajv.md) ^8.8.2
- [dids](https://npm.io/package/dids.md) ^4.0.0
- [knex](https://npm.io/package/knex.md) ^2.1.0
- [rxjs](https://npm.io/package/rxjs.md) ^7.5.2
- [lru_map](https://npm.io/package/lru_map.md) ^0.4.1
- [p-queue](https://npm.io/package/p-queue.md) 7.3.0
- [pg-boss](https://npm.io/package/pg-boss.md) ^8.2.0
- [sqlite3](https://npm.io/package/sqlite3.md) ^5.0.8
- [cartonne](https://npm.io/package/cartonne.md) ^1.0.3
- [it-first](https://npm.io/package/it-first.md) ^1.0.7
- [level-ts](https://npm.io/package/level-ts.md) ^2.1.0
- [mapmoize](https://npm.io/package/mapmoize.md) ^1.2.1
- [ajv-formats](https://npm.io/package/ajv-formats.md) ^2.1.1
- [uint8arrays](https://npm.io/package/uint8arrays.md) ^4.0.3
- [multiformats](https://npm.io/package/multiformats.md) ^11.0.1
- [@ipld/dag-cbor](https://npm.io/package/@ipld/dag-cbor.md) ^7.0.0
- [@stablelib/uuid](https://npm.io/package/@stablelib/uuid.md) ^1.0.1
- [await-semaphore](https://npm.io/package/await-semaphore.md) ^0.1.3
- [lodash.clonedeep](https://npm.io/package/lodash.clonedeep.md) ^4.5.0
- [@stablelib/random](https://npm.io/package/@stablelib/random.md) ^1.0.1
- [@stablelib/sha256](https://npm.io/package/@stablelib/sha256.md) ^1.0.1
- [@cambrianprotocol/common](https://npm.io/package/@cambrianprotocol/common.md) ^2.27.0
- [@ceramicnetwork/streamid](https://npm.io/package/@ceramicnetwork/streamid.md) ^2.14.0
- [@ethersproject/providers](https://npm.io/package/@ethersproject/providers.md) ^5.5.1
- [@ceramicnetwork/stream-tile](https://npm.io/package/@ceramicnetwork/stream-tile.md) ^2.19.0
- [@ceramicnetwork/anchor-utils](https://npm.io/package/@ceramicnetwork/anchor-utils.md) ^1.6.0
- [@ceramicnetwork/stream-model](https://npm.io/package/@ceramicnetwork/stream-model.md) ^1.5.0
- [@ceramicnetwork/ipfs-topology](https://npm.io/package/@ceramicnetwork/ipfs-topology.md) ^2.17.0
- [@ceramicnetwork/observability](https://npm.io/package/@ceramicnetwork/observability.md) ^1.0.4
- [@ceramicnetwork/anchor-listener](https://npm.io/package/@ceramicnetwork/anchor-listener.md) ^1.8.0
- [@ceramicnetwork/wasm-bloom-filter](https://npm.io/package/@ceramicnetwork/wasm-bloom-filter.md) ^0.1.0
- [@datastructures-js/priority-queue](https://npm.io/package/@datastructures-js/priority-queue.md) ^6.1.0
- [@ceramicnetwork/stream-caip10-link](https://npm.io/package/@ceramicnetwork/stream-caip10-link.md) ^2.18.0
- [@ceramicnetwork/pinning-aggregation](https://npm.io/package/@ceramicnetwork/pinning-aggregation.md) ^2.15.0
- [@ceramicnetwork/stream-tile-handler](https://npm.io/package/@ceramicnetwork/stream-tile-handler.md) ^2.18.0
- [@ceramicnetwork/pinning-ipfs-backend](https://npm.io/package/@ceramicnetwork/pinning-ipfs-backend.md) ^2.15.0
- [@ceramicnetwork/stream-model-handler](https://npm.io/package/@ceramicnetwork/stream-model-handler.md) ^1.5.0
- [@ceramicnetwork/stream-model-instance](https://npm.io/package/@ceramicnetwork/stream-model-instance.md) ^1.5.0
- [@ceramicnetwork/stream-caip10-link-handler](https://npm.io/package/@ceramicnetwork/stream-caip10-link-handler.md) ^2.16.0
- [@ceramicnetwork/stream-model-instance-handler](https://npm.io/package/@ceramicnetwork/stream-model-instance-handler.md) ^1.5.0

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 2.37.0 (latest) — 2023-03-08
- 2.37.0-rc.0 (next) — 2023-03-08
- 2.36.0-rc.0 — 2023-03-08
- 2.35.0-rc.0 — 2023-03-08
- 2.34.0-rc.0 — 2023-03-08
- 2.33.0-rc.0 — 2023-03-08
- 2.32.0-rc.0 — 2023-03-08

## README

# Ceramic Core
![ceramicnetwork](https://circleci.com/gh/ceramicnetwork/js-ceramic.svg?style=shield)
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
[![](https://img.shields.io/badge/Chat%20on-Discord-orange.svg?style=flat)](https://discord.gg/6VRZpGP)
[![Twitter](https://img.shields.io/twitter/follow/ceramicnetwork?label=Follow&style=social)](https://twitter.com/ceramicnetwork)

> This package contains the implementation of the core Ceramic protocol. It's exposed using a simple JavaScript API.

## Getting started

### Installation
```
$ npm install @ceramicnetwork/core
```

### Usage

See the [Ceramic developer site](https://developers.ceramic.network/) for more details about how to use this package.

```
import Ceramic from '@cambrianprotocol/core'
import TileDocument from '@ceramicnetwork/stream-tile'

import { create as createIPFS } from 'ipfs-core'

const ipfs = createIPFS()

const config: CeramicConfig = {}
const ceramic = await Ceramic.create(ipfs, config)

// create document example
const tileDocument = await TileDocument.create(ceramic, { test: 123 })
```

### Ceramic API

Complete Ceramic core API is available on [Ceramic API](https://github.com/ceramicnetwork/js-ceramic/blob/master/packages/common/src/ceramic-api.ts).

## Development
Run tests:
```
$ npm test
```

Run linter:
```
npm run lint
```

## Contributing
We are happy to accept small and large contributions. Make sure to check out the [Ceramic specifications](https://github.com/ceramicnetwork/ceramic/blob/main/SPECIFICATION.md) for details of how the protocol works.

## License

---
_Source: https://npm.io/package/@cambrianprotocol/core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
