Class Utils

Various utility functions

Hierarchy

Utils

Index

Constructors

Methods

anchorUpdate extractCapability getCommitData

Constructors

constructor

new Utils(): Utils
Returns Utils

Methods

`Static` anchorUpdate

anchorUpdate(ceramic: Ceramic, stream: Stream): Promise<void>
Trigger anchor for a stream.
Parameters
- ceramic: Ceramic
  
  Ceramic Core instance.
- stream: Stream
  
  Stream to trigger anchor on.
Returns Promise<void>
- Defined in packages/core/src/utils.ts:69

`Static` extractCapability

extractCapability(commit: any, dispatcher: Dispatcher): Promise<Cacao>
Attempts to load CACAO capability from IPFS if present in protected header of commit

Returns
a Cacao capability object if found, else null
Parameters
- commit: any
  
  the commit to load the capability for
- dispatcher: Dispatcher
  
  instance of dispatcher to load from IPFS
Returns Promise<Cacao>
- Defined in packages/core/src/utils.ts:47

`Static` getCommitData

getCommitData(dispatcher: Dispatcher, cid: CID<unknown, number, number, Version>, streamId?: StreamID, timestamp?: number): Promise<CommitData>
Return CommitData (with commit, JWS envelope, and/or anchor proof/timestamp, as applicable) for the specified CID
Parameters
- dispatcher: Dispatcher
- cid: CID<unknown, number, number, Version>
- Optional streamId: StreamID
- Optional timestamp: number
Returns Promise<CommitData>
- Defined in packages/core/src/utils.ts:17