Class CeramicClient

Ceramic client implementation

Hierarchy

CeramicClient

Implements

CeramicApi

Index

Constructors

Properties

_streamConstructors admin context index pin

Accessors

Methods

addStreamHandler applyCommit buildStreamFromState close createStreamFromGenesis getSupportedChains loadStream loadStreamCommits multiQuery requestAnchor setDID

Constructors

constructor

new CeramicClient(apiHost?: string, config?: Partial<CeramicClientConfig>): CeramicClient
Parameters
- apiHost: string = CERAMIC_HOST
- config: Partial<CeramicClientConfig> = {}
Returns CeramicClient
- Defined in packages/http-client/src/ceramic-http-client.ts:77

Properties

`Readonly` _streamConstructors

_streamConstructors: Record<number, StreamConstructor<Stream>>

`Readonly` admin

admin: AdminApi

`Readonly` context

context: Context

`Readonly` index

index: IndexApi

`Readonly` pin

pin: PinApi

Accessors

did

get did(): DID
Returns DID
Implementation of CeramicApi.did
- Defined in packages/http-client/src/ceramic-http-client.ts:98
set did(did: DID): void
Sets the DID instance that will be used to author commits to streams.
Parameters
- did: DID
Returns void
Implementation of CeramicApi.did
- Defined in packages/http-client/src/ceramic-http-client.ts:106

Methods

addStreamHandler

addStreamHandler<T>(streamHandler: StreamHandler<T>): void
Type Parameters
- T extends Stream<T>
Parameters
- streamHandler: StreamHandler<T>
Returns void
Implementation of CeramicApi.addStreamHandler
- Defined in packages/http-client/src/ceramic-http-client.ts:201

applyCommit

applyCommit<T>(streamId: string | StreamID, commit: CeramicCommit, opts?: CreateOpts | UpdateOpts): Promise<T>
Type Parameters
- T extends Stream<T>
Parameters
- streamId: string | StreamID
- commit: CeramicCommit
- opts: CreateOpts | UpdateOpts = {}
Returns Promise<T>
Implementation of CeramicApi.applyCommit
- Defined in packages/http-client/src/ceramic-http-client.ts:168

buildStreamFromState

buildStreamFromState<T>(state: StreamState): 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
  
  StreamState for a stream.
Returns T
Implementation of CeramicApi.buildStreamFromState
- Defined in packages/http-client/src/ceramic-http-client.ts:210

close

close(): Promise<void>
Returns Promise<void>
Implementation of CeramicApi.close
- Defined in packages/http-client/src/ceramic-http-client.ts:238

createStreamFromGenesis

createStreamFromGenesis<T>(type: number, genesis: any, opts?: CreateOpts): Promise<T>
Type Parameters
- T extends Stream<T>
Parameters
- type: number
- genesis: any
- opts: CreateOpts = {}
Returns Promise<T>
Implementation of CeramicApi.createStreamFromGenesis
- Defined in packages/http-client/src/ceramic-http-client.ts:110

getSupportedChains

getSupportedChains(): Promise<string[]>
Returns Promise<string[]>
Implementation of CeramicApi.getSupportedChains
- Defined in packages/http-client/src/ceramic-http-client.ts:226

loadStream

loadStream<T>(streamId: string | StreamID | CommitID, opts?: LoadOpts): Promise<T>
Type Parameters
- T extends Stream<T>
Parameters
- streamId: string | StreamID | CommitID
- opts: LoadOpts = {}
Returns Promise<T>
Implementation of CeramicApi.loadStream
- Defined in packages/http-client/src/ceramic-http-client.ts:127

loadStreamCommits

loadStreamCommits(streamId: string | StreamID): Promise<Record<string, any>[]>
Parameters
- streamId: string | StreamID
Returns Promise<Record<string, any>[]>
Implementation of CeramicApi.loadStreamCommits
- Defined in packages/http-client/src/ceramic-http-client.ts:163

multiQuery

multiQuery(queries: MultiQuery[], timeout?: number): Promise<Record<string, Stream>>
Parameters
- queries: MultiQuery[]
- Optional timeout: number
Returns Promise<Record<string, Stream>>
Implementation of CeramicApi.multiQuery
- Defined in packages/http-client/src/ceramic-http-client.ts:137

requestAnchor

requestAnchor(streamId: string | StreamID, opts?: LoadOpts): Promise<AnchorStatus>
Parameters
- streamId: string | StreamID
- opts: LoadOpts = {}
Returns Promise<AnchorStatus>
Implementation of CeramicApi.requestAnchor
- Defined in packages/http-client/src/ceramic-http-client.ts:186

setDID

setDID(did: DID): Promise<void>
Parameters
- did: DID
Returns Promise<void>
Implementation of CeramicApi.setDID
- Defined in packages/http-client/src/ceramic-http-client.ts:222