Sidetree spec v1.0.0

v1.0.2

Sidetree Spec v1.0

v0.9.1

Fork status: Not a fork*

v0.9.1	Code change	Persistent Store Breaking	Configuration Change
Core service	Yes	No*	No
Bitcoin microservice	No	No	No
IPFS microservice	No	No	No

*This release technically is a soft fork, but since we anticipate minimal impact, we release this version as a patch.

Core service

1. Handled the initial case where no general/auth keys are present in a Document.

v0.9.0

Fork status: Hard fork

v0.9.0	Code change	Persistent Store Breaking	Configuration Change
Core service	Yes	Yes	No
Bitcoin microservice	No	No	No
IPFS microservice	No	No	No

This release breaks backwards compatibility for Core service. Requires DB reset for Core service.

Core service

1. Renamed usage to purpose for public keys.
2. Update commit-reveal scheme aligns with recovery commit-reveal scheme.

v0.8.0

Fork status: Hard fork

v0.8.0	Code change	Persistent Store Breaking	Configuration Change
Core service	Yes	Yes	No
Bitcoin microservice	Yes	Yes	No
IPFS microservice	No	No	No

This release breaks backwards compatibility for Core and Bitcoin services. Requires DB reset for Core and Bitcoin service.

Core service

1. Changed anchor string format.
2. Changed DID unique suffix generation algorithm.
3. Removed the need for recovery reveal values.
4. Used commit-reveal chain as operation order instead of strict ledger time.
5. Fixed property casing in operation delta schema.
6. Allowed any key type for non-operation keys.

Bitcoin service

1. Fixed bug that caused potential crash upon restart.
2. Changed max operation count algorithm for value-locked transactions.
3. Fixed DB to store the denormalized quantile values.

v0.7.0

Fork status: Hard fork

v0.7.0	Code change	Persistent Store Breaking	Configuration Change
Core service	Yes	Yes	Yes
Bitcoin microservice	Yes	Yes	Yes
IPFS microservice	Yes	No	No

This is a release that intentionally breaks backwards compatibility. Requires DB reset for Core and Bitcoin services.

Core service

1. CAS file format revamp.
2. JWK key support.

Bitcoin service

1. Proof-of fee implemented.
2. Fee staking implemented.

IPFS service

1. Service now capable of terminating downloads that exceeds max size.

v0.6.1

v0.6.1	Protocol Breaking	Persistent Store Breaking	Configuration Change
Core service	No	Yes	Yes
Bitcoin microservice	No	Yes	Yes
IPFS microservice	No	No	No

Core service

1. Bug fixes on transaction selector and batchwriter

Bitcoin service

1. Genesis block reset (Nodes need to reset DB)

v0.6.0

v0.6.0	Protocol Breaking	Persistent Store Breaking	Configuration Change
Core service	Yes	Yes	Yes
Bitcoin microservice	Yes	Yes	Yes
IPFS microservice	No	No	No

Core service

1. Controller is now a property of the public key in DID doc
2. Add support for recovery operation
3. New long form implementation
4. Duplicate public key id in one DID doc is now invalid
5. Add one time password (OTP) scheme
6. Move Operation/type from header into payload
7. Add throughput limiter
8. Add map file structure
9. Bug fixes

Bitcoin service

1. Now log method name every jrpc call
2. Add proof of fee
3. Integrate bitcoin service with bitcoin test net
4. Bitcoin spending cap is now configurable
5. Now always returns complete blocks
6. WIP: support for bitcoin locking
7. Bug fixes

v0.5.0

v0.5.0	Protocol Breaking	Persistent Store Breaking	Configuration Change
Core service	Yes	No	No
Bitcoin microservice	Yes	No	No
IPFS microservice	No	No	No

Core service

1. Added support to return the service versions.
2. Added required usage property to public key entries in DID document.
3. Added compression to batch and anchor files.
4. Prevented rollback if current Blockchain time is behind last transaction time.
5. Changed unprotected header in operation requests to be protected.
6. Various engineering improvements.

Bitcoin service

1. Ignored transactions which have multiple OP_RETURN with Sidetree data.

v0.4.1

v0.4.1	Protocol Breaking	Persistent Store Breaking	Configuration Change
Core service	No	No	No
Bitcoin microservice	No	No	No
IPFS microservice	No	No	No

Core service

1. Tests - Boosted code coverage back up to > 80%.
2. Blockchain client - Replaced generic error throwing with specific error.
3. Removed core, bitcoin, and IPFS service samples.
4. Updated dependencies.
5. Fixed interface naming inconsistency.

v0.4.0

v0.4.0	Protocol Breaking	Persistent Store Breaking	Configuration Change
Core service	Yes	Yes	Yes
Bitcoin microservice	Yes	Yes	No
IPFS microservice	No	No	No

Core service

1. Implemented protocol upgrade support with backward-compatibility.
2. Replaced JSON patch based DID update mechanism to use strict update payload schema instead.
3. Added numerous error codes for bad operation request responses.
4. Added schema validation for update operation payload.
5. Removed concept of 'operation number' in update operation payload.
6. Added Secp256k1 key check to only allow compressed format.
7. Standardized interface naming.

Bitcoin microservice

1. anchorFileHash property renamed to anchorString in transaction objects returned in API.