@3sixty/node 0.0.0-stage → 0.20.0-next.0

package/docs/commands/bootstrap-dev.md

@@ -0,0 +1,51 @@
+# bootstrap-dev
+
+Bootstrap the development environment.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode. In single-tenant mode the organisation identity is stored as the node organisation ID, in multi-tenant mode a node tenant is created and associated with the organisation identity. Re-running the command reuses anything that already exists.
+
+## Usage
+
+```text
+bootstrap-dev: Bootstrap the development environment
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Deprecated aliases: bootstrap-legacy
+
+Example: bootstrap-dev --load-env="./.env.bootstrap-dev"
+```
+
+The command reads the following environment variables (use `load-env` to supply them from a file):
+
+| Variable                     | Default                        | Description                                                                 |
+| ---------------------------- | ------------------------------ | --------------------------------------------------------------------------- |
+| `TWIN_NODE_IDENTITY`         | generated                      | The DID of the node identity.                                               |
+| `TWIN_NODE_MNEMONIC`         | randomly generated             | The Bip39 mnemonic for the node identity seed.                              |
+| `TWIN_FEATURES`              | `admin-user,wallet`            | Comma-separated feature flags: `admin-user`, `wallet`.                      |
+| `TWIN_ORGANIZATION_IDENTITY` | generated                      | The DID to use for the organisation identity.                               |
+| `TWIN_ORGANIZATION_MNEMONIC` | randomly generated             | The Bip39 mnemonic for the organisation identity seed.                      |
+| `TWIN_TENANT_ID`             | generated                      | The tenant ID for the node tenant (multi-tenant only).                      |
+| `TWIN_TENANT_API_KEY`        | generated                      | The API key for the node tenant (multi-tenant only).                        |
+| `TWIN_ADMIN_USER_IDENTITY`   | generated                      | The DID for the admin user identity (`admin-user` feature).                 |
+| `TWIN_ADMIN_USER_MNEMONIC`   | randomly generated             | The Bip39 mnemonic for the admin user identity seed (`admin-user` feature). |
+| `TWIN_ADMIN_USER_NAME`       | `admin@node` or `admin@tenant` | The email/username for the admin user (`admin-user` feature).               |
+| `TWIN_ADMIN_USER_PASSWORD`   | randomly generated             | The password for the admin user (`admin-user` feature).                     |
+
+## Examples
+
+Run the complete bootstrap sequence using values from `.env.bootstrap-dev`:
+
+```shell
+3sixty-node bootstrap-dev --load-env=".env.bootstrap-dev"
+```
+
+The step-by-step equivalent is shown in the [usage guide](../usage.md#bootstrap-step-by-step).
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/help.md

@@ -0,0 +1,61 @@
+# help
+
+List all the commands, or show the parameters for a single command.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode, with the same behaviour in both.
+
+## Usage
+
+```text
+All the commands available are listed below, for more information use the --help option with a specific command.
+bootstrap-dev: Bootstrap the development environment
+identity-create: Create an identity
+identity-import: Import an identity
+identity-list: List all identities held in custody by the node
+identity-remove: Remove an identity
+identity-resolve: Resolve an identity DID to its full document
+identity-verification-method-create: Create an identity verification method
+identity-verification-method-import: Import an identity verification method
+identity-verifiable-credential-create: Create a verifiable credential
+node-identity-get: Get the identity currently assigned to the node
+node-identity-set: Set the node identity
+org-users-list: List all users belonging to an organization DID
+node-org-id-get: Get the organization ID currently assigned to the node (single-tenant only)
+node-org-id-set: Set the node organization ID (single-tenant only)
+tenant-org-id-set: Set the organization ID for a tenant
+tenant-org-alias-remove: Remove an alias from the tenant organization ID legacy list
+tenant-create: Create a tenant with associated api key
+tenant-get: Get the full configuration record for a single tenant
+tenant-import: Import a tenant with associated api key
+tenant-list: List all tenants
+tenant-list-by-org: List all tenants associated with a given organization DID
+tenant-remove: Remove a tenant
+tenant-update: Update a tenant with associated api key
+user-create: Create a user
+user-get: Get a user by email address
+user-remove: Remove a user and their identity profile
+user-update: Update a user
+user-update-password: Update the password of a user
+vault-key-create: Create a vault key for an identity
+vault-key-import: Import a vault key for an identity
+vault-key-remove: Remove a vault key for an identity
+vault-key-update: Replace the key material of an existing vault key for an identity
+```
+
+## Examples
+
+List all the commands:
+
+```shell
+3sixty-node --help
+```
+
+Show the help for a single command:
+
+```shell
+3sixty-node identity-create --help
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/identity-create.md

@@ -0,0 +1,67 @@
+# identity-create
+
+Create an identity.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode. `--node-organization-id` is only available in single-tenant mode and `--tenant-organization-id` is only available in multi-tenant mode.
+
+## Usage
+
+```text
+identity-create: Create an identity
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+mnemonic: (string, 24 words, optional)
+The mnemonic phrase to use for the identity. If not provided, a random mnemonic will be generated.
+
+identity: (string, did, optional)
+The DID of the identity to create. If not provided, a new DID will be generated.
+
+controller: (string, did, optional)
+The controller DID for the identity. If not provided, the identity will be its own controller.
+
+fund-wallet: (boolean, default: 'false', optional)
+Whether to fund the wallet associated with the identity from a faucet.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+output-json: (string, optional)
+Path to a .json file to store the command output.
+
+output-env: (string, optional)
+Path to a .env file to store the command output.
+
+output-env-prefix: (string, optional)
+Prefix to use for variables in the output .env file.
+
+node-id: (boolean, default: 'false', optional)
+If true, set the created identity DID as the node identity.
+
+node-organization-id: (boolean, default: 'false', optional)
+If true, set the created identity DID as the node organization ID (not available in multi-tenant mode).
+
+tenant-organization-id: (string, hex(32), optional)
+The tenant ID to set the created identity DID as the organization ID for (requires multi-tenant mode).
+
+Example: identity-create --mnemonic="..." --fund-wallet=true
+```
+
+## Examples
+
+Create the node identity, fund its wallet and set it as the node identity:
+
+```shell
+3sixty-node identity-create --node-id=true --fund-wallet=true --output-json="node-identity.json" --output-env="node-identity.env" --output-env-prefix=node
+```
+
+Create an identity controlled by an organisation:
+
+```shell
+3sixty-node identity-create --load-env="organization-identity.env" --controller=!ORGANIZATION_DID --output-json="user-identity.json" --output-env="user-identity.env" --output-env-prefix=user
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/identity-import.md

@@ -0,0 +1,37 @@
+# identity-import
+
+Import an identity.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode, with the same behaviour in both.
+
+## Usage
+
+```text
+identity-import: Import an identity
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+identity: (string, did, required)
+The DID of the identity to import.
+
+mnemonic: (string, 24 words, required)
+The mnemonic phrase to use for the identity.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: identity-import --identity="did:iota:..." --mnemonic="..."
+```
+
+## Examples
+
+Import an identity that already exists, storing its mnemonic in the vault:
+
+```shell
+3sixty-node identity-import --identity="did:iota:..." --mnemonic="..."
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/identity-list.md

@@ -0,0 +1,31 @@
+# identity-list
+
+List all identities held in custody by the node.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode, with the same behaviour in both.
+
+## Usage
+
+```text
+identity-list: List all identities held in custody by the node
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: identity-list
+```
+
+## Examples
+
+List every identity held in custody by the node, showing each DID and its controller:
+
+```shell
+3sixty-node identity-list
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/identity-remove.md

@@ -0,0 +1,46 @@
+# identity-remove
+
+Remove an identity.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode, with the same behaviour in both. The node identity and, in single-tenant mode, the node organisation identity cannot be removed.
+
+## Usage
+
+```text
+identity-remove: Remove an identity
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+identity: (string, did, required)
+The DID of the identity to remove.
+
+controller: (string, did, optional)
+The DID of the controller for the identity, defaults to the identity itself.
+
+remove-keys: (boolean, default: 'false', optional)
+Also remove the keys and mnemonic held in the vault for the identity.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: identity-remove --identity="did:iota:...." --remove-keys=true
+```
+
+## Examples
+
+Remove an identity document, keeping its keys in the vault:
+
+```shell
+3sixty-node identity-remove --identity="did:iota:..."
+```
+
+Remove an identity document together with all of its vault keys and its mnemonic:
+
+```shell
+3sixty-node identity-remove --identity="did:iota:..." --remove-keys=true
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/identity-resolve.md

@@ -0,0 +1,38 @@
+# identity-resolve
+
+Resolve an identity DID to its full document.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode, with the same behaviour in both.
+
+## Usage
+
+```text
+identity-resolve: Resolve an identity DID to its full document
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+identity: (string, did, required)
+The DID to resolve.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+output-json: (string, optional)
+Path to a .json file to store the resolved DID document.
+
+Example: identity-resolve --identity="did:iota:..."
+```
+
+## Examples
+
+Resolve any DID to its full document, pass `--output-json` to save the document to a file:
+
+```shell
+3sixty-node identity-resolve --identity="did:iota:..."
+3sixty-node identity-resolve --identity="did:iota:..." --output-json="did-document.json"
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/identity-verifiable-credential-create.md

@@ -0,0 +1,58 @@
+# identity-verifiable-credential-create
+
+Create a verifiable credential.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode, with the same behaviour in both.
+
+## Usage
+
+```text
+identity-verifiable-credential-create: Create a verifiable credential
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+identity: (string, did, required)
+The DID of the identity to use to create the credential.
+
+controller: (string, did, optional)
+The controller DID for the identity. If not provided, the identity will be its own controller.
+
+verification-method-id: (string, did with fragment, required)
+The ID of the verification method to use to create the credential.
+
+subject-json: (string, file, required)
+The subject JSON file to load.
+
+credential-id: (string, url, optional)
+The id of the verifiable credential.
+
+expiration-date: (string, ISO date-time, optional)
+The expiration date of the verifiable credential.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+output-json: (string, optional)
+Path to a .json file to store the command output.
+
+output-env: (string, optional)
+Path to a .env file to store the command output.
+
+output-env-prefix: (string, optional)
+Prefix to use for variables in the output .env file.
+
+Example: identity-verifiable-credential-create --identity="did:iota:...." --verification-method-id="my-id" --subject-json="./subject.json"
+```
+
+## Examples
+
+Create a verifiable credential using the attestation verification method:
+
+```shell
+3sixty-node identity-verifiable-credential-create --load-env="organization-identity.env,organization-attestation.env" --identity=!ORGANIZATION_DID --verification-method-id=!TWIN_ATTESTATION_VERIFICATION_METHOD_ID --subject-json="subject.json" --output-json="organization-attestation-credential.json" --output-env="organization-attestation-credential.env"
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/identity-verification-method-create.md

@@ -0,0 +1,55 @@
+# identity-verification-method-create
+
+Create an identity verification method.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode, with the same behaviour in both.
+
+## Usage
+
+```text
+identity-verification-method-create: Create an identity verification method
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+identity: (string, did, required)
+The DID of the identity to add the verification method to.
+
+controller: (string, did, optional)
+The controller DID for the identity. If not provided, the identity will be its own controller.
+
+verification-method-type: (string, default: 'assertionMethod', optional, options: [verificationMethod, authentication, assertionMethod, keyAgreement, capabilityInvocation, capabilityDelegation])
+The type of verification method to add.
+
+verification-method-id: (string, optional)
+The ID of the verification method to add.
+
+overwrite-mode: (string, default: 'skip', optional, options: [skip, overwrite, error])
+The mode to use when a verification method with the same ID already exists.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+output-json: (string, optional)
+Path to a .json file to store the command output.
+
+output-env: (string, optional)
+Path to a .env file to store the command output.
+
+output-env-prefix: (string, optional)
+Prefix to use for variables in the output .env file.
+
+Example: identity-verification-method-create --identity="did:iota:...." --verification-method-type="verificationMethod" --verification-method-id="my-key-1" --controller="did:iota:...."
+```
+
+## Examples
+
+Add the trust verification method to the organisation identity:
+
+```shell
+3sixty-node identity-verification-method-create --load-env="node-identity.env,organization-identity.env" --identity=!ORGANIZATION_DID --verification-method-type=assertionMethod --verification-method-id=!TWIN_TRUST_VERIFICATION_METHOD_ID --overwrite-mode=skip --output-json="organization-trust.json" --output-env="organization-trust.env"
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/identity-verification-method-import.md

@@ -0,0 +1,46 @@
+# identity-verification-method-import
+
+Import an identity verification method.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode, with the same behaviour in both.
+
+## Usage
+
+```text
+identity-verification-method-import: Import an identity verification method
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+identity: (string, did, required)
+The DID of the identity to import the verification method to.
+
+controller: (string, did, optional)
+The controller DID for the identity. If not provided, the identity will be its own controller.
+
+verification-method-type: (string, default: 'assertionMethod', required, options: [verificationMethod, authentication, assertionMethod, keyAgreement, capabilityInvocation, capabilityDelegation])
+The type of verification method to import.
+
+verification-method-id: (string, required)
+The ID of the verification method to import.
+
+private-key-hex: (string, required)
+The private key in hex format.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: identity-verification-method-import --identity="did:iota:...." --verification-method-type="verificationMethod" --verification-method-id="my-key-1" ----private-key-hex="15...a2"
+```
+
+## Examples
+
+Import an existing attestation verification method key:
+
+```shell
+3sixty-node identity-verification-method-import --load-env="node-identity.env,organization-identity.env,organization-attestation.env" --identity=!ORGANIZATION_DID --verification-method-type=assertionMethod --verification-method-id=!DID_VERIFICATION_METHOD_ID --private-key-hex=!DID_VERIFICATION_METHOD_PRIVATE_KEY_HEX
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/node-identity-get.md

@@ -0,0 +1,31 @@
+# node-identity-get
+
+Get the identity currently assigned to the node.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode, with the same behaviour in both.
+
+## Usage
+
+```text
+node-identity-get: Get the identity currently assigned to the node
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: node-identity-get
+```
+
+## Examples
+
+Resolve and display the DID document currently assigned as the node identity:
+
+```shell
+3sixty-node node-identity-get
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/node-identity-set.md

@@ -0,0 +1,36 @@
+# node-identity-set
+
+Set the node identity.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode, with the same behaviour in both.
+
+## Usage
+
+```text
+node-identity-set: Set the node identity
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+identity: (string, did, required)
+The identity to set in the node.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Deprecated aliases: node-set-identity
+
+Example: node-identity-set --identity="did:iota..."
+```
+
+## Examples
+
+Set an existing identity as the node identity:
+
+```shell
+3sixty-node node-identity-set --load-env="node-identity.env" --identity=!NODE_DID
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/node-org-id-get.md

@@ -0,0 +1,32 @@
+# node-org-id-get
+
+Get the organization ID currently assigned to the node.
+
+## Tenancy
+
+Single-tenant mode only. In multi-tenant mode the command fails, use the tenant commands instead.
+
+## Usage
+
+```text
+node-org-id-get: Get the organization ID currently assigned to the node
+single-tenant only
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: node-org-id-get
+```
+
+## Examples
+
+Display the organisation DID currently assigned to the node:
+
+```shell
+3sixty-node node-org-id-get
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/node-org-id-set.md

@@ -0,0 +1,37 @@
+# node-org-id-set
+
+Set the node organization ID.
+
+## Tenancy
+
+Single-tenant mode only. In multi-tenant mode the command fails, use the tenant commands instead.
+
+## Usage
+
+```text
+node-org-id-set: Set the node organization ID
+single-tenant only
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+organization-id: (string, did, required)
+The organization DID to set as the node organization ID.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Deprecated aliases: set-node-org-id
+
+Example: node-org-id-set --organization-id="did:iota:..."
+```
+
+## Examples
+
+Set the organisation identity on the node:
+
+```shell
+3sixty-node node-org-id-set --load-env="organization-identity.env" --organization-id=!ORGANIZATION_DID
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/org-users-list.md

@@ -0,0 +1,40 @@
+# org-users-list
+
+List all users belonging to an organization DID.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode. In single-tenant mode `--org-did` defaults to the node organisation ID, in multi-tenant mode it is required.
+
+## Usage
+
+```text
+org-users-list: List all users belonging to an organization DID
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+org-did: (string, did, optional)
+The organization DID to list users for. Defaults to the node organization ID in single-tenant mode.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: org-users-list --org-did="did:iota:..."
+```
+
+## Examples
+
+In single-tenant mode list the users of the node organisation:
+
+```shell
+3sixty-node org-users-list
+```
+
+List the users of a specific organisation:
+
+```shell
+3sixty-node org-users-list --load-env="organization-identity.env" --org-did=!ORGANIZATION_DID
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.