@ceramicnetwork/core
    TypeScript icon, indicating that this package has built-in type declarations

    1.13.0 • Public • Published

    Ceramic Core

    This package contains the implementation of the core Ceramic protocol. It's exposed using a simple JavaScript API.

    Getting started

    Installation

    $ npm install @ceramicnetwork/core
    

    Usage

    import Ceramic from '@ceramicnetwork/core'
    import TileDocument from '@ceramicnetwork/stream-tile'
    
    import IPFS from 'ipfs-core'
    import dagJose from 'dag-jose'
    import { convert } from 'blockcodec-to-ipld-format'
    
    const format = convert(dagJose)
    
    const ipfs = Ipfs.create({
        ipld: { formats: [format] },
    })
    
    const config: CeramicConfig = {}
    const ceramic = await Ceramic.create(ipfs, config)
    
    // create document example
    const tileDocument = await TileDocument.create(ceramic, { test: 123 })
    

    Ceramic API

    Complete Ceramic core API is available on Ceramic API.

    Development

    Run tests:

    $ npm test
    

    Run linter:

    npm run lint
    

    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

    Install

    npm i @ceramicnetwork/core

    DownloadsWeekly Downloads

    762

    Version

    1.13.0

    License

    (Apache-2.0 OR MIT)

    Unpacked Size

    614 kB

    Total Files

    163

    Last publish

    Collaborators

    • npm.3box
    • smrz2001
    • oed
    • zachferland
    • paul_lecam
    • stbrody
    • ukstv