Skip to main content

Decentralized Web Node (DWN) SDK

Code Coverage

Statements Branches Functions Lines

Introduction

This repository contains a reference implementation of Decentralized Web Node (DWN) as per the specification. This specification is in a draft state and very much so a WIP. For the foreseeable future, a lot of the work on DWN will be split across this repo and the repo that houses the specification, which you can find here. The current goal is to produce a beta implementation by Q4 2022. This won't include all interfaces described in the spec, but enough to begin building applications.

Proposals and issues for the specification itself should be submitted as pull requests to the spec repo.

Installation

npm install @tbd54566975/dwn-sdk-js

Usage

import { Dwn } from '@tbd54566975/dwn-sdk-js';

// cool things

Note: Works in both node and browser environments

⚠ Currently, in order to use this sdk in node environments you'll have to include the --es-module-specifier-resolution=node flag when running your javascript.

Project Resources

ResourceDescription
CODEOWNERSOutlines the project lead(s)
CODE_OF_CONDUCT.mdExpected behavior for project contributors, promoting a welcoming environment
CONTRIBUTING.mdDeveloper guide to build, test, run, access CI, chat, discuss, file issues
GOVERNANCE.mdProject governance
LICENSEApache License, Version 2.0