Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes Ceramic node API

Hierarchy

Indexable

[index: string]: any

Describes Ceramic node API

Index

Properties

did

did: DID | undefined

Optional loggerProvider

loggerProvider: LoggerProvider

pin

pin: PinApi

Methods

addStreamHandler

applyCommit

close

  • close(): Promise<void>

createStreamFromGenesis

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

getSupportedChains

  • getSupportedChains(): Promise<Array<string>>

loadStream

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

loadStreamCommits

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

multiQuery

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

requestAnchor

  • Requests an anchor for the given StreamID if the Stream isn't already anchored. Returns the new AnchorStatus for the Stream.

    Parameters

    • streamId: StreamID | string
    • Optional opts: LoadOpts

      used to load the current Stream state

    Returns Promise<AnchorStatus>

setDID

  • setDID(did: DID): Promise<void>
  • 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>