This repository is the welcoming point to TBD's open source efforts.
This repository is not a source forge, but a sync point for TBD projects. It's used for documentation, issues, and discussions that span our individual repositories.
All projects in the TBD family are in early prototyping. New contributors should expect a pace of development consistent with nascent technology: larger commits, frequent refactoring, changing APIs, and incomplete feature-sets. We believe: open source is not a publishing medium. These projects are open from the start to welcome your interest, invite discussion, identify early issues, and advise on design. An early adopter mindset will work well until these projects mature further.
The Discussion forums and Issue trackers are likely the best way to get involved now. Our project leads may be able to guide your efforts and incorporate your feedback in ways that will be most meaningful to you and the project's goals.
In particular, we want to ensure the New Contributor Experience is as smooth as possible. You should be able to:
- Understand each project's goals and scope
- Install prerequisite dependencies
- Clone and build the project
- Run the tests
- Join the conversation in Discussions and Issues
The tbDEX Protocol is the center of our work. It allows users to transact with financial institutions - without a central authority. Users can exchange fiat and crypto with providers who plug into the system.
Decentralized Web Node is
the architecture which makes this possible. It provides
the complex transport and identity systems necessary for parties to transact with one
another. We are developing a TypeScript- and JavaScript-based reference
implementation in the dwn-sdk-js repository.
Together, these systems open up a world of possibility for currency and information exchange. And they return ownership of data where we believe it belongs: with the user.
The tbDEX Protocol was first described in a whitepaper
in November 2021. From its abstract:
tbDEX is a protocol for discovering liquidity and exchanging assets (such as bitcoin, fiat money, or real world goods) when the existence of social trust is an intractable element of managing transaction risk. The tbDEX protocol facilitates decentralized networks of exchange between assets by providing a framework for establishing social trust, utilizing decentralized identity (DID) and verifiable credentials (VCs) to establish the provenance of identity in the real world. The protocol has no opinion on anonymity as a feature or consequence of transactions. Instead, it allows willing counterparties to negotiate and establish the minimum information acceptable for the exchange. Moreover, it provides the infrastructure necessary to create a ubiquity of on-ramps and off-ramps directly between the fiat and crypto financial systems without the need for centralized intermediaries and trust brokers. This makes crypto assets and decentralized financial services more accessible to everyone.
The source for the tbDEX whitepaper is here.
The tbdex-protocol repository is where
this work is housed. It describes the message formats/schemas used to transact. And it also
contains a preliminary mock implementation a PFI (Primary Financial Institution) may
implement when it plugs into the system.
Looking forward, the work done here may be split into separate repositories. For now it's faster to couple the message formats, libraries, and mock implementation together until the APIs harden.
The contribution guide welcomes contributors with resources to get involved.
| Project | Language | Description |
|---|---|---|
ssi-sdk |
Go | Standards-based primitives for using Decentralized Identifiers and Verifiable Credentials. |
ssi-service |
Go | An in-a-box service that handles the full Verifiable Credentials lifecycle, including issuance, verification, revocation, and more. |
dwn-sdk-js |
TypeScript | An implementation of the DIF's emerging decentralized personal datastore standard. |
tbdex-protocol |
Java | A playground as we iterate our way to a robust protocol. Mostly composed of tbDEX message schemas/formats and a mock PFI implemementaion. |
TBD uses GitHub Actions for our repository pipelines. Some checks, such as Security and License Scans, are identical across all our project repositories. Therefore, you can find these shared workflows in the .github/workflows directory.
| Resource | Description |
|---|---|
| CODEOWNERS | Outlines the project lead(s) |
| CODE_OF_CONDUCT.md | Expected behavior for project contributors, promoting a welcoming environment |
| CONTRIBUTING.md | Developer guide to build, test, run, access CI, chat, discuss, file issues |
| GOVERNANCE.md | Project governance |
| LICENSE | Apache License, Version 2.0 |