Inline IPLD#

This library implements the Inline IPLD spec for

• Hardware (host) architectrues (x86, ARM, etc)
• wasm32-unknown-unknown
• WebAssembly Components

Quickstart#

Nix Flakes#

foo@bar:~$  nix develop
🔨 Welcome to inline_ipld

[build]

  build                - [DEFAULT] Build for current host target
  build:host           - Build for current host target
  build:wasi           - Build for WASI
  build:wasm           - Build for wasm32-unknown-unknown
✂️  SNIP ✂️

foo@bar:~$ build:host
   Compiling inline_ipld v0.1.0 (/Users/expede/Documents/Volunteer/inline_ipld/inline_ipld)
    Finished dev [unoptimized + debuginfo] target(s) in 0.48s

foo@bar:~$ test:host
✂️  SNIP ✂️
test result: ok. 13 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 4.02s

foo@bar:~$ docs

TL;DR#

Inline IPLD is not a special codec, but rather a layer on top of the IPLD data model. This means that it is compatible with any IPLD codec.

The goal of Inline IPLD is to allow for inlining subgraphs that would otherwise need to be broken up for storage and inspection, which providing a standard way to recover "standard" IPLD (so that its CID doesn't change).

The shape of Inline IPLD is either:

{"/": {".": Ipld}}
{"/": {".": Ipld, "&": Cid}}

If the CID is omited, the CID configuration (codec, hash function, and version) is inherited by the CID of the parent node. In this case, the CID is calculated during extraction (i.e. returning back to regular IPLD).