diff --git a/gatsby-node.js b/gatsby-node.js index 39e6e475..71d7ebb3 100755 --- a/gatsby-node.js +++ b/gatsby-node.js @@ -154,39 +154,7 @@ const createTypeDocPage = async (createPage, name, downloadUrl) => { component: typedocTemplate, context: { slug, - typedoc: await typedoc.json(), - // We define the classes here so the data object passed as page context - // is as small as possible. - // Caveat: no live update during development when these values are changed. - // - // TODO: defining these classes for inclusion - // needs to be handled somewhere else to keep - // it generic for all TypeDoc specs - classes: [ - 'ocean/Ocean', - 'ocean/Account', - 'ocean/Assets', - 'ocean/Compute', - 'ocean/Versions', - 'ocean/DID', - 'ddo/DDO', - 'metadatacache/MetadataCache', - 'metadatacache/OnChainMetaDataCache', - 'provider/Provider', - 'datatokens/Datatokens', - 'datatokens/Network', - 'datatokens/Web3Provider', - 'balancer/OceanPool', - 'balancer/Pool', - 'balancer/PoolFactory', - 'exchange/FixedRateExchange', - 'models/Config', - 'utils/ConfigHelper', - 'utils/GasUtils', - 'ocean/utils/OceanUtils', - 'ocean/utils/WebServiceConnector', - 'utils/Logger' - ] + typedoc: await typedoc.json() } }) } catch (error) { diff --git a/ocean.js.json b/ocean.js.json new file mode 100644 index 00000000..7a2acbd5 --- /dev/null +++ b/ocean.js.json @@ -0,0 +1,10883 @@ +{ + "info": { + "title": "Ocean.js", + "description": "JavaScript client library for Ocean Protocol", + "version": "0.10.1", + "sourceUrl": "https://github.com/oceanprotocol/ocean.js/blob/main/" + }, + "id": 0, + "name": "@oceanprotocol/lib", + "kind": 0, + "kindString": "Project", + "flags": {}, + "originalName": "", + "children": [ + { + "id": 314, + "name": "utils", + "kind": 2, + "kindString": "Namespace", + "flags": {}, + "sources": [ + { + "fileName": "utils/index.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 1, + "name": "CreateProgressStep", + "kind": 4, + "kindString": "Enumeration", + "flags": {}, + "children": [ + { + "id": 2, + "name": "CreatingDataToken", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Assets.ts", + "line": 18, + "character": 19 + } + ], + "defaultValue": "0" + }, + { + "id": 3, + "name": "DataTokenCreated", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Assets.ts", + "line": 19, + "character": 18 + } + ], + "defaultValue": "1" + }, + { + "id": 7, + "name": "DdoStored", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Assets.ts", + "line": 23, + "character": 11 + } + ], + "defaultValue": "5" + }, + { + "id": 4, + "name": "EncryptingFiles", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Assets.ts", + "line": 20, + "character": 17 + } + ], + "defaultValue": "2" + }, + { + "id": 5, + "name": "FilesEncrypted", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Assets.ts", + "line": 21, + "character": 16 + } + ], + "defaultValue": "3" + }, + { + "id": 6, + "name": "StoringDdo", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Assets.ts", + "line": 22, + "character": 12 + } + ], + "defaultValue": "4" + } + ], + "groups": [ + { + "title": "Enumeration members", + "kind": 16, + "children": [ + 2, + 3, + 7, + 4, + 5, + 6 + ] + } + ], + "sources": [ + { + "fileName": "ocean/Assets.ts", + "line": 17, + "character": 30 + } + ] + }, + { + "id": 10, + "name": "OceanPlatformTechStatus", + "kind": 4, + "kindString": "Enumeration", + "flags": {}, + "children": [ + { + "id": 11, + "name": "Loading", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Versions.ts", + "line": 6, + "character": 9 + } + ], + "defaultValue": "\"Loading\"" + }, + { + "id": 13, + "name": "Stopped", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Versions.ts", + "line": 8, + "character": 9 + } + ], + "defaultValue": "\"Stopped\"" + }, + { + "id": 12, + "name": "Unknown", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Versions.ts", + "line": 7, + "character": 9 + } + ], + "defaultValue": "\"Unknown\"" + }, + { + "id": 14, + "name": "Working", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Versions.ts", + "line": 9, + "character": 9 + } + ], + "defaultValue": "\"Working\"" + } + ], + "groups": [ + { + "title": "Enumeration members", + "kind": 16, + "children": [ + 11, + 13, + 12, + 14 + ] + } + ], + "sources": [ + { + "fileName": "ocean/Versions.ts", + "line": 5, + "character": 35 + } + ] + }, + { + "id": 8, + "name": "OrderProgressStep", + "kind": 4, + "kindString": "Enumeration", + "flags": {}, + "children": [ + { + "id": 9, + "name": "TransferDataToken", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Assets.ts", + "line": 27, + "character": 19 + } + ], + "defaultValue": "0" + } + ], + "groups": [ + { + "title": "Enumeration members", + "kind": 16, + "children": [ + 9 + ] + } + ], + "sources": [ + { + "fileName": "ocean/Assets.ts", + "line": 26, + "character": 29 + } + ] + }, + { + "id": 64, + "name": "Account", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "shortText": "Account information." + }, + "children": [ + { + "id": 73, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "signatures": [ + { + "id": 74, + "name": "new Account", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 75, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "'0x0'" + }, + { + "id": 76, + "name": "config", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "InstantiableConfig" + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } + } + ] + }, + { + "id": 77, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPrivate": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "ocean/Account.ts", + "line": 8, + "character": 18 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 78, + "name": "token", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPrivate": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "ocean/Account.ts", + "line": 10, + "character": 15 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 103, + "name": "config", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "Instantiable.abstract.ts", + "line": 44, + "character": 22 + } + ], + "getSignature": [ + { + "id": 104, + "name": "config", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "type": { + "type": "reference", + "id": 112, + "name": "Config" + } + } + ] + }, + { + "id": 107, + "name": "instanceConfig", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "Instantiable.abstract.ts", + "line": 60, + "character": 30 + } + ], + "getSignature": [ + { + "id": 108, + "name": "instanceConfig", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "type": { + "type": "reference", + "name": "InstantiableConfig" + } + } + ] + }, + { + "id": 105, + "name": "logger", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "Instantiable.abstract.ts", + "line": 51, + "character": 22 + } + ], + "getSignature": [ + { + "id": 106, + "name": "logger", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "type": { + "type": "reference", + "name": "Logger" + } + } + ] + }, + { + "id": 99, + "name": "ocean", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "Instantiable.abstract.ts", + "line": 30, + "character": 21 + } + ], + "getSignature": [ + { + "id": 100, + "name": "ocean", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "type": { + "type": "reference", + "id": 27, + "name": "Ocean" + } + } + ] + }, + { + "id": 101, + "name": "web3", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "Instantiable.abstract.ts", + "line": 37, + "character": 20 + } + ], + "getSignature": [ + { + "id": 102, + "name": "web3", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "type": { + "type": "reference", + "name": "default" + } + } + ] + }, + { + "id": 97, + "name": "getEtherBalance", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ocean/Account.ts", + "line": 140, + "character": 30 + } + ], + "signatures": [ + { + "id": 98, + "name": "getEtherBalance", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Balance of Ether.(converted from wei).", + "returns": "\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 79, + "name": "getId", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ocean/Account.ts", + "line": 19, + "character": 14 + } + ], + "signatures": [ + { + "id": 80, + "name": "getId", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 92, + "name": "getOceanBalance", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ocean/Account.ts", + "line": 123, + "character": 30 + } + ], + "signatures": [ + { + "id": 93, + "name": "getOceanBalance", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Balance of Ocean Token. (converted from wei).", + "returns": "\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 87, + "name": "getPassword", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ocean/Account.ts", + "line": 39, + "character": 20 + } + ], + "signatures": [ + { + "id": 88, + "name": "getPassword", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns account password.", + "returns": "Account password.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 89, + "name": "getTokenBalance", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ocean/Account.ts", + "line": 82, + "character": 30 + } + ], + "signatures": [ + { + "id": 90, + "name": "getTokenBalance", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Balance of Any Token (converted from wei).", + "returns": "\n" + }, + "parameters": [ + { + "id": 91, + "name": "TokenAdress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 94, + "name": "getTokenSymbol", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ocean/Account.ts", + "line": 131, + "character": 29 + } + ], + "signatures": [ + { + "id": 95, + "name": "getTokenSymbol", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Symbol of a Token", + "returns": "\n" + }, + "parameters": [ + { + "id": 96, + "name": "TokenAdress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 81, + "name": "setId", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ocean/Account.ts", + "line": 23, + "character": 14 + } + ], + "signatures": [ + { + "id": 82, + "name": "setId", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 83, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 109, + "name": "setInstanceConfig", + "kind": 2048, + "kindString": "Method", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "Instantiable.abstract.ts", + "line": 89, + "character": 29 + } + ], + "signatures": [ + { + "id": 110, + "name": "setInstanceConfig", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 111, + "name": "config", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "InstantiableConfig" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 84, + "name": "setPassword", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ocean/Account.ts", + "line": 31, + "character": 20 + } + ], + "signatures": [ + { + "id": 85, + "name": "setPassword", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set account password." + }, + "parameters": [ + { + "id": 86, + "name": "password", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "Password for account.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 65, + "name": "getInstance", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true, + "isStatic": true + }, + "sources": [ + { + "fileName": "Instantiable.abstract.ts", + "line": 65, + "character": 33 + } + ], + "signatures": [ + { + "id": 66, + "name": "getInstance", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 67, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "any" + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 68, + "name": "setInstanceConfig", + "kind": 2048, + "kindString": "Method", + "flags": { + "isProtected": true, + "isStatic": true + }, + "sources": [ + { + "fileName": "Instantiable.abstract.ts", + "line": 71, + "character": 36 + } + ], + "signatures": [ + { + "id": 69, + "name": "setInstanceConfig", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 70, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "T" + } + ], + "name": "Instantiable" + } + } + ], + "parameters": [ + { + "id": 71, + "name": "instance", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "T" + } + }, + { + "id": 72, + "name": "__namedParameters", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "InstantiableConfig" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 73 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 77, + 78 + ] + }, + { + "title": "Accessors", + "kind": 262144, + "children": [ + 103, + 107, + 105, + 99, + 101 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 97, + 79, + 92, + 87, + 89, + 94, + 81, + 109, + 84, + 65, + 68 + ] + } + ], + "sources": [ + { + "fileName": "ocean/Account.ts", + "line": 7, + "character": 28 + } + ], + "extendedTypes": [ + { + "type": "reference", + "name": "Instantiable" + } + ] + }, + { + "id": 112, + "name": "Config", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 113, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "signatures": [ + { + "id": 114, + "name": "new Config", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "type": { + "type": "reference", + "id": 112, + "name": "Config" + } + } + ] + }, + { + "id": 133, + "name": "authMessage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "Message shown when the user creates its own token." + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 114, + "character": 20 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 134, + "name": "authTokenExpiration", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "Token expiration time in ms." + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 120, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 123, + "name": "datatokensABI", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "datatokens ABI" + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 57, + "character": 22 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "AbiItem" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "name": "AbiItem" + } + } + ] + } + }, + { + "id": 122, + "name": "factoryABI", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "Factory ABI" + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 51, + "character": 19 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "AbiItem" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "name": "AbiItem" + } + } + ] + } + }, + { + "id": 121, + "name": "factoryAddress", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "Factory address" + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 45, + "character": 23 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 127, + "name": "fixedRateExchangeAddress", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "FixedRateExchangeAddress" + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 81, + "character": 33 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 128, + "name": "fixedRateExchangeAddressABI", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "FixedRateExchangeAddressABI" + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 87, + "character": 36 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "AbiItem" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "name": "AbiItem" + } + } + ] + } + }, + { + "id": 117, + "name": "metadataCacheUri", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "Metadata Store URL." + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 21, + "character": 25 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 130, + "name": "metadataContractABI", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "DDOContractABI" + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 98, + "character": 28 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "AbiItem" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "name": "AbiItem" + } + } + ] + } + }, + { + "id": 129, + "name": "metadataContractAddress", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "DDOContractAddress" + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 92, + "character": 32 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 115, + "name": "nodeUri", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "Ethereum node URL." + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 9, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 120, + "name": "oceanTokenAddress", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "Ocean Token address" + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 39, + "character": 26 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 135, + "name": "parityUri", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 123, + "character": 18 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 126, + "name": "poolABI", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "Pool ABI" + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 75, + "character": 16 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "AbiItem" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "name": "AbiItem" + } + } + ] + } + }, + { + "id": 125, + "name": "poolFactoryABI", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "Pool Factory ABI" + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 69, + "character": 23 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "AbiItem" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "name": "AbiItem" + } + } + ] + } + }, + { + "id": 124, + "name": "poolFactoryAddress", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "Pool Factory address" + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 63, + "character": 27 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 116, + "name": "providerAddress", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "Address of Provider." + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 15, + "character": 24 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 118, + "name": "providerUri", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "Provider URL." + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 27, + "character": 20 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 131, + "name": "startBlock", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "block number of the deployment" + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 103, + "character": 19 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 136, + "name": "threshold", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 125, + "character": 18 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 132, + "name": "verbose", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "Log level." + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 108, + "character": 16 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "reference", + "name": "None" + }, + { + "type": "reference", + "name": "Error" + }, + { + "type": "reference", + "name": "Warn" + }, + { + "type": "reference", + "name": "Log" + }, + { + "type": "reference", + "name": "Verbose" + } + ] + } + }, + { + "id": 119, + "name": "web3Provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "comment": { + "shortText": "Web3 Provider." + }, + "sources": [ + { + "fileName": "models/Config.ts", + "line": 33, + "character": 21 + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 113 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 133, + 134, + 123, + 122, + 121, + 127, + 128, + 117, + 130, + 129, + 115, + 120, + 135, + 126, + 125, + 124, + 116, + 118, + 131, + 136, + 132, + 119 + ] + } + ], + "sources": [ + { + "fileName": "models/Config.ts", + "line": 4, + "character": 19 + } + ] + }, + { + "id": 315, + "name": "ConfigHelper", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 316, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "signatures": [ + { + "id": 317, + "name": "new ConfigHelper", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "type": { + "type": "reference", + "id": 315, + "name": "ConfigHelper" + } + } + ] + }, + { + "id": 318, + "name": "getAddressesFromEnv", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "utils/ConfigHelper.ts", + "line": 97, + "character": 28 + } + ], + "signatures": [ + { + "id": 319, + "name": "getAddressesFromEnv", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 320, + "name": "network", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ConfigHelperConfig" + } + ], + "name": "Partial" + } + } + ] + }, + { + "id": 321, + "name": "getConfig", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "utils/ConfigHelper.ts", + "line": 144, + "character": 18 + } + ], + "signatures": [ + { + "id": 322, + "name": "getConfig", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 323, + "name": "network", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 324, + "name": "infuraProjectId", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "name": "Config" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 316 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 318, + 321 + ] + } + ], + "sources": [ + { + "fileName": "utils/ConfigHelper.ts", + "line": 95, + "character": 25 + } + ] + }, + { + "id": 325, + "name": "DDO", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "shortText": "DID Descriptor Object.\nContains all the data related to an asset." + }, + "children": [ + { + "id": 332, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": { + "isPublic": true + }, + "signatures": [ + { + "id": 333, + "name": "new DDO", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 334, + "name": "ddo", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 325, + "name": "DDO" + } + ], + "name": "Partial" + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "id": 325, + "name": "DDO" + } + } + ] + }, + { + "id": 335, + "name": "@context", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 33, + "character": 3 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "'https://w3id.org/did/v1'" + }, + { + "id": 341, + "name": "authentication", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 51, + "character": 23 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 381, + "name": "Authentication" + } + }, + "defaultValue": "..." + }, + { + "id": 337, + "name": "created", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 43, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 339, + "name": "dataToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 47, + "character": 18 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 347, + "name": "dataTokenInfo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 63, + "character": 22 + } + ], + "type": { + "type": "reference", + "name": "DataTokenInfo" + } + }, + { + "id": 336, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "comment": { + "shortText": "DID, descentralized ID." + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 41, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "null" + }, + { + "id": 345, + "name": "isInPurgatory", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 59, + "character": 22 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "false" + }, + { + "type": "literal", + "value": "true" + } + ] + } + }, + { + "id": 344, + "name": "price", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 57, + "character": 14 + } + ], + "type": { + "type": "reference", + "id": 384, + "name": "BestPrice" + } + }, + { + "id": 343, + "name": "proof", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 55, + "character": 14 + } + ], + "type": { + "type": "reference", + "id": 442, + "name": "Proof" + } + }, + { + "id": 340, + "name": "publicKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 49, + "character": 18 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 447, + "name": "PublicKey" + } + }, + "defaultValue": "..." + }, + { + "id": 346, + "name": "purgatoryData", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 61, + "character": 22 + } + ], + "type": { + "type": "reference", + "id": 543, + "name": "PurgatoryData" + } + }, + { + "id": 342, + "name": "service", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 53, + "character": 16 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 464, + "name": "ServiceCommon" + } + }, + "defaultValue": "..." + }, + { + "id": 338, + "name": "updated", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 45, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 360, + "name": "addProof", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 133, + "character": 23 + } + ], + "signatures": [ + { + "id": 361, + "name": "addProof", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Generates and adds a simple hash proof on publicKey", + "returns": "\n" + }, + "parameters": [ + { + "id": 362, + "name": "ocean", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "Ocean instance." + }, + "type": { + "type": "reference", + "id": 27, + "name": "Ocean" + } + }, + { + "id": 363, + "name": "publicKey", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "Public key to be used on personal sign." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 364, + "name": "password", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 350, + "name": "findServiceById", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 80, + "character": 24 + } + ], + "signatures": [ + { + "id": 351, + "name": "findServiceById", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Finds a service of a DDO by index.", + "returns": "Service.\n" + }, + "typeParameter": [ + { + "id": 352, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 454, + "name": "ServiceType" + } + } + ], + "parameters": [ + { + "id": 353, + "name": "index", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "id": 538, + "typeArguments": [ + { + "type": "reference", + "name": "T" + } + ], + "name": "Service" + } + } + ] + }, + { + "id": 354, + "name": "findServiceByType", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 95, + "character": 26 + } + ], + "signatures": [ + { + "id": 355, + "name": "findServiceByType", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Finds a service of a DDO by type.", + "returns": "Service.\n" + }, + "typeParameter": [ + { + "id": 356, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 454, + "name": "ServiceType" + } + } + ], + "parameters": [ + { + "id": 357, + "name": "serviceType", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "Service type." + }, + "type": { + "type": "reference", + "name": "T" + } + } + ], + "type": { + "type": "reference", + "id": 538, + "typeArguments": [ + { + "type": "reference", + "name": "T" + } + ], + "name": "Service" + } + } + ] + }, + { + "id": 358, + "name": "getChecksum", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 107, + "character": 20 + } + ], + "signatures": [ + { + "id": 359, + "name": "getChecksum", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Generate the checksum using the current content.", + "returns": "DDO checksum.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 348, + "name": "shortId", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 71, + "character": 16 + } + ], + "signatures": [ + { + "id": 349, + "name": "shortId", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 329, + "name": "deserialize", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true, + "isStatic": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 29, + "character": 27 + } + ], + "signatures": [ + { + "id": 330, + "name": "deserialize", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Deserializes the DDO object.", + "returns": "DDO deserialized.\n" + }, + "parameters": [ + { + "id": 331, + "name": "ddoString", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 325, + "name": "DDO" + } + } + ] + }, + { + "id": 326, + "name": "serialize", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true, + "isStatic": true + }, + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 20, + "character": 25 + } + ], + "signatures": [ + { + "id": 327, + "name": "serialize", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Serializes the DDO object.", + "returns": "DDO serialized.\n" + }, + "parameters": [ + { + "id": 328, + "name": "ddo", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 325, + "name": "DDO" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 332 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 335, + 341, + 337, + 339, + 347, + 336, + 345, + 344, + 343, + 340, + 346, + 342, + 338 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 360, + 350, + 354, + 358, + 348, + 329, + 326 + ] + } + ], + "sources": [ + { + "fileName": "ddo/DDO.ts", + "line": 14, + "character": 16 + } + ] + }, + { + "id": 137, + "name": "DID", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "shortText": "Decentralized ID." + }, + "children": [ + { + "id": 144, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": { + "isPrivate": true + }, + "signatures": [ + { + "id": 145, + "name": "new DID", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 146, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 137, + "name": "default" + } + } + ] + }, + { + "id": 147, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPrivate": true + }, + "comment": { + "shortText": "ID." + }, + "sources": [ + { + "fileName": "ocean/DID.ts", + "line": 43, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 148, + "name": "getDid", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ocean/DID.ts", + "line": 53, + "character": 15 + } + ], + "signatures": [ + { + "id": 149, + "name": "getDid", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the DID.", + "returns": "\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 150, + "name": "getId", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "ocean/DID.ts", + "line": 61, + "character": 14 + } + ], + "signatures": [ + { + "id": 151, + "name": "getId", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the ID.", + "returns": "\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 141, + "name": "generate", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true, + "isStatic": true + }, + "sources": [ + { + "fileName": "ocean/DID.ts", + "line": 35, + "character": 24 + } + ], + "signatures": [ + { + "id": 142, + "name": "generate", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Generate a new DID.", + "returns": "\n" + }, + "parameters": [ + { + "id": 143, + "name": "dataTokenAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "Address of data token to use for DID." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 137, + "name": "default" + } + } + ] + }, + { + "id": 138, + "name": "parse", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true, + "isStatic": true + }, + "sources": [ + { + "fileName": "ocean/DID.ts", + "line": 13, + "character": 21 + } + ], + "signatures": [ + { + "id": 139, + "name": "parse", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Parses a DID from a string.", + "returns": "\n" + }, + "parameters": [ + { + "id": 140, + "name": "didString", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "DID in string." + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 137, + "name": "default" + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 137, + "name": "default" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 144 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 147 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 148, + 150, + 141, + 138 + ] + } + ], + "sources": [ + { + "fileName": "ocean/DID.ts", + "line": 7, + "character": 24 + } + ] + }, + { + "id": 204, + "name": "DataTokens", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "shortText": "Provides an interface to DataTokens" + }, + "children": [ + { + "id": 205, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "signatures": [ + { + "id": 206, + "name": "new DataTokens", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "comment": { + "shortText": "Instantiate DataTokens (independently of Ocean)." + }, + "parameters": [ + { + "id": 207, + "name": "factoryAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 208, + "name": "factoryABI", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "AbiItem" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "name": "AbiItem" + } + } + ] + } + }, + { + "id": 209, + "name": "datatokensABI", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "AbiItem" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "name": "AbiItem" + } + } + ] + } + }, + { + "id": 210, + "name": "web3", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "\n" + }, + "type": { + "type": "reference", + "name": "default" + } + }, + { + "id": 211, + "name": "logger", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Logger" + } + } + ], + "type": { + "type": "reference", + "id": 204, + "name": "DataTokens" + } + } + ] + }, + { + "id": 212, + "name": "GASLIMIT_DEFAULT", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 16, + "character": 25 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "1000000" + }, + { + "id": 215, + "name": "datatokensABI", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 19, + "character": 22 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "AbiItem" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "name": "AbiItem" + } + } + ] + } + }, + { + "id": 214, + "name": "factoryABI", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 18, + "character": 19 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "AbiItem" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "name": "AbiItem" + } + } + ] + } + }, + { + "id": 213, + "name": "factoryAddress", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 17, + "character": 23 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 217, + "name": "logger", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 21, + "character": 16 + } + ], + "type": { + "type": "reference", + "name": "Logger" + } + }, + { + "id": 216, + "name": "web3", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 20, + "character": 13 + } + ], + "type": { + "type": "reference", + "name": "default" + } + }, + { + "id": 274, + "name": "allowance", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 328, + "character": 24 + } + ], + "signatures": [ + { + "id": 275, + "name": "allowance", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Get Alloance" + }, + "parameters": [ + { + "id": 276, + "name": "dataTokenAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 277, + "name": "owner", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 278, + "name": "spender", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 234, + "name": "approve", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 132, + "character": 22 + } + ], + "signatures": [ + { + "id": 235, + "name": "approve", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Approve", + "returns": "transactionId\n" + }, + "parameters": [ + { + "id": 236, + "name": "dataTokenAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 237, + "name": "spender", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 238, + "name": "amount", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "Number of datatokens, as number. Will be converted to wei" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 239, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "TransactionReceipt" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 270, + "name": "balance", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 314, + "character": 22 + } + ], + "signatures": [ + { + "id": 271, + "name": "balance", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Get Address Balance for datatoken", + "returns": "balance Number of datatokens. Will be converted from wei\n" + }, + "parameters": [ + { + "id": 272, + "name": "dataTokenAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 273, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 227, + "name": "create", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 78, + "character": 21 + } + ], + "signatures": [ + { + "id": 228, + "name": "create", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Create new datatoken", + "returns": "datatoken address\n" + }, + "parameters": [ + { + "id": 229, + "name": "metadataCacheUri", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 230, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 231, + "name": "cap", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "text": "Maximum cap (Number) - will be converted to wei" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 232, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "text": "Token name" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 233, + "name": "symbol", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "text": "Token symbol" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 294, + "name": "fromWei", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 392, + "character": 16 + } + ], + "signatures": [ + { + "id": 295, + "name": "fromWei", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Convert from wei", + "returns": "string\n" + }, + "parameters": [ + { + "id": 296, + "name": "amount", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 218, + "name": "generateDtName", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 47, + "character": 23 + } + ], + "signatures": [ + { + "id": 219, + "name": "generateDtName", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Generate new datatoken name & symbol from a word list", + "returns": ">} datatoken name & symbol. Produces e.g. \"Endemic Jellyfish Token\" & \"ENDJEL-45\"\n" + }, + "parameters": [ + { + "id": 220, + "name": "wordList", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 221, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 223, + "name": "adjectives", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 49, + "character": 14 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 222, + "name": "nouns", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 48, + "character": 9 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 223, + 222 + ] + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 224, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 225, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 50, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 226, + "name": "symbol", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 50, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 225, + 226 + ] + } + ] + } + } + } + ] + }, + { + "id": 279, + "name": "getBlob", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 344, + "character": 22 + } + ], + "signatures": [ + { + "id": 280, + "name": "getBlob", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Get Blob", + "returns": "string\n" + }, + "parameters": [ + { + "id": 281, + "name": "dataTokenAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 288, + "name": "getCap", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 374, + "character": 21 + } + ], + "signatures": [ + { + "id": 289, + "name": "getCap", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Get Cap", + "returns": "string\n" + }, + "parameters": [ + { + "id": 290, + "name": "dataTokenAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 282, + "name": "getName", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 354, + "character": 22 + } + ], + "signatures": [ + { + "id": 283, + "name": "getName", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Get Name", + "returns": "string\n" + }, + "parameters": [ + { + "id": 284, + "name": "dataTokenAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 305, + "name": "getPreviousValidOrders", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 462, + "character": 37 + } + ], + "signatures": [ + { + "id": 306, + "name": "getPreviousValidOrders", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Search and return txid for a previous valid order with the same params", + "returns": "string\n" + }, + "parameters": [ + { + "id": 307, + "name": "dataTokenAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 308, + "name": "amount", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 309, + "name": "serviceId", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 310, + "name": "timeout", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "service timeout" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 311, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "consumer Address" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 312, + "name": "getStartOrderEventSignature", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 493, + "character": 36 + } + ], + "signatures": [ + { + "id": 313, + "name": "getStartOrderEventSignature", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 285, + "name": "getSymbol", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 364, + "character": 24 + } + ], + "signatures": [ + { + "id": 286, + "name": "getSymbol", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Get Symbol", + "returns": "string\n" + }, + "parameters": [ + { + "id": 287, + "name": "dataTokenAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 240, + "name": "mint", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 168, + "character": 19 + } + ], + "signatures": [ + { + "id": 241, + "name": "mint", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Mint", + "returns": "transactionId\n" + }, + "parameters": [ + { + "id": 242, + "name": "dataTokenAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 243, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 244, + "name": "amount", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "Number of datatokens, as number. Will be converted to wei" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 245, + "name": "toAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "text": "only if toAddress is different from the minter" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "TransactionReceipt" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 297, + "name": "startOrder", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 405, + "character": 25 + } + ], + "signatures": [ + { + "id": 298, + "name": "startOrder", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Start Order", + "returns": "string\n" + }, + "parameters": [ + { + "id": 299, + "name": "dataTokenAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 300, + "name": "consumer", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "consumer Address" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 301, + "name": "amount", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 302, + "name": "serviceId", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 303, + "name": "mpFeeAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 304, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "consumer Address" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "TransactionReceipt" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 291, + "name": "toWei", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 384, + "character": 14 + } + ], + "signatures": [ + { + "id": 292, + "name": "toWei", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Convert to wei", + "returns": "string\n" + }, + "parameters": [ + { + "id": 293, + "name": "amount", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 246, + "name": "transfer", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 211, + "character": 23 + } + ], + "signatures": [ + { + "id": 247, + "name": "transfer", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Transfer as number from address to toAddress", + "returns": "transactionId\n" + }, + "parameters": [ + { + "id": 248, + "name": "dataTokenAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 249, + "name": "toAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 250, + "name": "amount", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "Number of datatokens, as number. Will be converted to wei" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 251, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "TransactionReceipt" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 264, + "name": "transferFrom", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 280, + "character": 27 + } + ], + "signatures": [ + { + "id": 265, + "name": "transferFrom", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Transfer from fromAddress to address (needs an Approve operation before)", + "returns": "transactionId\n" + }, + "parameters": [ + { + "id": 266, + "name": "dataTokenAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 267, + "name": "fromAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 268, + "name": "amount", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "Number of datatokens, as number. Will be converted to wei" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 269, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 252, + "name": "transferToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 228, + "character": 28 + } + ], + "signatures": [ + { + "id": 253, + "name": "transferToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Transfer as number from address to toAddress", + "returns": "transactionId\n" + }, + "parameters": [ + { + "id": 254, + "name": "dataTokenAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 255, + "name": "toAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 256, + "name": "amount", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "Number of datatokens, as number. Will be converted to wei" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 257, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "TransactionReceipt" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 258, + "name": "transferWei", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 246, + "character": 26 + } + ], + "signatures": [ + { + "id": 259, + "name": "transferWei", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Transfer in wei from address to toAddress", + "returns": "transactionId\n" + }, + "parameters": [ + { + "id": 260, + "name": "dataTokenAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 261, + "name": "toAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 262, + "name": "amount", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "Number of datatokens, as number. Expressed as wei" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 263, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "TransactionReceipt" + } + ], + "name": "Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 205 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 212, + 215, + 214, + 213, + 217, + 216 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 274, + 234, + 270, + 227, + 294, + 218, + 279, + 288, + 282, + 305, + 312, + 285, + 240, + 297, + 291, + 246, + 264, + 252, + 258 + ] + } + ], + "sources": [ + { + "fileName": "datatokens/Datatokens.ts", + "line": 15, + "character": 23 + } + ] + }, + { + "id": 153, + "name": "MetadataCache", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "shortText": "Provides an interface with Metadata Cache.\nMetadata Cache provides an off-chain database cache for on-chain metadata about data assets." + }, + "children": [ + { + "id": 154, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "signatures": [ + { + "id": 155, + "name": "new MetadataCache", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "comment": { + "shortText": "Instantiate Metadata Cache (independently of Ocean) for off-chain interaction." + }, + "parameters": [ + { + "id": 156, + "name": "metadataCacheUri", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 157, + "name": "logger", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "\n" + }, + "type": { + "type": "reference", + "name": "Logger" + } + } + ], + "type": { + "type": "reference", + "id": 153, + "name": "MetadataCache" + } + } + ] + }, + { + "id": 158, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "metadatacache/MetadataCache.ts", + "line": 30, + "character": 14 + } + ], + "type": { + "type": "reference", + "name": "WebServiceConnector" + } + }, + { + "id": 159, + "name": "logger", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "metadatacache/MetadataCache.ts", + "line": 31, + "character": 16 + } + ], + "type": { + "type": "reference", + "name": "Logger" + } + }, + { + "id": 160, + "name": "metadataCacheUri", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "metadatacache/MetadataCache.ts", + "line": 32, + "character": 26 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 161, + "name": "url", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "metadatacache/MetadataCache.ts", + "line": 34, + "character": 17 + } + ], + "getSignature": [ + { + "id": 162, + "name": "url", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 165, + "name": "getAccessUrl", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "metadatacache/MetadataCache.ts", + "line": 53, + "character": 27 + } + ], + "signatures": [ + { + "id": 166, + "name": "getAccessUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 167, + "name": "accessToken", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 168, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 188, + "name": "getOwnerAssets", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "metadatacache/MetadataCache.ts", + "line": 204, + "character": 29 + } + ], + "signatures": [ + { + "id": 189, + "name": "getOwnerAssets", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 190, + "name": "owner", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "QueryResult" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 196, + "name": "getServiceEndpoint", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "metadatacache/MetadataCache.ts", + "line": 258, + "character": 27 + } + ], + "signatures": [ + { + "id": 197, + "name": "getServiceEndpoint", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 198, + "name": "did", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 137, + "name": "default" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 199, + "name": "getURI", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "metadatacache/MetadataCache.ts", + "line": 262, + "character": 15 + } + ], + "signatures": [ + { + "id": 200, + "name": "getURI", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 163, + "name": "getVersionInfo", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "metadatacache/MetadataCache.ts", + "line": 49, + "character": 29 + } + ], + "signatures": [ + { + "id": 164, + "name": "getVersionInfo", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 169, + "name": "queryMetadata", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "metadatacache/MetadataCache.ts", + "line": 80, + "character": 28 + } + ], + "signatures": [ + { + "id": 170, + "name": "queryMetadata", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Search over the DDOs using a query.", + "returns": "\n" + }, + "parameters": [ + { + "id": 171, + "name": "query", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "Query to filter the DDOs." + }, + "type": { + "type": "reference", + "name": "SearchQuery" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "QueryResult" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 191, + "name": "retire", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "metadatacache/MetadataCache.ts", + "line": 227, + "character": 21 + } + ], + "signatures": [ + { + "id": 192, + "name": "retire", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Retire a DDO (Delete)", + "returns": "Result.\n" + }, + "parameters": [ + { + "id": 193, + "name": "did", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "DID of the asset to update." + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 137, + "name": "default" + } + ] + } + }, + { + "id": 194, + "name": "updated", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "Updated field of the DDO" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 195, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "Signature using updated field to verify that the consumer has rights" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 175, + "name": "retrieveDDO", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "metadatacache/MetadataCache.ts", + "line": 133, + "character": 26 + } + ], + "signatures": [ + { + "id": 176, + "name": "retrieveDDO", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Retrieves a DDO by DID.", + "returns": "DDO of the asset.\n" + }, + "parameters": [ + { + "id": 177, + "name": "did", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "DID of the asset." + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 137, + "name": "default" + } + ] + } + }, + { + "id": 178, + "name": "metadataServiceEndpoint", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 325, + "name": "DDO" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 179, + "name": "retrieveDDOByUrl", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "metadatacache/MetadataCache.ts", + "line": 159, + "character": 31 + } + ], + "signatures": [ + { + "id": 180, + "name": "retrieveDDOByUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 181, + "name": "metadataServiceEndpoint", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 325, + "name": "DDO" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 172, + "name": "storeDDO", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "metadatacache/MetadataCache.ts", + "line": 106, + "character": 23 + } + ], + "signatures": [ + { + "id": 173, + "name": "storeDDO", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Stores a DDO in Metadata Store.", + "returns": "Final DDO.\n" + }, + "parameters": [ + { + "id": 174, + "name": "ddo", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "DDO to be stored." + }, + "type": { + "type": "reference", + "id": 325, + "name": "DDO" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 325, + "name": "DDO" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 182, + "name": "transferOwnership", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "metadatacache/MetadataCache.ts", + "line": 171, + "character": 32 + } + ], + "signatures": [ + { + "id": 183, + "name": "transferOwnership", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Transfer ownership of a DDO", + "returns": "Result.\n" + }, + "parameters": [ + { + "id": 184, + "name": "did", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "DID of the asset to update." + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 137, + "name": "default" + } + ] + } + }, + { + "id": 185, + "name": "newOwner", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "New owner of the DDO" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 186, + "name": "updated", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "Updated field of the DDO" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 187, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "Signature using updated field to verify that the consumer has rights" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 201, + "name": "transformResult", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "metadatacache/MetadataCache.ts", + "line": 266, + "character": 25 + } + ], + "signatures": [ + { + "id": 202, + "name": "transformResult", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 203, + "name": "__namedParameters", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "name": "QueryResult" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 154 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 158, + 159, + 160 + ] + }, + { + "title": "Accessors", + "kind": 262144, + "children": [ + 161 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 165, + 188, + 196, + 199, + 163, + 169, + 191, + 175, + 179, + 172, + 182, + 201 + ] + } + ], + "sources": [ + { + "fileName": "metadatacache/MetadataCache.ts", + "line": 29, + "character": 26 + } + ] + }, + { + "id": 27, + "name": "Ocean", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "shortText": "Main interface for Ocean Protocol." + }, + "children": [ + { + "id": 36, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "signatures": [ + { + "id": 37, + "name": "new Ocean", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "type": { + "type": "reference", + "id": 27, + "name": "Ocean" + } + } + ] + }, + { + "id": 43, + "name": "accounts", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "comment": { + "shortText": "Ocean account submodule" + }, + "sources": [ + { + "fileName": "ocean/Ocean.ts", + "line": 117, + "character": 17 + } + ], + "type": { + "type": "reference", + "name": "Accounts" + } + }, + { + "id": 44, + "name": "assets", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "comment": { + "shortText": "Ocean assets submodule" + }, + "sources": [ + { + "fileName": "ocean/Ocean.ts", + "line": 130, + "character": 15 + } + ], + "type": { + "type": "reference", + "name": "Assets" + } + }, + { + "id": 45, + "name": "compute", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "comment": { + "shortText": "Ocean compute submodule" + }, + "sources": [ + { + "fileName": "ocean/Ocean.ts", + "line": 136, + "character": 16 + } + ], + "type": { + "type": "reference", + "name": "Compute" + } + }, + { + "id": 46, + "name": "datatokens", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "comment": { + "shortText": "Ocean DataTokens submodule" + }, + "sources": [ + { + "fileName": "ocean/Ocean.ts", + "line": 142, + "character": 19 + } + ], + "type": { + "type": "reference", + "id": 204, + "name": "DataTokens" + } + }, + { + "id": 48, + "name": "fixedRateExchange", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "comment": { + "shortText": "Ocean FixedRateExchange submodule" + }, + "sources": [ + { + "fileName": "ocean/Ocean.ts", + "line": 154, + "character": 26 + } + ], + "type": { + "type": "reference", + "name": "OceanFixedRateExchange" + } + }, + { + "id": 41, + "name": "metadataCache", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "comment": { + "shortText": "MetadataCache instance." + }, + "sources": [ + { + "fileName": "ocean/Ocean.ts", + "line": 107, + "character": 22 + } + ], + "type": { + "type": "reference", + "id": 153, + "name": "MetadataCache" + } + }, + { + "id": 38, + "name": "network", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "comment": { + "shortText": "Network instance" + }, + "sources": [ + { + "fileName": "ocean/Ocean.ts", + "line": 89, + "character": 16 + } + ], + "type": { + "type": "reference", + "name": "Network" + } + }, + { + "id": 42, + "name": "onChainMetadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "comment": { + "shortText": "OnChainMetadataCache instance." + }, + "sources": [ + { + "fileName": "ocean/Ocean.ts", + "line": 112, + "character": 24 + } + ], + "type": { + "type": "reference", + "name": "OnChainMetadata" + } + }, + { + "id": 47, + "name": "pool", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "comment": { + "shortText": "Ocean Pools submodule" + }, + "sources": [ + { + "fileName": "ocean/Ocean.ts", + "line": 148, + "character": 13 + } + ], + "type": { + "type": "reference", + "name": "OceanPool" + } + }, + { + "id": 39, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "comment": { + "shortText": "Provider instance." + }, + "sources": [ + { + "fileName": "ocean/Ocean.ts", + "line": 95, + "character": 17 + } + ], + "type": { + "type": "reference", + "name": "Provider" + } + }, + { + "id": 50, + "name": "utils", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "comment": { + "shortText": "Ocean utils submodule" + }, + "sources": [ + { + "fileName": "ocean/Ocean.ts", + "line": 173, + "character": 14 + } + ], + "type": { + "type": "reference", + "name": "OceanUtils" + } + }, + { + "id": 49, + "name": "versions", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "comment": { + "shortText": "Ocean versions submodule" + }, + "sources": [ + { + "fileName": "ocean/Ocean.ts", + "line": 167, + "character": 17 + } + ], + "type": { + "type": "reference", + "name": "Versions" + } + }, + { + "id": 40, + "name": "web3Provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "comment": { + "shortText": "Web3 provider." + }, + "sources": [ + { + "fileName": "ocean/Ocean.ts", + "line": 101, + "character": 21 + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 55, + "name": "config", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "Instantiable.abstract.ts", + "line": 44, + "character": 22 + } + ], + "getSignature": [ + { + "id": 56, + "name": "config", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "type": { + "type": "reference", + "id": 112, + "name": "Config" + } + } + ] + }, + { + "id": 59, + "name": "instanceConfig", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "Instantiable.abstract.ts", + "line": 60, + "character": 30 + } + ], + "getSignature": [ + { + "id": 60, + "name": "instanceConfig", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "type": { + "type": "reference", + "name": "InstantiableConfig" + } + } + ] + }, + { + "id": 57, + "name": "logger", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "Instantiable.abstract.ts", + "line": 51, + "character": 22 + } + ], + "getSignature": [ + { + "id": 58, + "name": "logger", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "type": { + "type": "reference", + "name": "Logger" + } + } + ] + }, + { + "id": 51, + "name": "ocean", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "Instantiable.abstract.ts", + "line": 30, + "character": 21 + } + ], + "getSignature": [ + { + "id": 52, + "name": "ocean", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "type": { + "type": "reference", + "id": 27, + "name": "Ocean" + } + } + ] + }, + { + "id": 53, + "name": "web3", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "Instantiable.abstract.ts", + "line": 37, + "character": 20 + } + ], + "getSignature": [ + { + "id": 54, + "name": "web3", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "type": { + "type": "reference", + "name": "default" + } + } + ] + }, + { + "id": 61, + "name": "setInstanceConfig", + "kind": 2048, + "kindString": "Method", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "Instantiable.abstract.ts", + "line": 89, + "character": 29 + } + ], + "signatures": [ + { + "id": 62, + "name": "setInstanceConfig", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 63, + "name": "config", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "InstantiableConfig" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 28, + "name": "getInstance", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true, + "isStatic": true + }, + "sources": [ + { + "fileName": "ocean/Ocean.ts", + "line": 28, + "character": 33 + } + ], + "signatures": [ + { + "id": 29, + "name": "getInstance", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the instance of Ocean.", + "returns": "\n" + }, + "parameters": [ + { + "id": 30, + "name": "config", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "text": "Ocean instance configuration." + }, + "type": { + "type": "reference", + "id": 112, + "name": "Config" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 27, + "name": "Ocean" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 31, + "name": "setInstanceConfig", + "kind": 2048, + "kindString": "Method", + "flags": { + "isProtected": true, + "isStatic": true + }, + "sources": [ + { + "fileName": "Instantiable.abstract.ts", + "line": 71, + "character": 36 + } + ], + "signatures": [ + { + "id": 32, + "name": "setInstanceConfig", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 33, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "T" + } + ], + "name": "Instantiable" + } + } + ], + "parameters": [ + { + "id": 34, + "name": "instance", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "T" + } + }, + { + "id": 35, + "name": "__namedParameters", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "InstantiableConfig" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 36 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 43, + 44, + 45, + 46, + 48, + 41, + 38, + 42, + 47, + 39, + 50, + 49, + 40 + ] + }, + { + "title": "Accessors", + "kind": 262144, + "children": [ + 55, + 59, + 57, + 51, + 53 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 61, + 28, + 31 + ] + } + ], + "sources": [ + { + "fileName": "ocean/Ocean.ts", + "line": 22, + "character": 18 + } + ], + "extendedTypes": [ + { + "type": "reference", + "name": "Instantiable" + } + ] + }, + { + "id": 365, + "name": "AdditionalInformation", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "comment": { + "shortText": "Additional Information of Assets Metadata.", + "tags": [ + { + "tag": "see", + "text": "https://github.com/oceanprotocol/OEPs/tree/master/8#additional-information\n" + } + ] + }, + "children": [ + { + "id": 374, + "name": "categories", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Categories used to describe this content. Empty by default.", + "tags": [ + { + "tag": "example", + "text": "[\"Economy\", \"Data Science\"]\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/AdditionalInformation.ts", + "line": 61, + "character": 12 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 367, + "name": "copyrightHolder", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The party holding the legal copyright. Empty by default.", + "tags": [ + { + "tag": "example", + "text": "\"Met Office\"\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/AdditionalInformation.ts", + "line": 19, + "character": 17 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 366, + "name": "description", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Details of what the resource is. For a dataset, this attribute\nexplains what the data represents and what it can be used for.", + "tags": [ + { + "tag": "example", + "text": "\"Weather information of UK including temperature and humidity\"\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/AdditionalInformation.ts", + "line": 12, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 373, + "name": "inLanguage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The language of the content. Please use one of the language\ncodes from the {@link https://tools.ietf.org/html/bcp47 IETF BCP 47 standard}.", + "tags": [ + { + "tag": "example", + "text": "\"en\"\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/AdditionalInformation.ts", + "line": 54, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 369, + "name": "links", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Mapping of links for data samples, or links to find out more information.\nLinks may be to either a URL or another Asset. We expect marketplaces to\nconverge on agreements of typical formats for linked data: The Ocean Protocol\nitself does not mandate any specific formats as these requirements are likely\nto be domain-specific.", + "tags": [ + { + "tag": "example", + "text": "\n[\n {\n anotherSample: \"http://data.ceda.ac.uk/badc/ukcp09/data/gridded-land-obs/gridded-land-obs-daily/\",\n },\n {\n fieldsDescription: \"http://data.ceda.ac.uk/badc/ukcp09/\",\n },\n ]\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/AdditionalInformation.ts", + "line": 46, + "character": 7 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 370, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 371, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 372, + "name": "name", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + } + }, + { + "id": 377, + "name": "structuredMarkup", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A link to machine-readable structured markup (such as ttl/json-ld/rdf)\ndescribing the dataset." + }, + "sources": [ + { + "fileName": "ddo/interfaces/AdditionalInformation.ts", + "line": 84, + "character": 18 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 378, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 380, + "name": "mediaType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/AdditionalInformation.ts", + "line": 86, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 379, + "name": "uri", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/AdditionalInformation.ts", + "line": 85, + "character": 7 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 380, + 379 + ] + } + ] + } + } + } + }, + { + "id": 375, + "name": "tags", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Keywords or tags used to describe this content. Empty by default.", + "tags": [ + { + "tag": "example", + "text": "[\"weather\", \"uk\", \"2011\", \"temperature\", \"humidity\"]\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/AdditionalInformation.ts", + "line": 68, + "character": 6 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 376, + "name": "updateFrequency", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "An indication of update latency - i.e. How often are updates expected (seldom,\nannually, quarterly, etc.), or is the resource static that is never expected\nto get updated.", + "tags": [ + { + "tag": "example", + "text": "\"yearly\"\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/AdditionalInformation.ts", + "line": 77, + "character": 17 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 368, + "name": "workExample", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Example of the concept of this asset. This example is part\nof the metadata, not an external link.", + "tags": [ + { + "tag": "example", + "text": "\"423432fsd,51.509865,-0.118092,2011-01-01T10:55:11+00:00,7.2,68\"\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/AdditionalInformation.ts", + "line": 27, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 374, + 367, + 366, + 373, + 369, + 377, + 375, + 376, + 368 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/AdditionalInformation.ts", + "line": 5, + "character": 38 + } + ] + }, + { + "id": 381, + "name": "Authentication", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 383, + "name": "publicKey", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Authentication.ts", + "line": 3, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 382, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Authentication.ts", + "line": 2, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 383, + 382 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/Authentication.ts", + "line": 1, + "character": 31 + } + ] + }, + { + "id": 384, + "name": "BestPrice", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 386, + "name": "address", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/BestPrice.ts", + "line": 3, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 390, + "name": "datatoken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/BestPrice.ts", + "line": 7, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 388, + "name": "isConsumable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/BestPrice.ts", + "line": 5, + "character": 14 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "" + }, + { + "type": "literal", + "value": "false" + }, + { + "type": "literal", + "value": "true" + } + ] + } + }, + { + "id": 389, + "name": "ocean", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/BestPrice.ts", + "line": 6, + "character": 7 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 391, + "name": "pools", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/BestPrice.ts", + "line": 8, + "character": 7 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 385, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/BestPrice.ts", + "line": 2, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "" + }, + { + "type": "literal", + "value": "pool" + }, + { + "type": "literal", + "value": "exchange" + } + ] + } + }, + { + "id": 387, + "name": "value", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/BestPrice.ts", + "line": 4, + "character": 7 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 386, + 390, + 388, + 389, + 391, + 385, + 387 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/BestPrice.ts", + "line": 1, + "character": 26 + } + ] + }, + { + "id": 392, + "name": "Curation", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "comment": { + "shortText": "Curation attributes of Assets Metadata.", + "tags": [ + { + "tag": "see", + "text": "https://github.com/oceanprotocol/OEPs/tree/master/8\n" + } + ] + }, + "children": [ + { + "id": 396, + "name": "isListed", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag unsuitable content.", + "tags": [ + { + "tag": "example", + "text": "true\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/Curation.ts", + "line": 32, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 394, + "name": "numVotes", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Number of votes. 0 is the default value.", + "tags": [ + { + "tag": "example", + "text": "123\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/Curation.ts", + "line": 18, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 393, + "name": "rating", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Decimal value between 0 and 1. 0 is the default value.", + "tags": [ + { + "tag": "example", + "text": "0.93\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/Curation.ts", + "line": 11, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 395, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Schema applied to calculate the rating.", + "tags": [ + { + "tag": "example", + "text": "\"Binary Voting\"\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/Curation.ts", + "line": 25, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 396, + 394, + 393, + 395 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/Curation.ts", + "line": 5, + "character": 25 + } + ] + }, + { + "id": 397, + "name": "EditableMetadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 398, + "name": "description", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/EditableMetadata.ts", + "line": 4, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 400, + "name": "links", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/EditableMetadata.ts", + "line": 6, + "character": 7 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 401, + "name": "EditableMetadataLinks" + } + } + }, + { + "id": 399, + "name": "title", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/EditableMetadata.ts", + "line": 5, + "character": 7 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 398, + 400, + 399 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/EditableMetadata.ts", + "line": 3, + "character": 33 + } + ] + }, + { + "id": 401, + "name": "EditableMetadataLinks", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 402, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/EditableMetadataLinks.ts", + "line": 2, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 404, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/EditableMetadataLinks.ts", + "line": 4, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 403, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/EditableMetadataLinks.ts", + "line": 3, + "character": 5 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 402, + 404, + 403 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/EditableMetadataLinks.ts", + "line": 1, + "character": 38 + } + ] + }, + { + "id": 405, + "name": "File", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 411, + "name": "checksum", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "File checksum." + }, + "sources": [ + { + "fileName": "ddo/interfaces/File.ts", + "line": 37, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 412, + "name": "checksumType", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Checksum hash algorithm." + }, + "sources": [ + { + "fileName": "ddo/interfaces/File.ts", + "line": 43, + "character": 14 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 416, + "name": "compression", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "File compression (e.g. no, gzip, bzip2, etc).", + "tags": [ + { + "tag": "example", + "text": "\"zip\"\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/File.ts", + "line": 69, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 413, + "name": "contentLength", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "File content length." + }, + "sources": [ + { + "fileName": "ddo/interfaces/File.ts", + "line": 49, + "character": 15 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 410, + "name": "contentType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "File format, if applicable.", + "tags": [ + { + "tag": "example", + "text": "\"text/csv\"\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/File.ts", + "line": 31, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 415, + "name": "encoding", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "File encoding.", + "tags": [ + { + "tag": "example", + "text": "\"UTF-8\"\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/File.ts", + "line": 62, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 409, + "name": "index", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "File index." + }, + "sources": [ + { + "fileName": "ddo/interfaces/File.ts", + "line": 24, + "character": 7 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 406, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "File name." + }, + "sources": [ + { + "fileName": "ddo/interfaces/File.ts", + "line": 6, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 414, + "name": "resourceId", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Resource ID (depending on the source)." + }, + "sources": [ + { + "fileName": "ddo/interfaces/File.ts", + "line": 55, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 407, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "File URL." + }, + "sources": [ + { + "fileName": "ddo/interfaces/File.ts", + "line": 12, + "character": 5 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 408, + "name": "valid", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Is URL accessible." + }, + "sources": [ + { + "fileName": "ddo/interfaces/File.ts", + "line": 18, + "character": 7 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 411, + 412, + 416, + 413, + 410, + 415, + 409, + 406, + 414, + 407, + 408 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/File.ts", + "line": 1, + "character": 21 + } + ] + }, + { + "id": 417, + "name": "Metadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 420, + "name": "additionalInformation", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/Metadata.ts", + "line": 8, + "character": 23 + } + ], + "type": { + "type": "reference", + "id": 365, + "name": "AdditionalInformation" + } + }, + { + "id": 421, + "name": "curation", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/Metadata.ts", + "line": 9, + "character": 10 + } + ], + "type": { + "type": "reference", + "id": 392, + "name": "Curation" + } + }, + { + "id": 419, + "name": "encryptedFiles", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/Metadata.ts", + "line": 7, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 418, + "name": "main", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Metadata.ts", + "line": 6, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 433, + "name": "MetadataMain" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 420, + 421, + 419, + 418 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/Metadata.ts", + "line": 5, + "character": 25 + } + ] + }, + { + "id": 422, + "name": "MetadataAlgorithm", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 428, + "name": "container", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/MetadataAlgorithm.ts", + "line": 7, + "character": 11 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 429, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 430, + "name": "entrypoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/MetadataAlgorithm.ts", + "line": 8, + "character": 14 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 431, + "name": "image", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/MetadataAlgorithm.ts", + "line": 9, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 432, + "name": "tag", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/MetadataAlgorithm.ts", + "line": 10, + "character": 7 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 430, + 431, + 432 + ] + } + ] + } + } + }, + { + "id": 426, + "name": "format", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/MetadataAlgorithm.ts", + "line": 5, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 425, + "name": "language", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/MetadataAlgorithm.ts", + "line": 4, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 424, + "name": "rawcode", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/MetadataAlgorithm.ts", + "line": 3, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 423, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/MetadataAlgorithm.ts", + "line": 2, + "character": 5 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 427, + "name": "version", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/MetadataAlgorithm.ts", + "line": 6, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 428, + 426, + 425, + 424, + 423, + 427 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/MetadataAlgorithm.ts", + "line": 1, + "character": 34 + } + ] + }, + { + "id": 433, + "name": "MetadataMain", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "comment": { + "shortText": "Main attributes of assets metadata.", + "tags": [ + { + "tag": "see", + "text": "https://github.com/oceanprotocol/OEPs/tree/master/8\n" + } + ] + }, + "children": [ + { + "id": 441, + "name": "algorithm", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Metadata used only for assets with type `algorithm`." + }, + "sources": [ + { + "fileName": "ddo/interfaces/MetadataMain.ts", + "line": 65, + "character": 11 + } + ], + "type": { + "type": "reference", + "id": 422, + "name": "MetadataAlgorithm" + } + }, + { + "id": 438, + "name": "author", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Name of the entity generating this data (e.g. Tfl, Disney Corp, etc.).", + "tags": [ + { + "tag": "example", + "text": "\"Met Office\"\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/MetadataMain.ts", + "line": 45, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 436, + "name": "dateCreated", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The date on which the asset was created by the originator in\nISO 8601 format, Coordinated Universal Time.", + "tags": [ + { + "tag": "example", + "text": "\"2019-01-31T08:38:32Z\"\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/MetadataMain.ts", + "line": 29, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 437, + "name": "datePublished", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The date on which the asset DDO was registered into the metadata store.\nThis value is created automatically by Aquarius upon registering,\nso this value can't be set.", + "tags": [ + { + "tag": "example", + "text": "\"2019-01-31T08:38:32Z\"\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/MetadataMain.ts", + "line": 38, + "character": 15 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 440, + "name": "files", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Array of File objects including the encrypted file urls and some additional information." + }, + "sources": [ + { + "fileName": "ddo/interfaces/MetadataMain.ts", + "line": 59, + "character": 7 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 405, + "name": "File" + } + } + }, + { + "id": 439, + "name": "license", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Short name referencing the license of the asset (e.g. Public Domain, CC-0, CC-BY, No License Specified, etc. ).\nIf it's not specified, the following value will be added: \"No License Specified\".", + "tags": [ + { + "tag": "example", + "text": "\"CC-BY\"\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/MetadataMain.ts", + "line": 53, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 434, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Descriptive name of the Asset.", + "tags": [ + { + "tag": "example", + "text": "\"UK Weather information 2011\"\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/MetadataMain.ts", + "line": 14, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 435, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of the Asset. Helps to filter by the type of asset (\"dataset\" or \"algorithm\").", + "tags": [ + { + "tag": "example", + "text": "\"dataset\"\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/MetadataMain.ts", + "line": 21, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "dataset" + }, + { + "type": "literal", + "value": "algorithm" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 441, + 438, + 436, + 437, + 440, + 439, + 434, + 435 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/MetadataMain.ts", + "line": 8, + "character": 29 + } + ] + }, + { + "id": 15, + "name": "OceanPlatformTech", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 18, + "name": "commit", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ocean/Versions.ts", + "line": 15, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 16, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Versions.ts", + "line": 13, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 19, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Versions.ts", + "line": 16, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 10, + "name": "OceanPlatformTechStatus" + } + }, + { + "id": 17, + "name": "version", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ocean/Versions.ts", + "line": 14, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 18, + 16, + 19, + 17 + ] + } + ], + "sources": [ + { + "fileName": "ocean/Versions.ts", + "line": 12, + "character": 34 + } + ] + }, + { + "id": 20, + "name": "OceanPlatformVersions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 21, + "name": "lib", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Versions.ts", + "line": 20, + "character": 5 + } + ], + "type": { + "type": "reference", + "id": 15, + "name": "OceanPlatformTech" + } + }, + { + "id": 22, + "name": "metadataCache", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Versions.ts", + "line": 21, + "character": 15 + } + ], + "type": { + "type": "reference", + "id": 15, + "name": "OceanPlatformTech" + } + }, + { + "id": 23, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Versions.ts", + "line": 22, + "character": 10 + } + ], + "type": { + "type": "reference", + "id": 15, + "name": "OceanPlatformTech" + } + }, + { + "id": 24, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Versions.ts", + "line": 23, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 25, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 26, + "name": "ok", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ocean/Versions.ts", + "line": 24, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 26 + ] + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 21, + 22, + 23, + 24 + ] + } + ], + "sources": [ + { + "fileName": "ocean/Versions.ts", + "line": 19, + "character": 38 + } + ] + }, + { + "id": 442, + "name": "Proof", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 444, + "name": "created", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Proof.ts", + "line": 3, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 445, + "name": "creator", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Proof.ts", + "line": 4, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 446, + "name": "signatureValue", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Proof.ts", + "line": 5, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 443, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Proof.ts", + "line": 2, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 444, + 445, + 446, + 443 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/Proof.ts", + "line": 1, + "character": 22 + } + ] + }, + { + "id": 447, + "name": "PublicKey", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "comment": { + "shortText": "Public key data." + }, + "children": [ + { + "id": 448, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the key.", + "tags": [ + { + "tag": "example", + "text": "\"did:op:123456789abcdefghi#keys-1\"\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/PublicKey.ts", + "line": 10, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 450, + "name": "owner", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Key owner.", + "tags": [ + { + "tag": "example", + "text": "\"did:op:123456789abcdefghi\"\n" + } + ] + }, + "sources": [ + { + "fileName": "ddo/interfaces/PublicKey.ts", + "line": 27, + "character": 7 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 452, + "name": "publicKeyBase58", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/PublicKey.ts", + "line": 30, + "character": 17 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 453, + "name": "publicKeyHex", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/PublicKey.ts", + "line": 31, + "character": 14 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 451, + "name": "publicKeyPem", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/PublicKey.ts", + "line": 29, + "character": 14 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 449, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of key." + }, + "sources": [ + { + "fileName": "ddo/interfaces/PublicKey.ts", + "line": 16, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "Ed25519VerificationKey2018" + }, + { + "type": "literal", + "value": "RsaVerificationKey2018" + }, + { + "type": "literal", + "value": "EdDsaSAPublicKeySecp256k1" + }, + { + "type": "literal", + "value": "EthereumECDSAKey" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 448, + 450, + 452, + 453, + 451, + 449 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/PublicKey.ts", + "line": 4, + "character": 26 + } + ] + }, + { + "id": 543, + "name": "PurgatoryData", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 544, + "name": "did", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/PurgatoryData.ts", + "line": 2, + "character": 5 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 545, + "name": "reason", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/PurgatoryData.ts", + "line": 3, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 544, + 545 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/PurgatoryData.ts", + "line": 1, + "character": 30 + } + ] + }, + { + "id": 528, + "name": "ServiceAccess", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 530, + "name": "attributes", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 77, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 469, + "name": "ServiceAccessAttributes" + }, + "overwrites": { + "type": "reference", + "id": 468, + "name": "ServiceCommon.attributes" + } + }, + { + "id": 531, + "name": "index", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 12, + "character": 7 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 466, + "name": "ServiceCommon.index" + } + }, + { + "id": 532, + "name": "serviceEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 13, + "character": 17 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 467, + "name": "ServiceCommon.serviceEndpoint" + } + }, + { + "id": 529, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 76, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": "access" + }, + "overwrites": { + "type": "reference", + "id": 465, + "name": "ServiceCommon.type" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 530, + 531, + 532, + 529 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 75, + "character": 30 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 464, + "name": "ServiceCommon" + } + ] + }, + { + "id": 469, + "name": "ServiceAccessAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 477, + "name": "additionalInformation", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 7, + "character": 23 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 478, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 479, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 480, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + }, + "inheritedFrom": { + "type": "reference", + "id": 460, + "name": "ServiceCommonAttributes.additionalInformation" + } + }, + { + "id": 470, + "name": "main", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 18, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 471, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 475, + "name": "cost", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 22, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 472, + "name": "creator", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 19, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 474, + "name": "datePublished", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 21, + "character": 17 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 473, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 20, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 476, + "name": "timeout", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 23, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 475, + 472, + 474, + 473, + 476 + ] + } + ] + } + }, + "overwrites": { + "type": "reference", + "id": 456, + "name": "ServiceCommonAttributes.main" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 477, + 470 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 17, + "character": 40 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 455, + "name": "ServiceCommonAttributes" + } + ] + }, + { + "id": 464, + "name": "ServiceCommon", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 468, + "name": "attributes", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 14, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 455, + "name": "ServiceCommonAttributes" + } + }, + { + "id": 466, + "name": "index", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 12, + "character": 7 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 467, + "name": "serviceEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 13, + "character": 17 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 465, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 11, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 454, + "name": "ServiceType" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 468, + 466, + 467, + 465 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 10, + "character": 30 + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 523, + "name": "ServiceMetadata" + }, + { + "type": "reference", + "id": 528, + "name": "ServiceAccess" + }, + { + "type": "reference", + "id": 533, + "name": "ServiceCompute" + } + ] + }, + { + "id": 455, + "name": "ServiceCommonAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 460, + "name": "additionalInformation", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 7, + "character": 23 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 461, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 462, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 463, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 456, + "name": "main", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 6, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 457, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 458, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 459, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 460, + 456 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 5, + "character": 40 + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 469, + "name": "ServiceAccessAttributes" + }, + { + "type": "reference", + "id": 509, + "name": "ServiceComputeAttributes" + } + ] + }, + { + "id": 533, + "name": "ServiceCompute", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 535, + "name": "attributes", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 82, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 509, + "name": "ServiceComputeAttributes" + }, + "overwrites": { + "type": "reference", + "id": 468, + "name": "ServiceCommon.attributes" + } + }, + { + "id": 536, + "name": "index", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 12, + "character": 7 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 466, + "name": "ServiceCommon.index" + } + }, + { + "id": 537, + "name": "serviceEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 13, + "character": 17 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 467, + "name": "ServiceCommon.serviceEndpoint" + } + }, + { + "id": 534, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 81, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": "compute" + }, + "overwrites": { + "type": "reference", + "id": 465, + "name": "ServiceCommon.type" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 535, + 536, + 537, + 534 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 80, + "character": 31 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 464, + "name": "ServiceCommon" + } + ] + }, + { + "id": 509, + "name": "ServiceComputeAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 519, + "name": "additionalInformation", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 7, + "character": 23 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 520, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 521, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 522, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + }, + "inheritedFrom": { + "type": "reference", + "id": 460, + "name": "ServiceCommonAttributes.additionalInformation" + } + }, + { + "id": 510, + "name": "main", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 59, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 511, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 514, + "name": "cost", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 62, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 512, + "name": "creator", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 60, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 513, + "name": "datePublished", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 61, + "character": 17 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 517, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 65, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 518, + "name": "privacy", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 66, + "character": 11 + } + ], + "type": { + "type": "reference", + "id": 481, + "name": "ServiceComputePrivacy" + } + }, + { + "id": 516, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 64, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 485, + "name": "ServiceComputeProvider" + } + }, + { + "id": 515, + "name": "timeout", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 63, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 514, + 512, + 513, + 517, + 518, + 516, + 515 + ] + } + ] + } + }, + "overwrites": { + "type": "reference", + "id": 456, + "name": "ServiceCommonAttributes.main" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 519, + 510 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 58, + "character": 41 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 455, + "name": "ServiceCommonAttributes" + } + ] + }, + { + "id": 481, + "name": "ServiceComputePrivacy", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 483, + "name": "allowNetworkAccess", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 28, + "character": 20 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 482, + "name": "allowRawAlgorithm", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 27, + "character": 19 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 484, + "name": "trustedAlgorithms", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 29, + "character": 19 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 483, + 482, + 484 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 26, + "character": 38 + } + ] + }, + { + "id": 485, + "name": "ServiceComputeProvider", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 487, + "name": "description", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 34, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 488, + "name": "environment", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 35, + "character": 13 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 489, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 490, + "name": "cluster", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 36, + "character": 11 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 491, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 492, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 37, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 493, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 38, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 492, + 493 + ] + } + ] + } + } + }, + { + "id": 494, + "name": "supportedContainers", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 40, + "character": 23 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 495, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 498, + "name": "checksum", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 43, + "character": 14 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 496, + "name": "image", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 41, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 497, + "name": "tag", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 42, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 498, + 496, + 497 + ] + } + ] + } + } + } + }, + { + "id": 499, + "name": "supportedServers", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 45, + "character": 20 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 500, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 503, + "name": "cost", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 48, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 504, + "name": "cpu", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 49, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 507, + "name": "disk", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 52, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 505, + "name": "gpu", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 50, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 508, + "name": "maxExecutionTime", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 53, + "character": 22 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 506, + "name": "memory", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 51, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 501, + "name": "serverId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 46, + "character": 14 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 502, + "name": "serverType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 47, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 503, + 504, + 507, + 505, + 508, + 506, + 501, + 502 + ] + } + ] + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 490, + 494, + 499 + ] + } + ] + } + } + }, + { + "id": 486, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 33, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 487, + 488, + 486 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 32, + "character": 39 + } + ] + }, + { + "id": 523, + "name": "ServiceMetadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 525, + "name": "attributes", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 72, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 417, + "name": "Metadata" + }, + "overwrites": { + "type": "reference", + "id": 468, + "name": "ServiceCommon.attributes" + } + }, + { + "id": 526, + "name": "index", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 12, + "character": 7 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 466, + "name": "ServiceCommon.index" + } + }, + { + "id": 527, + "name": "serviceEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 13, + "character": 17 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 467, + "name": "ServiceCommon.serviceEndpoint" + } + }, + { + "id": 524, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 71, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": "metadata" + }, + "overwrites": { + "type": "reference", + "id": 465, + "name": "ServiceCommon.type" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 525, + 526, + 527, + 524 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 70, + "character": 32 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 464, + "name": "ServiceCommon" + } + ] + }, + { + "id": 540, + "name": "ServicePrices", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 542, + "name": "cost", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/ServicePrices.ts", + "line": 3, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 541, + "name": "serviceIndex", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/ServicePrices.ts", + "line": 2, + "character": 14 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 542, + 541 + ] + } + ], + "sources": [ + { + "fileName": "ddo/interfaces/ServicePrices.ts", + "line": 1, + "character": 30 + } + ] + }, + { + "id": 538, + "name": "Service", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 85, + "character": 19 + } + ], + "typeParameter": [ + { + "id": 539, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 454, + "name": "ServiceType" + }, + { + "type": "literal", + "value": "default" + } + ] + }, + "default": { + "type": "literal", + "value": "default" + } + } + ], + "type": { + "type": "conditional", + "checkType": { + "type": "reference", + "name": "T" + }, + "extendsType": { + "type": "literal", + "value": "metadata" + }, + "trueType": { + "type": "reference", + "id": 523, + "name": "ServiceMetadata" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "name": "T" + }, + "extendsType": { + "type": "literal", + "value": "access" + }, + "trueType": { + "type": "reference", + "id": 528, + "name": "ServiceAccess" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "name": "T" + }, + "extendsType": { + "type": "literal", + "value": "compute" + }, + "trueType": { + "type": "reference", + "id": 533, + "name": "ServiceCompute" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "name": "T" + }, + "extendsType": { + "type": "literal", + "value": "default" + }, + "trueType": { + "type": "reference", + "id": 464, + "name": "ServiceCommon" + }, + "falseType": { + "type": "reference", + "id": 464, + "name": "ServiceCommon" + } + } + } + } + } + }, + { + "id": 454, + "name": "ServiceType", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "ddo/interfaces/Service.ts", + "line": 3, + "character": 23 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "authorization" + }, + { + "type": "literal", + "value": "metadata" + }, + { + "type": "literal", + "value": "access" + }, + { + "type": "literal", + "value": "compute" + } + ] + } + }, + { + "id": 152, + "name": "Logger", + "kind": 32, + "kindString": "Variable", + "flags": { + "isConst": true + }, + "sources": [ + { + "fileName": "utils/Logger.ts", + "line": 43, + "character": 27 + } + ], + "type": { + "type": "reference", + "name": "Logger" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Namespaces", + "kind": 2, + "children": [ + 314 + ] + }, + { + "title": "Enumerations", + "kind": 4, + "children": [ + 1, + 10, + 8 + ] + }, + { + "title": "Classes", + "kind": 128, + "children": [ + 64, + 112, + 315, + 325, + 137, + 204, + 153, + 27 + ] + }, + { + "title": "Interfaces", + "kind": 256, + "children": [ + 365, + 381, + 384, + 392, + 397, + 401, + 405, + 417, + 422, + 433, + 15, + 20, + 442, + 447, + 543, + 528, + 469, + 464, + 455, + 533, + 509, + 481, + 485, + 523, + 540 + ] + }, + { + "title": "Type aliases", + "kind": 4194304, + "children": [ + 538, + 454 + ] + }, + { + "title": "Variables", + "kind": 32, + "children": [ + 152 + ] + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 1, + "character": 0 + } + ] +} \ No newline at end of file diff --git a/src/templates/Typedoc/Entities.jsx b/src/templates/Typedoc/Entities.jsx index c482f584..767293fc 100644 --- a/src/templates/Typedoc/Entities.jsx +++ b/src/templates/Typedoc/Entities.jsx @@ -201,7 +201,7 @@ PropertyWrapper.propTypes = { const Entities = ({ entities, sourceUrl }) => entities.map(({ name, comment, children }) => ( -
+

{name}

diff --git a/src/templates/Typedoc/Toc.jsx b/src/templates/Typedoc/Toc.jsx index 6845df72..c1890cf2 100644 --- a/src/templates/Typedoc/Toc.jsx +++ b/src/templates/Typedoc/Toc.jsx @@ -4,7 +4,7 @@ import slugify from 'slugify' import shortid from 'shortid' import Scrollspy from 'react-scrollspy' import Scroll from '../../components/Scroll' -import { filterByKindOfProperty } from './utils' +// import { filterByKindOfProperty } from './utils' import stylesSidebar from '../../components/Sidebar.module.scss' export default class Toc extends PureComponent { @@ -14,13 +14,13 @@ export default class Toc extends PureComponent { subItems = (children, parentName) => children && - children.filter(filterByKindOfProperty).map(({ name, decorators }) => { + children.map(({ name, decorators }) => { const deprecation = (decorators || []).filter( ({ name }) => name === 'deprecated' )[0] // Assuming deprecated annotation return ( -
  • +
  • { + children.map(({ name }) => { return `${parentName}-${name && slugify(name)}` }) ) diff --git a/src/templates/Typedoc/index.jsx b/src/templates/Typedoc/index.jsx index 791c7c5d..d3ba71df 100644 --- a/src/templates/Typedoc/index.jsx +++ b/src/templates/Typedoc/index.jsx @@ -8,13 +8,15 @@ import HeaderSection from '../../components/HeaderSection' import Sidebar from '../../components/Sidebar' import DocHeader from '../../components/DocHeader' import Seo from '../../components/Seo' -import { cleanTypedocData } from './utils' +// import { cleanTypedocData } from './utils' import Entities from './Entities' import Toc from './Toc' import stylesDoc from '../Doc.module.scss' +import typedocSpecMock from '../../../ocean.js.json' + export default class TypedocTemplate extends Component { static propTypes = { data: PropTypes.object.isRequired, @@ -22,11 +24,6 @@ export default class TypedocTemplate extends Component { pageContext: PropTypes.object.isRequired } - typedocCleaned = cleanTypedocData( - this.props.pageContext.typedoc, - this.props.pageContext.classes - ) - // output section title as defined in sections.yml sectionTitle = this.props.data.allSectionsYaml.edges.map(({ node }) => { // compare section against section title from sections.yml @@ -37,8 +34,8 @@ export default class TypedocTemplate extends Component { render() { const { location, pageContext } = this.props - const { typedoc } = pageContext - const { info } = typedoc + // const { typedoc } = pageContext + const { info } = typedocSpecMock const { title, description, version, sourceUrl } = info return ( @@ -66,7 +63,7 @@ export default class TypedocTemplate extends Component { sidebar="references" collapsed toc - tocComponent={} + tocComponent={} />
    @@ -77,7 +74,7 @@ export default class TypedocTemplate extends Component { />