Ocean.js

`utils`

LogLevel

Enumeration

private

src/utils/Logger.ts#L1

Logger

Class

private

src/utils/Logger.ts#L9

SubscribableObserver

Class

private

src/utils/SubscribableObserver.ts#L1

SubscribablePromise

Class

private

src/utils/SubscribablePromise.ts#L3

AssetResolved

Interface

private

src/utils/AssetResolverHelper.ts#L4

LoggerInstance

Variable

private

src/utils/Logger.ts#L43

assetResolve

Function

private

src/utils/AssetResolverHelper.ts#L13

didNoZeroX

Function

private

src/utils/ConversionTypeHelpers.ts#L25

didPrefixed

Function

private

src/utils/ConversionTypeHelpers.ts#L12

didTransformer

Function

private

src/utils/ConversionTypeHelpers.ts#L14

didZeroX

Function

private

src/utils/ConversionTypeHelpers.ts#L24

generateId

Function

private

src/utils/GeneratorHelpers.ts#L3

getFairGasPrice

Function

private

src/utils/GasUtils.ts#L4

isDdo

Function

private

src/utils/AssetResolverHelper.ts#L9

noDidPrefixed

Function

private

src/utils/ConversionTypeHelpers.ts#L13

noZeroX

Function

private

src/utils/ConversionTypeHelpers.ts#L5

objectPromiseAll

Function

private

src/utils/PromiseResolver.ts#L11

zeroX

Function

private

src/utils/ConversionTypeHelpers.ts#L4

zeroXTransformer

Function

private

src/utils/ConversionTypeHelpers.ts#L6

`CreateProgressStep`

CreatingDataToken

Enumeration member

private

src/ocean/Assets.ts#L25

DataTokenCreated

Enumeration member

private

src/ocean/Assets.ts#L26

DdoStored

Enumeration member

private

src/ocean/Assets.ts#L30

EncryptingFiles

Enumeration member

private

src/ocean/Assets.ts#L27

FilesEncrypted

Enumeration member

private

src/ocean/Assets.ts#L28

StoringDdo

Enumeration member

private

src/ocean/Assets.ts#L29

`CredentialType`

address

Enumeration member

private

src/ddo/interfaces/Credentials.ts#L2

credential3Box

Enumeration member

private

src/ddo/interfaces/Credentials.ts#L3

`LogLevel`

Error

Enumeration member

private

src/utils/Logger.ts#L3

Log

Enumeration member

private

src/utils/Logger.ts#L5

None

Enumeration member

private

src/utils/Logger.ts#L2

Verbose

Enumeration member

private

src/utils/Logger.ts#L6

Warn

Enumeration member

private

src/utils/Logger.ts#L4

`OceanPlatformTechStatus`

Loading

Enumeration member

private

src/ocean/Versions.ts#L6

Stopped

Enumeration member

private

src/ocean/Versions.ts#L8

Unknown

Enumeration member

private

src/ocean/Versions.ts#L7

Working

Enumeration member

private

src/ocean/Versions.ts#L9

`OrderProgressStep`

TransferDataToken

Enumeration member

private

src/ocean/Assets.ts#L34

`Account`

Account information.

constructor

Constructor

private

src/ocean/Account.ts#L12

password

Property

private

password

src/ocean/Account.ts#L8

token

Property

private

token

src/ocean/Account.ts#L10

config

Accessor

private

src/Instantiable.abstract.ts#L38

instanceConfig

Accessor

private

src/Instantiable.abstract.ts#L49

logger

Accessor

private

src/Instantiable.abstract.ts#L45

ocean

Accessor

private

src/Instantiable.abstract.ts#L24

web3

Accessor

private

src/Instantiable.abstract.ts#L31

getEtherBalance

Method

Balance of Ether.(converted from wei).

Returns

Promise<string>

src/ocean/Account.ts#L140

getId

Method

Returns

string

src/ocean/Account.ts#L19

getOceanBalance

Method

Balance of Ocean Token. (converted from wei).

Returns

Promise<string>

src/ocean/Account.ts#L123

getPassword

Method

Returns account password.

Returns

string

src/ocean/Account.ts#L39

getTokenBalance

Method

Balance of Any Token (converted from wei).

Parameters

`TokenAdress`

string

Returns

Promise<string>

src/ocean/Account.ts#L82

getTokenSymbol

Method

Symbol of a Token

Parameters

`TokenAdress`

string

Returns

Promise<string>

src/ocean/Account.ts#L131

setId

Method

Parameters

`id`

string

Returns

void

src/ocean/Account.ts#L23

setInstanceConfig

Method

private

Parameters

`config`

InstantiableConfig

Returns

void

src/Instantiable.abstract.ts#L78

setPassword

Method

Set account password.

Parameters

`password`

string

Password for account.

Returns

void

src/ocean/Account.ts#L31

getInstance

Method

static

Parameters

`args`

any[]

Returns

Promise<any>

src/Instantiable.abstract.ts#L54

setInstanceConfig

Method

static

private

Parameters

`instance`

`__namedParameters`

InstantiableConfig

Returns

void

src/Instantiable.abstract.ts#L60

`Config`

constructor

Constructor

private

authMessage

Property

Message shown when the user creates its own token.

authMessage

src/models/Config.ts#L127

authTokenExpiration

Property

Token expiration time in ms.

authTokenExpiration

src/models/Config.ts#L133

datatokensABI

Property

datatokens ABI

datatokensABI

src/models/Config.ts#L57

dispenserABI

Property

DispenserABI

dispenserABI

src/models/Config.ts#L99

dispenserAddress

Property

DispenserAddress

dispenserAddress

src/models/Config.ts#L93

factoryABI

Property

Factory ABI

factoryABI

src/models/Config.ts#L51

factoryAddress

Property

Factory address

factoryAddress

src/models/Config.ts#L45

fixedRateExchangeAddress

Property

FixedRateExchangeAddress

fixedRateExchangeAddress

src/models/Config.ts#L81

fixedRateExchangeAddressABI

Property

FixedRateExchangeAddressABI

fixedRateExchangeAddressABI

src/models/Config.ts#L87

metadataCacheUri

Property

Metadata Store URL.

metadataCacheUri

src/models/Config.ts#L21

metadataContractABI

Property

DDOContractABI

metadataContractABI

src/models/Config.ts#L111

metadataContractAddress

Property

DDOContractAddress

metadataContractAddress

src/models/Config.ts#L105

nodeUri

Property

Ethereum node URL.

nodeUri

src/models/Config.ts#L9

oceanTokenAddress

Property

Ocean Token address

oceanTokenAddress

src/models/Config.ts#L39

parityUri

Property

parityUri

src/models/Config.ts#L136

poolABI

Property

Pool ABI

poolABI

src/models/Config.ts#L75

poolFactoryABI

Property

Pool Factory ABI

poolFactoryABI

src/models/Config.ts#L69

poolFactoryAddress

Property

Pool Factory address

poolFactoryAddress

src/models/Config.ts#L63

providerAddress

Property

Address of Provider.

providerAddress

src/models/Config.ts#L15

providerUri

Property

Provider URL.

providerUri

src/models/Config.ts#L27

startBlock

Property

block number of the deployment

startBlock

src/models/Config.ts#L116

threshold

Property

threshold

src/models/Config.ts#L138

verbose

Property

Log level.

verbose

src/models/Config.ts#L121

web3Provider

Property

Web3 Provider.

web3Provider

src/models/Config.ts#L33

`ConfigHelper`

constructor

Constructor

private

getAddressesFromEnv

Method

Parameters

`network`

string

Returns

Partial<ConfigHelperConfig>

src/utils/ConfigHelper.ts#L134

getConfig

Method

Parameters

`network`

`infuraProjectId`?

string

Returns

Config

src/utils/ConfigHelper.ts#L199

`DDO`

DID Descriptor Object. Contains all the data related to an asset.

constructor

Constructor

src/ddo/DDO.ts#L70

@context

Property

@context

src/ddo/DDO.ts#L36

authentication

Property

authentication

src/ddo/DDO.ts#L52

chainId

Property

chainId

src/ddo/DDO.ts#L68

created

Property

created

src/ddo/DDO.ts#L44

credentials

Property

credentials

src/ddo/DDO.ts#L66

dataToken

Property

dataToken

src/ddo/DDO.ts#L48

dataTokenInfo

Property

dataTokenInfo

src/ddo/DDO.ts#L64

id

Property

DID, descentralized ID.

src/ddo/DDO.ts#L42

isInPurgatory

Property

isInPurgatory

src/ddo/DDO.ts#L60

price

Property

price

src/ddo/DDO.ts#L58

proof

Property

proof

src/ddo/DDO.ts#L56

publicKey

Property

publicKey

src/ddo/DDO.ts#L50

purgatoryData

Property

purgatoryData

src/ddo/DDO.ts#L62

service

Property

service

src/ddo/DDO.ts#L54

updated

Property

updated

src/ddo/DDO.ts#L46

addProof

Method

Generates and adds a simple hash proof on publicKey

Parameters

`ocean`

Ocean

Ocean instance.

`publicKey`

string

Public key to be used on personal sign.

`password`?

string

Returns

Promise<void>

src/ddo/DDO.ts#L138

findServiceById

Method

Finds a service of a DDO by index.

Parameters

`index`

number

Returns

Service<T>

src/ddo/DDO.ts#L85

findServiceByType

Method

Finds a service of a DDO by type.

Parameters

`serviceType`

Service type.

Returns

Service<T>

src/ddo/DDO.ts#L100

getChecksum

Method

Generate the checksum using the current content.

Returns

string

src/ddo/DDO.ts#L112

shortId

Method

Returns

string

src/ddo/DDO.ts#L76

deserialize

Method

static

Deserializes the DDO object.

Parameters

`ddoString`

string

Returns

DDO

src/ddo/DDO.ts#L30

serialize

Method

static

Serializes the DDO object.

Parameters

`ddo`

DDO

Returns

string

src/ddo/DDO.ts#L21

`DID`

Decentralized ID.

constructor

Constructor

private

src/ocean/DID.ts#L45

id

Property

private

ID.

src/ocean/DID.ts#L43

getDid

Method

Returns the DID.

Returns

string

src/ocean/DID.ts#L53

getId

Method

Returns the ID.

Returns

string

src/ocean/DID.ts#L61

generate

Method

static

Generate a new DID.

Parameters

`dataTokenAddress`

string

Address of data token to use for DID.

Returns

default

src/ocean/DID.ts#L35

parse

Method

static

Parses a DID from a string.

Parameters

`didString`

DID in string.

Returns

default

src/ocean/DID.ts#L13

`DataTokens`

Provides an interface to DataTokens

constructor

Constructor

private

Instantiate DataTokens (independently of Ocean).

src/datatokens/Datatokens.ts#L30

GASLIMIT_DEFAULT

Property

GASLIMIT_DEFAULT

src/datatokens/Datatokens.ts#L16

datatokensABI

Property

datatokensABI

src/datatokens/Datatokens.ts#L19

factoryABI

Property

factoryABI

src/datatokens/Datatokens.ts#L18

factoryAddress

Property

factoryAddress

src/datatokens/Datatokens.ts#L17

logger

Property

private

logger

src/datatokens/Datatokens.ts#L21

startBlock

Property

startBlock

src/datatokens/Datatokens.ts#L22

web3

Property

web3

src/datatokens/Datatokens.ts#L20

allowance

Method

Get Alloance

Parameters

`dataTokenAddress`

string

`owner`

string

`spender`

string

Returns

Promise<string>

src/datatokens/Datatokens.ts#L331

approve

Method

Approve

Parameters

`dataTokenAddress`

string

`spender`

string

`amount`

string

Number of datatokens, as number. Will be converted to wei

`address`

string

Returns

Promise<TransactionReceipt>

src/datatokens/Datatokens.ts#L135

approveMinter

Method

Approve minter role

Parameters

`dataTokenAddress`

string

`address`

string

only proposad minter can call this

Returns

Promise<TransactionReceipt>

src/datatokens/Datatokens.ts#L557

balance

Method

Get Address Balance for datatoken

Parameters

`dataTokenAddress`

string

`address`

string

Returns

Promise<string>

src/datatokens/Datatokens.ts#L317

create

Method

Create new datatoken

Parameters

`metadataCacheUri`

string

`address`

string

`cap`?

string

Maximum cap (Number) - will be converted to wei

`name`?

string

Token name

`symbol`?

string

Token symbol

Returns

Promise<string>

src/datatokens/Datatokens.ts#L81

fromWei

Method

Convert from wei

Parameters

`amount`

string

Returns

string

src/datatokens/Datatokens.ts#L395

generateDtName

Method

Generate new datatoken name & symbol from a word list

Parameters

`wordList`?

Returns

src/datatokens/Datatokens.ts#L50

getBlob

Method

Get Blob

Parameters

`dataTokenAddress`

string

Returns

Promise<string>

src/datatokens/Datatokens.ts#L347

getCap

Method

Get Cap

Parameters

`dataTokenAddress`

string

Returns

Promise<string>

src/datatokens/Datatokens.ts#L377

getName

Method

Get Name

Parameters

`dataTokenAddress`

string

Returns

Promise<string>

src/datatokens/Datatokens.ts#L357

getPreviousValidOrders

Method

Search and return txid for a previous valid order with the same params

Parameters

`dataTokenAddress`

string

`amount`

string

`serviceId`

number

`timeout`

number

service timeout

`address`

string

consumer Address

Returns

Promise<string>

src/datatokens/Datatokens.ts#L466

getStartOrderEventSignature

Method

Returns

string

src/datatokens/Datatokens.ts#L505

getSymbol

Method

Get Symbol

Parameters

`dataTokenAddress`

string

Returns

Promise<string>

src/datatokens/Datatokens.ts#L367

isMinter

Method

Check if an address has the minter role

Parameters

`dataTokenAddress`

string

* @param {String} address

`address`

string

Returns

Promise<boolean>

src/datatokens/Datatokens.ts#L590

mint

Method

Mint

Parameters

`dataTokenAddress`

string

`address`

string

`amount`

string

Number of datatokens, as number. Will be converted to wei

`toAddress`?

string

only if toAddress is different from the minter

Returns

Promise<TransactionReceipt>

src/datatokens/Datatokens.ts#L171

proposeMinter

Method

Purpose a new minter

Parameters

`dataTokenAddress`

string

`newMinterAddress`

string

`address`

string

only current minter can call this

Returns

Promise<TransactionReceipt>

src/datatokens/Datatokens.ts#L521

startOrder

Method

Start Order

Parameters

`dataTokenAddress`

string

`consumer`

string

consumer Address

`amount`

string

`serviceId`

number

`mpFeeAddress`

string

`address`

string

consumer Address

Returns

Promise<TransactionReceipt>

src/datatokens/Datatokens.ts#L408

toWei

Method

Convert to wei

Parameters

`amount`

string

Returns

string

src/datatokens/Datatokens.ts#L387

transfer

Method

Transfer as number from address to toAddress

Parameters

`dataTokenAddress`

string

`toAddress`

string

`amount`

string

Number of datatokens, as number. Will be converted to wei

`address`

string

Returns

Promise<TransactionReceipt>

src/datatokens/Datatokens.ts#L214

transferFrom

Method

Transfer from fromAddress to address (needs an Approve operation before)

Parameters

`dataTokenAddress`

string

`fromAddress`

string

`amount`

string

Number of datatokens, as number. Will be converted to wei

`address`

string

Returns

Promise<string>

src/datatokens/Datatokens.ts#L283

transferToken

Method

Transfer as number from address to toAddress

Parameters

`dataTokenAddress`

string

`toAddress`

string

`amount`

string

Number of datatokens, as number. Will be converted to wei

`address`

string

Returns

Promise<TransactionReceipt>

src/datatokens/Datatokens.ts#L231

transferWei

Method

Transfer in wei from address to toAddress

Parameters

`dataTokenAddress`

string

`toAddress`

string

`amount`

string

Number of datatokens, as number. Expressed as wei

`address`

string

Returns

Promise<TransactionReceipt>

src/datatokens/Datatokens.ts#L249

`MetadataCache`

Provides an interface with Metadata Cache. Metadata Cache provides an off-chain database cache for on-chain metadata about data assets.

constructor

Constructor

private

Instantiate Metadata Cache (independently of Ocean) for off-chain interaction.

src/metadatacache/MetadataCache.ts#L59

fetch

Property

fetch

src/metadatacache/MetadataCache.ts#L46

logger

Property

private

logger

src/metadatacache/MetadataCache.ts#L47

metadataCacheUri

Property

private

metadataCacheUri

src/metadatacache/MetadataCache.ts#L48

url

Accessor

private

src/metadatacache/MetadataCache.ts#L50

encryptDDO

Method

Encrypts a DDO

Parameters

`ddo`

any

bytes to be encrypted.

Returns

Promise<any>

src/metadatacache/MetadataCache.ts#L149

getAccessUrl

Method

Parameters

`accessToken`

any

`payload`

any

Returns

Promise<string>

src/metadatacache/MetadataCache.ts#L69

getOwnerAssets

Method

Parameters

`owner`

string

Returns

Promise<QueryResult>

src/metadatacache/MetadataCache.ts#L277

getServiceEndpoint

Method

Parameters

`did`

default

Returns

string

src/metadatacache/MetadataCache.ts#L333

getURI

Method

Returns

string

src/metadatacache/MetadataCache.ts#L337

getVersionInfo

Method

Returns

Promise<any>

src/metadatacache/MetadataCache.ts#L65

queryMetadata

Method

Search over the DDOs using a query.

Parameters

`query`

SearchQuery

Query to filter the DDOs.

Returns

Promise<QueryResult>

src/metadatacache/MetadataCache.ts#L96

retire

Method

Retire a DDO (Delete)

Parameters

`did`

DID of the asset to update.

`updated`

string

Updated field of the DDO

`signature`

string

Signature using updated field to verify that the consumer has rights

Returns

Promise<string>

src/metadatacache/MetadataCache.ts#L302

retrieveDDO

Method

Retrieves a DDO by DID.

Parameters

`did`

DID of the asset.

`metadataServiceEndpoint`?

string

Returns

Promise<DDO>

src/metadatacache/MetadataCache.ts#L206

retrieveDDOByUrl

Method

Parameters

`metadataServiceEndpoint`?

string

Returns

Promise<DDO>

src/metadatacache/MetadataCache.ts#L232

storeDDO

Method

Stores a DDO in Metadata Store.

Parameters

`ddo`

DDO

DDO to be stored.

Returns

Promise<DDO>

src/metadatacache/MetadataCache.ts#L122

transferOwnership

Method

Transfer ownership of a DDO

Parameters

`did`

DID of the asset to update.

`newOwner`

string

New owner of the DDO

`updated`

string

Updated field of the DDO

`signature`

string

Signature using updated field to verify that the consumer has rights

Returns

Promise<string>

src/metadatacache/MetadataCache.ts#L244

transformResult

Method

private

Parameters

`__namedParameters`

any

Returns

QueryResult

src/metadatacache/MetadataCache.ts#L341

validateMetadata

Method

Validate Metadata

Parameters

`metadata`

metadata to be validated. If it's a Metadata, it will be validated agains the local schema. Else, it's validated agains the remote schema

Returns

Promise<ValidateMetadata>

src/metadatacache/MetadataCache.ts#L174

`Ocean`

Main interface for Ocean Protocol.

constructor

Constructor

private

OceanDispenser

Property

Ocean Dispenser submodule

OceanDispenser

src/ocean/Ocean.ts#L172

accounts

Property

Ocean account submodule

accounts

src/ocean/Ocean.ts#L129

assets

Property

Ocean assets submodule

assets

src/ocean/Ocean.ts#L142

compute

Property

Ocean compute submodule

compute

src/ocean/Ocean.ts#L148

datatokens

Property

Ocean DataTokens submodule

datatokens

src/ocean/Ocean.ts#L154

fixedRateExchange

Property

Ocean FixedRateExchange submodule

fixedRateExchange

src/ocean/Ocean.ts#L166

metadataCache

Property

MetadataCache instance.

metadataCache

src/ocean/Ocean.ts#L119

network

Property

Network instance

network

src/ocean/Ocean.ts#L101

onChainMetadata

Property

OnChainMetadataCache instance.

onChainMetadata

src/ocean/Ocean.ts#L124

pool

Property

Ocean Pools submodule

pool

src/ocean/Ocean.ts#L160

provider

Property

Provider instance.

provider

src/ocean/Ocean.ts#L107

utils

Property

Ocean utils submodule

utils

src/ocean/Ocean.ts#L191

versions

Property

Ocean versions submodule

versions

src/ocean/Ocean.ts#L185

web3Provider

Property

Web3 provider.

web3Provider

src/ocean/Ocean.ts#L113

config

Accessor

private

src/Instantiable.abstract.ts#L38

instanceConfig

Accessor

private

src/Instantiable.abstract.ts#L49

logger

Accessor

private

src/Instantiable.abstract.ts#L45

ocean

Accessor

private

src/Instantiable.abstract.ts#L24

web3

Accessor

private

src/Instantiable.abstract.ts#L31

setInstanceConfig

Method

private

Parameters

`config`

InstantiableConfig

Returns

void

src/Instantiable.abstract.ts#L78

getInstance

Method

static

Returns the instance of Ocean.

Parameters

`config`

Config

Ocean instance configuration.

Returns

Promise<Ocean>

src/ocean/Ocean.ts#L29

setInstanceConfig

Method

static

private

Parameters

`instance`

`__namedParameters`

InstantiableConfig

Returns

void

src/Instantiable.abstract.ts#L60

`Provider`

Provides an interface for provider service. Provider service is the technical component executed by the Publishers allowing to them to provide extended data services.

constructor

Constructor

private

baseUrl

Property

private

baseUrl

src/provider/Provider.ts#L29

computeAddress

Property

computeAddress

src/provider/Provider.ts#L31

nonce

Property

nonce

src/provider/Provider.ts#L28

providerAddress

Property

providerAddress

src/provider/Provider.ts#L32

providerVersion

Property

providerVersion

src/provider/Provider.ts#L33

servicesEndpoints

Property

servicesEndpoints

src/provider/Provider.ts#L30

config

Accessor

private

src/Instantiable.abstract.ts#L38

instanceConfig

Accessor

private

src/Instantiable.abstract.ts#L49

logger

Accessor

private

src/Instantiable.abstract.ts#L45

ocean

Accessor

private

src/Instantiable.abstract.ts#L24

url

Accessor

src/provider/Provider.ts#L52

web3

Accessor

private

src/Instantiable.abstract.ts#L31

computeDelete

Method

Instruct the provider to stop & delete all resources for a compute job

Parameters

`did`

string

`consumerAccount`

default

`jobId`

string

Returns

Promise<>

src/provider/Provider.ts#L357

computeStart

Method

Instruct the provider to start a compute job

Parameters

`did`

string

`consumerAccount`

default

`algorithm`

ComputeAlgorithm

`output`?

ComputeOutput

`txId`?

string

`serviceIndex`?

string

`serviceType`?

string

`tokenAddress`?

string

`additionalInputs`?

ComputeInput[]

Returns

Promise<>

src/provider/Provider.ts#L256

computeStatus

Method

Parameters

`did`

string

`consumerAccount`

default

`jobId`?

string

`txId`?

string

`sign`

boolean

Returns

Promise<>

src/provider/Provider.ts#L399

computeStop

Method

Instruct the provider to stop a compute job

Parameters

`did`

string

`consumerAccount`

default

`jobId`

string

Returns

Promise<>

src/provider/Provider.ts#L317

createHashSignature

Method

Parameters

`account`

default

`message`

string

Returns

Promise<string>

src/provider/Provider.ts#L101

createSignature

Method

Parameters

`account`

default

`agreementId`

string

Returns

Promise<string>

src/provider/Provider.ts#L92

download

Method

Parameters

`did`

string

`txId`

string

`tokenAddress`

string

`serviceType`

string

`serviceIndex`

string

`destination`

string

`account`

default

`files`

File[]

`index`

number

Returns

Promise<any>

src/provider/Provider.ts#L212

encrypt

Method

Parameters

`did`

string

`document`

any

`account`

default

Returns

Promise<string>

src/provider/Provider.ts#L110

fileinfo

Method

Get URL details (if possible)

Parameters

`url`

string

or did

Returns

Promise<>

src/provider/Provider.ts#L135

getComputeDeleteEndpoint

Method

Returns

ServiceEndpoint

src/provider/Provider.ts#L478

getComputeStartEndpoint

Method

Returns

ServiceEndpoint

src/provider/Provider.ts#L466

getComputeStatusEndpoint

Method

Returns

ServiceEndpoint

src/provider/Provider.ts#L474

getComputeStopEndpoint

Method

Returns

ServiceEndpoint

src/provider/Provider.ts#L470

getDownloadEndpoint

Method

Returns

ServiceEndpoint

src/provider/Provider.ts#L482

getEncryptEndpoint

Method

Returns

ServiceEndpoint

src/provider/Provider.ts#L458

getEndpointURL

Method

Parameters

`serviceName`

string

Returns

ServiceEndpoint

src/provider/Provider.ts#L85

getFileinfoEndpoint

Method

Returns

ServiceEndpoint

src/provider/Provider.ts#L462

getInitializeEndpoint

Method

Returns

ServiceEndpoint

src/provider/Provider.ts#L450

getNonce

Method

Get nonce from provider

Parameters

`consumerAddress`

string

Returns

Promise<string>

src/provider/Provider.ts#L172

getNonceEndpoint

Method

Returns

ServiceEndpoint

src/provider/Provider.ts#L454

getServiceEndpoints

Method

Returns the service endpoints that exist in provider.

Returns

Promise<>

src/provider/Provider.ts#L62

initialize

Method

Parameters

`asset`

`serviceIndex`

number

`serviceType`

string

`consumerAddress`

string

Returns

Promise<string>

src/provider/Provider.ts#L187

isFileConsumable

Method

Parameters

`did`

default

`serviceIndex`

number

Returns

Promise<boolean>

src/provider/Provider.ts#L152

isValidProvider

Method

Check for a valid provider at URL

Parameters

`url`

string

Returns

Promise<boolean>

src/provider/Provider.ts#L490

setBaseUrl

Method

Parameters

`url`

string

Returns

Promise<boolean>

src/provider/Provider.ts#L46

setInstanceConfig

Method

private

Parameters

`config`

InstantiableConfig

Returns

void

src/Instantiable.abstract.ts#L78

getInstance

Method

static

Returns the instance of Provider.

Parameters

`config`

InstantiableConfig

Returns

Promise<Provider>

src/provider/Provider.ts#L38

setInstanceConfig

Method

static

private

Parameters

`instance`

`__namedParameters`

InstantiableConfig

Returns

void

src/Instantiable.abstract.ts#L60

`AdditionalInformation`

Additional Information of Assets Metadata.

private

The party holding the legal copyright. Empty by default.

copyrightHolder

src/ddo/interfaces/AdditionalInformation.ts#L19

description

Property

private

Details of what the resource is. For a dataset, this attribute explains what the data represents and what it can be used for.

description

src/ddo/interfaces/AdditionalInformation.ts#L12

inLanguage

Property

private

The language of the content. Please use one of the language codes from the {@link https://tools.ietf.org/html/bcp47 IETF BCP 47 standard}.

inLanguage

src/ddo/interfaces/AdditionalInformation.ts#L54

links

Property

private

Mapping of links for data samples, or links to find out more information. Links may be to either a URL or another Asset. We expect marketplaces to converge on agreements of typical formats for linked data: The Ocean Protocol itself does not mandate any specific formats as these requirements are likely to be domain-specific.

links

src/ddo/interfaces/AdditionalInformation.ts#L46

structuredMarkup

Property

private

A link to machine-readable structured markup (such as ttl/json-ld/rdf) describing the dataset.

structuredMarkup

src/ddo/interfaces/AdditionalInformation.ts#L84

private

An indication of update latency - i.e. How often are updates expected (seldom, annually, quarterly, etc.), or is the resource static that is never expected to get updated.

updateFrequency

src/ddo/interfaces/AdditionalInformation.ts#L77

workExample

Property

private

Example of the concept of this asset. This example is part of the metadata, not an external link.

workExample

src/ddo/interfaces/AdditionalInformation.ts#L27

`Authentication`

publicKey

Property

private

publicKey

src/ddo/interfaces/Authentication.ts#L3

type

Property

private

type

src/ddo/interfaces/Authentication.ts#L2

`BestPrice`

address

Property

private

address

src/ddo/interfaces/BestPrice.ts#L3

datatoken

Property

private

datatoken

src/ddo/interfaces/BestPrice.ts#L7

exchange_id

Property

private

exchange_id

src/ddo/interfaces/BestPrice.ts#L9

isConsumable

Property

private

isConsumable

src/ddo/interfaces/BestPrice.ts#L5

ocean

Property

private

ocean

src/ddo/interfaces/BestPrice.ts#L6

pools

Property

private

pools

src/ddo/interfaces/BestPrice.ts#L10

type

Property

private

type

src/ddo/interfaces/BestPrice.ts#L2

value

Property

private

value

src/ddo/interfaces/BestPrice.ts#L4

`ConfigHelperConfig`

authMessage

Property

Message shown when the user creates its own token.

authMessage

src/models/Config.ts#L127

authTokenExpiration

Property

Token expiration time in ms.

authTokenExpiration

src/models/Config.ts#L133

datatokensABI

Property

datatokens ABI

datatokensABI

src/models/Config.ts#L57

dispenserABI

Property

DispenserABI

dispenserABI

src/models/Config.ts#L99

dispenserAddress

Property

DispenserAddress

dispenserAddress

src/models/Config.ts#L93

explorerUri

Property

private

explorerUri

src/utils/ConfigHelper.ts#L12

factoryABI

Property

Factory ABI

factoryABI

src/models/Config.ts#L51

factoryAddress

Property

Factory address

factoryAddress

src/models/Config.ts#L45

fixedRateExchangeAddress

Property

FixedRateExchangeAddress

fixedRateExchangeAddress

src/models/Config.ts#L81

fixedRateExchangeAddressABI

Property

FixedRateExchangeAddressABI

fixedRateExchangeAddressABI

src/models/Config.ts#L87

metadataCacheUri

Property

Metadata Store URL.

metadataCacheUri

src/models/Config.ts#L21

metadataContractABI

Property

DDOContractABI

metadataContractABI

src/models/Config.ts#L111

metadataContractAddress

Property

DDOContractAddress

metadataContractAddress

src/models/Config.ts#L105

network

Property

private

network

src/utils/ConfigHelper.ts#L10

networkId

Property

private

networkId

src/utils/ConfigHelper.ts#L9

nodeUri

Property

Ethereum node URL.

nodeUri

src/models/Config.ts#L9

oceanTokenAddress

Property

Ocean Token address

oceanTokenAddress

src/models/Config.ts#L39

oceanTokenSymbol

Property

private

oceanTokenSymbol

src/utils/ConfigHelper.ts#L13

parityUri

Property

parityUri

src/models/Config.ts#L136

poolABI

Property

Pool ABI

poolABI

src/models/Config.ts#L75

poolFactoryABI

Property

Pool Factory ABI

poolFactoryABI

src/models/Config.ts#L69

poolFactoryAddress

Property

Pool Factory address

poolFactoryAddress

src/models/Config.ts#L63

providerAddress

Property

Address of Provider.

providerAddress

src/models/Config.ts#L15

providerUri

Property

Provider URL.

providerUri

src/models/Config.ts#L27

startBlock

Property

block number of the deployment

startBlock

src/models/Config.ts#L116

subgraphUri

Property

private

subgraphUri

src/utils/ConfigHelper.ts#L11

threshold

Property

threshold

src/models/Config.ts#L138

verbose

Property

Log level.

verbose

src/models/Config.ts#L121

web3Provider

Property

Web3 Provider.

web3Provider

src/models/Config.ts#L33

`Credential`

type

Property

private

type

src/ddo/interfaces/Credentials.ts#L9

value

Property

private

value

src/ddo/interfaces/Credentials.ts#L10

`Credentials`

allow

Property

private

allow

src/ddo/interfaces/Credentials.ts#L14

deny

Property

private

deny

src/ddo/interfaces/Credentials.ts#L15

`Curation`

Curation attributes of Assets Metadata.

isListed

Property

private

Flag unsuitable content.

isListed

src/ddo/interfaces/Curation.ts#L32

numVotes

Property

private

Number of votes. 0 is the default value.

numVotes

src/ddo/interfaces/Curation.ts#L18

rating

Property

private

Decimal value between 0 and 1. 0 is the default value.

rating

src/ddo/interfaces/Curation.ts#L11

schema

Property

private

Schema applied to calculate the rating.

schema

src/ddo/interfaces/Curation.ts#L25

`EditableMetadata`

description

Property

private

description

src/ddo/interfaces/EditableMetadata.ts#L5

links

Property

private

links

src/ddo/interfaces/EditableMetadata.ts#L7

status

Property

private

status

src/ddo/interfaces/EditableMetadata.ts#L8

title

Property

private

title

src/ddo/interfaces/EditableMetadata.ts#L6

`EditableMetadataLinks`

name

Property

private

name

src/ddo/interfaces/EditableMetadataLinks.ts#L2

type

Property

private

type

src/ddo/interfaces/EditableMetadataLinks.ts#L4

url

Property

private

url

src/ddo/interfaces/EditableMetadataLinks.ts#L3

`File`

checksum

Property

private

File checksum.

checksum

src/ddo/interfaces/File.ts#L31

checksumType

Property

private

Checksum hash algorithm.

checksumType

src/ddo/interfaces/File.ts#L37

compression

Property

private

File compression (e.g. no, gzip, bzip2, etc).

compression

src/ddo/interfaces/File.ts#L63

contentLength

Property

private

File content length.

contentLength

src/ddo/interfaces/File.ts#L43

contentType

Property

private

File format, if applicable.

contentType

src/ddo/interfaces/File.ts#L25

encoding

Property

private

File encoding.

encoding

src/ddo/interfaces/File.ts#L56

index

Property

private

File index.

index

src/ddo/interfaces/File.ts#L18

name

Property

private

File name.

name

src/ddo/interfaces/File.ts#L6

resourceId

Property

private

Resource ID (depending on the source).

resourceId

src/ddo/interfaces/File.ts#L49

url

Property

private

File URL.

url

src/ddo/interfaces/File.ts#L12

valid

Property

private

File availability (check fileinfo connectivity)

valid

src/ddo/interfaces/File.ts#L69

`Metadata`

additionalInformation

Property

private

additionalInformation

src/ddo/interfaces/Metadata.ts#L9

curation

Property

private

curation

src/ddo/interfaces/Metadata.ts#L10

encryptedFiles

Property

private

encryptedFiles

src/ddo/interfaces/Metadata.ts#L8

main

Property

private

main

src/ddo/interfaces/Metadata.ts#L7

status

Property

private

status

src/ddo/interfaces/Metadata.ts#L11

`MetadataAlgorithm`

container

Property

private

container

src/ddo/interfaces/MetadataAlgorithm.ts#L7

format

Property

private

format

src/ddo/interfaces/MetadataAlgorithm.ts#L5

language

Property

private

language

src/ddo/interfaces/MetadataAlgorithm.ts#L4

rawcode

Property

private

rawcode

src/ddo/interfaces/MetadataAlgorithm.ts#L3

url

Property

private

url

src/ddo/interfaces/MetadataAlgorithm.ts#L2

version

Property

private

version

src/ddo/interfaces/MetadataAlgorithm.ts#L6

`MetadataMain`

Main attributes of assets metadata.

algorithm

Property

private

Metadata used only for assets with type `algorithm`.

algorithm

src/ddo/interfaces/MetadataMain.ts#L65

author

Property

private

Name of the entity generating this data (e.g. Tfl, Disney Corp, etc.).

author

src/ddo/interfaces/MetadataMain.ts#L45

dateCreated

Property

private

The date on which the asset was created by the originator in ISO 8601 format, Coordinated Universal Time.

dateCreated

src/ddo/interfaces/MetadataMain.ts#L29

datePublished

Property

private

The date on which the asset DDO was registered into the metadata store. This value is created automatically by Aquarius upon registering, so this value can't be set.

datePublished

src/ddo/interfaces/MetadataMain.ts#L38

files

Property

private

Array of File objects including the encrypted file urls and some additional information.

files

src/ddo/interfaces/MetadataMain.ts#L59

license

Property

private

Short name referencing the license of the asset (e.g. Public Domain, CC-0, CC-BY, No License Specified, etc. ). If it's not specified, the following value will be added: "No License Specified".

license

src/ddo/interfaces/MetadataMain.ts#L53