Skip to content

[WIP] A collection of all on-going integration / finalization efforts and open tasks. #17

@Exulansis

Description

@Exulansis

This issue attempts to list all current open tasks and integration efforts. The main goal of this issue is to ensure nothing is accidentally omitted, as well as to provide for a space for discussions.


As far as tasks from milestone 1 are concerned:

  1. Write out a new DID method spec document for the did:stack:v2 DID method.

The updated spec can be found here. All relevant sections are updated. The specification document is pending further review / corrections. Open TODOs are:

  • Incorporate received feedback and corrections
  • (editorial) Update links and references
  1. Provide an implementation of a DID resolver module for did:stack:v2 DIDs.

The resolver implementation can be found in this repository. In order to facilitate the development of the resolver module, a number of functions related to DID registration had to be defined as well. These functions are not relevant for this deliverable, and are not exposed to the end users. Open TODOs are:

  • (Optional / nice to have) - Return the user's Gaia hub URL as part of the resolved DID document (as a service endpoint section). Was scoped in initially, but the implementation effort is trivial. Issue was raised on the Discord channel, also documented in Return the DID's Gaia HUB url in the resolved DID Document #8.

As far as tasks from milestone 2 are concerned:

  1. Integrate / migrate the resolver code with / to the Stacks.js repository, as a new package
    The stacks.js repository has been forked, and the "did-resolver" package is integrated here. Open TODOs are:
  • Open a pull request to the upstream repository to include the new package.
  • Publish the module to the appropriate repositories (specifically NPM), under the appropriate name, e.g. @stacks/did-resolver.
  1. Add a new HTTP endpoint to the Stacks-Blockchain-Api repository, namely /v2/dids/:did enabling the easy resolution of v2 DIDs.
    The stacks-blockchain-api repository has been forked, and the integration has started with this commit. Open TODOs on this front are:
  • Update the dependencies to make use of the @stacks/did-resolver module published to NPM as opposed to a local copy.
  • Finalize the openapi.yaml documentation to include correct example and schema definition for the expected return value.
  • Open a pull request to the upstream repository to include the new endpoint.

As far as tasks from milestone 3 are concerned:

  1. Integrate the Stacks DID resolver with the Jolocom SDK
    The SDK plugin is finalized, defined here. A simple test is included as well to ensure the resolution works as intended. Open TODOs are:
  • Release a new version of the Jolocom SDK which registers / uses this plugin by default.
  1. Integration with the DIF Unversal Resolver service.
    A "Dockerized" version of the resolver module is defined and included here. The docker container can be run using the appropriate script (npm run uni-resolver-driver) for testing purposes. Open TODOs are:
  • Publish the Docker Image to Docker Hub
  • Open a PR against the Universal Resolver repository to include the published image.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions