@enbox/dwn-server 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,353 @@
+# DWN Server <!-- omit in toc -->
+
+Exposes a multi-tenanted DWN (aka Decentralized Web Node) through a JSON-RPC API over `http:` and `ws:`
+
+- [Supported DBs](#supported-dbs)
+- [Installation](#installation)
+- [Package usage](#package-usage)
+- [Running The Server](#running-the-server)
+- [JSON-RPC API](#json-rpc-api)
+  - [Available Methods](#available-methods)
+    - [`dwn.processMessage`](#dwnprocessmessage)
+      - [Params](#params)
+      - [Example Request Message](#example-request-message)
+      - [Example Success Response](#example-success-response)
+      - [Example Error Response](#example-error-response)
+      - [Transporting large amounts of data](#transporting-large-amounts-of-data)
+      - [Receiving large amounts of data](#receiving-large-amounts-of-data)
+- [npm scripts](#npm-scripts)
+- [Configuration](#configuration)
+  - [Storage Options](#storage-options)
+
+## Supported DBs
+
+- LevelDB :heavy_check_mark:
+- SQLite :heavy_check_mark:
+- MySQL :heavy_check_mark:
+- PostgreSQL :heavy_check_mark:
+
+See more in [Storage Options](#storage-options)
+
+## Running online environment
+
+Interested in contributing instantly? You can make your updates directly without cloning in the running CodeSandbox environment.
+
+[![Button to click and edit the code in CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/github/enboxorg/enbox/dwn-server/main)
+
+## Installation
+
+```bash
+npm install @enbox/dwn-server
+```
+
+## Package usage
+
+```typescript
+import { DwnServer } from '@enbox/dwn-server';
+
+const server = new DwnServer();
+
+server.start();
+```
+
+## Running the server
+
+### Running via docker
+
+`docker run -p 3000:3000 -v myvolume:/dwn-server/data ghcr.io/enboxorg/enbox/dwn-server:main`
+
+This can run on services like AWS, GCP, VPS, home server (with ngrok or cloudflare), fly.io, render.com etc.
+Ideally the volume is persistent so that data is kept (or has to be synced back from another DWN instance).
+
+### Running a specific version
+
+Running the command above will run the latest version at the time the image is pulled. If you need to run a specific version (and in many cases this is recommended) [you can see the list published images here](https://github.com/enboxorg/enbox/dwn-server/pkgs/container/dwn-server/versions)
+
+To run a specific image:
+`docker pull ghcr.io/enboxorg/enbox/dwn-server@sha256:870e0f0f12016e6607060a81ea31458443f7439522fab2688d7a6706ab366c58`
+
+### Running Locally for Development
+
+```bash
+git clone https://github.com/enboxorg/enbox/dwn-server.git
+cd dwn-server
+npm install
+npm run server
+```
+
+### Building a docker image locally
+
+A docker image is continuously published from this repository, but if you want to build it locally run:
+`docker build -t dwn-server .`
+
+## JSON-RPC API
+
+[JSON-RPC](https://www.jsonrpc.org/specification) is a lightweight remote procedure call (RPC) protocol that uses JSON as a data format for exchanging information between a client and a server over a network. JSON-RPC is language-independent and transport-agnostic which makes it usable in a variety of contexts (e.g. browser, server-side)
+
+With JSON-RPC, a client sends a request message to a server over a network, and the server responds with a response message.
+
+The request message consists of:
+
+- a method name (`method`)
+- a set of parameters (`params`)
+- an identifier (`id`).
+
+The response message contains:
+
+- the same identifier that was sent with the request message (`id`)
+- the result of the method invocation (`result`)
+- an error message if the method invocation failed (`error`)
+
+### Available Methods
+
+#### `dwn.processMessage`
+
+Used to send DWeb Messages to the server.
+
+##### Params
+
+| Property      | Required (Y/N) | Description                                                               |
+| ------------- | -------------- | ------------------------------------------------------------------------- |
+| `target`      | Y              | The DID that the message is intended for                                  |
+| `message`     | Y              | The DWeb Message                                                          |
+| `encodedData` | N              | Data associated to the message (e.g. data associated to a `RecordsWrite`) |
+
+##### Example Request Message
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": "b23f9e31-4966-4972-8048-af3eed43cb41",
+  "method": "dwn.processMessage",
+  "params": {
+    "message": {
+      "recordId": "bafyreidtix6ghjmsbg7eitexsmwzvjxc7aelagsqasybmql7zrms34ju6i",
+      "descriptor": {
+        "interface": "Records",
+        "method": "Write",
+        "dataCid": "bafkreidnfo6aux5qbg3wwzy5hvwexnoyhk3q3v47znka2afa6mf2rffkbi",
+        "dataSize": 32,
+        "dateCreated": "2023-04-30T22:49:37.713976Z",
+        "dateModified": "2023-04-30T22:49:37.713976Z",
+        "dataFormat": "application/json"
+      },
+      "authorization": {
+        "payload": "eyJyZWNvcmRJZCI6ImJhZnlyZWlkdGl4Nmdoam1zYmc3ZWl0ZXhzbXd6dmp4YzdhZWxhZ3NxYXN5Ym1xbDd6cm1zMzRqdTZpIiwiZGVzY3JpcHRvckNpZCI6ImJhZnlyZWlheTVwNWZ1bzJhc2hqZXRvbzR1M3p1b282dW02cGlzNHl5NnUzaHE1emxsdmZhN2ZubXY0In0",
+        "signatures": [
+          {
+            "protected": "eyJhbGciOiJFZERTQSIsImtpZCI6ImRpZDprZXk6ejZNa3UxaDRMZGtoWFczSG5uQktBTnhnVWFRMTYyY3ZXbVJ1emNiZDJZZThWc3RaI2RpZDprZXk6ejZNa3UxaDRMZGtoWFczSG5uQktBTnhnVWFRMTYyY3ZXbVJ1emNiZDJZZThWc3RaI3o2TWt1MWg0TGRraFhXM0hubkJLQU54Z1VhUTE2MmN2V21SdXpjYmQyWWU4VnN0WiJ9",
+            "signature": "cy_RtWjjVK2mmKkI_35qiv54_1Pp_f7SjAx0z75PBL4th-fgfjuLZmF-V3czCWwFYMMnN0W4zl3LJ2jEf_t9DQ"
+          }
+        ]
+      }
+    },
+    "target": "did:key:z6Mku1h4LdkhXW3HnnBKANxgUaQ162cvWmRuzcbd2Ye8VstZ",
+    "encodedData": "ub3-FwUsSs4GgZWqt5eXSH41RKlwCx41y3dgio9Di74"
+  }
+}
+```
+
+##### Example Success Response
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": "18eb421f-4750-4e31-a062-412b71139546",
+  "result": {
+    "reply": {
+      "status": {
+        "code": 202,
+        "detail": "Accepted"
+      }
+    }
+  }
+}
+```
+
+##### Example Error Response
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": "1c7f6ed8-eaaf-447c-aaf3-b9e61f3f59af",
+  "error": {
+    "code": -50400,
+    "message": "Unexpected token ';', \";;;;@!#@!$$#!@%\" is not valid JSON"
+  }
+}
+```
+
+##### Transporting large amounts of data
+
+`RecordsWrite` data can be of any size. If needed, large amounts of data can be streamed to the server over http by:
+
+- including the JSON-RPC request message in a `dwn-request` request header
+- setting the `content-type` request header to `application/octet-stream`
+- sending binary data in the request body.
+
+> :bulb: Examples can be found in the [`examples`](./examples) directory.
+
+##### Receiving large amounts of data
+
+`RecordsWrite` data can be of any size. `RecordsWrite` messages returned as the result of a `RecordsQuery` will include `encodedData` _if_ the `RecordsWrite` data is under `9.77KB`. Data larger than this will need to be fetched using `RecordsRead` which can be done over http. The response to a `RecordsRead` includes:
+
+- The JSON-RPC response message in a `dwn-response` header
+- The associated data as binary in the response body.
+
+Examples can be found in the `examples` directory.
+
+> :bulb: **TODO**: Add examples in `examples` directory
+
+## Hosting your own DWN-server
+
+By default, when you call `web5.connect()` there will be some bootstrap DWN nodes included which allow people to reach you via your DID.
+
+You may want to run a DWN server just for you, or as a public service for you and your friends and family.
+DWNs can be as simple as a docker image or a node process running somewhere.
+
+DWN-servers can run anywhere you can run node.js or docker. http and websocket need to be available to the DWN server.
+See below for some suggestions.
+
+### Running on render.com
+
+You can run an instance on the render.com service:
+
+- Create a render.com account
+- Fork this repo
+- Upgrade your render.com account to a paid account
+- Create a new "Web service" type application
+- Choose the forked repo to run (or you can point to the main repo)
+- Choose the "starter" size instance
+- Create a 1GB (or larger) disk, and mount it on /dwn-server/data
+
+### Running with ngrok
+
+You can run a DWN-server on your local machine or home server and expose it to the internet using ngrok.
+
+First, install [ngrok](https://ngrok.com/download)
+
+Then run:
+
+```bash
+docker run -p 3000:3000 -v myvolume:/dwn-server/data ghcr.io/enboxorg/enbox/dwn-server:main
+
+## in another terminal:
+ngrok http 3000
+```
+
+Note the resulting publicly addressable https url for your DWN instance.
+
+### Running with cloudflared
+
+Cloudflare has a tunnel service that you can use to expose your DWN server to the internet, if you run it on a server at home.
+With [cloudflared](https://github.com/cloudflare/cloudflared) installed, run the following commands:
+
+```bash
+git clone https://github.com/enboxorg/enbox/dwn-server.git
+cd dwn-server
+npm install
+npm run server
+
+## in another terminal:
+
+cloudflared tunnel --url http://localhost:3000
+```
+
+### Running on GCP
+
+... check back soon ...
+(enterprising people I am sure can work it out)
+
+## `npm` scripts
+
+| Script                 | Description                                                        |
+| ---------------------- | ------------------------------------------------------------------ |
+| `npm run build:esm`    | compiles typescript into ESM JS                                    |
+| `npm run build:cjs`    | compiles typescript into CommonJS                                  |
+| `npm run build`        | compiles typescript into ESM JS & CommonJS                         |
+| `npm run clean`        | deletes compiled JS                                                |
+| `npm run lint`         | runs linter                                                        |
+| `npm run lint:fix`     | runs linter and fixes auto-fixable problems                        |
+| `npm run test`         | runs tests                                                         |
+| `npm run server`       | starts server                                                      |
+| `npm run prepare`      | prepares husky for pre-commit hooks (auto-runs with `npm install`) |
+
+## Configuration
+
+Configuration can be set using environment variables
+
+| Env Var                                           | Description                                                                                                                    | Default                |
+| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ---------------------- |
+| `DS_PORT`                                         | Port that the server listens on                                                                                                | `3000`                 |
+| `DS_MAX_RECORD_DATA_SIZE`                         | Maximum size for `RecordsWrite` data. use `b`, `kb`, `mb`, `gb` for value                                                      | `1gb`                  |
+| `DS_WEBSOCKET_SERVER`                             | Whether to enable listening over `ws:`. values: `on`,`off`                                                                     | `on`                   |
+| `DWN_BASE_URL`                                    | Base external URL of this DWN. Used to construct URL paths such as the `Request URI` for the Web5 Connect flow.                | `http://localhost`     |
+| `DWN_EVENT_STREAM_PLUGIN_PATH`                    | Path to DWN Event Stream plugin to use. Default single-node implementation will be used if left empty.                         | unset                  |
+| `DWN_REGISTRATION_STORE_URL`                      | URL to use for storage of registered DIDs. Leave unset to if DWN does not require registration (ie. open for all)              | unset                  |
+| `DWN_REGISTRATION_PROOF_OF_WORK_SEED`             | Optional seed to generate the challenge nonce from, this allows all DWN instances in a cluster to generate the same challenge. | unset                  |
+| `DWN_REGISTRATION_PROOF_OF_WORK_ENABLED`          | Require new users to complete a proof-of-work challenge                                                                        | `false`                |
+| `DWN_REGISTRATION_PROOF_OF_WORK_INITIAL_MAX_HASH` | Initial maximum allowed hash in 64 char HEX string. The more leading zeros (smaller number) the higher the difficulty.         | `000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF` |
+| `DWN_STORAGE`                                     | URL to use for storage by default. See [Storage Options](#storage-options) for details                                         | `level://data`         |
+| `DWN_STORAGE_MESSAGES`                            | Connection URL or file path to custom plugin to use for the message store.                                                     | value of `DWN_STORAGE` |
+| `DWN_STORAGE_DATA`                                | Connection URL or file path to custom plugin to use for the data store.                                                        | value of `DWN_STORAGE` |
+| `DWN_STORAGE_RESUMABLE_TASKS`                     | Connection URL or file path to custom plugin to use for the resumable task store.                                              | value of `DWN_STORAGE` |
+| `DWN_STORAGE_EVENTS`                              | Connection URL or file path to custom plugin to use for the event store.                                                       | value of `DWN_STORAGE` |
+| `DWN_TERMS_OF_SERVICE_FILE_PATH`                  | Required terms of service agreement if set. Value is path to the terms of service file.                                        | unset                  |
+| `DWN_TTL_CACHE_URL`                               | URL of the TTL cache used by the DWN. Currently only supports SQL databases.                                                   | `sqlite://`            |
+
+### Storage Options
+
+Several built storage options are supported, and may be configured with the `DWN_STORAGE_*` environment variables:
+
+| Database   | Example                                               | Notes                                                                                                                                                                                 |
+| ---------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| LevelDB    | `level://data`                                        | use three slashes for absolute paths, two for relative. Example shown uses directory `data` in the current working directory                                                          |
+| Sqlite     | `sqlite://dwn.db`                                     | use three slashes for absolute paths, two for relative. Example shown creates a file `dwn.db` in the current working directory                                                        |
+| MySQL      | `mysql://user:pass@host/db?debug=true&timezone=-0700` | [all URL options documented here](https://github.com/mysqljs/mysql#connection-options)                                                                                                |
+| PostgreSQL | `postgres:///dwn`                                     | any options other than the URL scheme (`postgres://`) may also be specified via [standard environment variables](https://node-postgres.com/features/connecting#environment-variables) |
+
+### Plugins
+
+In some scenarios, you may want to provide a custom implementation of a pluggable module for the DWN Server. The following interfaces defined in `dwn-sdk-js` package are supported:
+
+- `DataStore`
+- `MessageStore`
+- `ResumableDataStore`
+- `EventLog`
+- `EventStream`
+
+To load your custom plugin, specify the absolute path to the `.js` file of your custom implementation using the corresponding environment variable. For instance, use `DWN_STORAGE_DATA` for a custom DWN Data Store.
+
+Refer to the `tests/plugins/*.ts` files for examples of plugin implementations. In summary, you need to:
+
+- Implement the corresponding interface from the `dwn-sdk-js` package. For example, implement the `DataStore` interface for a DWN Data Store.
+- Ensure that the built `.js` file that will be referenced by the DWN Server config environment variable contains a class that:
+  1. Is a default export. This is how DWN Server locates the correct class for instantiation.
+  1. Has a public constructor that does not take any arguments. This is how DWN Server instantiates the plugin.
+
+## Registration Requirements
+
+There are multiple optional registration gates, each of which can be enabled (all are disabled by default). Tenants (DIDs) must comply with whatever
+requirements are enabled before they are allowed to use the server. Tenants that have not completed the registration requirements will be met with a 401. Note that registration is tracked in a database, and only SQL-based databases are supported (LevelDB is not supported). Current registration
+requirements are available at the `/info` endpoint.
+
+- **Proof of Work** (`DWN_REGISTRATION_PROOF_OF_WORK_ENABLED=true`) - new tenants must GET `/registration/proof-of-work` for a challenge, then generate a nonce that produces a string that has a sha256 hex sum starting with the specified (`complexity`) number of zeros (`0`) when added to the end of the challenge (`sha256(challenge + nonce)`). This nonce should be POSTed to `/registration/proof-of-work` with a JSON body including the `challenge`, the nonce in field `response` and `did`. Challenges expire after 5 minutes, and complexity will increase based on the number of successful proof-of-work registrations that have been completed within the last hour. This registration requirement is listed in `/info` as `proof-of-work-sha256-v0`.
+- **Terms of Service** (`DWN_TERMS_OF_SERVICE_FILE_PATH=/path/to/terms-of-service.txt`) - new tenants must GET `/registration/terms-of-service` to fetch the terms. These terms must be displayed to the human end-user, who must actively accept them. When the user accepts the terms, send the sha256 hash of the accepted terms and the user's did via POST `/registration/terms-of-service`. The JSON body should have fields `termsOfServiceHash` and `did`. To change the terms, update the file and restart the server. Users that accepted the old terms will be blocked until they accept the new terms. This registration requirement is listed in `/info` as `terms-of-service`.
+
+## Server info
+
+the server exposes information about itself via the `/info` endpoint, which returns data in the following format:
+
+```json
+{
+  "server": "@enbox/dwn-server",
+  "maxFileSize": 1073741824,
+  "registrationRequirements": ["proof-of-work-sha256-v0", "terms-of-service"],
+  "version": "0.1.5",
+  "sdkVersion": "0.2.6",
+  "webSocketSupport": "true"
+}
+```
+
+- `server` is read from the `process.env.npm_package_name` variable that `npm` provides. If that does not exist, it will check for a `DWN_SERVER_PACKAGE_NAME` environment variable set by the user, or otherwise it will default to `@enbox/dwn-server`.
+- `version` and `sdkVersion` are read from the `package.json` file. It will locate the file's path either from the `process.env.npm_package_json` variable that `npm` provides. If that does not exist, it will check for a `DWN_SERVER_PACKAGE_JSON` environment variable set by the user, or otherwise it will default to `/dwn-server/package.json` which is the path within the default Docker container build.