@windingtree/org.id-resolver 2.3.4 → 3.0.0-beta.10

package/README.md

@@ -1,234 +1,29 @@
 [![Build Status](https://travis-ci.org/windingtree/org.id-resolver.svg?branch=master)](https://travis-ci.org/windingtree/org.id-resolver)
-[![Coverage Status](https://coveralls.io/repos/github/windingtree/org.id-resolver/badge.svg?branch=master)](https://coveralls.io/github/windingtree/org.id-resolver?branch=master&v=2.0)
 
-<a href="https://orgid.tech"><img src="https://github.com/windingtree/branding/raw/master/org.id/svg/org.id-logo.svg" height="50" alt="ORG.ID"></a>
+# ORGiD DID Resolver
 
-## ORG.ID DID Resolver
+A utility for ORGiD DID resolution according to [Decentralized Identifier Resolution](https://w3c-ccg.github.io/did-resolution/) specification.
 
-ORG.ID DID Resolver is an application for resolving ORG.ID data in [W3C DID](https://w3c.github.io/did-core/) format.
+## Documentation
 
-## Usage
+- [ORGiD DID resolver documentation](docs/index.md)
+- [ORGiD SDK documentation](https://windingtree.github.io/org.id-sdk/)
 
-### Command Line
+## Setup
 
-```sh
-git clone git@github.com:windingtree/org.id-resolver.git
-cd org.id-resolver
-npm i
-npm link
-chmod +x src/cli.js
-```
-
-```sh
-./src/cli.js endpoint=<WEB3_PROVIDER> orgid=<ORGID_ADDRESS> did=did:orgid:0x6d98103810d50b3711ea81c187a48245109ba094644ddbc54f8d0c4c
-```
-
-### NPM Module
-
-```sh
-npm i @windingtree/org.id-resolver
-```
-
-```javascript
-const Web3 = require('web3');
-const {
-    OrgIdResolver,
-    httpFetchMethod,
-    linkedInFetchMethod,
-    twitterFetchMethod,
-    whoisService
-} = require('@windingtree/org.id-resolver');
-
-const web3 = new Web3('<WEB3_PROVIDER>'); // HTTP(s) or WS(s)
-const resolver = new OrgIdResolver({
-    web3,
-    orgId: '<ORGID_ADDRESS>' // TODO: #3
-});
-resolver.registerSocialFetchMethod(linkedInFetchMethod, {
-    key: '<LINKEDIN_API_KEY>'
-});
-resolver.registerSocialFetchMethod(twitterFetchMethod, {
-    key: '<TWITTER_API_KEY>'
-});
-resolver.registerFetchMethod(httpFetchMethod);
-resolver.registerService(whoisService);
-
-const result = await resolver.resolve('did:orgid:0x62a7502f4c44d8147b8f7b2a1dbeb8503e8446e77355bb2e4ebf999c7ecc5808');
-```
-
-## Algorithm
-
-1. Validate DID syntax (must be `did:orgid:bytes32`)
-2. Read organization data from ORG.ID Registry
-3. Fetch and validate [ORG.JSON](https://github.com/windingtree/org.json-schema):
-4. Try to resolve assertions and credentials
-
-The response of the resolver contains the following information
-
-```json
-{
-    // An object that has been resolved from the given DID.
-    // Can be equal to `null` if JSON file not passed hashes equality check
-    // or if the file is not passed validation against the ORG.ID schema
-    "didDocument": {...},
-
-    // Organization identifier
-    "id": "<organization_id>",
-
-    "organization": {
-        "orgId": "<organization_id>",
-        "orgJsonHash": "<organization_json_hash>",
-        "orgJsonUri": "<organization_json_uri>",
-        "orgJsonUriBackup1": "<organization_json_uri>",
-        "orgJsonUriBackup2": "<organization_json_uri>",
-        "parentOrgId": "<parent_organization_hash_or_zero_hash>",
-        "owner": "<owner_eth_address>",
-        "director": "<director_eth_address>",
-        "isActive": true,// true for `enabled` and false for `disabled`
-        "isDirectorshipAccepted": true,// director confirmation status
-    },
-
-    // List of validation results
-    "checks": [
-        {
-            "type": "DID_SYNTAX",
-            "passed": true,
-            "errors": [],
-            "warnings": []
-        },
-        {
-            "type": "ORGID",
-            "passed": true,
-            "errors": [],
-            "warnings": []
-        },
-        {
-            "type": "DID_DOCUMENT",
-            "passed": true,
-            "errors": [],
-            "warnings": []
-        },
-        {
-            "type": "TRUST_ASSERTIONS",
-            "passed": true
-        }
-    ],
-
-    // Verified trust section of the `didDocument`
-    "trust": {
-        "assertions": [
-            {
-                "type": "dns",
-                "claim": "test.com",
-                "proof": "TXT",
-                "verified": true
-            },
-            {
-                "type": "domain",
-                "claim": "test2.com",
-                "proof": "http://test2.com/orgid.txt",
-                "verified": true,
-                "whois": {
-                    "domainName": "TEST2.COM",
-                    "registryDomainId": "1234567_DOMAIN_COM-VRSN",
-                    "registrarWhoisServer": "whois.server.net",
-                    "registrarUrl": "http://www.whois.net",
-                    "updatedDate": "2021-03-22T05:01:08Z",
-                    "creationDate": "2011-05-09T18:58:13Z",
-                    "expiryDate": "2024-05-09T18:58:13Z",
-                    "registrar": "Cool Domain",
-                    "registrarIanaId": "345",
-                    "registrarAbuseContactEmail": "abuse@support.server.net",
-                    "registrarAbuseContactPhone": "+33.1234567",
-                    "domainStatus": "clientTransferProhibited",
-                    "nameServer": "NS.SERVER.COM",
-                    "DNSSEC": "unsigned"
-                }
-            },
-            {
-                "type": "domain",
-                "claim": "test3.com",
-                "proof": "http://test3.com/orgid.txt",
-                "verified": false // Not verified
-            },
-            {
-                "type": "social",
-                "claim": "twitter.com/jack",
-                "proof": "https://twitter.com/jack/status/123456789/",
-                "verified": true
-            }
-        ]
-    },
-
-    // Resolver meta-data like version, date of result and process duration
-    "resolverMetadata": {
-        "version": "2.0.0",
-        "retrieved": "2020-02-21T18:14:13.278Z",
-        "duration": 979,
-        "orgIdAddress": "0x2cb8dCf26830B969555E04C2EDe3fc1D1BaD504E"
-    }
-}
-```
-
-## Fetching methods
-
-At least one fetching method is required to the proper working of the resolver.
-This library provides a simple fetching method of a file that available via http/https - `httpFetchMethod`.
-
-To use this method you can get its configuration from the package this way:
-
-```javascript
-const { OrgIdResolver, httpFetchMethod } = require('@windingtree/org.id-resolver');
-const resolver = new OrgIdResolver({...});
-resolver.registerFetchMethod(httpFetchMethod);// fetching method should be registered
-```
-
-Future versions of `DID resolver` library will support more fetching methods like:
-IPFS, Swarm and Arweave
-
-Creation of custom fetching methods is quite simple task. Look at the example of simple fetching method configuration:
-
-```javascript
-module.exports = {
-    name: 'unique_method_name',
-
-    // Regexp to match your URI schema
-    pattern: '^yourpatternrule:',
-
-    fetch: async uri => {
-        const data = await yourCustomHandler(uri);
-        return data;
-    }
-};
-```
-
-## Development
-
-### Test
-
-```sh
-npm run test
-npm run test ./<path_to_test_file>.js
+```bash
+yarn install
 ```
 
-## Test coverage
+## Build
 
 ```bash
-npm run coverage
+yarn build
 ```
 
-## Lint
+## Linting & Testing
 
 ```bash
-npm run lint
-
+yarn lint
+yarn test
 ```
-
-## ORG.ID Ecosystem
-
-- [Winding Tree DAO](https://github.com/windingtree/dao) controls ORG.ID Registry smart contract and some Directories (including their rules)
-- [ORG.ID Registry](https://github.com/windingtree/org.id) contains records of all organizations and organizational units
-- [ORG.JSON Schema](https://github.com/windingtree/org.json-schema) is a data format for describing organizations
-- **ORG.ID Resolver (you are here)**
-- [ORG.ID Directories](https://github.com/windingtree/org.id-directories) are curated lists of organizations
-- [Arbor](https://arbor.fm) can be used to look up an ORG.ID, and also to create and manage your own ORG.ID

package/dist/package.json

@@ -0,0 +1,59 @@
+{
+    "name": "@windingtree/org.id-resolver",
+    "version": "3.0.0-beta.9",
+    "description": "ORGiD DID resolver",
+    "main": "dist/src/index.js",
+    "types": "dist/src/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "scripts": {
+        "lint": "npx eslint . --ext .ts",
+        "lint:fix": "npx eslint . --ext .ts --fix",
+        "build": "rm -rf dist && npx tsc -p tsconfig-build.json",
+        "test": "npx hardhat test",
+        "test:coverage": "npx nyc --reporter=html --reporter=lcov hardhat test"
+    },
+    "keywords": [
+        "windingtree",
+        "orgid",
+        "did",
+        "resolver",
+        "typescript"
+    ],
+    "author": "Kostiantyn Smyrnov <kostysh@gmail.com>",
+    "homepage": "https://github.com/windingtree/org.id-resolver#README",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+ssh://git@github.com:windingtree/org.id-resolver.git"
+    },
+    "dependencies": {
+        "@windingtree/org.id": "3.0.0-beta.6",
+        "@windingtree/org.id-auth": "1.0.0-beta.27",
+        "@windingtree/org.id-core": "1.0.0-beta.27",
+        "@windingtree/org.id-utils": "1.0.0-beta.26",
+        "@windingtree/org.json-schema": "1.0.0-beta.5",
+        "ethers": "5.5.1",
+        "luxon": "2.1.1"
+    },
+    "devDependencies": {
+        "@istanbuljs/nyc-config-typescript": "1.0.1",
+        "@nomiclabs/hardhat-ethers": "2.0.2",
+        "@types/chai": "4.2.22",
+        "@types/chai-as-promised": "7.1.4",
+        "@types/luxon": "2.0.7",
+        "@types/mocha": "9.0.0",
+        "@windingtree/org.id-test-setup": "1.0.0-beta.27",
+        "chai": "4.3.4",
+        "chai-as-promised": "7.1.1",
+        "eslint": "8.3.0",
+        "hardhat": "2.7.0",
+        "nyc": "15.1.0",
+        "ts-node": "10.4.0",
+        "typescript": "4.5.2"
+    }
+}

package/dist/src/index.d.ts

@@ -0,0 +1,118 @@
+import type { ORGJSONVCNFT } from '@windingtree/org.json-schema/types/orgVc';
+import type { ORGJSON, CapabilityDelegationReference } from '@windingtree/org.json-schema/types/org.json';
+import type { JWK } from '@windingtree/org.id-auth/dist/keys';
+import type { OrgIdData, KnownProvider } from '@windingtree/org.id-core';
+export interface ChainResolver {
+    getOrgId(orgId: string): Promise<OrgIdData | null>;
+}
+export interface FetcherResolver {
+    getOrgJson(uri: string): Promise<ORGJSONVCNFT>;
+}
+export interface ChainConfig {
+    blockchainId: string;
+    blockchainType: string;
+    init(): ChainResolver;
+}
+export interface FetcherConfig {
+    id: string;
+    name: string;
+    init(): FetcherResolver;
+}
+export interface ResolverOptions {
+    chains: ChainConfig[];
+    fetchers: FetcherConfig[];
+    maxDepth?: number;
+}
+export interface Chains {
+    [blockchainId: string]: {
+        resolver: ChainResolver;
+        config: {
+            blockchainId: string;
+            blockchainType: string;
+        };
+    };
+}
+export interface Fetchers {
+    [id: string]: {
+        resolver: FetcherResolver;
+        config: {
+            id: string;
+            name: string;
+        };
+    };
+}
+export declare type DidResolutionContext = 'https://w3id.org/did-resolution/v1';
+export declare type DidResolutionContentType = 'application/did+ld+json';
+export interface NormalizedOrgIdData extends Omit<OrgIdData, 'tokenId'> {
+    tokenId: string;
+}
+export interface DidResolutionMetaData {
+    contentType: DidResolutionContentType;
+    retrieved: string;
+    duration: number;
+    resolverVersion: string;
+    credential?: ORGJSONVCNFT;
+    error?: string;
+}
+export interface DidDocumentMetadata {
+    created?: string;
+    updated?: string;
+    deactivated?: boolean;
+    data?: NormalizedOrgIdData;
+}
+export interface DidResolutionResponse {
+    '@context': DidResolutionContext;
+    did: string;
+    didDocument: ORGJSON | null;
+    didResolutionMetadata: DidResolutionMetaData;
+    didDocumentMetadata: DidDocumentMetadata | null;
+}
+export interface OrgIdResolverAPI {
+    resolve(orgId: string): Promise<DidResolutionResponse>;
+}
+export interface DidGroupedCheckResult extends RegExpExecArray {
+    groups: {
+        did: string;
+        method: string;
+        network?: string;
+        id: string;
+        query?: string;
+        fragment?: string;
+    };
+}
+export interface IpfsUriGroupedResult extends RegExpExecArray {
+    groups: {
+        protocol: string;
+        cid: string;
+    };
+}
+export interface ParsedDid {
+    did: string;
+    method: string;
+    network: string;
+    orgId: string;
+    query?: string;
+    fragment?: string;
+}
+export interface ParsedUri {
+    uri: string;
+    type: string;
+}
+export interface ResolverCache {
+    [did: string]: DidResolutionResponse;
+}
+export declare type VerificationMethodPublicKey = JWK | string;
+export declare const setupChains: (chains: ChainConfig[]) => Chains;
+export declare const setupFetchers: (fetchers: FetcherConfig[]) => Fetchers;
+export declare const parseDid: (did: string) => ParsedDid;
+export declare const parseUri: (uri: string) => ParsedUri;
+export declare const parseCapabilityDelegates: (capabilityDelegate: CapabilityDelegationReference) => string[];
+export declare const buildEvmChainConfig: (blockchainId: string, blockchainType: string, orgIdContractAddress: string, providerOrUri: KnownProvider) => ChainConfig;
+export declare const buildHttpFetcherConfig: () => FetcherConfig;
+export declare const buildDidResolutionResponse: (did: string, resolutionStart: number, orgId?: OrgIdData | undefined, didDocument?: import("@windingtree/org.json-schema/types/org.json").OrgJsonReference | undefined, error?: string | undefined) => DidResolutionResponse;
+/**
+ * ORGiD resolver implementation
+ * according to https://w3c-ccg.github.io/did-resolution
+ * and https://www.w3.org/TR/did-core/#did-resolution
+ */
+export declare const OrgIdResolver: (options: ResolverOptions) => OrgIdResolverAPI;