leofcoin / ipld-leofcoin

ipld-leofcoin

JavaScript implementation of the IPLD format spec for Leofcoin.

Table of Contents

• Install
  • npm
  • Use in Node.js
  • Use in a browser with browserify, webpack or any other bundler
  • Use in a browser Using a script tag
• Usage
• Maintainers
• Contribute
• License

Install

npm

> npm install ipld-leofcoin

Use in Node.js

const IpldLeofcoin = require('ipld-leofcoin')

Use in a browser with browserify, webpack or any other bundler

The code published to npm that gets loaded on require is in fact a ES5 transpiled version with the right shims added. This means that you can require it and use with your favourite bundler without having to adjust asset management process.

var IpldLeofcoin = require('ipld-leofcoin')

Use in a browser Using a script tag

Loading this module through a script tag will make the IpldLeofcoin obj available in the global namespace.

<script src="https://unpkg.com/ipld-leofcoin/dist/index.min.js"></script>
<!-- OR -->
<script src="https://unpkg.com/ipld-leofcoin/dist/index.js"></script>

Usage

As this is is an implementation of the IPLD format spec, it should be used through the IPLD resolver. See the IPLD format spec for details about the API.

Though it can also be used as a standalone module:

const IpldLeofcoin = require('ipld-leofcoin')

// `leofcoinBlock` is some binary Leofcoin block
IpldLeofcoin.util.deserialize(leofcoinBlock, (err, dagNode) => {
  if (err) {
    throw err
  }
  console.log(dagNode)
})

Maintainers

@vandeurenglenn

Contribute

Feel free to join in. All welcome. Open an issue!

License

MIT © 2018 IPFS
MIT © 2020 Leofcoin