Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @ceramicnetwork/common

Ceramic Common

This package contains common Ceramic types and utilities.

Installation

 
$ npm install @ceramicnetwork/common

Contributing

We are happy to accept small and large contributions. Make sure to check out the Ceramic specifications for details of how the protocol works.

License

Index

References

Enumerations

Classes

Interfaces

Type aliases

Functions

Object literals

References

AnchorCommit

Re-exports AnchorCommit

AnchorOpts

Re-exports AnchorOpts

AnchorProof

Re-exports AnchorProof

AnchorService

Re-exports AnchorService

AnchorServiceAnchored

Re-exports AnchorServiceAnchored

AnchorServiceFailed

Re-exports AnchorServiceFailed

AnchorServicePending

Re-exports AnchorServicePending

AnchorServiceProcessing

Re-exports AnchorServiceProcessing

AnchorServiceResponse

Re-exports AnchorServiceResponse

AnchorStatus

Re-exports AnchorStatus

AnchorValidator

Re-exports AnchorValidator

CeramicApi

Re-exports CeramicApi

CeramicCommit

Re-exports CeramicCommit

CeramicSigner

Re-exports CeramicSigner

CidList

Re-exports CidList

CidString

Re-exports CidString

CommitData

Re-exports CommitData

CommitHeader

Re-exports CommitHeader

CommitMeta

Re-exports CommitMeta

CommitType

Re-exports CommitType

Context

Re-exports Context

CreateOpts

Re-exports CreateOpts

Designator

Re-exports Designator

DiagnosticsLogger

Re-exports DiagnosticsLogger

DiagnosticsLoggerBase

Re-exports DiagnosticsLoggerBase

FileLoggerFactory

Re-exports FileLoggerFactory

GenesisCommit

Re-exports GenesisCommit

GenesisHeader

Re-exports GenesisHeader

InternalOpts

Re-exports InternalOpts

LoadOpts

Re-exports LoadOpts

LogEntry

Re-exports LogEntry

LogLevel

Re-exports LogLevel

LogStyle

Re-exports LogStyle

LoggerConfig

Re-exports LoggerConfig

LoggerProvider

Re-exports LoggerProvider

LoggerProviderBase

Re-exports LoggerProviderBase

MultiQuery

Re-exports MultiQuery

Networks

Re-exports Networks

PinApi

Re-exports PinApi

PinningBackend

Re-exports PinningBackend

PinningBackendStatic

Re-exports PinningBackendStatic

PinningInfo

Re-exports PinningInfo

PinningOpts

Re-exports PinningOpts

Pipeable

Re-exports Pipeable

PublishOpts

Re-exports PublishOpts

RawCommit

Re-exports RawCommit

RunningStateLike

Re-exports RunningStateLike

ServiceLog

Re-exports ServiceLog

ServiceLogger

Re-exports ServiceLogger

ServiceLoggerBase

Re-exports ServiceLoggerBase

SignatureStatus

Re-exports SignatureStatus

SignedCommit

Re-exports SignedCommit

SignedCommitContainer

Re-exports SignedCommitContainer

Stream

Re-exports Stream

StreamConstructor

Re-exports StreamConstructor

StreamHandler

Re-exports StreamHandler

StreamMetadata

Re-exports StreamMetadata

StreamNext

Re-exports StreamNext

StreamState

Re-exports StreamState

StreamStateHolder

Re-exports StreamStateHolder

StreamStateSubject

Re-exports StreamStateSubject

StreamStatic

Re-exports StreamStatic

StreamUtils

Re-exports StreamUtils

SubscriptionSet

Re-exports SubscriptionSet

SyncOptions

Re-exports SyncOptions

TestUtils

Re-exports TestUtils

UnreachableCaseError

Re-exports UnreachableCaseError

UpdateOpts

Re-exports UpdateOpts

WriteableStream

Re-exports WriteableStream

fetchJson

Re-exports fetchJson

Type aliases

AnchorServiceResponse

AnchorServiceResponse: AnchorServicePending | AnchorServiceProcessing | AnchorServiceAnchored | AnchorServiceFailed

Describes anchor service response

CeramicCommit

CeramicCommit: AnchorCommit | GenesisCommit | RawCommit | SignedCommit | SignedCommitContainer

CidList

CidList: Record<CidString, Designator[]>

CidString

CidString: string

CommitMeta

CommitMeta: { cid: CID; disableTimecheck?: boolean; timestamp?: number }

Commit meta-information, like CID and timestamp.

Type declaration

  • cid: CID
  • Optional disableTimecheck?: boolean

    Do not time-check a signature.

  • Optional timestamp?: number

Designator

Designator: string

GenesisCommit

GenesisCommit: { data?: any; header: GenesisHeader }

Type declaration

IpfsApi

IpfsApi: IPFS

PinningInfo

PinningInfo: Record<string, any>

SignedCommit

SignedCommit: DagJWS

SignedCommitContainer

SignedCommitContainer: DagJWSResult

Functions

StreamStatic

  • StreamStatic<T>(): (Anonymous function)

fetchJson

  • fetchJson(url: string, opts?: FetchOpts): Promise<any>

Object literals

Const DEFAULT_LOG_CONFIG

DEFAULT_LOG_CONFIG: object

logLevel

logLevel: LogLevel = LogLevel.important

logToFiles

logToFiles: boolean = false

Const consoleLogger

consoleLogger: object

err

err: error = console.error

imp

imp: log = console.log

info

info: log = console.log

warn

warn: warn = console.warn