Ocean.js v0.19.0
JavaScript client library for Ocean Protocol
utils
generateDatatokenName
Function
private
Generate new datatoken name & symbol from a word list
src/utils/Datatokens.ts#L7CreateProgressStep
CredentialType
LogLevel
OceanPlatformTechStatus
OrderProgressStep
Account
Account information.
getEtherBalance
Method
Balance of Ether.(converted from wei).
Returns
Promise<string>
getOceanBalance
Method
Balance of Ocean Token. (converted from wei).
Returns
Promise<string>
getTokenBalance
Method
Balance of Any Token (converted from wei).
Parameters
TokenAdress
string
Returns
Promise<string>
getTokenDecimals
Method
Decimals of Any Token
Parameters
TokenAdress
string
Returns
Promise<number>
getTokenSymbol
Method
Symbol of a Token
Parameters
TokenAdress
string
Returns
Promise<string>
setInstanceConfig
Method
private
Parameters
config
InstantiableConfig
Returns
void
setPassword
Method
Set account password.
Parameters
password
string
Password for account.
Returns
void
setInstanceConfig
Method
static
private
Parameters
instance
T
__namedParameters
InstantiableConfig
Returns
void
Config
constructor
Constructor
private
authMessage
Property
Message shown when the user creates its own token.
authMessage
fixedRateExchangeAddress
Property
FixedRateExchangeAddress
fixedRateExchangeAddress
fixedRateExchangeAddressABI
Property
FixedRateExchangeAddressABI
fixedRateExchangeAddressABI
ConfigHelper
constructor
Constructor
private
getAddressesFromEnv
Method
Parameters
network
string
Returns
Partial<ConfigHelperConfig>
DDO
DID Descriptor Object.
Contains all the data related to an asset.
addProof
Method
Generates and adds a simple hash proof on publicKey
Parameters
publicKey
string
Public key to be used on personal sign.
password?
string
Returns
Promise<void>
findServiceById
Method
Finds a service of a DDO by index.
Parameters
index
number
Returns
Service<T>
findServiceByType
Method
Finds a service of a DDO by type.
Parameters
serviceType
T
Service type.
Returns
Service<T>
deserialize
Method
static
Deserializes the DDO object.
Parameters
ddoString
string
Returns
DID
Decentralized ID.
generate
Method
static
Generate a new DID.
Parameters
dataTokenAddress
string
Address of data token to use for DID.
Returns
parse
Method
static
Parses a DID from a string.
Parameters
didString
DID in string.
Returns
DataTokens
Provides an interface to DataTokens
constructor
Constructor
private
Instantiate DataTokens (independently of Ocean).
src/datatokens/Datatokens.ts#L30allowance
Method
Get Alloance
Parameters
dataTokenAddress
string
owner
string
spender
string
Returns
Promise<string>
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>
approveMinter
Method
Approve minter role
Parameters
dataTokenAddress
string
address
string
only proposad minter can call this
Returns
Promise<TransactionReceipt>
balance
Method
Get Address Balance for datatoken
Parameters
dataTokenAddress
string
address
string
Returns
Promise<string>
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>
generateDtName
Method
Generate new datatoken name & symbol from a word list
Parameters
wordList?
Returns
getBlob
Method
Get Blob
Parameters
dataTokenAddress
string
Returns
Promise<string>
getCap
Method
Get Cap
Parameters
dataTokenAddress
string
Returns
Promise<string>
getName
Method
Get Name
Parameters
dataTokenAddress
string
Returns
Promise<string>
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>
getSymbol
Method
Get Symbol
Parameters
dataTokenAddress
string
Returns
Promise<string>
isMinter
Method
Check if an address has the minter role
Parameters
dataTokenAddress
string
* @param {String} address
address
string
Returns
Promise<boolean>
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>
proposeMinter
Method
Purpose a new minter
Parameters
dataTokenAddress
string
newMinterAddress
string
address
string
only current minter can call this
Returns
Promise<TransactionReceipt>
startOrder
Method
Start Order
Parameters
dataTokenAddress
string
consumer
string
consumer Address
amount
string
serviceId
number
mpFeeAddress
string
address
string
consumer Address
Returns
Promise<TransactionReceipt>
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>
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>
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>
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>
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#L52encryptDDO
Method
Encrypts a DDO
Parameters
ddo
any
bytes to be encrypted.
Returns
Promise<any>
getAccessUrl
Method
Parameters
accessToken
any
payload
any
Returns
Promise<string>
queryMetadata
Method
Search over the DDOs using a query.
Parameters
query
SearchQuery
Query to filter the DDOs.
Returns
Promise<any>
retrieveDDO
Method
Retrieves a DDO by DID.
Parameters
did
DID of the asset.
metadataServiceEndpoint?
string
Returns
Promise<DDO>
retrieveDDOByUrl
Method
Parameters
metadataServiceEndpoint?
string
Returns
Promise<DDO>
sleep
Method
Simple blocking sleep function
Parameters
ms
number
Returns
Promise<unknown>
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>
waitForAqua
Method
Blocks until Aqua will cache the did (or the update for that did) or timeouts
Parameters
did
string
DID of the asset.
txid?
string
used when the did exists and we expect an update with that txid.
Returns
Promise<void>
Ocean
Main interface for Ocean Protocol.
constructor
Constructor
private
setInstanceConfig
Method
private
Parameters
config
InstantiableConfig
Returns
void
getInstance
Method
static
Returns the instance of Ocean.
Parameters
Returns
Promise<Ocean>
setInstanceConfig
Method
static
private
Parameters
instance
T
__namedParameters
InstantiableConfig
Returns
void
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
computeDelete
Method
Instruct the provider to stop & delete all resources for a compute job
Returns
Promise<>
computeStart
Method
Instruct the provider to start a compute job
Parameters
did
string
consumerAccount
algorithm
ComputeAlgorithm
output?
ComputeOutput
txId?
string
serviceIndex?
string
serviceType?
string
tokenAddress?
string
additionalInputs?
ComputeInput[]
userCustomParameters?
UserCustomParameters
Returns
Promise<>
computeStop
Method
Instruct the provider to stop a compute job
Returns
Promise<>
download
Method
Parameters
did
string
txId
string
tokenAddress
string
serviceType
string
serviceIndex
string
destination
string
account
files
File[]
index
number
userCustomParameters?
UserCustomParameters
Returns
Promise<any>
fileinfo
Method
Get URL details (if possible)
Parameters
url
string
or did
Returns
Promise<>
getNonce
Method
Get nonce from provider
Parameters
consumerAddress
string
Returns
Promise<string>
getServiceEndpoints
Method
Returns the service endpoints that exist
in provider.
Returns
Promise<>
initialize
Method
Parameters
asset
serviceIndex
number
serviceType
string
consumerAddress
string
userCustomParameters?
UserCustomParameters
Returns
Promise<string>
isValidProvider
Method
Check for a valid provider at URL
Parameters
url
string
Returns
Promise<boolean>
setInstanceConfig
Method
private
Parameters
config
InstantiableConfig
Returns
void
getInstance
Method
static
Returns the instance of Provider.
Parameters
config
InstantiableConfig
Returns
Promise<Provider>
setInstanceConfig
Method
static
private
Parameters
instance
T
__namedParameters
InstantiableConfig
Returns
void
AdditionalInformation
Additional Information of Assets Metadata.
categories
Property
private
Categories used to describe this content. Empty by default.
categories
copyrightHolder
Property
private
The party holding the legal copyright. Empty by default.
copyrightHolder
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
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
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
structuredMarkup
Property
private
A link to machine-readable structured markup (such as ttl/json-ld/rdf)
describing the dataset.
structuredMarkup
tags
Property
private
Keywords or tags used to describe this content. Empty by default.
tags
updateFrequency
Property
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
workExample
Property
private
Example of the concept of this asset. This example is part
of the metadata, not an external link.
workExample
Authentication
BestPrice
ConfigHelperConfig
authMessage
Property
Message shown when the user creates its own token.
authMessage
fixedRateExchangeAddress
Property
FixedRateExchangeAddress
fixedRateExchangeAddress
fixedRateExchangeAddressABI
Property
FixedRateExchangeAddressABI
fixedRateExchangeAddressABI
Credential
Credentials
Curation
Curation attributes of Assets Metadata.
numVotes
Property
private
Number of votes. 0 is the default value.
numVotes
rating
Property
private
Decimal value between 0 and 1. 0 is the default value.
rating
schema
Property
private
Schema applied to calculate the rating.
schema
EditableMetadata
EditableMetadataLinks
File
compression
Property
private
File compression (e.g. no, gzip, bzip2, etc).
compression
resourceId
Property
private
Resource ID (depending on the source).
resourceId
valid
Property
private
File availability (check fileinfo connectivity)
valid
Metadata
MetadataAlgorithm
MetadataMain
Main attributes of assets metadata.
algorithm
Property
private
Metadata used only for assets with type `algorithm`.
algorithm
author
Property
private
Name of the entity generating this data (e.g. Tfl, Disney Corp, etc.).
author
dateCreated
Property
private
The date on which the asset was created by the originator in
ISO 8601 format, Coordinated Universal Time.
dateCreated
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
files
Property
private
Array of File objects including the encrypted file urls and some additional information.
files
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
type
Property
private
Type of the Asset. Helps to filter by the type of asset ("dataset" or "algorithm").
type
OceanPlatformTech
OceanPlatformVersions
Proof
PublicKey
Public key data.
PurgatoryData
ServiceAccess
ServiceAccessAttributes
ServiceCommon
ServiceCommonAttributes
ServiceCompute
ServiceComputeAttributes
ServiceComputePrivacy
allowAllPublishedAlgorithms
Property
private
allowAllPublishedAlgorithms
publisherTrustedAlgorithms
Property
private
publisherTrustedAlgorithms