Skip to content

Commit

Permalink
remove reference impl (#1213)
Browse files Browse the repository at this point in the history
* remove reference impl

* update readme

* update ci

* add spec-up

* add spec-up
  • Loading branch information
decentralgabe committed Apr 4, 2023
1 parent 94d861c commit bb4bb16
Show file tree
Hide file tree
Showing 366 changed files with 8,281 additions and 38,431 deletions.
8 changes: 0 additions & 8 deletions .dockerignore

This file was deleted.

7 changes: 4 additions & 3 deletions .github/workflows/ci.yml
Expand Up @@ -16,6 +16,7 @@ jobs:
with:
node-version: ${{ matrix.node-version }}
- run: npm i
- run: npm run build
- run: npm run test:only # so we don't run the code coverage badge creation script and let the line below handle it
- run: npm run badge:cc:ci # throws if README output differs to README to be checked in (thus detects if tests are not run)
- run: |
node -e "require('spec-up')({ nowatch: true })"
npm run spec
rm -rf node_modules
32 changes: 0 additions & 32 deletions .github/workflows/release.yml

This file was deleted.

32 changes: 0 additions & 32 deletions .github/workflows/unstable-release.yml

This file was deleted.

26 changes: 2 additions & 24 deletions README.md
@@ -1,6 +1,7 @@
# Sidetree

This repository contains both the blockchain-agnostic Sidetree specification and a Node.js based reference implementation.
This repository contains both the blockchain-agnostic Sidetree specification.
A reference implementation [can be found here](https://github.com/decentralized-identity/sidetree-reference-impl).

## Specification

Expand All @@ -22,26 +23,3 @@ See the [API spec](https://identity.foundation/sidetree/api/) for the full API s
10. When you are happy with your changes, commit to your topic branch and open a Pull Request on GitHub and reviewers will be alerted to review for a potential merge.
11. Make sure to tag people continuously to ensure your PR is reviewed in a timely manner.
12. PRs that sit open without comments / reviews, will be closed at the editors discretion.

## Reference Implementation

![CI](https://github.com/decentralized-identity/sidetree/workflows/CI/badge.svg)
![npm-version](https://badgen.net/npm/v/@decentralized-identity/sidetree)
![npm-unstable-version](https://badgen.net/npm/v/@decentralized-identity/sidetree/unstable)


Code Coverage

![Statements](https://img.shields.io/badge/statements-100%25-brightgreen.svg?style=flat) ![Branches](https://img.shields.io/badge/branches-100%25-brightgreen.svg?style=flat) ![Functions](https://img.shields.io/badge/functions-100%25-brightgreen.svg?style=flat) ![Lines](https://img.shields.io/badge/lines-100%25-brightgreen.svg?style=flat)

See the [test vectors](tests/fixtures) for input fixtures that are expected by all sidetree implementations.

See the [reference implementation document](docs/core.md) for description of the reference implementation.

See the [styleguide](docs/styleguide.md) for details regarding this specification and implementation conformance to industry conventions for JSON and HTTP.


### Release Process

Refer to [here](/docs/release-process.md) for details on the release process of the artifacts in this repository.

4 changes: 2 additions & 2 deletions docs/core.md
Expand Up @@ -82,7 +82,7 @@ The orchestration layer requires implementation of following interfaces per prot
### REST API HTTP Response status codes

| HTTP status code | Description |
| ---------------- | ---------------------------------------- |
|------------------|------------------------------------------|
| 200 | Everything went well. |
| 400 | Bad client request. |
| 401 | Unauthenticated or unauthorized request. |
Expand Down Expand Up @@ -749,4 +749,4 @@ Event data: none
### `sidetree_observer_loop_success`
Occurs every time the observer completes a processing loop.

Event data: none
Event data: none
60 changes: 0 additions & 60 deletions docs/release-process.md

This file was deleted.

16 changes: 8 additions & 8 deletions docs/type-registry.md
Expand Up @@ -5,11 +5,11 @@ The following table is a registry of DID type strings that can be used in Sidetr
The registry is predicated on mapping well-known schema-defined objects to terse byte strings. All types are of non-human entities, objects, and things. To propose additions to the list, file an Issue with this repo and add the `did-type` and `feature` tags.


| Type Name | Schema | Type String |
|---------------------------|----------------------|:---------------------------|
| Organization | https://schema.org/Organization | 0001 |
| Government Organization | https://schema.org/GovernmentOrganization | 0002 |
| Corporation | https://schema.org/Corporation | 0003 |
| Local Business | https://schema.org/LocalBusiness | 0004 |
| Software Package | https://schema.org/SoftwareSourceCode | 0005 |
| Web App | https://schema.org/WebApplication | 0006 |
| Type Name | Schema | Type String |
|-------------------------|-------------------------------------------|:------------|
| Organization | https://schema.org/Organization | 0001 |
| Government Organization | https://schema.org/GovernmentOrganization | 0002 |
| Corporation | https://schema.org/Corporation | 0003 |
| Local Business | https://schema.org/LocalBusiness | 0004 |
| Software Package | https://schema.org/SoftwareSourceCode | 0005 |
| Web App | https://schema.org/WebApplication | 0006 |
39 changes: 0 additions & 39 deletions lib/bitcoin/BitcoinBlockDataIterator.ts

This file was deleted.

0 comments on commit bb4bb16

Please sign in to comment.