TBD54566975 / web5-wallet

A reference implementation of a web5 wallet in react native
Apache License 2.0
13 stars 8 forks source link

Flesh out a sharable DWN protocol standard #66

Closed shamilovtim closed 1 week ago

shamilovtim commented 11 months ago

DWN protocols currently aren't required to specify their types or shape which means our goal of facilitating their sharing is not being met.

Ideas we have:

  1. Typescript types should be shipped
  2. JSON Schema should be shipped
  3. Protocols could maybe ship as an npm package? credit: @mistermoe
  4. Maybe JSDocs should be required?

Follow up thoughts:

How do we lint a future protocol and ensure that our standards are being met? For example, if we say that they should ship types how do we lint and accept/reject such a protocol?

shamilovtim commented 11 months ago

Idea: we model after https://github.com/DefinitelyTyped/DefinitelyTyped and claim an npm scope like @web5-protocols. Then we allow pull requests to a Github repo web5-protocols and similar to DefinitelyTyped, each package gets published to npm under @web5-protocols/name-of-package.