@blockchaincommons/dcbor - v1.0.0-beta.1
    Preparing search index...

    @blockchaincommons/dcbor - v1.0.0-beta.1

    Blockchain Commons Deterministic CBOR ("dCBOR")

    bc-dcbor-ts is a CBOR codec for TypeScript that focuses on writing and parsing deterministic CBOR per IETF draft-mcnally-deterministic-cbor. It deliberately does not support the parts of the CBOR spec that are forbidden by deterministic encoding (such as indefinite-length arrays and maps), and it is strict in both what it writes and what it reads: it returns decoding errors when variable-length integers are not encoded in their minimal form, when CBOR map keys are not in lexicographic order, or when there is extra data past the end of the decoded item.

    The library is ESM-first (with CommonJS support), has zero runtime dependencies, and produces byte-for-byte identical output to the Rust reference implementation.

    @blockchaincommons/dcbor is published to npm. Install it with your package manager of choice:

    npm install @blockchaincommons/dcbor
    # or
    pnpm add @blockchaincommons/dcbor
    # or
    yarn add @blockchaincommons/dcbor
    # or
    bun add @blockchaincommons/dcbor

    Requirements: TypeScript >= 5.7 is required to consume the published types. Node >= 22.12 is required. Runtime code has no dependencies.

    The entire public surface can be introduced in about a minute:

    import {
      cbor, encodeCbor, decodeCbor, tryDecode, taggedValue,
      isMap, asText, expectArray, extractCbor, CborMap, CborDate,
    } from "@blockchaincommons/dcbor";
    import { diagnostic, hexAnnotated } from "@blockchaincommons/dcbor/diagnostic";

    // Construct: cbor() is the single polymorphic constructor.
    const value = cbor({ name: "Alice", scores: [98, 87], active: true });
    const dated = taggedValue(1, 1675854714); // the only tagged-value constructor

    // Encode: deterministic bytes - equal values always encode identically.
    const bytes = encodeCbor(value); // Uint8Array<ArrayBuffer>

    // Decode: decodeCbor throws CborError; tryDecode returns a Result.
    const decoded = decodeCbor(bytes);
    const result = tryDecode(bytes); // { ok: true, value } | { ok: false, error }

    // Read: fixed prefix semantics.
    isMap(decoded);          // is*     -> type-narrowing boolean guard
    asText(decoded);         // as*     -> T | undefined
    expectArray(decoded);    // expect* -> T, or throws CborError
    extractCbor(decoded);    // explicit native extraction (CborNative)

    // Format (subpath - never rides on the value prototype):
    diagnostic(decoded, { annotate: true });
    hexAnnotated(decoded);

    Runnable examples live in the examples/ directory.

    bc-dcbor-ts is currently under active development and in beta testing. It should not be used for production tasks until it has had further testing and auditing. See Blockchain Commons' Development Phases.

    • 1.0.0-beta.1 (July 21, 2026) - Initial beta implementation.
    • Continued testing and auditing on the path from beta to a stable 1.0.0 release.
    • Stabilization of the typed-decode API (CborCodec<T> / decodeWith), currently marked @beta.
    • Ongoing tracking of the draft-mcnally-deterministic-cbor specification as it advances through the IETF process.
    • Continued parity with the Rust reference implementation as it evolves (see RUST_DIVERGENCES.md).

    @blockchaincommons/dcbor has zero runtime dependencies. To build and work on it, you'll need the following tools:

    • Node.js >= 22.12 - JavaScript runtime.
    • Bun - used in CI to install dependencies and run scripts (any Node-compatible package manager also works).
    • TypeScript >= 5.7 - language and type checker.

    Derived from ...

    This bc-dcbor-ts project is either derived from or was inspired by:

    bc-dcbor-ts is a project of Blockchain Commons. We are proudly a "not-for-profit" social benefit corporation committed to open source & open development. Our work is funded entirely by donations and collaborative partnerships with people like you. Every contribution will be spent on building open tools, technologies, and techniques that sustain and advance blockchain and internet security infrastructure and promote an open web.

    To financially support further development of bc-dcbor-ts and other projects, please consider becoming a Patron of Blockchain Commons through ongoing monthly patronage as a GitHub Sponsor. You can also support Blockchain Commons with bitcoins at our BTCPay Server.

    We encourage public contributions through issues and pull requests! Please review CONTRIBUTING.md for details on our development process. All contributions to this repository require a GPG signed Contributor License Agreement.

    The best place to talk about Blockchain Commons and its projects is in our GitHub Discussions areas.

    Gordian Developer Community. For standards and open-source developers who want to talk about interoperable wallet specifications, please use the Discussions area of the Gordian Developer Community repo. This is where you talk about Gordian specifications such as Gordian Envelope, bc-shamir, Sharded Secret Key Reconstruction, and bc-ur as well as the larger Gordian Architecture, its Principles of independence, privacy, resilience, and openness, and its macro-architectural ideas such as functional partition (including airgapping, the original name of this community).

    Gordian User Community. For users of the Gordian reference apps, including Gordian Coordinator, Gordian Seed Tool, Gordian Server, Gordian Wallet, and SpotBit as well as our whole series of CLI apps. This is a place to talk about bug reports and feature requests as well as to explore how our reference apps embody the Gordian Principles.

    Blockchain Commons Discussions. For developers, interns, and patrons of Blockchain Commons, please use the discussions area of the Community repo to talk about general Blockchain Commons issues, the intern program, or topics other than those covered by the Gordian Developer Community or the Gordian User Community.

    As an open-source, open-development community, Blockchain Commons does not have the resources to provide direct support of our projects. Please consider the discussions area as a locale where you might get answers to questions. Alternatively, please use this repository's issues feature. Unfortunately, we can not make any promises on response time.

    If your company requires support to use our projects, please feel free to contact us directly about options. We may be able to offer you a contract for support from one of our contributors, or we might be able to point you to another entity who can offer the contractual support that you need.

    The following people directly contributed to this repository. You can add your name here by getting involved. The first step is learning how to contribute from our CONTRIBUTING.md documentation.

    Name Role Github Email GPG Fingerprint
    Christopher Allen Principal Architect @ChristopherA <ChristopherA@LifeWithAlacrity.com> FDFE 14A5 4ECB 30FC 5D22 74EF F8D3 6C91 3574 05ED
    Wolf McNally Lead Researcher/Engineer @wolfmcnally <Wolf@WolfMcNally.com> 9436 52EE 3844 1760 C3DC 3536 4B6C 2FCF 8947 80AE
    Leonardo Custodio Maintainer @leonardocustodio <leonardo@snowpine.io> 59DA D997 67EF 3BAB 2B90 D057 5384 DEF3 B582 450D

    Blockchain Commons Deterministic CBOR for TypeScript was produced as a collaboration between Blockchain Commons and one of our patrons, Parity Technologies: Parity wrote the wrappers based on Blockchain Commons' specifications and reference libraries. Blockchain Commons is dedicated to not just creating open infrastructure on our own, but also coordinating the work of other companies in benefiting the Commons. Thanks to Parity for working directly with us in this manner.

    We want to keep all of our software safe for everyone. If you have discovered a security vulnerability, we appreciate your help in disclosing it to us in a responsible manner. We are unfortunately not able to offer bug bounties at this time.

    We do ask that you offer us good faith and use best efforts not to leak information or harm any user, their data, or our developer community. Please give us a reasonable amount of time to fix the issue before you publish it. Do not defraud our users or us in the process of discovery. We promise not to bring legal action against researchers who point out a problem provided they do their best to follow the these guidelines.

    Please report suspected security vulnerabilities in private via email to ChristopherA@BlockchainCommons.com (do not use this email for support). Please do NOT create publicly viewable issues for suspected security vulnerabilities.

    The following keys may be used to communicate sensitive information to developers:

    Name Fingerprint
    Christopher Allen FDFE 14A5 4ECB 30FC 5D22 74EF F8D3 6C91 3574 05ED

    You can import a key by running the following command with that individual’s fingerprint: gpg --recv-keys "<fingerprint>" Ensure that you put quotes around fingerprints that contain spaces.

    Settings
    Member Visibility

    On This Page
    Blockchain Commons Deterministic CBOR ("dCBOR")