{ "info": { "title": "Hello", "description": "Hello", "version": "vhello", "sourceUrl": "https://github.com/oceanprotocol/ocean.js/blob/main/" }, "id": 0, "name": "@oceanprotocol/lib", "kind": 0, "kindString": "Project", "flags": {}, "originalName": "", "children": [ { "id": 305, "name": "utils", "kind": 2, "kindString": "Namespace", "flags": {}, "sources": [ { "fileName": "utils/index.ts", "line": 1, "character": 0 } ] }, { "id": 342, "name": "CreateProgressStep", "kind": 4, "kindString": "Enumeration", "flags": {}, "children": [ { "id": 343, "name": "CreatingDataToken", "kind": 16, "kindString": "Enumeration member", "flags": {}, "sources": [ { "fileName": "ocean/Assets.ts", "line": 18, "character": 19 } ], "defaultValue": "0" }, { "id": 344, "name": "DataTokenCreated", "kind": 16, "kindString": "Enumeration member", "flags": {}, "sources": [ { "fileName": "ocean/Assets.ts", "line": 19, "character": 18 } ], "defaultValue": "1" }, { "id": 348, "name": "DdoStored", "kind": 16, "kindString": "Enumeration member", "flags": {}, "sources": [ { "fileName": "ocean/Assets.ts", "line": 23, "character": 11 } ], "defaultValue": "5" }, { "id": 345, "name": "EncryptingFiles", "kind": 16, "kindString": "Enumeration member", "flags": {}, "sources": [ { "fileName": "ocean/Assets.ts", "line": 20, "character": 17 } ], "defaultValue": "2" }, { "id": 346, "name": "FilesEncrypted", "kind": 16, "kindString": "Enumeration member", "flags": {}, "sources": [ { "fileName": "ocean/Assets.ts", "line": 21, "character": 16 } ], "defaultValue": "3" }, { "id": 347, "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": [343, 344, 348, 345, 346, 347] } ], "sources": [ { "fileName": "ocean/Assets.ts", "line": 17, "character": 30 } ] }, { "id": 1, "name": "OceanPlatformTechStatus", "kind": 4, "kindString": "Enumeration", "flags": {}, "children": [ { "id": 2, "name": "Loading", "kind": 16, "kindString": "Enumeration member", "flags": {}, "sources": [ { "fileName": "ocean/Versions.ts", "line": 6, "character": 9 } ], "defaultValue": "\"Loading\"" }, { "id": 4, "name": "Stopped", "kind": 16, "kindString": "Enumeration member", "flags": {}, "sources": [ { "fileName": "ocean/Versions.ts", "line": 8, "character": 9 } ], "defaultValue": "\"Stopped\"" }, { "id": 3, "name": "Unknown", "kind": 16, "kindString": "Enumeration member", "flags": {}, "sources": [ { "fileName": "ocean/Versions.ts", "line": 7, "character": 9 } ], "defaultValue": "\"Unknown\"" }, { "id": 5, "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": [2, 4, 3, 5] } ], "sources": [ { "fileName": "ocean/Versions.ts", "line": 5, "character": 35 } ] }, { "id": 349, "name": "OrderProgressStep", "kind": 4, "kindString": "Enumeration", "flags": {}, "children": [ { "id": 350, "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": [350] } ], "sources": [ { "fileName": "ocean/Assets.ts", "line": 26, "character": 29 } ] }, { "id": 55, "name": "Account", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "Account information." }, "children": [ { "id": 64, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { "id": 65, "name": "new Account", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 66, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "'0x0'" }, { "id": 67, "name": "config", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "name": "InstantiableConfig" } } ], "type": { "type": "reference", "id": 55, "name": "default" } } ] }, { "id": 68, "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": 69, "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": 94, "name": "config", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "Instantiable.abstract.ts", "line": 44, "character": 22 } ], "getSignature": [ { "id": 95, "name": "config", "kind": 524288, "kindString": "Get signature", "flags": {}, "type": { "type": "reference", "id": 103, "name": "Config" } } ] }, { "id": 98, "name": "instanceConfig", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "Instantiable.abstract.ts", "line": 60, "character": 30 } ], "getSignature": [ { "id": 99, "name": "instanceConfig", "kind": 524288, "kindString": "Get signature", "flags": {}, "type": { "type": "reference", "name": "InstantiableConfig" } } ] }, { "id": 96, "name": "logger", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "Instantiable.abstract.ts", "line": 51, "character": 22 } ], "getSignature": [ { "id": 97, "name": "logger", "kind": 524288, "kindString": "Get signature", "flags": {}, "type": { "type": "reference", "name": "Logger" } } ] }, { "id": 90, "name": "ocean", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "Instantiable.abstract.ts", "line": 30, "character": 21 } ], "getSignature": [ { "id": 91, "name": "ocean", "kind": 524288, "kindString": "Get signature", "flags": {}, "type": { "type": "reference", "id": 18, "name": "Ocean" } } ] }, { "id": 92, "name": "web3", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "Instantiable.abstract.ts", "line": 37, "character": 20 } ], "getSignature": [ { "id": 93, "name": "web3", "kind": 524288, "kindString": "Get signature", "flags": {}, "type": { "type": "reference", "name": "default" } } ] }, { "id": 88, "name": "getEtherBalance", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "ocean/Account.ts", "line": 140, "character": 30 } ], "signatures": [ { "id": 89, "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": 70, "name": "getId", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "ocean/Account.ts", "line": 19, "character": 14 } ], "signatures": [ { "id": 71, "name": "getId", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 83, "name": "getOceanBalance", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "ocean/Account.ts", "line": 123, "character": 30 } ], "signatures": [ { "id": 84, "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": 78, "name": "getPassword", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "ocean/Account.ts", "line": 39, "character": 20 } ], "signatures": [ { "id": 79, "name": "getPassword", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns account password.", "returns": "Account password.\n" }, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 80, "name": "getTokenBalance", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "ocean/Account.ts", "line": 82, "character": 30 } ], "signatures": [ { "id": 81, "name": "getTokenBalance", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Balance of Any Token (converted from wei).", "returns": "\n" }, "parameters": [ { "id": 82, "name": "TokenAdress", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "Promise" } } ] }, { "id": 85, "name": "getTokenSymbol", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "ocean/Account.ts", "line": 131, "character": 29 } ], "signatures": [ { "id": 86, "name": "getTokenSymbol", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Symbol of a Token", "returns": "\n" }, "parameters": [ { "id": 87, "name": "TokenAdress", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "Promise" } } ] }, { "id": 72, "name": "setId", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "ocean/Account.ts", "line": 23, "character": 14 } ], "signatures": [ { "id": 73, "name": "setId", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 74, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 100, "name": "setInstanceConfig", "kind": 2048, "kindString": "Method", "flags": { "isProtected": true }, "sources": [ { "fileName": "Instantiable.abstract.ts", "line": 89, "character": 29 } ], "signatures": [ { "id": 101, "name": "setInstanceConfig", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 102, "name": "config", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "name": "InstantiableConfig" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 75, "name": "setPassword", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "ocean/Account.ts", "line": 31, "character": 20 } ], "signatures": [ { "id": 76, "name": "setPassword", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Set account password." }, "parameters": [ { "id": 77, "name": "password", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "Password for account.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 56, "name": "getInstance", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true, "isStatic": true }, "sources": [ { "fileName": "Instantiable.abstract.ts", "line": 65, "character": 33 } ], "signatures": [ { "id": 57, "name": "getInstance", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 58, "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": 59, "name": "setInstanceConfig", "kind": 2048, "kindString": "Method", "flags": { "isProtected": true, "isStatic": true }, "sources": [ { "fileName": "Instantiable.abstract.ts", "line": 71, "character": 36 } ], "signatures": [ { "id": 60, "name": "setInstanceConfig", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 61, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "name": "T" } ], "name": "Instantiable" } } ], "parameters": [ { "id": 62, "name": "instance", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "name": "T" } }, { "id": 63, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "name": "InstantiableConfig" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [64] }, { "title": "Properties", "kind": 1024, "children": [68, 69] }, { "title": "Accessors", "kind": 262144, "children": [94, 98, 96, 90, 92] }, { "title": "Methods", "kind": 2048, "children": [88, 70, 83, 78, 80, 85, 72, 100, 75, 56, 59] } ], "sources": [ { "fileName": "ocean/Account.ts", "line": 7, "character": 28 } ], "extendedTypes": [ { "type": "reference", "name": "Instantiable" } ] }, { "id": 103, "name": "Config", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 104, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { "id": 105, "name": "new Config", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", "id": 103, "name": "Config" } } ] }, { "id": 124, "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": 125, "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": 114, "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": 113, "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": 112, "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": 118, "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": 119, "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": 108, "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": 121, "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": 120, "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": 106, "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": 111, "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": 126, "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": 117, "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": 116, "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": 115, "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": 107, "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": 109, "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": 122, "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": 127, "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": 123, "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": 110, "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": [104] }, { "title": "Properties", "kind": 1024, "children": [ 124, 125, 114, 113, 112, 118, 119, 108, 121, 120, 106, 111, 126, 117, 116, 115, 107, 109, 122, 127, 123, 110 ] } ], "sources": [ { "fileName": "models/Config.ts", "line": 4, "character": 19 } ], "extendedBy": [ { "type": "reference", "id": 316, "name": "ConfigHelperConfig" } ] }, { "id": 306, "name": "ConfigHelper", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 307, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { "id": 308, "name": "new ConfigHelper", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", "id": 306, "name": "ConfigHelper" } } ] }, { "id": 309, "name": "getAddressesFromEnv", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "utils/ConfigHelper.ts", "line": 97, "character": 28 } ], "signatures": [ { "id": 310, "name": "getAddressesFromEnv", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 311, "name": "network", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 316, "name": "ConfigHelperConfig" } ], "name": "Partial" } } ] }, { "id": 312, "name": "getConfig", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "utils/ConfigHelper.ts", "line": 144, "character": 18 } ], "signatures": [ { "id": 313, "name": "getConfig", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 314, "name": "network", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 315, "name": "infuraProjectId", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 103, "name": "Config" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [307] }, { "title": "Methods", "kind": 2048, "children": [309, 312] } ], "sources": [ { "fileName": "utils/ConfigHelper.ts", "line": 95, "character": 25 } ] }, { "id": 361, "name": "DDO", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "DID Descriptor Object.\nContains all the data related to an asset." }, "children": [ { "id": 368, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isPublic": true }, "signatures": [ { "id": 369, "name": "new DDO", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 370, "name": "ddo", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 361, "name": "DDO" } ], "name": "Partial" }, "defaultValue": "..." } ], "type": { "type": "reference", "id": 361, "name": "DDO" } } ] }, { "id": 371, "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": 377, "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": 417, "name": "Authentication" } }, "defaultValue": "..." }, { "id": 373, "name": "created", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "sources": [ { "fileName": "ddo/DDO.ts", "line": 43, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 375, "name": "dataToken", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "sources": [ { "fileName": "ddo/DDO.ts", "line": 47, "character": 18 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 383, "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": 372, "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": 381, "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": 380, "name": "price", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "sources": [ { "fileName": "ddo/DDO.ts", "line": 57, "character": 14 } ], "type": { "type": "reference", "id": 420, "name": "BestPrice" } }, { "id": 379, "name": "proof", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "sources": [ { "fileName": "ddo/DDO.ts", "line": 55, "character": 14 } ], "type": { "type": "reference", "id": 478, "name": "Proof" } }, { "id": 376, "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": 483, "name": "PublicKey" } }, "defaultValue": "..." }, { "id": 382, "name": "purgatoryData", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true, "isOptional": true }, "sources": [ { "fileName": "ddo/DDO.ts", "line": 61, "character": 22 } ], "type": { "type": "reference", "id": 579, "name": "PurgatoryData" } }, { "id": 378, "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": 500, "name": "ServiceCommon" } }, "defaultValue": "..." }, { "id": 374, "name": "updated", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "sources": [ { "fileName": "ddo/DDO.ts", "line": 45, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 396, "name": "addProof", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "ddo/DDO.ts", "line": 133, "character": 23 } ], "signatures": [ { "id": 397, "name": "addProof", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Generates and adds a simple hash proof on publicKey", "returns": "\n" }, "parameters": [ { "id": 398, "name": "ocean", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "Ocean instance." }, "type": { "type": "reference", "id": 18, "name": "Ocean" } }, { "id": 399, "name": "publicKey", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "Public key to be used on personal sign." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 400, "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": 386, "name": "findServiceById", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "ddo/DDO.ts", "line": 80, "character": 24 } ], "signatures": [ { "id": 387, "name": "findServiceById", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Finds a service of a DDO by index.", "returns": "Service.\n" }, "typeParameter": [ { "id": 388, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "id": 490, "name": "ServiceType" } } ], "parameters": [ { "id": 389, "name": "index", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "reference", "id": 574, "typeArguments": [ { "type": "reference", "name": "T" } ], "name": "Service" } } ] }, { "id": 390, "name": "findServiceByType", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "ddo/DDO.ts", "line": 95, "character": 26 } ], "signatures": [ { "id": 391, "name": "findServiceByType", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Finds a service of a DDO by type.", "returns": "Service.\n" }, "typeParameter": [ { "id": 392, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "id": 490, "name": "ServiceType" } } ], "parameters": [ { "id": 393, "name": "serviceType", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "Service type." }, "type": { "type": "reference", "name": "T" } } ], "type": { "type": "reference", "id": 574, "typeArguments": [ { "type": "reference", "name": "T" } ], "name": "Service" } } ] }, { "id": 394, "name": "getChecksum", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "ddo/DDO.ts", "line": 107, "character": 20 } ], "signatures": [ { "id": 395, "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": 384, "name": "shortId", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "ddo/DDO.ts", "line": 71, "character": 16 } ], "signatures": [ { "id": 385, "name": "shortId", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 365, "name": "deserialize", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true, "isStatic": true }, "sources": [ { "fileName": "ddo/DDO.ts", "line": 29, "character": 27 } ], "signatures": [ { "id": 366, "name": "deserialize", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Deserializes the DDO object.", "returns": "DDO deserialized.\n" }, "parameters": [ { "id": 367, "name": "ddoString", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 361, "name": "DDO" } } ] }, { "id": 362, "name": "serialize", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true, "isStatic": true }, "sources": [ { "fileName": "ddo/DDO.ts", "line": 20, "character": 25 } ], "signatures": [ { "id": 363, "name": "serialize", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Serializes the DDO object.", "returns": "DDO serialized.\n" }, "parameters": [ { "id": 364, "name": "ddo", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 361, "name": "DDO" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [368] }, { "title": "Properties", "kind": 1024, "children": [ 371, 377, 373, 375, 383, 372, 381, 380, 379, 376, 382, 378, 374 ] }, { "title": "Methods", "kind": 2048, "children": [396, 386, 390, 394, 384, 365, 362] } ], "sources": [ { "fileName": "ddo/DDO.ts", "line": 14, "character": 16 } ] }, { "id": 128, "name": "DID", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "Decentralized ID." }, "children": [ { "id": 135, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isPrivate": true }, "signatures": [ { "id": 136, "name": "new DID", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 137, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 128, "name": "default" } } ] }, { "id": 138, "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": 139, "name": "getDid", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "ocean/DID.ts", "line": 53, "character": 15 } ], "signatures": [ { "id": 140, "name": "getDid", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns the DID.", "returns": "\n" }, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 141, "name": "getId", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "ocean/DID.ts", "line": 61, "character": 14 } ], "signatures": [ { "id": 142, "name": "getId", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns the ID.", "returns": "\n" }, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 132, "name": "generate", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true, "isStatic": true }, "sources": [ { "fileName": "ocean/DID.ts", "line": 35, "character": 24 } ], "signatures": [ { "id": 133, "name": "generate", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Generate a new DID.", "returns": "\n" }, "parameters": [ { "id": 134, "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": 128, "name": "default" } } ] }, { "id": 129, "name": "parse", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true, "isStatic": true }, "sources": [ { "fileName": "ocean/DID.ts", "line": 13, "character": 21 } ], "signatures": [ { "id": 130, "name": "parse", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Parses a DID from a string.", "returns": "\n" }, "parameters": [ { "id": 131, "name": "didString", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "DID in string." }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "id": 128, "name": "default" } ] } } ], "type": { "type": "reference", "id": 128, "name": "default" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [135] }, { "title": "Properties", "kind": 1024, "children": [138] }, { "title": "Methods", "kind": 2048, "children": [139, 141, 132, 129] } ], "sources": [ { "fileName": "ocean/DID.ts", "line": 7, "character": 24 } ] }, { "id": 195, "name": "DataTokens", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "Provides an interface to DataTokens" }, "children": [ { "id": 196, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { "id": 197, "name": "new DataTokens", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Instantiate DataTokens (independently of Ocean)." }, "parameters": [ { "id": 198, "name": "factoryAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 199, "name": "factoryABI", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "union", "types": [ { "type": "reference", "name": "AbiItem" }, { "type": "array", "elementType": { "type": "reference", "name": "AbiItem" } } ] } }, { "id": 200, "name": "datatokensABI", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "union", "types": [ { "type": "reference", "name": "AbiItem" }, { "type": "array", "elementType": { "type": "reference", "name": "AbiItem" } } ] } }, { "id": 201, "name": "web3", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "\n" }, "type": { "type": "reference", "name": "default" } }, { "id": 202, "name": "logger", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "name": "Logger" } } ], "type": { "type": "reference", "id": 195, "name": "DataTokens" } } ] }, { "id": 203, "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": 206, "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": 205, "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": 204, "name": "factoryAddress", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 17, "character": 23 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 208, "name": "logger", "kind": 1024, "kindString": "Property", "flags": { "isPrivate": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 21, "character": 16 } ], "type": { "type": "reference", "name": "Logger" } }, { "id": 207, "name": "web3", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 20, "character": 13 } ], "type": { "type": "reference", "name": "default" } }, { "id": 265, "name": "allowance", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 328, "character": 24 } ], "signatures": [ { "id": 266, "name": "allowance", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Get Alloance" }, "parameters": [ { "id": 267, "name": "dataTokenAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 268, "name": "owner", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 269, "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": 225, "name": "approve", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 132, "character": 22 } ], "signatures": [ { "id": 226, "name": "approve", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Approve", "returns": "transactionId\n" }, "parameters": [ { "id": 227, "name": "dataTokenAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 228, "name": "spender", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 229, "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": 230, "name": "address", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "name": "TransactionReceipt" } ], "name": "Promise" } } ] }, { "id": 261, "name": "balance", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 314, "character": 22 } ], "signatures": [ { "id": 262, "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": 263, "name": "dataTokenAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 264, "name": "address", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "Promise" } } ] }, { "id": 218, "name": "create", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 78, "character": 21 } ], "signatures": [ { "id": 219, "name": "create", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Create new datatoken", "returns": "datatoken address\n" }, "parameters": [ { "id": 220, "name": "metadataCacheUri", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 221, "name": "address", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 222, "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": 223, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "text": "Token name" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 224, "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": 285, "name": "fromWei", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 392, "character": 16 } ], "signatures": [ { "id": 286, "name": "fromWei", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Convert from wei", "returns": "string\n" }, "parameters": [ { "id": 287, "name": "amount", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 209, "name": "generateDtName", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 47, "character": 23 } ], "signatures": [ { "id": 210, "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": 211, "name": "wordList", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 212, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 214, "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": 213, "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": [214, 213] } ] } } } ], "type": { "type": "reflection", "declaration": { "id": 215, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 216, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 50, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 217, "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": [216, 217] } ] } } } ] }, { "id": 270, "name": "getBlob", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 344, "character": 22 } ], "signatures": [ { "id": 271, "name": "getBlob", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Get Blob", "returns": "string\n" }, "parameters": [ { "id": 272, "name": "dataTokenAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "Promise" } } ] }, { "id": 279, "name": "getCap", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 374, "character": 21 } ], "signatures": [ { "id": 280, "name": "getCap", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Get Cap", "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": 273, "name": "getName", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 354, "character": 22 } ], "signatures": [ { "id": 274, "name": "getName", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Get Name", "returns": "string\n" }, "parameters": [ { "id": 275, "name": "dataTokenAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "Promise" } } ] }, { "id": 296, "name": "getPreviousValidOrders", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 462, "character": 37 } ], "signatures": [ { "id": 297, "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": 298, "name": "dataTokenAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 299, "name": "amount", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 300, "name": "serviceId", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 301, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "service timeout" }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 302, "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": 303, "name": "getStartOrderEventSignature", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 493, "character": 36 } ], "signatures": [ { "id": 304, "name": "getStartOrderEventSignature", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 276, "name": "getSymbol", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 364, "character": 24 } ], "signatures": [ { "id": 277, "name": "getSymbol", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Get Symbol", "returns": "string\n" }, "parameters": [ { "id": 278, "name": "dataTokenAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "Promise" } } ] }, { "id": 231, "name": "mint", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 168, "character": 19 } ], "signatures": [ { "id": 232, "name": "mint", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Mint", "returns": "transactionId\n" }, "parameters": [ { "id": 233, "name": "dataTokenAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 234, "name": "address", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 235, "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": 236, "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": 288, "name": "startOrder", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 405, "character": 25 } ], "signatures": [ { "id": 289, "name": "startOrder", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Start Order", "returns": "string\n" }, "parameters": [ { "id": 290, "name": "dataTokenAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 291, "name": "consumer", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "consumer Address" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 292, "name": "amount", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 293, "name": "serviceId", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 294, "name": "mpFeeAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 295, "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": 282, "name": "toWei", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 384, "character": 14 } ], "signatures": [ { "id": 283, "name": "toWei", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Convert to wei", "returns": "string\n" }, "parameters": [ { "id": 284, "name": "amount", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 237, "name": "transfer", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 211, "character": 23 } ], "signatures": [ { "id": 238, "name": "transfer", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Transfer as number from address to toAddress", "returns": "transactionId\n" }, "parameters": [ { "id": 239, "name": "dataTokenAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 240, "name": "toAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 241, "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": 242, "name": "address", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "name": "TransactionReceipt" } ], "name": "Promise" } } ] }, { "id": 255, "name": "transferFrom", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 280, "character": 27 } ], "signatures": [ { "id": 256, "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": 257, "name": "dataTokenAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 258, "name": "fromAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 259, "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": 260, "name": "address", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "Promise" } } ] }, { "id": 243, "name": "transferToken", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 228, "character": 28 } ], "signatures": [ { "id": 244, "name": "transferToken", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Transfer as number from address to toAddress", "returns": "transactionId\n" }, "parameters": [ { "id": 245, "name": "dataTokenAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 246, "name": "toAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 247, "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": 248, "name": "address", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "name": "TransactionReceipt" } ], "name": "Promise" } } ] }, { "id": 249, "name": "transferWei", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 246, "character": 26 } ], "signatures": [ { "id": 250, "name": "transferWei", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Transfer in wei from address to toAddress", "returns": "transactionId\n" }, "parameters": [ { "id": 251, "name": "dataTokenAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 252, "name": "toAddress", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 253, "name": "amount", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "Number of datatokens, as number. Expressed as wei" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 254, "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": [196] }, { "title": "Properties", "kind": 1024, "children": [203, 206, 205, 204, 208, 207] }, { "title": "Methods", "kind": 2048, "children": [ 265, 225, 261, 218, 285, 209, 270, 279, 273, 296, 303, 276, 231, 288, 282, 237, 255, 243, 249 ] } ], "sources": [ { "fileName": "datatokens/Datatokens.ts", "line": 15, "character": 23 } ] }, { "id": 144, "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": 145, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { "id": 146, "name": "new MetadataCache", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Instantiate Metadata Cache (independently of Ocean) for off-chain interaction." }, "parameters": [ { "id": 147, "name": "metadataCacheUri", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 148, "name": "logger", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "\n" }, "type": { "type": "reference", "name": "Logger" } } ], "type": { "type": "reference", "id": 144, "name": "MetadataCache" } } ] }, { "id": 149, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "sources": [ { "fileName": "metadatacache/MetadataCache.ts", "line": 30, "character": 14 } ], "type": { "type": "reference", "name": "WebServiceConnector" } }, { "id": 150, "name": "logger", "kind": 1024, "kindString": "Property", "flags": { "isPrivate": true }, "sources": [ { "fileName": "metadatacache/MetadataCache.ts", "line": 31, "character": 16 } ], "type": { "type": "reference", "name": "Logger" } }, { "id": 151, "name": "metadataCacheUri", "kind": 1024, "kindString": "Property", "flags": { "isPrivate": true }, "sources": [ { "fileName": "metadatacache/MetadataCache.ts", "line": 32, "character": 26 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 152, "name": "url", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "metadatacache/MetadataCache.ts", "line": 34, "character": 17 } ], "getSignature": [ { "id": 153, "name": "url", "kind": 524288, "kindString": "Get signature", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 156, "name": "getAccessUrl", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "metadatacache/MetadataCache.ts", "line": 53, "character": 27 } ], "signatures": [ { "id": 157, "name": "getAccessUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 158, "name": "accessToken", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } }, { "id": 159, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "Promise" } } ] }, { "id": 179, "name": "getOwnerAssets", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "metadatacache/MetadataCache.ts", "line": 204, "character": 29 } ], "signatures": [ { "id": 180, "name": "getOwnerAssets", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 181, "name": "owner", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "name": "QueryResult" } ], "name": "Promise" } } ] }, { "id": 187, "name": "getServiceEndpoint", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "metadatacache/MetadataCache.ts", "line": 258, "character": 27 } ], "signatures": [ { "id": 188, "name": "getServiceEndpoint", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 189, "name": "did", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 128, "name": "default" } } ], "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 190, "name": "getURI", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "metadatacache/MetadataCache.ts", "line": 262, "character": 15 } ], "signatures": [ { "id": 191, "name": "getURI", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 154, "name": "getVersionInfo", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "metadatacache/MetadataCache.ts", "line": 49, "character": 29 } ], "signatures": [ { "id": 155, "name": "getVersionInfo", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "Promise" } } ] }, { "id": 160, "name": "queryMetadata", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "metadatacache/MetadataCache.ts", "line": 80, "character": 28 } ], "signatures": [ { "id": 161, "name": "queryMetadata", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Search over the DDOs using a query.", "returns": "\n" }, "parameters": [ { "id": 162, "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": 182, "name": "retire", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "metadatacache/MetadataCache.ts", "line": 227, "character": 21 } ], "signatures": [ { "id": 183, "name": "retire", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Retire a DDO (Delete)", "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": 128, "name": "default" } ] } }, { "id": 185, "name": "updated", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "Updated field of the DDO" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 186, "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": 166, "name": "retrieveDDO", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "metadatacache/MetadataCache.ts", "line": 133, "character": 26 } ], "signatures": [ { "id": 167, "name": "retrieveDDO", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Retrieves a DDO by DID.", "returns": "DDO of the asset.\n" }, "parameters": [ { "id": 168, "name": "did", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "DID of the asset." }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "id": 128, "name": "default" } ] } }, { "id": 169, "name": "metadataServiceEndpoint", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 361, "name": "DDO" } ], "name": "Promise" } } ] }, { "id": 170, "name": "retrieveDDOByUrl", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "metadatacache/MetadataCache.ts", "line": 159, "character": 31 } ], "signatures": [ { "id": 171, "name": "retrieveDDOByUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 172, "name": "metadataServiceEndpoint", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 361, "name": "DDO" } ], "name": "Promise" } } ] }, { "id": 163, "name": "storeDDO", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "metadatacache/MetadataCache.ts", "line": 106, "character": 23 } ], "signatures": [ { "id": 164, "name": "storeDDO", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Stores a DDO in Metadata Store.", "returns": "Final DDO.\n" }, "parameters": [ { "id": 165, "name": "ddo", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "DDO to be stored." }, "type": { "type": "reference", "id": 361, "name": "DDO" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 361, "name": "DDO" } ], "name": "Promise" } } ] }, { "id": 173, "name": "transferOwnership", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true }, "sources": [ { "fileName": "metadatacache/MetadataCache.ts", "line": 171, "character": 32 } ], "signatures": [ { "id": 174, "name": "transferOwnership", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Transfer ownership of a DDO", "returns": "Result.\n" }, "parameters": [ { "id": 175, "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": 128, "name": "default" } ] } }, { "id": 176, "name": "newOwner", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "New owner of the DDO" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 177, "name": "updated", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "Updated field of the DDO" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 178, "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": 192, "name": "transformResult", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "metadatacache/MetadataCache.ts", "line": 266, "character": 25 } ], "signatures": [ { "id": 193, "name": "transformResult", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 194, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" }, "defaultValue": "..." } ], "type": { "type": "reference", "name": "QueryResult" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [145] }, { "title": "Properties", "kind": 1024, "children": [149, 150, 151] }, { "title": "Accessors", "kind": 262144, "children": [152] }, { "title": "Methods", "kind": 2048, "children": [ 156, 179, 187, 190, 154, 160, 182, 166, 170, 163, 173, 192 ] } ], "sources": [ { "fileName": "metadatacache/MetadataCache.ts", "line": 29, "character": 26 } ] }, { "id": 18, "name": "Ocean", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "Main interface for Ocean Protocol." }, "children": [ { "id": 27, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { "id": 28, "name": "new Ocean", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", "id": 18, "name": "Ocean" } } ] }, { "id": 34, "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": 35, "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": 36, "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": 37, "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": 195, "name": "DataTokens" } }, { "id": 39, "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": 32, "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": 144, "name": "MetadataCache" } }, { "id": 29, "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": 33, "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": 38, "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": 30, "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": 41, "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": 40, "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": 31, "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": 46, "name": "config", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "Instantiable.abstract.ts", "line": 44, "character": 22 } ], "getSignature": [ { "id": 47, "name": "config", "kind": 524288, "kindString": "Get signature", "flags": {}, "type": { "type": "reference", "id": 103, "name": "Config" } } ] }, { "id": 50, "name": "instanceConfig", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "Instantiable.abstract.ts", "line": 60, "character": 30 } ], "getSignature": [ { "id": 51, "name": "instanceConfig", "kind": 524288, "kindString": "Get signature", "flags": {}, "type": { "type": "reference", "name": "InstantiableConfig" } } ] }, { "id": 48, "name": "logger", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "Instantiable.abstract.ts", "line": 51, "character": 22 } ], "getSignature": [ { "id": 49, "name": "logger", "kind": 524288, "kindString": "Get signature", "flags": {}, "type": { "type": "reference", "name": "Logger" } } ] }, { "id": 42, "name": "ocean", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "Instantiable.abstract.ts", "line": 30, "character": 21 } ], "getSignature": [ { "id": 43, "name": "ocean", "kind": 524288, "kindString": "Get signature", "flags": {}, "type": { "type": "reference", "id": 18, "name": "Ocean" } } ] }, { "id": 44, "name": "web3", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "Instantiable.abstract.ts", "line": 37, "character": 20 } ], "getSignature": [ { "id": 45, "name": "web3", "kind": 524288, "kindString": "Get signature", "flags": {}, "type": { "type": "reference", "name": "default" } } ] }, { "id": 52, "name": "setInstanceConfig", "kind": 2048, "kindString": "Method", "flags": { "isProtected": true }, "sources": [ { "fileName": "Instantiable.abstract.ts", "line": 89, "character": 29 } ], "signatures": [ { "id": 53, "name": "setInstanceConfig", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 54, "name": "config", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "name": "InstantiableConfig" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 19, "name": "getInstance", "kind": 2048, "kindString": "Method", "flags": { "isPublic": true, "isStatic": true }, "sources": [ { "fileName": "ocean/Ocean.ts", "line": 28, "character": 33 } ], "signatures": [ { "id": 20, "name": "getInstance", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns the instance of Ocean.", "returns": "\n" }, "parameters": [ { "id": 21, "name": "config", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "text": "Ocean instance configuration." }, "type": { "type": "reference", "id": 103, "name": "Config" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 18, "name": "Ocean" } ], "name": "Promise" } } ] }, { "id": 22, "name": "setInstanceConfig", "kind": 2048, "kindString": "Method", "flags": { "isProtected": true, "isStatic": true }, "sources": [ { "fileName": "Instantiable.abstract.ts", "line": 71, "character": 36 } ], "signatures": [ { "id": 23, "name": "setInstanceConfig", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 24, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "name": "T" } ], "name": "Instantiable" } } ], "parameters": [ { "id": 25, "name": "instance", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "name": "T" } }, { "id": 26, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "name": "InstantiableConfig" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [27] }, { "title": "Properties", "kind": 1024, "children": [34, 35, 36, 37, 39, 32, 29, 33, 38, 30, 41, 40, 31] }, { "title": "Accessors", "kind": 262144, "children": [46, 50, 48, 42, 44] }, { "title": "Methods", "kind": 2048, "children": [52, 19, 22] } ], "sources": [ { "fileName": "ocean/Ocean.ts", "line": 22, "character": 18 } ], "extendedTypes": [ { "type": "reference", "name": "Instantiable" } ] }, { "id": 401, "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": 410, "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": 403, "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": 402, "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": 409, "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": 405, "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": 406, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 407, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 408, "name": "name", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } } }, { "id": 413, "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": 414, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 416, "name": "mediaType", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/AdditionalInformation.ts", "line": 86, "character": 13 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 415, "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": [416, 415] } ] } } } }, { "id": 411, "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": 412, "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": 404, "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": [410, 403, 402, 409, 405, 413, 411, 412, 404] } ], "sources": [ { "fileName": "ddo/interfaces/AdditionalInformation.ts", "line": 5, "character": 38 } ] }, { "id": 417, "name": "Authentication", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 419, "name": "publicKey", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Authentication.ts", "line": 3, "character": 11 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 418, "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": [419, 418] } ], "sources": [ { "fileName": "ddo/interfaces/Authentication.ts", "line": 1, "character": 31 } ] }, { "id": 420, "name": "BestPrice", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 422, "name": "address", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/BestPrice.ts", "line": 3, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 426, "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": 424, "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": 425, "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": 427, "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": 421, "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": 423, "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": [422, 426, 424, 425, 427, 421, 423] } ], "sources": [ { "fileName": "ddo/interfaces/BestPrice.ts", "line": 1, "character": 26 } ] }, { "id": 316, "name": "ConfigHelperConfig", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 338, "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" }, "inheritedFrom": { "type": "reference", "id": 124, "name": "Config.authMessage" } }, { "id": 339, "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" }, "inheritedFrom": { "type": "reference", "id": 125, "name": "Config.authTokenExpiration" } }, { "id": 328, "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" } } ] }, "inheritedFrom": { "type": "reference", "id": 114, "name": "Config.datatokensABI" } }, { "id": 327, "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" } } ] }, "inheritedFrom": { "type": "reference", "id": 113, "name": "Config.factoryABI" } }, { "id": 326, "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" }, "inheritedFrom": { "type": "reference", "id": 112, "name": "Config.factoryAddress" } }, { "id": 332, "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" }, "inheritedFrom": { "type": "reference", "id": 118, "name": "Config.fixedRateExchangeAddress" } }, { "id": 333, "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" } } ] }, "inheritedFrom": { "type": "reference", "id": 119, "name": "Config.fixedRateExchangeAddressABI" } }, { "id": 322, "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" }, "inheritedFrom": { "type": "reference", "id": 108, "name": "Config.metadataCacheUri" } }, { "id": 335, "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" } } ] }, "inheritedFrom": { "type": "reference", "id": 121, "name": "Config.metadataContractABI" } }, { "id": 334, "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" }, "inheritedFrom": { "type": "reference", "id": 120, "name": "Config.metadataContractAddress" } }, { "id": 318, "name": "network", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "utils/ConfigHelper.ts", "line": 17, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 317, "name": "networkId", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "utils/ConfigHelper.ts", "line": 16, "character": 11 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 320, "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" }, "inheritedFrom": { "type": "reference", "id": 106, "name": "Config.nodeUri" } }, { "id": 325, "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" }, "inheritedFrom": { "type": "reference", "id": 111, "name": "Config.oceanTokenAddress" } }, { "id": 340, "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" }, "inheritedFrom": { "type": "reference", "id": 126, "name": "Config.parityUri" } }, { "id": 331, "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" } } ] }, "inheritedFrom": { "type": "reference", "id": 117, "name": "Config.poolABI" } }, { "id": 330, "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" } } ] }, "inheritedFrom": { "type": "reference", "id": 116, "name": "Config.poolFactoryABI" } }, { "id": 329, "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" }, "inheritedFrom": { "type": "reference", "id": 115, "name": "Config.poolFactoryAddress" } }, { "id": 321, "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" }, "inheritedFrom": { "type": "reference", "id": 107, "name": "Config.providerAddress" } }, { "id": 323, "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" }, "inheritedFrom": { "type": "reference", "id": 109, "name": "Config.providerUri" } }, { "id": 336, "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" }, "inheritedFrom": { "type": "reference", "id": 122, "name": "Config.startBlock" } }, { "id": 319, "name": "subgraphUri", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "utils/ConfigHelper.ts", "line": 18, "character": 13 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 341, "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" }, "inheritedFrom": { "type": "reference", "id": 127, "name": "Config.threshold" } }, { "id": 337, "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" } ] }, "inheritedFrom": { "type": "reference", "id": 123, "name": "Config.verbose" } }, { "id": 324, "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" }, "inheritedFrom": { "type": "reference", "id": 110, "name": "Config.web3Provider" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 338, 339, 328, 327, 326, 332, 333, 322, 335, 334, 318, 317, 320, 325, 340, 331, 330, 329, 321, 323, 336, 319, 341, 337, 324 ] } ], "sources": [ { "fileName": "utils/ConfigHelper.ts", "line": 15, "character": 35 } ], "extendedTypes": [ { "type": "reference", "id": 103, "name": "Config" } ] }, { "id": 428, "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": 432, "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": 430, "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": 429, "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": 431, "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": [432, 430, 429, 431] } ], "sources": [ { "fileName": "ddo/interfaces/Curation.ts", "line": 5, "character": 25 } ] }, { "id": 433, "name": "EditableMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 434, "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": 436, "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": 437, "name": "EditableMetadataLinks" } } }, { "id": 435, "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": [434, 436, 435] } ], "sources": [ { "fileName": "ddo/interfaces/EditableMetadata.ts", "line": 3, "character": 33 } ] }, { "id": 437, "name": "EditableMetadataLinks", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 438, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/EditableMetadataLinks.ts", "line": 2, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 440, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/EditableMetadataLinks.ts", "line": 4, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 439, "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": [438, 440, 439] } ], "sources": [ { "fileName": "ddo/interfaces/EditableMetadataLinks.ts", "line": 1, "character": 38 } ] }, { "id": 441, "name": "File", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 447, "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": 448, "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": 452, "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": 449, "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": 446, "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": 451, "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": 445, "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": 442, "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": 450, "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": 443, "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": 444, "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": [447, 448, 452, 449, 446, 451, 445, 442, 450, 443, 444] } ], "sources": [ { "fileName": "ddo/interfaces/File.ts", "line": 1, "character": 21 } ] }, { "id": 453, "name": "Metadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 456, "name": "additionalInformation", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "ddo/interfaces/Metadata.ts", "line": 8, "character": 23 } ], "type": { "type": "reference", "id": 401, "name": "AdditionalInformation" } }, { "id": 457, "name": "curation", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "ddo/interfaces/Metadata.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", "id": 428, "name": "Curation" } }, { "id": 455, "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": 454, "name": "main", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Metadata.ts", "line": 6, "character": 6 } ], "type": { "type": "reference", "id": 469, "name": "MetadataMain" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [456, 457, 455, 454] } ], "sources": [ { "fileName": "ddo/interfaces/Metadata.ts", "line": 5, "character": 25 } ] }, { "id": 458, "name": "MetadataAlgorithm", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 464, "name": "container", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/MetadataAlgorithm.ts", "line": 7, "character": 11 } ], "type": { "type": "reflection", "declaration": { "id": 465, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 466, "name": "entrypoint", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/MetadataAlgorithm.ts", "line": 8, "character": 14 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 467, "name": "image", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/MetadataAlgorithm.ts", "line": 9, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 468, "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": [466, 467, 468] } ] } } }, { "id": 462, "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": 461, "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": 460, "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": 459, "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": 463, "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": [464, 462, 461, 460, 459, 463] } ], "sources": [ { "fileName": "ddo/interfaces/MetadataAlgorithm.ts", "line": 1, "character": 34 } ] }, { "id": 469, "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": 477, "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": 458, "name": "MetadataAlgorithm" } }, { "id": 474, "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": 472, "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": 473, "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": 476, "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": 441, "name": "File" } } }, { "id": 475, "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": 470, "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": 471, "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": [477, 474, 472, 473, 476, 475, 470, 471] } ], "sources": [ { "fileName": "ddo/interfaces/MetadataMain.ts", "line": 8, "character": 29 } ] }, { "id": 6, "name": "OceanPlatformTech", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 9, "name": "commit", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "ocean/Versions.ts", "line": 15, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 7, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ocean/Versions.ts", "line": 13, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 10, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ocean/Versions.ts", "line": 16, "character": 8 } ], "type": { "type": "reference", "id": 1, "name": "OceanPlatformTechStatus" } }, { "id": 8, "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": [9, 7, 10, 8] } ], "sources": [ { "fileName": "ocean/Versions.ts", "line": 12, "character": 34 } ] }, { "id": 11, "name": "OceanPlatformVersions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 12, "name": "lib", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ocean/Versions.ts", "line": 20, "character": 5 } ], "type": { "type": "reference", "id": 6, "name": "OceanPlatformTech" } }, { "id": 13, "name": "metadataCache", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ocean/Versions.ts", "line": 21, "character": 15 } ], "type": { "type": "reference", "id": 6, "name": "OceanPlatformTech" } }, { "id": 14, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ocean/Versions.ts", "line": 22, "character": 10 } ], "type": { "type": "reference", "id": 6, "name": "OceanPlatformTech" } }, { "id": 15, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ocean/Versions.ts", "line": 23, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 16, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 17, "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": [17] } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [12, 13, 14, 15] } ], "sources": [ { "fileName": "ocean/Versions.ts", "line": 19, "character": 38 } ] }, { "id": 351, "name": "Order", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 353, "name": "amount", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ocean/Assets.ts", "line": 32, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 356, "name": "consumer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ocean/Assets.ts", "line": 35, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 358, "name": "did", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "ocean/Assets.ts", "line": 37, "character": 5 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 352, "name": "dtAddress", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ocean/Assets.ts", "line": 31, "character": 11 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 357, "name": "payer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ocean/Assets.ts", "line": 36, "character": 7 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 359, "name": "serviceId", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "ocean/Assets.ts", "line": 38, "character": 11 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 360, "name": "serviceType", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "ocean/Assets.ts", "line": 39, "character": 13 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 354, "name": "timestamp", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ocean/Assets.ts", "line": 33, "character": 11 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 355, "name": "transactionHash", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ocean/Assets.ts", "line": 34, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [353, 356, 358, 352, 357, 359, 360, 354, 355] } ], "sources": [ { "fileName": "ocean/Assets.ts", "line": 30, "character": 22 } ] }, { "id": 478, "name": "Proof", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 480, "name": "created", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Proof.ts", "line": 3, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 481, "name": "creator", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Proof.ts", "line": 4, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 482, "name": "signatureValue", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Proof.ts", "line": 5, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 479, "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": [480, 481, 482, 479] } ], "sources": [ { "fileName": "ddo/interfaces/Proof.ts", "line": 1, "character": 22 } ] }, { "id": 483, "name": "PublicKey", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { "shortText": "Public key data." }, "children": [ { "id": 484, "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": 486, "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": 488, "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": 489, "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": 487, "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": 485, "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": [484, 486, 488, 489, 487, 485] } ], "sources": [ { "fileName": "ddo/interfaces/PublicKey.ts", "line": 4, "character": 26 } ] }, { "id": 579, "name": "PurgatoryData", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 580, "name": "did", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/PurgatoryData.ts", "line": 2, "character": 5 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 581, "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": [580, 581] } ], "sources": [ { "fileName": "ddo/interfaces/PurgatoryData.ts", "line": 1, "character": 30 } ] }, { "id": 564, "name": "ServiceAccess", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 566, "name": "attributes", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 77, "character": 12 } ], "type": { "type": "reference", "id": 505, "name": "ServiceAccessAttributes" }, "overwrites": { "type": "reference", "id": 504, "name": "ServiceCommon.attributes" } }, { "id": 567, "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": 502, "name": "ServiceCommon.index" } }, { "id": 568, "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": 503, "name": "ServiceCommon.serviceEndpoint" } }, { "id": 565, "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": 501, "name": "ServiceCommon.type" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [566, 567, 568, 565] } ], "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 75, "character": 30 } ], "extendedTypes": [ { "type": "reference", "id": 500, "name": "ServiceCommon" } ] }, { "id": 505, "name": "ServiceAccessAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 513, "name": "additionalInformation", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 7, "character": 23 } ], "type": { "type": "reflection", "declaration": { "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 515, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 516, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "inheritedFrom": { "type": "reference", "id": 496, "name": "ServiceCommonAttributes.additionalInformation" } }, { "id": 506, "name": "main", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 18, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 507, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 511, "name": "cost", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 22, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 508, "name": "creator", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 19, "character": 11 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 510, "name": "datePublished", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 21, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 509, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 20, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 512, "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": [511, 508, 510, 509, 512] } ] } }, "overwrites": { "type": "reference", "id": 492, "name": "ServiceCommonAttributes.main" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [513, 506] } ], "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 17, "character": 40 } ], "extendedTypes": [ { "type": "reference", "id": 491, "name": "ServiceCommonAttributes" } ] }, { "id": 500, "name": "ServiceCommon", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 504, "name": "attributes", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 14, "character": 12 } ], "type": { "type": "reference", "id": 491, "name": "ServiceCommonAttributes" } }, { "id": 502, "name": "index", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 12, "character": 7 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 503, "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": 501, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 11, "character": 6 } ], "type": { "type": "reference", "id": 490, "name": "ServiceType" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [504, 502, 503, 501] } ], "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 10, "character": 30 } ], "extendedBy": [ { "type": "reference", "id": 559, "name": "ServiceMetadata" }, { "type": "reference", "id": 564, "name": "ServiceAccess" }, { "type": "reference", "id": 569, "name": "ServiceCompute" } ] }, { "id": 491, "name": "ServiceCommonAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 496, "name": "additionalInformation", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 7, "character": 23 } ], "type": { "type": "reflection", "declaration": { "id": 497, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 498, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 499, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 492, "name": "main", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 6, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 493, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 494, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 495, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [496, 492] } ], "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 5, "character": 40 } ], "extendedBy": [ { "type": "reference", "id": 505, "name": "ServiceAccessAttributes" }, { "type": "reference", "id": 545, "name": "ServiceComputeAttributes" } ] }, { "id": 569, "name": "ServiceCompute", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 571, "name": "attributes", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 82, "character": 12 } ], "type": { "type": "reference", "id": 545, "name": "ServiceComputeAttributes" }, "overwrites": { "type": "reference", "id": 504, "name": "ServiceCommon.attributes" } }, { "id": 572, "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": 502, "name": "ServiceCommon.index" } }, { "id": 573, "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": 503, "name": "ServiceCommon.serviceEndpoint" } }, { "id": 570, "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": 501, "name": "ServiceCommon.type" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [571, 572, 573, 570] } ], "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 80, "character": 31 } ], "extendedTypes": [ { "type": "reference", "id": 500, "name": "ServiceCommon" } ] }, { "id": 545, "name": "ServiceComputeAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 555, "name": "additionalInformation", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 7, "character": 23 } ], "type": { "type": "reflection", "declaration": { "id": 556, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 557, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 558, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "inheritedFrom": { "type": "reference", "id": 496, "name": "ServiceCommonAttributes.additionalInformation" } }, { "id": 546, "name": "main", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 59, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 547, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 550, "name": "cost", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 62, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 548, "name": "creator", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 60, "character": 11 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 549, "name": "datePublished", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 61, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 553, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 65, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 554, "name": "privacy", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 66, "character": 11 } ], "type": { "type": "reference", "id": 517, "name": "ServiceComputePrivacy" } }, { "id": 552, "name": "provider", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 64, "character": 12 } ], "type": { "type": "reference", "id": 521, "name": "ServiceComputeProvider" } }, { "id": 551, "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": [550, 548, 549, 553, 554, 552, 551] } ] } }, "overwrites": { "type": "reference", "id": 492, "name": "ServiceCommonAttributes.main" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [555, 546] } ], "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 58, "character": 41 } ], "extendedTypes": [ { "type": "reference", "id": 491, "name": "ServiceCommonAttributes" } ] }, { "id": 517, "name": "ServiceComputePrivacy", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 519, "name": "allowNetworkAccess", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 28, "character": 20 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 518, "name": "allowRawAlgorithm", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 27, "character": 19 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 520, "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": [519, 518, 520] } ], "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 26, "character": 38 } ] }, { "id": 521, "name": "ServiceComputeProvider", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 523, "name": "description", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 34, "character": 13 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 524, "name": "environment", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 35, "character": 13 } ], "type": { "type": "reflection", "declaration": { "id": 525, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 526, "name": "cluster", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 36, "character": 11 } ], "type": { "type": "reflection", "declaration": { "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 528, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 37, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 529, "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": [528, 529] } ] } } }, { "id": 530, "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": 531, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 534, "name": "checksum", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 43, "character": 14 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 532, "name": "image", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 41, "character": 11 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 533, "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": [534, 532, 533] } ] } } } }, { "id": 535, "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": 536, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 539, "name": "cost", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 48, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 540, "name": "cpu", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 49, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 543, "name": "disk", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 52, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 541, "name": "gpu", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 50, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 544, "name": "maxExecutionTime", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 53, "character": 22 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 542, "name": "memory", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 51, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 537, "name": "serverId", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 46, "character": 14 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 538, "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": [539, 540, 543, 541, 544, 542, 537, 538] } ] } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [526, 530, 535] } ] } } }, { "id": 522, "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": [523, 524, 522] } ], "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 32, "character": 39 } ] }, { "id": 559, "name": "ServiceMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 561, "name": "attributes", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 72, "character": 12 } ], "type": { "type": "reference", "id": 453, "name": "Metadata" }, "overwrites": { "type": "reference", "id": 504, "name": "ServiceCommon.attributes" } }, { "id": 562, "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": 502, "name": "ServiceCommon.index" } }, { "id": 563, "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": 503, "name": "ServiceCommon.serviceEndpoint" } }, { "id": 560, "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": 501, "name": "ServiceCommon.type" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [561, 562, 563, 560] } ], "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 70, "character": 32 } ], "extendedTypes": [ { "type": "reference", "id": 500, "name": "ServiceCommon" } ] }, { "id": 576, "name": "ServicePrices", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 578, "name": "cost", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/ServicePrices.ts", "line": 3, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 577, "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": [578, 577] } ], "sources": [ { "fileName": "ddo/interfaces/ServicePrices.ts", "line": 1, "character": 30 } ] }, { "id": 574, "name": "Service", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "ddo/interfaces/Service.ts", "line": 85, "character": 19 } ], "typeParameter": [ { "id": 575, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "id": 490, "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": 559, "name": "ServiceMetadata" }, "falseType": { "type": "conditional", "checkType": { "type": "reference", "name": "T" }, "extendsType": { "type": "literal", "value": "access" }, "trueType": { "type": "reference", "id": 564, "name": "ServiceAccess" }, "falseType": { "type": "conditional", "checkType": { "type": "reference", "name": "T" }, "extendsType": { "type": "literal", "value": "compute" }, "trueType": { "type": "reference", "id": 569, "name": "ServiceCompute" }, "falseType": { "type": "conditional", "checkType": { "type": "reference", "name": "T" }, "extendsType": { "type": "literal", "value": "default" }, "trueType": { "type": "reference", "id": 500, "name": "ServiceCommon" }, "falseType": { "type": "reference", "id": 500, "name": "ServiceCommon" } } } } } }, { "id": 490, "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": 143, "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": [305] }, { "title": "Enumerations", "kind": 4, "children": [342, 1, 349] }, { "title": "Classes", "kind": 128, "children": [55, 103, 306, 361, 128, 195, 144, 18] }, { "title": "Interfaces", "kind": 256, "children": [ 401, 417, 420, 316, 428, 433, 437, 441, 453, 458, 469, 6, 11, 351, 478, 483, 579, 564, 505, 500, 491, 569, 545, 517, 521, 559, 576 ] }, { "title": "Type aliases", "kind": 4194304, "children": [574, 490] }, { "title": "Variables", "kind": 32, "children": [143] } ], "sources": [ { "fileName": "index.ts", "line": 1, "character": 0 } ] }