Class Ceramic

Ceramic core implementation.

To install this library:
$ npm install --save @ceramicnetwork/core

Hierarchy

Ceramic

Implements

StreamReaderWriter
StreamStateLoader

Constructors

constructor

new Ceramic(modules: CeramicModules, params: CeramicParameters): Ceramic
Parameters
- modules: CeramicModules
- params: CeramicParameters
Returns Ceramic
- Defined in packages/core/src/ceramic.ts:221

Properties

`Readonly` _streamHandlers

_streamHandlers: HandlersMap

`Readonly` admin

admin: AdminApi

`Readonly` anchorService

anchorService: AnchorService

`Readonly` dispatcher

dispatcher: Dispatcher

`Readonly` feed

feed: PublicFeed

`Readonly` loggerProvider

loggerProvider: LoggerProvider

`Readonly` repository

repository: Repository

Accessors

did

get did(): DID
Get DID. This should only be used if you need to interrogate the DID that was set for this ceramic. For most instances, prefer signer, as it has the necessary information for creating and verifying signatures.

Returns DID
- Defined in packages/core/src/ceramic.ts:331
set did(did: DID): void
Sets the DID instance that will be used to author commits to streams. The DID instance also includes the DID Resolver that will be used to verify commits from others.
Parameters
- did: DID
Returns void
- Defined in packages/core/src/ceramic.ts:340

index

get index(): LocalIndexApi
Returns LocalIndexApi
- Defined in packages/core/src/ceramic.ts:302

ipfs

get ipfs(): IpfsApi
Get IPFS instance

Returns IpfsApi
- Defined in packages/core/src/ceramic.ts:322

pubsubTopic

get pubsubTopic(): string
Returns string
- Defined in packages/core/src/ceramic.ts:306

signer

get signer(): CeramicSigner
Get the signer for this ceramic, used in creating and verifying signatures. This should be used for all of those instances rather than did, since the signer has any additional logic related to creating and verifying signatures.

Returns CeramicSigner
Implementation of StreamReaderWriter.signer
- Defined in packages/core/src/ceramic.ts:315

Methods

_checkIPFSPersistence

_checkIPFSPersistence(): Promise<void>
Used at startup to do a sanity check that the IPFS node has the commit data for pinned streams as expected.

Returns Promise<void>
- Defined in packages/core/src/ceramic.ts:548

_ensureGenesis

_ensureGenesis(genesis: CeramicCommit, streamRef: StreamRef, opts: LoadOpts): Promise<void>
Used to ensure that the given genesis commit contents already exist on IPFS so we don't time out trying to load it.
Parameters
- genesis: CeramicCommit
- streamRef: StreamRef
- opts: LoadOpts
Returns Promise<void>
- Defined in packages/core/src/ceramic.ts:739

_init

_init(doPeerDiscovery: boolean): Promise<void>
Finishes initialization and startup of a Ceramic instance. This usually should not be called directly - most users will prefer to call Ceramic.create() instead which calls this internally.
Parameters
- doPeerDiscovery: boolean
  
  Controls whether we connect to the "peerlist" to manually perform IPFS peer discovery
Returns Promise<void>
- Defined in packages/core/src/ceramic.ts:476

_startupChecks

_startupChecks(): Promise<void>
Runs some checks at node startup to ensure that the node is healthy and properly configured. Throws an Error if any issues are detected

Returns Promise<void>
- Defined in packages/core/src/ceramic.ts:524

addStreamHandler

addStreamHandler<T>(streamHandler: StreamHandler<T>): void
Register new stream handler
Type Parameters
- T extends Stream<T>
Parameters
- streamHandler: StreamHandler<T>
  
  Stream type handler
Returns void
- Defined in packages/core/src/ceramic.ts:589

applyCommit

applyCommit<T>(streamId: string | StreamID, commit: CeramicCommit, opts?: UpdateOpts): Promise<T>
Applies commit on a given stream
Type Parameters
- T extends Stream<T>
Parameters
- streamId: string | StreamID
  
  Stream ID
- commit: CeramicCommit
  
  Commit to be applied
- opts: UpdateOpts = {}
  
  Initialization options
Returns Promise<T>
Implementation of StreamReaderWriter.applyCommit
- Defined in packages/core/src/ceramic.ts:627

buildStreamFromState

buildStreamFromState<T>(state: StreamState<StreamMetadata>): T
Turns +state+ into a Stream instance of the appropriate StreamType. Does not add the resulting instance to a cache.
Type Parameters
- T extends Stream<T> = Stream
Parameters
- state: StreamState<StreamMetadata>
  
  StreamState for a stream.
Returns T
- Defined in packages/core/src/ceramic.ts:883

close

close(): Promise<void>
Close Ceramic instance gracefully

Returns Promise<void>
- Defined in packages/core/src/ceramic.ts:890

createStreamFromGenesis

createStreamFromGenesis<T>(type: number, genesis: any, opts?: CreateOpts): Promise<T>
Creates stream from genesis commit
Type Parameters
- T extends Stream<T>
Parameters
- type: number
  
  Stream type
- genesis: any
  
  Genesis CID
- opts: CreateOpts = {}
  
  Initialization options
Returns Promise<T>
Implementation of StreamReaderWriter.createStreamFromGenesis
- Defined in packages/core/src/ceramic.ts:668

getSupportedChains

getSupportedChains(): Promise<string[]>
Returns
An array of the CAIP-2 chain IDs of the blockchains that are supported for anchoring streams.

Returns Promise<string[]>
- Defined in packages/core/src/ceramic.ts:874

loadStream

loadStream<T>(streamId: string | StreamID | CommitID, opts?: LoadOpts): Promise<T>
Load stream type instance
Type Parameters
- T extends Stream<T>
Parameters
- streamId: string | StreamID | CommitID
  
  Stream ID
- opts: LoadOpts = {}
  
  Initialization options
Returns Promise<T>
Implementation of StreamReaderWriter.loadStream
- Defined in packages/core/src/ceramic.ts:690

loadStreamCommits

loadStreamCommits(streamId: string | StreamID): Promise<Record<string, any>[]>
Load all stream commits by stream ID
Parameters
- streamId: string | StreamID
  
  Stream ID
Returns Promise<Record<string, any>[]>
- Defined in packages/core/src/ceramic.ts:850

loadStreamState

loadStreamState(streamId: StreamID): Promise<StreamState<StreamMetadata>>
Load stream state for indexing queries, bypassing the stream cache and repository loading queue
Parameters
- streamId: StreamID
  
  Stream ID
Returns Promise<StreamState<StreamMetadata>>
Implementation of StreamStateLoader.loadStreamState
- Defined in packages/core/src/ceramic.ts:728

multiQuery

multiQuery(queries: MultiQuery[], timeout?: number): Promise<Record<string, Stream>>
Load all stream types instances for given multiqueries
Parameters
- queries: MultiQuery[]
  
  Array of MultiQueries
- timeout: number = 7000
  
  Timeout in milliseconds
Returns Promise<Record<string, Stream>>
Implementation of StreamReaderWriter.multiQuery
- Defined in packages/core/src/ceramic.ts:819

nodeStatus

nodeStatus(): Promise<NodeStatusResponse>
Returns Promise<NodeStatusResponse>
- Defined in packages/core/src/ceramic.ts:593

requestAnchor

requestAnchor(streamId: string | StreamID, opts?: LoadOpts & AnchorOpts): Promise<AnchorStatus>
Requests an anchor for the given StreamID if the Stream isn't already anchored. Returns the new AnchorStatus for the Stream.
Parameters
- streamId: string | StreamID
- opts: LoadOpts & AnchorOpts = {}
  
  used to load the current Stream state
Returns Promise<AnchorStatus>
Implementation of StreamReaderWriter.requestAnchor
- Defined in packages/core/src/ceramic.ts:651

`Static` _processConfig

_processConfig(ipfs: IpfsApi, config: CeramicConfig): [CeramicModules, CeramicParameters]
Parses the given CeramicConfig and generates the appropriate CeramicParameters and CeramicModules from it. This usually should not be called directly - most users will prefer to call Ceramic.create() instead which calls this internally.
Parameters
- ipfs: IpfsApi
- config: CeramicConfig
Returns [CeramicModules, CeramicParameters]
- Defined in packages/core/src/ceramic.ts:350

`Static` create

create(ipfs: IpfsApi, config?: CeramicConfig): Promise<Ceramic>
Create Ceramic instance
Parameters
- ipfs: IpfsApi
  
  IPFS instance
- config: CeramicConfig = {}
  
  Ceramic configuration
Returns Promise<Ceramic>
- Defined in packages/core/src/ceramic.ts:460

Class Ceramic

Ceramic core implementation.

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

modules: CeramicModules

params: CeramicParameters

Returns Ceramic

Properties

Readonly _streamHandlers

Readonly admin

Readonly anchorService

Readonly dispatcher

Readonly feed

Readonly loggerProvider

Readonly repository

Accessors

did

Returns DID

Parameters

did: DID

Returns void

index

Returns LocalIndexApi

ipfs

Returns IpfsApi

pubsubTopic

Returns string

signer

Returns CeramicSigner

Methods

_checkIPFSPersistence

Returns Promise<void>

_ensureGenesis

Parameters

genesis: CeramicCommit

streamRef: StreamRef

opts: LoadOpts

Returns Promise<void>

_init

Parameters

doPeerDiscovery: boolean

Returns Promise<void>

_startupChecks

Returns Promise<void>

addStreamHandler

Type Parameters

T extends Stream<T>

Parameters

streamHandler: StreamHandler<T>

Returns void

applyCommit

Type Parameters

T extends Stream<T>

Parameters

streamId: string | StreamID

commit: CeramicCommit

opts: UpdateOpts = {}

Returns Promise<T>

buildStreamFromState

Type Parameters

T extends Stream<T> = Stream

Parameters

state: StreamState<StreamMetadata>

Returns T

close

Returns Promise<void>

createStreamFromGenesis

Type Parameters

T extends Stream<T>

Parameters

type: number

genesis: any

`Readonly` _streamHandlers

`Readonly` admin

`Readonly` anchorService

`Readonly` dispatcher

`Readonly` feed

`Readonly` loggerProvider

`Readonly` repository

`Static` _processConfig

`Static` create