JavaScript API References¶

This page contains a list of all packages and modules included in the Ceramic TypeScript implementation. Click into individual packages for detailed documentation on its APIs and types.

Node¶

Core¶

@ceramicnetwork/core: Implementation of the Ceramic protocol, exposed using a simple JS API.

Common¶

@ceramicnetwork/common: Common Ceramic types and utilities.

StreamID¶

@ceramicnetwork/streamid: Utility for encoding and decoding StreamIDs and CommitIDs.

StreamType: Tile Handler¶

@ceramicnetwork/stream-tile-handler: Handler implementation for the TileDocument StreamType.

StreamType: Caip10Link Handler¶

@ceramicnetwork/stream-caip10-link-handler: Handler implementation for the Caip10Link StreamType.

Pinning¶

@ceramicnetwork/pinning-aggregation: Aggregation of backends for pinning stream content and state.

Pinning: IPFS Backend¶

@ceramicnetwork/pinning-ipfs-backend: Backend for pinning IPFS records on IPFS.

Pinning: Powergate Backend¶

@ceramicnetwork/pinning-powergate-backend: Backend for pinning IPFS records on Filecoin via a Powergate service.

Logger¶

@ceramicnetwork/logger: Utilities for logging.

Clients¶

HTTP Client¶

@ceramicnetwork/http-client: HTTP client for Ceramic.

CLI¶

@ceramicnetwork/cli: Command line interface for Ceramic.

StreamType: Tile¶

@ceramicnetwork/stream-tile: Implementation of the TileDocument StreamType.

StreamType: Caip10Link¶

@ceramicnetwork/stream-caip10-link: Implementation of the Caip10Link StreamType.

DIDs¶

JS DID¶

js-did: Interface for interacting with DIDs.

3ID DID Resolver¶

@ceramicnetwork/3id-did-resolver: Resolver for the 3ID DID method.

Key DID Resolver¶

key-did-resolver: Resolver for the Key DID method.

Blockchain Utils: Linking¶

@ceramicnetwork/blockchain-utils-linking: Utility functions for linking blockchain accounts to DIDs.

Blockchain Utils: Validation¶

@ceramicnetwork/blockchain-utils-validation: Utility functions to validate links of blockchain accounts linked a DID