Class CeramicDaemon

Ceramic daemon implementation

Hierarchy

  • CeramicDaemon

Constructors

constructor

Properties

ceramic diagnosticsLogger hostname port

Methods

_getCollection _getCollectionCount _notSupported _pinNotSupported _pinWarningOk _verifyAndDiscardAdminCode applyCommit close commits content createReadOnlyStreamFromGenesis createStreamFromGenesis documentsFeed generateAdminCode getAdminCode getCollectionCount_post getCollection_post getIndexedModelData getIndexedModels getSupportedChains healthcheck listPinned listen multiQuery nodeStatus pinStream registerAPIPaths requestAnchor shutdownServer startIndexingModelData startIndexingModels state stopIndexingModelData stopIndexingModels unpinStream validateAdminRequest create

Constructors

constructor

Properties

ceramic

ceramic: Ceramic

Readonly diagnosticsLogger

diagnosticsLogger: DiagnosticsLogger

hostname

hostname: string

port

port: number

Methods

_getCollection

  • _getCollection(httpQuery: Record<string, any>): Promise<Record<string, any>>

  • Helper function for the shared implementation of serving a collection query

    Parameters

    • httpQuery: Record<string, any>

    Returns Promise<Record<string, any>>

_getCollectionCount

  • _getCollectionCount(httpQuery: Record<string, any>): Promise<Record<string, any>>

  • Parameters

    • httpQuery: Record<string, any>

    Returns Promise<Record<string, any>>

_notSupported

  • _notSupported(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<void>

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

_pinNotSupported

  • _pinNotSupported(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<void>

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

_pinWarningOk

  • _pinWarningOk(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<void>

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

_verifyAndDiscardAdminCode

applyCommit

  • Apply one commit to the existing stream

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

close

commits

  • Get all stream commits

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

content

  • Render the most recent version of a stream's contents

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

createReadOnlyStreamFromGenesis

  • Create read-only stream from genesis commit

    Dev

    Useful when the streamId is unknown, but you have the genesis contents

    TODO

    Should return null if stream does not already exist instead of current behavior, publishing to IPFS. With that change it will make sense to rename this, e.g. loadStreamFromGenesis

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

createStreamFromGenesis

  • Create stream from init commit

    Dev

    Useful when the streamId is unknown, but you have the init contents

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

documentsFeed

  • Parameters

    • _: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns void

generateAdminCode

getAdminCode

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

getCollectionCount_post

  • getCollectionCount_post(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<void>

  • Implementation of count queries (the 'collection/count' http endpoint) using the HTTP POST method.

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

getCollection_post

  • getCollection_post(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<void>

  • Implementation of collection queries (the 'collection' http endpoint) using the HTTP POST method.

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

getIndexedModelData

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

getIndexedModels

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

getSupportedChains

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

healthcheck

  • Checks for availability of subsystems that Ceramic depends on (e.g. IPFS)

    Dev

    Only checking for IPFS right now but checks for other subsystems can go here in the future

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

listPinned

  • List pinned streams

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

listen

multiQuery

  • Load multiple streams and paths using an array of multiqueries

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

nodeStatus

  • Returns diagnostic/introspection information

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

pinStream

  • Pin stream

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

registerAPIPaths

requestAnchor

  • Request stream to be anchored

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

shutdownServer

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

startIndexingModelData

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

startIndexingModels

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

state

  • Get stream state

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

stopIndexingModelData

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

stopIndexingModels

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

unpinStream

  • Unpin stream

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>

    Returns Promise<void>

validateAdminRequest

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>
    • next: NextFunction

    Returns Promise<void>

Static create

Settings

Member Visibility

Theme