w3c / w3c/json-ld-syntax

RDF* in CBOR?

Open
#451 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

spec:enhancement substantive:class 4
Dominant language
HTML
Stars
139
Forks
23
PR merge metrics
No merged PRs in 30d

Description

We are working a new specification for a binary format using IETF CBOR called "Gordian Envelopes". We are planning to submit this spec for Gordian Envelopes that leverages deterministic CBOR as an IETF Internet-Draft by end of the week:

ABSTRACT: The envelope protocol specifies a format for hierarchical binary data built on CBOR. Envelopes are designed with "smart documents" in mind, and have a number of unique features including easy representation of semantic structures like triples, built-in normalization, a built-in Merkle-like digest tree, and the ability for the holder of a document to selectively encrypt or elide specific parts of a document without invalidating the digest tree or cryptographic signatures that rely on it

https://blockchaincommons.github.io/WIPs-IETF-draft-envelope/draft-mcnally-envelope.html

In particular for this group, it supports triples where both the predicates and objects can be fully nested, i.e. "envelopes in envelopes". Part of the goal for this was to support annotation to allow for semantic clarity of both.

As I understand it, this approach comes closest to RDF* in approach, as it is more that a LPG (labeled property graph). Gordian Envelopes are, however, ONLY a data format, it does not specify or require semantic data.

We have a high-level overview of Gordian Envelops at:

https://www.blockchaincommons.com/introduction/Envelope-Intro/

A more engineering-level introduction at:

https://github.com/BlockchainCommons/Gordian/blob/master/Docs/Envelope-Tech-Intro.md

We have a video playlist starting with a 10m high-level introduction:

https://www.youtube.com/playlist?list=PLCkrqxOY1FbooYwJ7ZhpJ_QQk8Az1aCnG

We have a reference CLI implementation (written in Swift) available now, and some of our patrons have begun porting libraries to more languages like Kotlin, Typescript, Python, and Blockchain Commons is also committed to porting to Rust as funding allows. Let us know your needs!

For those of you who don't like videos, we have an annotated introduction to our CLI reference implementation that really demonstrates of the power of CBOR with Gordian Envelopes:

https://github.com/BlockchainCommons/envelope-cli-swift/blob/master/Transcripts/1-OVERVIEW-TRANSCRIPT.md

I'm seeking someone with a greater familiarity with RDF* architectures to identify if Gordian Envelopes might be useful to this community.

cc/ @wolfmcnally @selfissued @drummondreed

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Gordian Envelopes IETF draft and Envelope-Tech-Intro.md, then compare their nested triple model with RDF* architectures. Done would be a documented assessment of whether Gordian Envelopes is useful to the JSON-LD/RDF* community, including any relevant compatibility or distinction.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.