Interface CeramicApi

Describes Ceramic node API

Hierarchy

CeramicSigner
- CeramicApi

Indexable

[index: string]: any

Describes Ceramic node API

Index

Properties

Methods

Properties

did

did: DID | undefined

Optional loggerProvider

loggerProvider: LoggerProvider

pin

Methods

addStreamHandler

addStreamHandler<T>(streamHandler: StreamHandler<T>): void

- Defined in packages/common/src/ceramic-api.ts:65
Register Stream handler

Type parameters
- T: Stream
Parameters
- streamHandler: StreamHandler<T>
  
  StreamHandler instance
Returns void

applyCommit

applyCommit<T>(streamId: StreamID | string, commit: CeramicCommit, opts?: CreateOpts | UpdateOpts): Promise<T>

- Defined in packages/common/src/ceramic-api.ts:101
Applies commit on the existing stream

Type parameters
- T: Stream
Parameters
- streamId: StreamID | string
  
  Stream ID
- commit: CeramicCommit
  
  Commit to be applied
- Optional opts: CreateOpts | UpdateOpts
  
  Initialization options
Returns Promise<T>

close

close(): Promise<void>

- Defined in packages/common/src/ceramic-api.ts:119
Closes Ceramic instance

Returns Promise<void>

createStreamFromGenesis

createStreamFromGenesis<T>(type: number, genesis: any, opts?: CreateOpts): Promise<T>

- Defined in packages/common/src/ceramic-api.ts:73
Create Stream from genesis commit

Type parameters
- T: Stream
Parameters
- type: number
  
  Stream type
- genesis: any
  
  Genesis commit
- Optional opts: CreateOpts
  
  Initialization options
Returns Promise<T>

getSupportedChains

getSupportedChains(): Promise<Array<string>>

- Defined in packages/common/src/ceramic-api.ts:114
Returns Promise<Array<string>>

An array of the CAIP-2 chain IDs of the blockchains that are supported for anchoring stream.

loadStream

loadStream<T>(streamId: StreamID | CommitID | string, opts?: LoadOpts): Promise<T>

- Defined in packages/common/src/ceramic-api.ts:80
Loads Stream instance

Type parameters
- T: Stream
Parameters
- streamId: StreamID | CommitID | string
  
  Stream ID
- Optional opts: LoadOpts
  
  Initialization options
Returns Promise<T>

loadStreamCommits

loadStreamCommits(streamId: StreamID | string): Promise<Array<Record<string, any>>>

- Defined in packages/common/src/ceramic-api.ts:86
Load all stream commits by stream ID

Parameters
- streamId: StreamID | string
  
  Stream ID
Returns Promise<Array<Record<string, any>>>

multiQuery

multiQuery(queries: Array<MultiQuery>, timeout?: number): Promise<Record<string, Stream>>

- Defined in packages/common/src/ceramic-api.ts:93
Load all stream types instances for given multiqueries

Parameters
- queries: Array<MultiQuery>
  
  Array of MultiQueries
- Optional timeout: number
  
  Timeout in milliseconds
Returns Promise<Record<string, Stream>>

setDID

setDID(did: DID): Promise<void>

- Defined in packages/common/src/ceramic-api.ts:108
Sets the DID instance that will be used to author commits to stream. The DID instance also includes the DID Resolver that will be used to verify commits from others.

Parameters
- did: DID
Returns Promise<void>